Add links to guides and GitHub discussions (#25271)
This should increase the likelihood for feedback Closes #25270 Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
This commit is contained in:
Alexander Schwartz
GitHub
parent
672cef89d2
commit
a08f112f79
17 changed files with 31 additions and 10 deletions
|
|
@ -67,7 +67,7 @@ Deploying Keycloak to multiple independent sites is essential for some environme
|
|||
This release adds preview-support for active-passive deployments for Keycloak.
|
||||
|
||||
A lot of work has gone into testing and verifying a setup which can sustain load and recover from the failure scenarios.
|
||||
To get started, use the high-availability guide which also includes a comprehensive blueprint to deploy a highly available Keycloak to a cloud environment.
|
||||
To get started, use the https://www.keycloak.org/guides#high-availability[high-availability guide] which also includes a comprehensive blueprint to deploy a highly available Keycloak to a cloud environment.
|
||||
|
||||
|
||||
= Adapters
|
||||
|
|
|
|||
|
|
@ -4,7 +4,8 @@
|
|||
<@tmpl.guide
|
||||
title="Building blocks active-passive deployments"
|
||||
summary="Overview of building blocks, alternatives and not considered options"
|
||||
preview="true" >
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269" >
|
||||
|
||||
The following building blocks are needed to set up an active-passive deployment with synchronous replication.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,8 @@
|
|||
<@tmpl.guide
|
||||
title="Concepts for active-passive deployments"
|
||||
summary="Understanding an active-passive deployment with synchronous replication"
|
||||
preview="true" >
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269" >
|
||||
|
||||
This topic describes a highly available active/passive setup and the behavior to expect. It outlines the requirements of the high availability active/passive architecture and describes the benefits and tradeoffs.
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
title="Concepts for database connection pools"
|
||||
summary="Understand these concepts to avoid resource exhaustion and congestion"
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
|
||||
tileVisible="false" >
|
||||
|
||||
This section is intended when you want to understand considerations and best practices on how to configure database connection pools for {project_name}.
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
title="Concepts for sizing CPU and memory resources"
|
||||
summary="Understand these concepts to avoid resource exhaustion and congestion"
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
|
||||
tileVisible="false" >
|
||||
|
||||
Use this as a starting point to size a product environment.
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
title="Concepts for configuring thread pools"
|
||||
summary="Understand these concepts to avoid resource exhaustion and congestion"
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
|
||||
tileVisible="false" >
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
title="Connect {project_name} with an external {jdgserver_name}"
|
||||
summary="Building block for an Infinispan deployment on Kubernetes"
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
|
||||
tileVisible="false" >
|
||||
|
||||
This topic describes advanced {jdgserver_name} configurations for {project_name} on Kubernetes.
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
title="Deploy AWS Aurora in multiple availability zones"
|
||||
summary="Building block for a database"
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
|
||||
tileVisible="false" >
|
||||
|
||||
This topic describes how to deploy an Aurora regional deployment of a PostgreSQL instance across multiple availability zones to tolerate one or more availability zone failures in a given AWS region.
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
title="Deploy an AWS Route 53 loadbalancer"
|
||||
summary="Building block for a loadbalancer"
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
|
||||
tileVisible="false" >
|
||||
|
||||
This topic describes the procedure required to configure DNS based failover for Multi-AZ {project_name} clusters using AWS Route53 for an active/passive setup. These instructions are intended for used with the setup described in the <@links.ha id="concepts-active-passive-sync"/> {section}.
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
title="Deploy {jdgserver_name} for HA with the {jdgserver_name} Operator"
|
||||
summary="Building block for an {jdgserver_name} deployment on Kubernetes"
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
|
||||
tileVisible="false" >
|
||||
|
||||
include::partials/infinispan/infinispan-attributes.adoc[]
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
title="Deploy {project_name} for HA with the {project_name} Operator"
|
||||
summary="Building block for a Keycloak deployment"
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269"
|
||||
tileVisible="false" >
|
||||
|
||||
This guide describes advanced {project_name} configurations for Kubernetes which are load tested and will recover from single Pod failures.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,8 @@
|
|||
<@tmpl.guide
|
||||
title="Multi-site deployments"
|
||||
summary="Connect multiple {project_name} deployments in different sites to increase the overall availability"
|
||||
preview="true" >
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269" >
|
||||
|
||||
{project_name} supports deployments that consist of multiple {project_name} instances that connect to each other using its embedded Infinispan; load balancers can distribute the load evenly across those instances.
|
||||
Those setups are intended for a transparent network on a single site.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,8 @@
|
|||
<@tmpl.guide
|
||||
title="Fail over to the secondary site"
|
||||
summary="This describes the automatic and operational procedures necessary"
|
||||
preview="true" >
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269" >
|
||||
|
||||
This {section} describes the steps to fail over from primary site to secondary site in a setup as outlined in <@links.ha id="concepts-active-passive-sync" /> together with the blueprints outlined in <@links.ha id="bblocks-active-passive-sync" />.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,8 @@
|
|||
<@tmpl.guide
|
||||
title="Recover from an out-of-sync passive site"
|
||||
summary="This describes the automatic and operational procedures necessary"
|
||||
preview="true" >
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269" >
|
||||
|
||||
This {section} describes the procedures required to synchronize the secondary site with the primary site in a setup as outlined in <@links.ha id="concepts-active-passive-sync" /> together with the blueprints outlined in <@links.ha id="bblocks-active-passive-sync" />.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,8 @@
|
|||
<@tmpl.guide
|
||||
title="Switch back to the primary site"
|
||||
summary="This describes the operational procedures necessary"
|
||||
preview="true" >
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269" >
|
||||
|
||||
These procedures switch back to the primary site back after a failover or switchover to the secondary site.
|
||||
In a setup as outlined in <@links.ha id="concepts-active-passive-sync" /> together with the blueprints outlined in <@links.ha id="bblocks-active-passive-sync" />.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,8 @@
|
|||
<@tmpl.guide
|
||||
title="Switch over to the secondary site"
|
||||
summary="This topic describes the operational procedures necessary"
|
||||
preview="true" >
|
||||
preview="true"
|
||||
previewDiscussionLink="https://github.com/keycloak/keycloak/discussions/25269" >
|
||||
|
||||
This procedure switches from the primary site to the secondary site when using a setup as outlined in <@links.ha id="concepts-active-passive-sync" /> together with the blueprints outlined in <@links.ha id="bblocks-active-passive-sync" />.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<#import "/templates/options.adoc" as opts>
|
||||
|
||||
<#macro guide title summary priority=999 includedOptions="" preview="" tileVisible="true">
|
||||
<#macro guide title summary priority=999 includedOptions="" preview="" tileVisible="true" previewDiscussionLink="">
|
||||
:guide-id: ${id}
|
||||
:guide-title: ${title}
|
||||
:guide-summary: ${summary}
|
||||
|
|
@ -14,7 +14,13 @@ include::../attributes.adoc[]
|
|||
= ${title}
|
||||
|
||||
ifeval::["${preview}" == "true"]
|
||||
WARNING: This {section} is describing a feature which is currently in preview. Please provide your feedback while we’re continuing to work on this.
|
||||
WARNING: This {section} is describing a feature which is currently in preview.
|
||||
ifeval::["${previewDiscussionLink}" == ""]
|
||||
Please provide your feedback while we’re continuing to work on this.
|
||||
endif::[]
|
||||
ifeval::["${previewDiscussionLink}" != ""]
|
||||
Please provide your feedback by link:${previewDiscussionLink}[joining this discussion] while we’re continuing to work on this.
|
||||
endif::[]
|
||||
endif::[]
|
||||
|
||||
<#nested>
|
||||
|
|
|
|||
Loading…
Reference in a new issue