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

KEYCLOAK-15955 Implement a pluggable Upgrade strategy

Browse source
This commit is contained in:
vmuzikar 2020-11-20 17:21:16 +01:00 committed by Stian Thorgersen
parent 817eb73093
commit 02a09538ba
3 changed files with 45 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
server_installation/topics.adoc
View file

@ -60,3 +60,4 @@ include::topics/operator/external-database.adoc[]
include::topics/operator/keycloak-backup-cr.adoc[]
include::topics/operator/extensions.adoc[]
include::topics/operator/command-options.adoc[]
include::topics/operator/upgrading.adoc[]

43
server_installation/topics/operator/upgrading.adoc Normal file
View file

@ -0,0 +1,43 @@
[[_operator-upgrade-strategy]]
=== Upgrade strategy
You can configure how the operator performs {project_name} upgrades. You can choose from the following upgrade strategies.
* `recreate`: This is the default strategy. The operator removes all {project_name} replicas, optionally creates a backup
and then creates the replicas based on a newer {project_name} image. This strategy is suitable for major upgrades as
a single {project_name} version is accessing the underlying database. The downside is {project_name} needs to be shut
down during the upgrade.
* `rolling`: The operator removes one replica at a time and creates it again based on a newer {project_name} image. This
ensures a zero-downtime upgrade but is more suitable for minor version upgrades that do not require database migration
since the database is accessed by multiple {project_name} versions concurrently. Automatic backups are not supported
with this strategy.
.Example YAML file for a Keycloak custom resource
```yaml
apiVersion: keycloak.org/v1alpha1
kind: Keycloak
metadata:
name: example-keycloak
labels:
ifeval::[{project_community}==true]
app: keycloak
endif::[]
ifeval::[{project_product}==true]
app: sso
endif::[]
spec:
instances: 2
migration:
strategy: recreate
backups:
enabled: True
externalAccess:
enabled: True
```
ifeval::[{project_community}==true]
.Additional Resources
* For more information on rolling updates, see the https://kubernetes.io/docs/tutorials/stateful-application/basic-stateful-set/#rolling-update[Updating StatefulSets manual].
endif::[]

1
tests/src/test/resources/ignored-links
View file

@ -36,3 +36,4 @@ https://issues.redhat.com/secure/CreateIssueDetails*
https://developer.paypal.com/developer/applications
https://account.live.com/developers/applications/create
https://developer.twitter.com/apps/
https://kubernetes.io/docs/tutorials/stateful-application/basic-stateful-set/#rolling-update