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

KEYCLOAK-19549 specify backup is deprecated and external database is default (#1277)

Browse source 
* KEYCLOAK-19549 specify backup is deprecated and external database is default

* Update server_installation/topics/operator/keycloak-backup-cr.adoc

Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>

* KEYCLOAK-19549 [PR] implemented comments

* KEYCLOAK-19549 [PR] implemented comments

* KEYCLOAK-19549 [PR] implemented comments

Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
This commit is contained in:
Jonathan Vila 2021-11-10 11:55:15 +01:00 committed by GitHub
parent 54ebff775c
commit 0a0d802f1a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 15 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -2,7 +2,7 @@
[[_external_database]] [[_external_database]]
=== Connecting to an external database === Connecting to an external database
You can use the Operator to connect to an external PostgreSQL database by modifying the Keycloak custom resource and creating a `keycloak-db-secret` YAML file. Note that values are Base64 encoded. You can use the Operator to connect to an external PostgreSQL database by creating a `keycloak-db-secret` YAML file and setting Keycloak CR externalDatabase property to enabled. Note that values are Base64 encoded.
.Example YAML file for `keycloak-db-secret` .Example YAML file for `keycloak-db-secret`
```yaml ```yaml

7
server_installation/topics/operator/installation.adoc
View file

@ -153,3 +153,10 @@ endif::[]
* For more information on OpenShift Operators, see the link:https://docs.openshift.com/container-platform/4.4/operators/olm-what-operators-are.html[OpenShift Operators guide]. * For more information on OpenShift Operators, see the link:https://docs.openshift.com/container-platform/4.4/operators/olm-what-operators-are.html[OpenShift Operators guide].
[[_operator_production_usage]]
=== Using the {project_operator} in production environment
* The usage of embedded DB is not supported in a production environment.
* Backup CRD is deprecated and not supported in a production environment.
* We fully support using the rest of the CRDs in production, despite the `v1alpha1` version. We do not plan to make any breaking changes in this CRDs version.

5
server_installation/topics/operator/keycloak-backup-cr.adoc
View file

@ -2,6 +2,11 @@
[[_backup-cr]] [[_backup-cr]]
=== Scheduling database backups === Scheduling database backups
[WARNING]
====
Backup CR is *deprecated* and could be removed in future releases.
====
You can use the Operator to schedule automatic backups of the database as defined by custom resources. The custom resource triggers a backup job You can use the Operator to schedule automatic backups of the database as defined by custom resources. The custom resource triggers a backup job
ifeval::[{project_community}==true] ifeval::[{project_community}==true]
(or a `CronJob` in the case of Periodic Backups) (or a `CronJob` in the case of Periodic Backups)

4
server_installation/topics/operator/keycloak-cr.adoc
View file

@ -29,7 +29,7 @@ ifeval::[{project_community}==true]
or an Ingress for Kubernetes or an Ingress for Kubernetes
endif::[] endif::[]
for the {project_name} cluster. for the {project_name} cluster.
* `externalDatabase` - applies only if you want to connect an externally hosted database. That topic is covered in the xref:_external_database[external database] section of this guide. * `externalDatabase` - in order to connect to an externally hosted database. That topic is covered in the xref:_external_database[external database] section of this guide. Setting it to false should be used only for testing purposes and will install an embedded PostgreSQL database. Be aware that externalDatabase:false is *NOT* supported in production environments.
.Example YAML file for a Keycloak custom resource .Example YAML file for a Keycloak custom resource
```yaml ```yaml
@ -243,4 +243,4 @@ Events:
* Once the installation of {project_name} completes, you are ready to xref:_realm-cr[create a realm custom resource]. * Once the installation of {project_name} completes, you are ready to xref:_realm-cr[create a realm custom resource].
* If you have an external database, you can modify the Keycloak custom resource to support it. See xref:_external_database[Connecting to an external database]. * An external database is the supported option and needs to be enabled in the Keycloak custom resource. You can disable this option only for testing and enable it when you switch to a production environment. See xref:_external_database[Connecting to an external database].