Skip to content

Commit 12f88fb

Browse files
author
Strimzi CI
committed
Update documentation (Strimzi CI build )
Signed-off-by: Strimzi CI <ci@strimzi.io>
1 parent 5b92d3e commit 12f88fb

10 files changed

Lines changed: 49 additions & 49 deletions

File tree

contributing/guide/contributing.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1472,7 +1472,7 @@ <h3 id="access_another_writers_unmerged_commits"><a class="link" href="#access_a
14721472
</ol>
14731473
</div>
14741474
<div class="paragraph">
1475-
<p><em>Revised on 2026-09-05 14:20:11 UTC</em></p>
1475+
<p><em>Revised on 2026-09-07 09:11:23 UTC</em></p>
14761476
</div>
14771477
</div>
14781478
</div>

contributing/guide/full.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1914,15 +1914,15 @@ <h3 id="access_another_writers_unmerged_commits"><a class="link" href="#access_a
19141914
</ol>
19151915
</div>
19161916
<div class="paragraph">
1917-
<p><em>Revised on 2026-09-05 14:20:09 UTC</em></p>
1917+
<p><em>Revised on 2026-09-07 09:11:21 UTC</em></p>
19181918
</div>
19191919
</div>
19201920
</div>
19211921
</div>
19221922
</div>
19231923
<div id="footer">
19241924
<div id="footer-text">
1925-
Last updated 2026-09-05 14:20:02 UTC
1925+
Last updated 2026-09-07 09:11:14 UTC
19261926
</div>
19271927
</div>
19281928
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

