Deploying to main from @ abf57c7f79eb658d876a91898f1d3a276a932ec0 🚀

keycloak · Feb 7, 2025 · f16772b · f16772b
1 parent abf1cde
commit f16772b
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 8 deletions.
diff --git a/nightly/operator/advanced-configuration.html b/nightly/operator/advanced-configuration.html
@@ -644,6 +644,21 @@ <h3 id="_managing_keycloak_operator_updates_preview">Managing Keycloak Operator
 <div class="paragraph">
 <p>The Keycloak Operator offers updates strategies to control how the Operator handles changes to the Keycloak CR.</p>
 </div>
+<div class="admonitionblock caution">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-caution" title="Caution"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>While on preview stage, the feature <code>rolling-updates</code> must be enabled.
+Otherwise, the Keycloak Operator will fail.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
 <div class="paragraph">
 <p><strong>Supported Updates Types:</strong></p>
 </div>
@@ -687,14 +702,21 @@ <h4 id="_configuring_the_update_strategy">Configuring the Update Strategy</h4>
 metadata:
   name: example-kc
 spec:
+  features:
+    enabled:
+      - rolling-updates <i class="conum" data-value="1"></i><b>(1)</b>
   update:
-    strategy: Recreate|&lt;not set&gt; <i class="conum" data-value="1"></i><b>(1)</b></code></pre>
+    strategy: Recreate|&lt;not set&gt; <i class="conum" data-value="2"></i><b>(2)</b></code></pre>
 </div>
 </div>
 <div class="colist arabic">
 <table>
 <tr>
 <td><i class="conum" data-value="1"></i><b>1</b></td>
+<td>Enable preview feature <code>rolling-updates</code>.</td>
+</tr>
+<tr>
+<td><i class="conum" data-value="2"></i><b>2</b></td>
 <td>Set the desired update strategy here (Recreate in this example).</td>
 </tr>
 </table>

diff --git a/nightly/server/all-config.html b/nightly/server/all-config.html
@@ -971,7 +971,7 @@ <h2 id="category-feature">Feature</h2>
 </div>
 </div>
 </div></div></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>account-api[:v1]</code>, <code>account[:v3]</code>, <code>admin-api[:v1]</code>, <code>admin-fine-grained-authz[:v1,v2]</code>, <code>admin[:v2]</code>, <code>authorization[:v1]</code>, <code>cache-embedded-remote-store[:v1]</code>, <code>ciba[:v1]</code>, <code>client-policies[:v1]</code>, <code>client-secret-rotation[:v1]</code>, <code>client-types[:v1]</code>, <code>clusterless[:v1]</code>, <code>declarative-ui[:v1]</code>, <code>device-flow[:v1]</code>, <code>docker[:v1]</code>, <code>dpop[:v1]</code>, <code>dynamic-scopes[:v1]</code>, <code>fips[:v1]</code>, <code>hostname[:v2]</code>, <code>impersonation[:v1]</code>, <code>ipa-tuura-federation[:v1]</code>, <code>kerberos[:v1]</code>, <code>login[:v2,v1]</code>, <code>multi-site[:v1]</code>, <code>oid4vc-vci[:v1]</code>, <code>opentelemetry[:v1]</code>, <code>organization[:v1]</code>, <code>par[:v1]</code>, <code>passkeys[:v1]</code>, <code>persistent-user-sessions[:v1]</code>, <code>preview</code>, <code>quick-theme[:v1]</code>, <code>recovery-codes[:v1]</code>, <code>scripts[:v1]</code>, <code>step-up-authentication[:v1]</code>, <code>token-exchange-federated[:v2]</code>, <code>token-exchange-standard[:v2]</code>, <code>token-exchange-subject-impersonation[:v2]</code>, <code>token-exchange[:v1]</code>, <code>transient-users[:v1]</code>, <code>update-email[:v1]</code>, <code>user-event-metrics[:v1]</code>, <code>web-authn[:v1]</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>account-api[:v1]</code>, <code>account[:v3]</code>, <code>admin-api[:v1]</code>, <code>admin-fine-grained-authz[:v1,v2]</code>, <code>admin[:v2]</code>, <code>authorization[:v1]</code>, <code>cache-embedded-remote-store[:v1]</code>, <code>ciba[:v1]</code>, <code>client-policies[:v1]</code>, <code>client-secret-rotation[:v1]</code>, <code>client-types[:v1]</code>, <code>clusterless[:v1]</code>, <code>declarative-ui[:v1]</code>, <code>device-flow[:v1]</code>, <code>docker[:v1]</code>, <code>dpop[:v1]</code>, <code>dynamic-scopes[:v1]</code>, <code>fips[:v1]</code>, <code>hostname[:v2]</code>, <code>impersonation[:v1]</code>, <code>ipa-tuura-federation[:v1]</code>, <code>kerberos[:v1]</code>, <code>login[:v2,v1]</code>, <code>multi-site[:v1]</code>, <code>oid4vc-vci[:v1]</code>, <code>opentelemetry[:v1]</code>, <code>organization[:v1]</code>, <code>par[:v1]</code>, <code>passkeys[:v1]</code>, <code>persistent-user-sessions[:v1]</code>, <code>preview</code>, <code>quick-theme[:v1]</code>, <code>recovery-codes[:v1]</code>, <code>rolling-updates[:v1]</code>, <code>scripts[:v1]</code>, <code>step-up-authentication[:v1]</code>, <code>token-exchange-federated[:v2]</code>, <code>token-exchange-standard[:v2]</code>, <code>token-exchange-subject-impersonation[:v2]</code>, <code>token-exchange[:v1]</code>, <code>transient-users[:v1]</code>, <code>update-email[:v1]</code>, <code>user-event-metrics[:v1]</code>, <code>web-authn[:v1]</code></p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
