libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

KEYCLOAK-19145 remove POSTGRES_HOST and improve docs on intermediate db service

Browse source
This commit is contained in:
Jonathan Vila 2021-11-10 08:23:33 +01:00 committed by GitHub
parent 1c5327bbf4
commit 71a78c0e80
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
server_installation/topics/operator/external-database.adoc
View file

@ -15,8 +15,6 @@ stringData:
POSTGRES_DATABASE: <Database Name> POSTGRES_DATABASE: <Database Name>
POSTGRES_EXTERNAL_ADDRESS: <External Database IP or URL (resolvable by K8s)> POSTGRES_EXTERNAL_ADDRESS: <External Database IP or URL (resolvable by K8s)>
POSTGRES_EXTERNAL_PORT: <External Database Port> POSTGRES_EXTERNAL_PORT: <External Database Port>
# Strongly recommended to use <'Keycloak CR-Name'-postgresql>
POSTGRES_HOST: <Database Service Name>
POSTGRES_PASSWORD: <Database Password> POSTGRES_PASSWORD: <Database Password>
# Required for AWS Backup functionality # Required for AWS Backup functionality
POSTGRES_SUPERUSER: true POSTGRES_SUPERUSER: true
@ -35,11 +33,12 @@ endif::[]
The other properties work in the same way for a hosted or external database. Set them as follows: The other properties work in the same way for a hosted or external database. Set them as follows:
* `POSTGRES_DATABASE` - Database name to be used. * `POSTGRES_DATABASE` - Database name to be used.
* `POSTGRES_HOST` - The name of the `Service` used to communicate with a database. Typically `keycloak-postgresql`.
* `POSTGRES_USERNAME` - Database username * `POSTGRES_USERNAME` - Database username
* `POSTGRES_PASSWORD` - Database password * `POSTGRES_PASSWORD` - Database password
* `POSTGRES_SUPERUSER` - Indicates, whether backups should run as super user. Typically `true`. * `POSTGRES_SUPERUSER` - Indicates, whether backups should run as super user. Typically `true`.
The Operator will create a Service named `keycloak-postgresql`. This Service is configured by the Operator to expose the external database based on the content of `POSTGRES_EXTERNAL_ADDRESS`. {project_name} uses this Service to connect to the Database, which means it does not connect to the Database directly but rather through this Service.
The Keycloak custom resource requires updates to enable external database support. The Keycloak custom resource requires updates to enable external database support.
.Example YAML file for `Keycloak` custom resource that supports an external database .Example YAML file for `Keycloak` custom resource that supports an external database