docs/operators/in-development/configuring-book.html

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3464,34 +3464,34 @@ <h3 id="configuring_service_account_based_authentication"><a class="link" href="
34643464
<div class="ulist">
34653465
<ul>
34663466
<li>
3467-
<p><code>oauth.jwks.endpoint.uri</code> points to the JWKS endpoint of the Kubernetes API server, which publishes the keys used to sign the Service Account tokens.
3468-
Tokens are validated locally by the Kafka nodes using these keys.</p>
3467+
<p><code>principal.builder.class</code> maps the validated tokens to Kafka principals.
3468+
For more information on the requirements that apply to principal builders, see the description of setting a custom principal builder that follows.</p>
34693469
</li>
34703470
<li>
3471-
<p><code>oauth.valid.issuer.uri</code> is the token issuer of your Kubernetes cluster and is checked against the <code>iss</code> claim of the token.</p>
3471+
<p><code>unsecuredLoginStringClaim_sub</code> satisfies the parameter validation of the <code>OAuthBearerLoginModule</code> and isn&#8217;t used for authentication.</p>
34723472
</li>
34733473
<li>
3474-
<p><code>oauth.server.bearer.token.location</code> and <code>oauth.ssl.truststore.location</code> point to the Service Account token and the Kubernetes CA certificate mounted by Strimzi into the Kafka containers.
3475-
The token is used to authenticate against the JWKS endpoint, which is not available to unauthenticated users by default.</p>
3474+
<p><code>oauth.check.access.token.type</code> is disabled because Service Account tokens don&#8217;t contain the <code>typ</code> claim expected by the OAuth standard.</p>
34763475
</li>
34773476
<li>
3478-
<p><code>oauth.username.claim</code> uses the <code>sub</code> claim of the token as the name of the Kafka principal.</p>
3477+
<p><code>oauth.custom.claim.check</code> restricts the listener to tokens issued for a specific audience.</p>
34793478
</li>
34803479
<li>
3481-
<p><code>oauth.check.access.token.type</code> is disabled because Service Account tokens don&#8217;t contain the <code>typ</code> claim expected by the OAuth standard.</p>
3480+
<p><code>oauth.valid.issuer.uri</code> is the token issuer of your Kubernetes cluster and is checked against the <code>iss</code> claim of the token.</p>
34823481
</li>
34833482
<li>
3484-
<p><code>oauth.include.accept.header</code> is disabled because the Kubernetes API server rejects requests that set the <code>Accept</code> header.</p>
3483+
<p><code>oauth.jwks.endpoint.uri</code> points to the JWKS endpoint of the Kubernetes API server, which publishes the keys used to sign the Service Account tokens.
3484+
Tokens are validated locally by the Kafka nodes using these keys.</p>
34853485
</li>
34863486
<li>
3487-
<p><code>unsecuredLoginStringClaim_sub</code> satisfies the parameter validation of the <code>OAuthBearerLoginModule</code> and isn&#8217;t used for authentication.</p>
3487+
<p><code>oauth.username.claim</code> uses the <code>sub</code> claim of the token as the name of the Kafka principal.</p>
34883488
</li>
34893489
<li>
3490-
<p><code>oauth.custom.claim.check</code> restricts the listener to tokens issued for a specific audience.</p>
3490+
<p><code>oauth.server.bearer.token.location</code> and <code>oauth.ssl.truststore.location</code> point to the Service Account token and the Kubernetes CA certificate mounted by Strimzi into the Kafka containers.
3491+
The token is used to authenticate against the JWKS endpoint, which is not available to unauthenticated users by default.</p>
34913492
</li>
34923493
<li>
3493-
<p><code>principal.builder.class</code> maps the validated tokens to Kafka principals.
3494-
For more information on the requirements that apply to principal builders, see the description of setting a custom principal builder that follows.</p>
3494+
<p><code>oauth.include.accept.header</code> is disabled because the Kubernetes API server rejects requests that set the <code>Accept</code> header.</p>
34953495
</li>
34963496
</ul>
34973497
</div>
@@ -6189,7 +6189,7 @@ <h2 id="type-ProjectedVolumeSource-reference"><a class="link" href="#type-Projec
61896189
<td class="tableblock halign-left valign-top"><p class="tableblock">serviceAccountToken</p></td>
61906190
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#serviceaccounttokenprojection-v1-core">ServiceAccountTokenProjection</a></p></td>
61916191
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
6192-
<p>information about the serviceAccountToken data to project.</p>
6192+
<p>Information about the serviceAccountToken data to project.</p>
61936193
</div></div></td>
61946194
</tr>
61956195
</tbody>
@@ -10607,18 +10607,18 @@ <h3 id="using_kubernetes_service_account_tokens_for_authentication"><a class="li
1060710607
<div class="ulist">
1060810608
<ul>
1060910609
<li>
10610-
<p>The <code>projected</code> volume asks Kubernetes to issue a token for the Service Account of the operand pod with the <code>my-internal-listener</code> audience and to store it in a file named <code>token</code>.</p>
10610+
<p><code>sasl.login.callback.handler.class</code> sets the Strimzi callback handler that passes the token to the Kafka cluster.</p>
1061110611
</li>
1061210612
<li>
10613-
<p>The volume is mounted at <code>/mnt/auth-token</code>, so the token is available in the <code>/mnt/auth-token/token</code> file.
10614-
Additional volumes can be mounted only into paths that start with <code>/mnt</code>.
10615-
For more information about additional volumes, see <a href="./configuring.html#con-common-configuration-volumes-reference" target="_blank" rel="noopener">Additional Volumes</a>.</p>
10613+
<p><code>oauth.access.token.location</code> tells the Kafka client where to find the token file.</p>
1061610614
</li>
1061710615
<li>
10618-
<p><code>oauth.access.token.location</code> tells the Kafka client where to find the token file.</p>
10616+
<p>The <code>projected</code> volume asks Kubernetes to issue a token for the Service Account of the operand pod with the <code>my-internal-listener</code> audience and to store it in a file named <code>token</code>.</p>
1061910617
</li>
1062010618
<li>
10621-
<p><code>sasl.login.callback.handler.class</code> sets the Strimzi callback handler that passes the token to the Kafka cluster.</p>
10619+
<p>The volume is mounted at <code>/mnt/auth-token</code>, so the token is available in the <code>/mnt/auth-token/token</code> file.
10620+
Additional volumes can be mounted only into paths that start with <code>/mnt</code>.
10621+
For more information about additional volumes, see <a href="./configuring.html#con-common-configuration-volumes-reference" target="_blank" rel="noopener">Additional Volumes</a>.</p>
1062210622
</li>
1062310623
</ul>
1062410624
</div>

docs/operators/in-development/contributing-book.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1472,7 +1472,7 @@ <h3 id="access_another_writers_unmerged_commits"><a class="link" href="#access_a
14721472
</ol>
14731473
</div>
14741474
<div class="paragraph">
1475-
<p><em>Revised on 2026-09-05 14:20:11 UTC</em></p>
1475+
<p><em>Revised on 2026-09-07 09:11:23 UTC</em></p>
14761476
</div>
14771477
</div>
14781478
</div>