@@ -988,7 +988,7 @@ <h2 id="category-feature">Feature</h2>
 </div>
 </div>
 </div></div></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>account</code>, <code>account-api</code>, <code>admin</code>, <code>admin-api</code>, <code>admin-fine-grained-authz</code>, <code>authorization</code>, <code>cache-embedded-remote-store</code>, <code>ciba</code>, <code>client-policies</code>, <code>client-secret-rotation</code>, <code>client-types</code>, <code>clusterless</code>, <code>declarative-ui</code>, <code>device-flow</code>, <code>docker</code>, <code>dpop</code>, <code>dynamic-scopes</code>, <code>fips</code>, <code>impersonation</code>, <code>ipa-tuura-federation</code>, <code>kerberos</code>, <code>login</code>, <code>multi-site</code>, <code>oid4vc-vci</code>, <code>opentelemetry</code>, <code>organization</code>, <code>par</code>, <code>passkeys</code>, <code>persistent-user-sessions</code>, <code>preview</code>, <code>quick-theme</code>, <code>recovery-codes</code>, <code>scripts</code>, <code>step-up-authentication</code>, <code>token-exchange</code>, <code>token-exchange-federated</code>, <code>token-exchange-standard</code>, <code>token-exchange-subject-impersonation</code>, <code>transient-users</code>, <code>update-email</code>, <code>user-event-metrics</code>, <code>web-authn</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>account</code>, <code>account-api</code>, <code>admin</code>, <code>admin-api</code>, <code>admin-fine-grained-authz</code>, <code>authorization</code>, <code>cache-embedded-remote-store</code>, <code>ciba</code>, <code>client-policies</code>, <code>client-secret-rotation</code>, <code>client-types</code>, <code>clusterless</code>, <code>declarative-ui</code>, <code>device-flow</code>, <code>docker</code>, <code>dpop</code>, <code>dynamic-scopes</code>, <code>fips</code>, <code>impersonation</code>, <code>ipa-tuura-federation</code>, <code>kerberos</code>, <code>login</code>, <code>multi-site</code>, <code>oid4vc-vci</code>, <code>opentelemetry</code>, <code>organization</code>, <code>par</code>, <code>passkeys</code>, <code>persistent-user-sessions</code>, <code>preview</code>, <code>quick-theme</code>, <code>recovery-codes</code>, <code>rolling-updates</code>, <code>scripts</code>, <code>step-up-authentication</code>, <code>token-exchange</code>, <code>token-exchange-federated</code>, <code>token-exchange-standard</code>, <code>token-exchange-subject-impersonation</code>, <code>transient-users</code>, <code>update-email</code>, <code>user-event-metrics</code>, <code>web-authn</code></p></td>
 </tr>
 </tbody>
 </table>

