apiVersion: k8s.keycloak.org/v2alpha1
+kind: Keycloak
+metadata:
+ name: example-kc
+spec:
+ update:
+ strategy: Recreate|<not set> (1)
+diff --git a/2024/01/keycloak-2305-released.html b/2024/01/keycloak-2305-released.html index 0785033b828..93f92bb6685 100644 --- a/2024/01/keycloak-2305-released.html +++ b/2024/01/keycloak-2305-released.html @@ -62,6 +62,9 @@
January 29 2024
+To download the release go to Keycloak downloads.
diff --git a/nightly/guides.html b/nightly/guides.html index d31cc70be47..d27f2d8fae5 100644 --- a/nightly/guides.html +++ b/nightly/guides.html @@ -786,21 +786,6 @@The Keycloak Operator offers updates strategies to control how the Operator handles changes to the Keycloak CR.
+Supported Updates Types:
+Update the StatefulSet in a rolling fashion, minimizing downtime (requires multiple replicas).
+Scale down the StatefulSet before applying updates, causing temporary downtime.
+The update strategy is specified within the spec
section of the Keycloak CR YAML definition.
+ + | +
+
+
+During this preview stage, the update strategy defaults to mimicking Keycloak 26.1 or older behavior: +When the Keycloak CR’s image field changes, the Operator scales down the StatefulSet before applying the new image, resulting in downtime. +Any configuration change will be a rolling update. + |
+
apiVersion: k8s.keycloak.org/v2alpha1
+kind: Keycloak
+metadata:
+ name: example-kc
+spec:
+ update:
+ strategy: Recreate|<not set> (1)
+1 | +Set the desired update strategy here (Recreate in this example). | +
Value | +Downtime? | +Description | +
---|---|---|
|
+On image name or tag change |
+Mimics Keycloak 26.1 or older behavior. +When the image field changes, the StatefulSet is scaled down before applying the new image. |
+
|
+On any configuration or image change |
+The StatefulSet is scaled down before applying the new configuration or image. |
+
When you export a realm specific file name conventions are used, which must also be used for importing from a directory or import at startup. The realm file to be imported must be named <realm name>-realm.json. +Regular and federated user files associated with a realm must be named <realm-name>-users-<file number>.json and <realm-name>-federated-users-<file number>.json. Failure to use this convention will result in errors or +user files not being imported.
+