docs/operators/in-development/full/configuring.html

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3906,34 +3906,34 @@ <h3 id="configuring_service_account_based_authentication"><a class="link" href="
39063906
<div class="ulist">
39073907
<ul>
39083908
<li>
3909-
<p><code>oauth.jwks.endpoint.uri</code> points to the JWKS endpoint of the Kubernetes API server, which publishes the keys used to sign the Service Account tokens.
3910-
Tokens are validated locally by the Kafka nodes using these keys.</p>
3909+
<p><code>principal.builder.class</code> maps the validated tokens to Kafka principals.
3910+
For more information on the requirements that apply to principal builders, see the description of setting a custom principal builder that follows.</p>
39113911
</li>
39123912
<li>
3913-
<p><code>oauth.valid.issuer.uri</code> is the token issuer of your Kubernetes cluster and is checked against the <code>iss</code> claim of the token.</p>
3913+
<p><code>unsecuredLoginStringClaim_sub</code> satisfies the parameter validation of the <code>OAuthBearerLoginModule</code> and isn&#8217;t used for authentication.</p>
39143914
</li>
39153915
<li>
3916-
<p><code>oauth.server.bearer.token.location</code> and <code>oauth.ssl.truststore.location</code> point to the Service Account token and the Kubernetes CA certificate mounted by Strimzi into the Kafka containers.
3917-
The token is used to authenticate against the JWKS endpoint, which is not available to unauthenticated users by default.</p>
3916+
<p><code>oauth.check.access.token.type</code> is disabled because Service Account tokens don&#8217;t contain the <code>typ</code> claim expected by the OAuth standard.</p>
39183917
</li>
39193918
<li>
3920-
<p><code>oauth.username.claim</code> uses the <code>sub</code> claim of the token as the name of the Kafka principal.</p>
3919+
<p><code>oauth.custom.claim.check</code> restricts the listener to tokens issued for a specific audience.</p>
39213920
</li>
39223921
<li>
3923-
<p><code>oauth.check.access.token.type</code> is disabled because Service Account tokens don&#8217;t contain the <code>typ</code> claim expected by the OAuth standard.</p>
3922+
<p><code>oauth.valid.issuer.uri</code> is the token issuer of your Kubernetes cluster and is checked against the <code>iss</code> claim of the token.</p>
39243923
</li>
39253924
<li>
3926-
<p><code>oauth.include.accept.header</code> is disabled because the Kubernetes API server rejects requests that set the <code>Accept</code> header.</p>
3925+
<p><code>oauth.jwks.endpoint.uri</code> points to the JWKS endpoint of the Kubernetes API server, which publishes the keys used to sign the Service Account tokens.
3926+
Tokens are validated locally by the Kafka nodes using these keys.</p>
39273927
</li>
39283928
<li>
3929-
<p><code>unsecuredLoginStringClaim_sub</code> satisfies the parameter validation of the <code>OAuthBearerLoginModule</code> and isn&#8217;t used for authentication.</p>
3929+
<p><code>oauth.username.claim</code> uses the <code>sub</code> claim of the token as the name of the Kafka principal.</p>
39303930
</li>
39313931
<li>
3932-
<p><code>oauth.custom.claim.check</code> restricts the listener to tokens issued for a specific audience.</p>
3932+
<p><code>oauth.server.bearer.token.location</code> and <code>oauth.ssl.truststore.location</code> point to the Service Account token and the Kubernetes CA certificate mounted by Strimzi into the Kafka containers.
3933+
The token is used to authenticate against the JWKS endpoint, which is not available to unauthenticated users by default.</p>
39333934
</li>
39343935
<li>
3935-
<p><code>principal.builder.class</code> maps the validated tokens to Kafka principals.
3936-
For more information on the requirements that apply to principal builders, see the description of setting a custom principal builder that follows.</p>
3936+
<p><code>oauth.include.accept.header</code> is disabled because the Kubernetes API server rejects requests that set the <code>Accept</code> header.</p>
39373937
</li>
39383938
</ul>
39393939
</div>
@@ -6631,7 +6631,7 @@ <h2 id="type-ProjectedVolumeSource-reference"><a class="link" href="#type-Projec
66316631
<td class="tableblock halign-left valign-top"><p class="tableblock">serviceAccountToken</p></td>
66326632
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#serviceaccounttokenprojection-v1-core">ServiceAccountTokenProjection</a></p></td>
66336633
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
6634-
<p>information about the serviceAccountToken data to project.</p>
6634+
<p>Information about the serviceAccountToken data to project.</p>
66356635
</div></div></td>
66366636
</tr>
66376637
</tbody>
@@ -11049,18 +11049,18 @@ <h3 id="using_kubernetes_service_account_tokens_for_authentication"><a class="li
1104911049
<div class="ulist">
1105011050
<ul>
1105111051
<li>
11052-
<p>The <code>projected</code> volume asks Kubernetes to issue a token for the Service Account of the operand pod with the <code>my-internal-listener</code> audience and to store it in a file named <code>token</code>.</p>
11052+
<p><code>sasl.login.callback.handler.class</code> sets the Strimzi callback handler that passes the token to the Kafka cluster.</p>
1105311053
</li>
1105411054
<li>
11055-
<p>The volume is mounted at <code>/mnt/auth-token</code>, so the token is available in the <code>/mnt/auth-token/token</code> file.
11056-
Additional volumes can be mounted only into paths that start with <code>/mnt</code>.
11057-
For more information about additional volumes, see <a href="./configuring.html#con-common-configuration-volumes-reference" target="_blank" rel="noopener">Additional Volumes</a>.</p>
11055+
<p><code>oauth.access.token.location</code> tells the Kafka client where to find the token file.</p>
1105811056
</li>
1105911057
<li>
11060-
<p><code>oauth.access.token.location</code> tells the Kafka client where to find the token file.</p>
11058+
<p>The <code>projected</code> volume asks Kubernetes to issue a token for the Service Account of the operand pod with the <code>my-internal-listener</code> audience and to store it in a file named <code>token</code>.</p>
1106111059
</li>
1106211060
<li>
11063-
<p><code>sasl.login.callback.handler.class</code> sets the Strimzi callback handler that passes the token to the Kafka cluster.</p>
11061+
<p>The volume is mounted at <code>/mnt/auth-token</code>, so the token is available in the <code>/mnt/auth-token/token</code> file.
11062+
Additional volumes can be mounted only into paths that start with <code>/mnt</code>.
11063+
For more information about additional volumes, see <a href="./configuring.html#con-common-configuration-volumes-reference" target="_blank" rel="noopener">Additional Volumes</a>.</p>
1106411064
</li>
1106511065
</ul>
1106611066
</div>
@@ -16447,7 +16447,7 @@ <h2 id="type-StrimziPodSetStatus-reference"><a class="link" href="#type-StrimziP
1644716447
</div>
1644816448
<div id="footer">
1644916449
<div id="footer-text">
16450-
Last updated 2026-09-05 14:20:02 UTC
16450+
Last updated 2026-09-07 09:11:14 UTC
1645116451
</div>
1645216452
</div>
1645316453
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