diff --git a/nightly/server/containers.html b/nightly/server/containers.html
@@ -547,7 +547,7 @@ <h2 id="_relevant_options">Relevant options</h2>
 </div>
 </div>
 </div></div></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>account-api[:v1]</code>, <code>account[:v3]</code>, <code>admin-api[:v1]</code>, <code>admin-fine-grained-authz[:v1,v2]</code>, <code>admin[:v2]</code>, <code>authorization[:v1]</code>, <code>cache-embedded-remote-store[:v1]</code>, <code>ciba[:v1]</code>, <code>client-policies[:v1]</code>, <code>client-secret-rotation[:v1]</code>, <code>client-types[:v1]</code>, <code>clusterless[:v1]</code>, <code>declarative-ui[:v1]</code>, <code>device-flow[:v1]</code>, <code>docker[:v1]</code>, <code>dpop[:v1]</code>, <code>dynamic-scopes[:v1]</code>, <code>fips[:v1]</code>, <code>hostname[:v2]</code>, <code>impersonation[:v1]</code>, <code>ipa-tuura-federation[:v1]</code>, <code>kerberos[:v1]</code>, <code>login[:v2,v1]</code>, <code>multi-site[:v1]</code>, <code>oid4vc-vci[:v1]</code>, <code>opentelemetry[:v1]</code>, <code>organization[:v1]</code>, <code>par[:v1]</code>, <code>passkeys[:v1]</code>, <code>persistent-user-sessions[:v1]</code>, <code>preview</code>, <code>quick-theme[:v1]</code>, <code>recovery-codes[:v1]</code>, <code>scripts[:v1]</code>, <code>step-up-authentication[:v1]</code>, <code>token-exchange-federated[:v2]</code>, <code>token-exchange-standard[:v2]</code>, <code>token-exchange-subject-impersonation[:v2]</code>, <code>token-exchange[:v1]</code>, <code>transient-users[:v1]</code>, <code>update-email[:v1]</code>, <code>user-event-metrics[:v1]</code>, <code>web-authn[:v1]</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>account-api[:v1]</code>, <code>account[:v3]</code>, <code>admin-api[:v1]</code>, <code>admin-fine-grained-authz[:v1,v2]</code>, <code>admin[:v2]</code>, <code>authorization[:v1]</code>, <code>cache-embedded-remote-store[:v1]</code>, <code>ciba[:v1]</code>, <code>client-policies[:v1]</code>, <code>client-secret-rotation[:v1]</code>, <code>client-types[:v1]</code>, <code>clusterless[:v1]</code>, <code>declarative-ui[:v1]</code>, <code>device-flow[:v1]</code>, <code>docker[:v1]</code>, <code>dpop[:v1]</code>, <code>dynamic-scopes[:v1]</code>, <code>fips[:v1]</code>, <code>hostname[:v2]</code>, <code>impersonation[:v1]</code>, <code>ipa-tuura-federation[:v1]</code>, <code>kerberos[:v1]</code>, <code>login[:v2,v1]</code>, <code>multi-site[:v1]</code>, <code>oid4vc-vci[:v1]</code>, <code>opentelemetry[:v1]</code>, <code>organization[:v1]</code>, <code>par[:v1]</code>, <code>passkeys[:v1]</code>, <code>persistent-user-sessions[:v1]</code>, <code>preview</code>, <code>quick-theme[:v1]</code>, <code>recovery-codes[:v1]</code>, <code>rolling-updates[:v1]</code>, <code>scripts[:v1]</code>, <code>step-up-authentication[:v1]</code>, <code>token-exchange-federated[:v2]</code>, <code>token-exchange-standard[:v2]</code>, <code>token-exchange-subject-impersonation[:v2]</code>, <code>token-exchange[:v1]</code>, <code>transient-users[:v1]</code>, <code>update-email[:v1]</code>, <code>user-event-metrics[:v1]</code>, <code>web-authn[:v1]</code></p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">

diff --git a/nightly/server/features.html b/nightly/server/features.html
@@ -303,6 +303,10 @@ <h2 id="_preview_features">Preview features</h2>
 <dd>
 <p><span class="features-description">Recovery codes</span></p>
 </dd>
+<dt class="hdlist1"><span class="features-name">rolling-updates</span></dt>
+<dd>
+<p><span class="features-description">Rolling Updates</span></p>
+</dd>
 <dt class="hdlist1"><span class="features-name">scripts</span></dt>
 <dd>
 <p><span class="features-description">Write custom authenticators using JavaScript</span></p>
