diff --git a/nightly/operator/advanced-configuration.html b/nightly/operator/advanced-configuration.html index 8460533ffdf..fb9a8b095d7 100644 --- a/nightly/operator/advanced-configuration.html +++ b/nightly/operator/advanced-configuration.html @@ -644,6 +644,21 @@
The Keycloak Operator offers updates strategies to control how the Operator handles changes to the Keycloak CR.
+ + | +
+
+
+While on preview stage, the feature |
+
Supported Updates Types:
1 | +Enable preview feature rolling-updates . |
+
2 | Set the desired update strategy here (Recreate in this example). |
account-api[:v1]
, account[:v3]
, admin-api[:v1]
, admin-fine-grained-authz[:v1,v2]
, admin[:v2]
, authorization[:v1]
, cache-embedded-remote-store[:v1]
, ciba[:v1]
, client-policies[:v1]
, client-secret-rotation[:v1]
, client-types[:v1]
, clusterless[:v1]
, declarative-ui[:v1]
, device-flow[:v1]
, docker[:v1]
, dpop[:v1]
, dynamic-scopes[:v1]
, fips[:v1]
, hostname[:v2]
, impersonation[:v1]
, ipa-tuura-federation[:v1]
, kerberos[:v1]
, login[:v2,v1]
, multi-site[:v1]
, oid4vc-vci[:v1]
, opentelemetry[:v1]
, organization[:v1]
, par[:v1]
, passkeys[:v1]
, persistent-user-sessions[:v1]
, preview
, quick-theme[:v1]
, recovery-codes[:v1]
, scripts[:v1]
, step-up-authentication[:v1]
, token-exchange-federated[:v2]
, token-exchange-standard[:v2]
, token-exchange-subject-impersonation[:v2]
, token-exchange[:v1]
, transient-users[:v1]
, update-email[:v1]
, user-event-metrics[:v1]
, web-authn[:v1]
account-api[:v1]
, account[:v3]
, admin-api[:v1]
, admin-fine-grained-authz[:v1,v2]
, admin[:v2]
, authorization[:v1]
, cache-embedded-remote-store[:v1]
, ciba[:v1]
, client-policies[:v1]
, client-secret-rotation[:v1]
, client-types[:v1]
, clusterless[:v1]
, declarative-ui[:v1]
, device-flow[:v1]
, docker[:v1]
, dpop[:v1]
, dynamic-scopes[:v1]
, fips[:v1]
, hostname[:v2]
, impersonation[:v1]
, ipa-tuura-federation[:v1]
, kerberos[:v1]
, login[:v2,v1]
, multi-site[:v1]
, oid4vc-vci[:v1]
, opentelemetry[:v1]
, organization[:v1]
, par[:v1]
, passkeys[:v1]
, persistent-user-sessions[:v1]
, preview
, quick-theme[:v1]
, recovery-codes[:v1]
, rolling-updates[:v1]
, scripts[:v1]
, step-up-authentication[:v1]
, token-exchange-federated[:v2]
, token-exchange-standard[:v2]
, token-exchange-subject-impersonation[:v2]
, token-exchange[:v1]
, transient-users[:v1]
, update-email[:v1]
, user-event-metrics[:v1]
, web-authn[:v1]
account
, account-api
, admin
, admin-api
, admin-fine-grained-authz
, authorization
, cache-embedded-remote-store
, ciba
, client-policies
, client-secret-rotation
, client-types
, clusterless
, declarative-ui
, device-flow
, docker
, dpop
, dynamic-scopes
, fips
, impersonation
, ipa-tuura-federation
, kerberos
, login
, multi-site
, oid4vc-vci
, opentelemetry
, organization
, par
, passkeys
, persistent-user-sessions
, preview
, quick-theme
, recovery-codes
, scripts
, step-up-authentication
, token-exchange
, token-exchange-federated
, token-exchange-standard
, token-exchange-subject-impersonation
, transient-users
, update-email
, user-event-metrics
, web-authn
account
, account-api
, admin
, admin-api
, admin-fine-grained-authz
, authorization
, cache-embedded-remote-store
, ciba
, client-policies
, client-secret-rotation
, client-types
, clusterless
, declarative-ui
, device-flow
, docker
, dpop
, dynamic-scopes
, fips
, impersonation
, ipa-tuura-federation
, kerberos
, login
, multi-site
, oid4vc-vci
, opentelemetry
, organization
, par
, passkeys
, persistent-user-sessions
, preview
, quick-theme
, recovery-codes
, rolling-updates
, scripts
, step-up-authentication
, token-exchange
, token-exchange-federated
, token-exchange-standard
, token-exchange-subject-impersonation
, transient-users
, update-email
, user-event-metrics
, web-authn
account-api[:v1]
, account[:v3]
, admin-api[:v1]
, admin-fine-grained-authz[:v1,v2]
, admin[:v2]
, authorization[:v1]
, cache-embedded-remote-store[:v1]
, ciba[:v1]
, client-policies[:v1]
, client-secret-rotation[:v1]
, client-types[:v1]
, clusterless[:v1]
, declarative-ui[:v1]
, device-flow[:v1]
, docker[:v1]
, dpop[:v1]
, dynamic-scopes[:v1]
, fips[:v1]
, hostname[:v2]
, impersonation[:v1]
, ipa-tuura-federation[:v1]
, kerberos[:v1]
, login[:v2,v1]
, multi-site[:v1]
, oid4vc-vci[:v1]
, opentelemetry[:v1]
, organization[:v1]
, par[:v1]
, passkeys[:v1]
, persistent-user-sessions[:v1]
, preview
, quick-theme[:v1]
, recovery-codes[:v1]
, scripts[:v1]
, step-up-authentication[:v1]
, token-exchange-federated[:v2]
, token-exchange-standard[:v2]
, token-exchange-subject-impersonation[:v2]
, token-exchange[:v1]
, transient-users[:v1]
, update-email[:v1]
, user-event-metrics[:v1]
, web-authn[:v1]
account-api[:v1]
, account[:v3]
, admin-api[:v1]
, admin-fine-grained-authz[:v1,v2]
, admin[:v2]
, authorization[:v1]
, cache-embedded-remote-store[:v1]
, ciba[:v1]
, client-policies[:v1]
, client-secret-rotation[:v1]
, client-types[:v1]
, clusterless[:v1]
, declarative-ui[:v1]
, device-flow[:v1]
, docker[:v1]
, dpop[:v1]
, dynamic-scopes[:v1]
, fips[:v1]
, hostname[:v2]
, impersonation[:v1]
, ipa-tuura-federation[:v1]
, kerberos[:v1]
, login[:v2,v1]
, multi-site[:v1]
, oid4vc-vci[:v1]
, opentelemetry[:v1]
, organization[:v1]
, par[:v1]
, passkeys[:v1]
, persistent-user-sessions[:v1]
, preview
, quick-theme[:v1]
, recovery-codes[:v1]
, rolling-updates[:v1]
, scripts[:v1]
, step-up-authentication[:v1]
, token-exchange-federated[:v2]
, token-exchange-standard[:v2]
, token-exchange-subject-impersonation[:v2]
, token-exchange[:v1]
, transient-users[:v1]
, update-email[:v1]
, user-event-metrics[:v1]
, web-authn[:v1]
Recovery codes
Rolling Updates
+Write custom authenticators using JavaScript
@@ -369,7 +373,7 @@account-api[:v1]
, account[:v3]
, admin-api[:v1]
, admin-fine-grained-authz[:v1,v2]
, admin[:v2]
, authorization[:v1]
, cache-embedded-remote-store[:v1]
, ciba[:v1]
, client-policies[:v1]
, client-secret-rotation[:v1]
, client-types[:v1]
, clusterless[:v1]
, declarative-ui[:v1]
, device-flow[:v1]
, docker[:v1]
, dpop[:v1]
, dynamic-scopes[:v1]
, fips[:v1]
, hostname[:v2]
, impersonation[:v1]
, ipa-tuura-federation[:v1]
, kerberos[:v1]
, login[:v2,v1]
, multi-site[:v1]
, oid4vc-vci[:v1]
, opentelemetry[:v1]
, organization[:v1]
, par[:v1]
, passkeys[:v1]
, persistent-user-sessions[:v1]
, preview
, quick-theme[:v1]
, recovery-codes[:v1]
, scripts[:v1]
, step-up-authentication[:v1]
, token-exchange-federated[:v2]
, token-exchange-standard[:v2]
, token-exchange-subject-impersonation[:v2]
, token-exchange[:v1]
, transient-users[:v1]
, update-email[:v1]
, user-event-metrics[:v1]
, web-authn[:v1]
account-api[:v1]
, account[:v3]
, admin-api[:v1]
, admin-fine-grained-authz[:v1,v2]
, admin[:v2]
, authorization[:v1]
, cache-embedded-remote-store[:v1]
, ciba[:v1]
, client-policies[:v1]
, client-secret-rotation[:v1]
, client-types[:v1]
, clusterless[:v1]
, declarative-ui[:v1]
, device-flow[:v1]
, docker[:v1]
, dpop[:v1]
, dynamic-scopes[:v1]
, fips[:v1]
, hostname[:v2]
, impersonation[:v1]
, ipa-tuura-federation[:v1]
, kerberos[:v1]
, login[:v2,v1]
, multi-site[:v1]
, oid4vc-vci[:v1]
, opentelemetry[:v1]
, organization[:v1]
, par[:v1]
, passkeys[:v1]
, persistent-user-sessions[:v1]
, preview
, quick-theme[:v1]
, recovery-codes[:v1]
, rolling-updates[:v1]
, scripts[:v1]
, step-up-authentication[:v1]
, token-exchange-federated[:v2]
, token-exchange-standard[:v2]
, token-exchange-subject-impersonation[:v2]
, token-exchange[:v1]
, transient-users[:v1]
, update-email[:v1]
, user-event-metrics[:v1]
, web-authn[:v1]
account
, account-api
, admin
, admin-api
, admin-fine-grained-authz
, authorization
, cache-embedded-remote-store
, ciba
, client-policies
, client-secret-rotation
, client-types
, clusterless
, declarative-ui
, device-flow
, docker
, dpop
, dynamic-scopes
, fips
, impersonation
, ipa-tuura-federation
, kerberos
, login
, multi-site
, oid4vc-vci
, opentelemetry
, organization
, par
, passkeys
, persistent-user-sessions
, preview
, quick-theme
, recovery-codes
, scripts
, step-up-authentication
, token-exchange
, token-exchange-federated
, token-exchange-standard
, token-exchange-subject-impersonation
, transient-users
, update-email
, user-event-metrics
, web-authn
account
, account-api
, admin
, admin-api
, admin-fine-grained-authz
, authorization
, cache-embedded-remote-store
, ciba
, client-policies
, client-secret-rotation
, client-types
, clusterless
, declarative-ui
, device-flow
, docker
, dpop
, dynamic-scopes
, fips
, impersonation
, ipa-tuura-federation
, kerberos
, login
, multi-site
, oid4vc-vci
, opentelemetry
, organization
, par
, passkeys
, persistent-user-sessions
, preview
, quick-theme
, recovery-codes
, rolling-updates
, scripts
, step-up-authentication
, token-exchange
, token-exchange-federated
, token-exchange-standard
, token-exchange-subject-impersonation
, transient-users
, update-email
, user-event-metrics
, web-authn
+ + | +
+
+
+While on preview stage, the feature |
+
The goal of this tool is to assist with modifying a Keycloak deployment, whether upgrading to a new version, enabling/disabling features, or changing configuration. The outcome will indicate whether a rolling upgrade is possible or if a recreate upgrade is required.
@@ -189,7 +204,7 @@bin/kc.[sh|bat] update-compatibility metadata --file=/path/to/file.json
+bin/kc.[sh|bat] update-compatibility metadata --file=/path/to/file.json --features=rolling-updates
bin/kc.[sh|bat] update-compatibility check --file=/path/to/file.json
+bin/kc.[sh|bat] update-compatibility check --file=/path/to/file.json --features=rolling-updates
Rolling Upgrade is not possible. The deployment must be shut down before applying the new configuration.
4
Rolling Upgrade is not possible.
+The feature rolling-updates
is disabled.