Skip to content

Commit

Permalink
Merge pull request #103 from vshn/keycloak/ha
Browse files Browse the repository at this point in the history
Add end-user docs for Keycloak HA configuration
  • Loading branch information
TheBigLee authored May 17, 2024
2 parents 98fa6c8 + c0a4ff5 commit 3afc391
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
** xref:vshn-managed/keycloak/delete.adoc[Deletion]
** xref:vshn-managed/keycloak/plans.adoc[]
** xref:vshn-managed/keycloak/restore.adoc[Restore]
** xref:vshn-managed/keycloak/replicas.adoc[]
.OpenSearch
* xref:exoscale-dbaas/opensearch/index.adoc[On Exoscale]
Expand Down
29 changes: 29 additions & 0 deletions docs/modules/ROOT/pages/vshn-managed/keycloak/replicas.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
= High Availability

Keycloak by VSHN comes with support for multiple instances and High Availability using https://infinispan.org/[Infinispan].
You have the option to configure up to two additional replicas.

== Enable High Availability

To enable high availability you need to set the number of instances to `2` or `3`, which will provision one or two replicas.

The following example configuration will start a Keycloak service with two replicas.

[source,yaml]
----
apiVersion: vshn.appcat.vshn.io/v1
kind: VSHNKeycloak
metadata:
name: keycloak-app1-prod
spec:
parameters:
instances: 3
----

NOTE: When enabling HA for Keycloak, the underlying PostgreSQL database will also be switched to HA and will use the same amount of replicas as defined for Keycloak.

NOTE: Please be aware that enabling high availability will use significantly more resources and will cost two to three times more.

IMPORTANT: On APPUiO Cloud, it's currently not possible to deploy more than two instances, or more than a single instance that is larger than `standard-2`.
Please contact https://docs.appuio.cloud/user/contact.html[APPUiO Cloud support], if this blocks you from running your application.

0 comments on commit 3afc391

Please sign in to comment.