@@ -369,7 +373,7 @@ <h2 id="_relevant_options">Relevant options</h2>
 </div>
 </div>
 </div></div></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>account-api[:v1]</code>, <code>account[:v3]</code>, <code>admin-api[:v1]</code>, <code>admin-fine-grained-authz[:v1,v2]</code>, <code>admin[:v2]</code>, <code>authorization[:v1]</code>, <code>cache-embedded-remote-store[:v1]</code>, <code>ciba[:v1]</code>, <code>client-policies[:v1]</code>, <code>client-secret-rotation[:v1]</code>, <code>client-types[:v1]</code>, <code>clusterless[:v1]</code>, <code>declarative-ui[:v1]</code>, <code>device-flow[:v1]</code>, <code>docker[:v1]</code>, <code>dpop[:v1]</code>, <code>dynamic-scopes[:v1]</code>, <code>fips[:v1]</code>, <code>hostname[:v2]</code>, <code>impersonation[:v1]</code>, <code>ipa-tuura-federation[:v1]</code>, <code>kerberos[:v1]</code>, <code>login[:v2,v1]</code>, <code>multi-site[:v1]</code>, <code>oid4vc-vci[:v1]</code>, <code>opentelemetry[:v1]</code>, <code>organization[:v1]</code>, <code>par[:v1]</code>, <code>passkeys[:v1]</code>, <code>persistent-user-sessions[:v1]</code>, <code>preview</code>, <code>quick-theme[:v1]</code>, <code>recovery-codes[:v1]</code>, <code>scripts[:v1]</code>, <code>step-up-authentication[:v1]</code>, <code>token-exchange-federated[:v2]</code>, <code>token-exchange-standard[:v2]</code>, <code>token-exchange-subject-impersonation[:v2]</code>, <code>token-exchange[:v1]</code>, <code>transient-users[:v1]</code>, <code>update-email[:v1]</code>, <code>user-event-metrics[:v1]</code>, <code>web-authn[:v1]</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>account-api[:v1]</code>, <code>account[:v3]</code>, <code>admin-api[:v1]</code>, <code>admin-fine-grained-authz[:v1,v2]</code>, <code>admin[:v2]</code>, <code>authorization[:v1]</code>, <code>cache-embedded-remote-store[:v1]</code>, <code>ciba[:v1]</code>, <code>client-policies[:v1]</code>, <code>client-secret-rotation[:v1]</code>, <code>client-types[:v1]</code>, <code>clusterless[:v1]</code>, <code>declarative-ui[:v1]</code>, <code>device-flow[:v1]</code>, <code>docker[:v1]</code>, <code>dpop[:v1]</code>, <code>dynamic-scopes[:v1]</code>, <code>fips[:v1]</code>, <code>hostname[:v2]</code>, <code>impersonation[:v1]</code>, <code>ipa-tuura-federation[:v1]</code>, <code>kerberos[:v1]</code>, <code>login[:v2,v1]</code>, <code>multi-site[:v1]</code>, <code>oid4vc-vci[:v1]</code>, <code>opentelemetry[:v1]</code>, <code>organization[:v1]</code>, <code>par[:v1]</code>, <code>passkeys[:v1]</code>, <code>persistent-user-sessions[:v1]</code>, <code>preview</code>, <code>quick-theme[:v1]</code>, <code>recovery-codes[:v1]</code>, <code>rolling-updates[:v1]</code>, <code>scripts[:v1]</code>, <code>step-up-authentication[:v1]</code>, <code>token-exchange-federated[:v2]</code>, <code>token-exchange-standard[:v2]</code>, <code>token-exchange-subject-impersonation[:v2]</code>, <code>token-exchange[:v1]</code>, <code>transient-users[:v1]</code>, <code>update-email[:v1]</code>, <code>user-event-metrics[:v1]</code>, <code>web-authn[:v1]</code></p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
