mirror of
https://github.com/keycloak/keycloak.git
synced 2026-01-10 15:32:05 -03:30
93ede306f5
Closes #42869 Signed-off-by: Ryan Emerson <remerson@ibm.com> Signed-off-by: Alexander Schwartz <alexander.schwartz@ibm.com> Co-authored-by: Alexander Schwartz <alexander.schwartz@ibm.com>
87 lines
3.5 KiB
Plaintext
87 lines
3.5 KiB
Plaintext
<#import "/templates/guide.adoc" as tmpl>
|
|
<#import "/templates/links.adoc" as links>
|
|
<#import "/templates/profile.adoc" as profile>
|
|
|
|
<@tmpl.guide
|
|
title="High availability overview"
|
|
summary="Explore the different {project_name} high-availability architectures" >
|
|
|
|
{project_name} can be deployed in a number of high-availability architectures, allowing system administrators to pick the deployment type most suitable
|
|
for their needs. Ease of deployment, cost and fault-tolerance guarantees are important considerations when determining the correct architecture
|
|
for your deployments.
|
|
|
|
<@profile.ifProduct>
|
|
|
|
Any {project_name} deployment must be installed on a properly configured OpenShift cluster that has been configured per
|
|
the https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/installation_overview/index[OpenShift installation instructions].
|
|
For any {project_name} installations on OpenShift clusters that span multiple sites (i.e. single cluster or multi-clusters across multiple availability zones)
|
|
the OpenShift cluster must adhere to the https://access.redhat.com/articles/3220991[Guidance for Red Hat OpenShift Container Platform Clusters].
|
|
|
|
Ultimately high availability architectures involve many components in addition to the software running and the responsibility
|
|
for availability of the service is with the customer. This guide has recommended practices for using the {project_name}
|
|
in such high availability architectures.
|
|
|
|
</@profile.ifProduct>
|
|
|
|
== Architectures
|
|
|
|
This document describes two high availability architectures in which to deploy {project_name}: Single-cluster deployments and multi-cluster deployments.
|
|
|
|
=== Single-cluster deployments
|
|
|
|
Deploy {project_name} in a single cluster, optionally across multiple availability-zones or data centers with the required
|
|
network latency and database configuration, using <@links.ha id="single-cluster-introduction" />.
|
|
|
|
Advantages::
|
|
* No external dependencies
|
|
|
|
<@profile.ifProduct>
|
|
|
|
* Deployment in a single {kubernetes} cluster
|
|
|
|
</@profile.ifProduct>
|
|
|
|
<@profile.ifCommunity>
|
|
|
|
* Deployment in a single {kubernetes} cluster or a set of virtual machines with transparent networking
|
|
|
|
</@profile.ifCommunity>
|
|
|
|
* Tolerate availability-zone failure or data center failure, if deployed to multiple availability zones or data centers
|
|
|
|
Disadvantages::
|
|
* {kubernetes} cluster is a single point of failure:
|
|
** Control-plane failures could impact all {project_name} pods
|
|
|
|
=== Multi-cluster deployments
|
|
|
|
Connect two {project_name} clusters deployed for example in different {kubernetes} clusters in two availability zones
|
|
or data centers with the required network latency and database configuration using <@links.ha id="multi-cluster-introduction" />.
|
|
|
|
Advantages::
|
|
* Tolerate availability-zone failure
|
|
* Tolerate {kubernetes} cluster failure
|
|
* Bridge two networks that do not offer transparent networking
|
|
* Regulatory compliance when distinct deployments are required
|
|
|
|
Disadvantages::
|
|
* Complexity:
|
|
** External load-balancer required
|
|
** Separate {jdgserver_name} cluster required on each site
|
|
* Cost:
|
|
** Additional load-balancer required
|
|
** Additional compute is required for external {jdgserver_name} clusters
|
|
** Two {kubernetes} control-planes must be provisioned
|
|
* Not supported with three or more availability zones
|
|
|
|
=== Next Steps
|
|
|
|
To learn more about the different high-availability architectures and their supported configurations, please consult the individual {sections}.
|
|
|
|
<@profile.ifCommunity>
|
|
* <@links.ha id="single-cluster-introduction" />
|
|
* <@links.ha id="multi-cluster-introduction" />
|
|
</@profile.ifCommunity>
|
|
|
|
</@tmpl.guide>
|