-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #103 from vshn/keycloak/ha
Add end-user docs for Keycloak HA configuration
- Loading branch information
Showing
2 changed files
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
docs/modules/ROOT/pages/vshn-managed/keycloak/replicas.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|