@@ -386,7 +390,7 @@ <h2 id="_relevant_options">Relevant options</h2>
 </div>
 </div>
 </div></div></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>account</code>, <code>account-api</code>, <code>admin</code>, <code>admin-api</code>, <code>admin-fine-grained-authz</code>, <code>authorization</code>, <code>cache-embedded-remote-store</code>, <code>ciba</code>, <code>client-policies</code>, <code>client-secret-rotation</code>, <code>client-types</code>, <code>clusterless</code>, <code>declarative-ui</code>, <code>device-flow</code>, <code>docker</code>, <code>dpop</code>, <code>dynamic-scopes</code>, <code>fips</code>, <code>impersonation</code>, <code>ipa-tuura-federation</code>, <code>kerberos</code>, <code>login</code>, <code>multi-site</code>, <code>oid4vc-vci</code>, <code>opentelemetry</code>, <code>organization</code>, <code>par</code>, <code>passkeys</code>, <code>persistent-user-sessions</code>, <code>preview</code>, <code>quick-theme</code>, <code>recovery-codes</code>, <code>scripts</code>, <code>step-up-authentication</code>, <code>token-exchange</code>, <code>token-exchange-federated</code>, <code>token-exchange-standard</code>, <code>token-exchange-subject-impersonation</code>, <code>transient-users</code>, <code>update-email</code>, <code>user-event-metrics</code>, <code>web-authn</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>account</code>, <code>account-api</code>, <code>admin</code>, <code>admin-api</code>, <code>admin-fine-grained-authz</code>, <code>authorization</code>, <code>cache-embedded-remote-store</code>, <code>ciba</code>, <code>client-policies</code>, <code>client-secret-rotation</code>, <code>client-types</code>, <code>clusterless</code>, <code>declarative-ui</code>, <code>device-flow</code>, <code>docker</code>, <code>dpop</code>, <code>dynamic-scopes</code>, <code>fips</code>, <code>impersonation</code>, <code>ipa-tuura-federation</code>, <code>kerberos</code>, <code>login</code>, <code>multi-site</code>, <code>oid4vc-vci</code>, <code>opentelemetry</code>, <code>organization</code>, <code>par</code>, <code>passkeys</code>, <code>persistent-user-sessions</code>, <code>preview</code>, <code>quick-theme</code>, <code>recovery-codes</code>, <code>rolling-updates</code>, <code>scripts</code>, <code>step-up-authentication</code>, <code>token-exchange</code>, <code>token-exchange-federated</code>, <code>token-exchange-standard</code>, <code>token-exchange-subject-impersonation</code>, <code>transient-users</code>, <code>update-email</code>, <code>user-event-metrics</code>, <code>web-authn</code></p></td>
 </tr>
 </tbody>
 </table>

diff --git a/nightly/server/update-compatibility.html b/nightly/server/update-compatibility.html
@@ -98,6 +98,21 @@ <h1>Update Compatibility Tool</h1>
 </tr>
 </table>
 </div>
+<div class="admonitionblock caution">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-caution" title="Caution"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>While on preview stage, the feature <code>rolling-updates</code> must be enabled.
+Otherwise, the commands will fail.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
 <div class="paragraph">
 <p>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.</p>
@@ -189,7 +204,7 @@ <h2 id="_generating_the_metadata">Generating the Metadata</h2>
 <div class="listingblock">
 <div class="title">Generate and save the metadata from the current deployment.</div>
 <div class="content">
-<pre class="highlight"><code class="language-bash" data-lang="bash">bin/kc.[sh|bat] update-compatibility metadata --file=/path/to/file.json</code></pre>
+<pre class="highlight"><code class="language-bash" data-lang="bash">bin/kc.[sh|bat] update-compatibility metadata --file=/path/to/file.json --features=rolling-updates</code></pre>
 </div>
 </div>
 <div class="paragraph">
@@ -227,7 +242,7 @@ <h2 id="_checking_the_metadata">Checking the Metadata</h2>
 <div class="listingblock">
 <div class="title">Check the metadata from a previous deployment.</div>
 <div class="content">
-<pre class="highlight"><code class="language-bash" data-lang="bash">bin/kc.[sh|bat] update-compatibility check --file=/path/to/file.json</code></pre>
+<pre class="highlight"><code class="language-bash" data-lang="bash">bin/kc.[sh|bat] update-compatibility check --file=/path/to/file.json --features=rolling-updates</code></pre>
 </div>
 </div>
 <div class="admonitionblock warning">
@@ -316,6 +331,11 @@ <h2 id="_checking_the_metadata">Checking the Metadata</h2>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Rolling Upgrade is not possible.
 The deployment must be shut down before applying the new configuration.</p></td>
 </tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>4</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Rolling Upgrade is not possible.
+The feature <code>rolling-updates</code> is disabled.</p></td>
+</tr>
 </tbody>
 </table>
 </div>