docs/operators/in-development/full/contributing.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1914,15 +1914,15 @@ <h3 id="access_another_writers_unmerged_commits"><a class="link" href="#access_a
19141914
</ol>
19151915
</div>
19161916
<div class="paragraph">
1917-
<p><em>Revised on 2026-09-05 14:20:09 UTC</em></p>
1917+
<p><em>Revised on 2026-09-07 09:11:21 UTC</em></p>
19181918
</div>
19191919
</div>
19201920
</div>
19211921
</div>
19221922
</div>
19231923
<div id="footer">
19241924
<div id="footer-text">
1925-
Last updated 2026-09-05 14:20:02 UTC
1925+
Last updated 2026-09-07 09:11:14 UTC
19261926
</div>
19271927
</div>
19281928
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

docs/operators/in-development/full/deploying.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39182,7 +39182,7 @@ <h4 id="reference_based_messaging_flow"><a class="link" href="#reference_based_m
3918239182
</div>
3918339183
<div id="footer">
3918439184
<div id="footer-text">
39185-
Last updated 2026-09-05 14:20:02 UTC
39185+
Last updated 2026-09-07 09:11:14 UTC
3918639186
</div>
3918739187
</div>
3918839188
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

docs/operators/in-development/full/glossary.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1127,7 +1127,7 @@ <h3 id="user_operator"><a class="link" href="#user_operator">User Operator</a></
11271127
</div>
11281128
<div id="footer">
11291129
<div id="footer-text">
1130-
Last updated 2026-09-05 14:20:02 UTC
1130+
Last updated 2026-09-07 09:11:14 UTC
11311131
</div>
11321132
</div>
11331133
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

docs/operators/in-development/full/overview.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1790,7 +1790,7 @@ <h2 id="metrics-overview_str"><a class="link" href="#metrics-overview_str">10. M
17901790
</div>
17911791
<div id="footer">
17921792
<div id="footer-text">
1793-
Last updated 2026-09-05 14:20:02 UTC
1793+
Last updated 2026-09-07 09:11:14 UTC
17941794
</div>
17951795
</div>
17961796
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

glossary/guide/full.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1127,7 +1127,7 @@ <h3 id="user_operator"><a class="link" href="#user_operator">User Operator</a></
11271127
</div>
11281128
<div id="footer">
11291129
<div id="footer-text">
1130-
Last updated 2026-09-05 14:20:02 UTC
1130+
Last updated 2026-09-07 09:11:14 UTC
11311131
</div>
11321132
</div>
11331133
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>

0 commit comments

Comments
 (0)