Skip to content

Commit

Permalink
Update documentation (Strimzi CI build )
Browse files Browse the repository at this point in the history
Signed-off-by: Strimzi CI <[email protected]>
  • Loading branch information
Strimzi CI committed Jul 26, 2024
1 parent a1d2172 commit 3509d47
Show file tree
Hide file tree
Showing 9 changed files with 587 additions and 131 deletions.
2 changes: 1 addition & 1 deletion contributing/guide/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -1485,7 +1485,7 @@ <h3 id="access_another_writers_unmerged_commits"><a class="link" href="#access_a
</ol>
</div>
<div class="paragraph">
<p><em>Revised on 2024-07-26 14:13:14 UTC</em></p>
<p><em>Revised on 2024-07-26 16:54:32 UTC</em></p>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions contributing/guide/full.html
Original file line number Diff line number Diff line change
Expand Up @@ -1927,15 +1927,15 @@ <h3 id="access_another_writers_unmerged_commits"><a class="link" href="#access_a
</ol>
</div>
<div class="paragraph">
<p><em>Revised on 2024-07-26 14:13:13 UTC</em></p>
<p><em>Revised on 2024-07-26 16:54:30 UTC</em></p>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-26 14:12:50 UTC
Last updated 2024-07-26 16:54:09 UTC
</div>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
Expand Down
14 changes: 7 additions & 7 deletions docs/operators/in-development/configuring-book.html
Original file line number Diff line number Diff line change
Expand Up @@ -2810,7 +2810,7 @@ <h2 id="type-KafkaListenerAuthenticationOAuth-reference"><a class="link" href="#
<td class="tableblock halign-left valign-top"><p class="tableblock">fallbackUserNameClaim</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>The fallback username claim to be used for the user id if the claim specified by <code>userNameClaim</code> is not present. This is useful when <code>client_credentials</code> authentication only results in the client id being provided in another claim. It only takes effect if <code>userNameClaim</code> is set.</p>
<p>The fallback username claim to be used for the user ID if the claim specified by <code>userNameClaim</code> is not present. This is useful when <code>client_credentials</code> authentication only results in the client ID being provided in another claim. It only takes effect if <code>userNameClaim</code> is set.</p>
</div></div></td>
</tr>
<tr>
Expand Down Expand Up @@ -2985,14 +2985,14 @@ <h2 id="type-KafkaListenerAuthenticationOAuth-reference"><a class="link" href="#
<td class="tableblock halign-left valign-top"><p class="tableblock">serverBearerTokenLocation</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Path to the file on the local filesystem that contains a bearer token to be used instead of client_id and secret when authenticating to authorization server.</p>
<p>Path to the file on the local filesystem that contains a bearer token to be used instead of client ID and secret when authenticating to authorization server.</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">userNamePrefix</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>The prefix to use with the value of <code>userNameClaim</code> to construct the user id. This only takes effect if <code>userNameClaim</code> is specified, and the value is present for the claim. When used in combination with <code>fallbackUserNameClaims</code> it ensures consistent mapping of usernames and client ids into the same user id space and prevents name collisions.</p>
<p>The prefix to use with the value of <code>userNameClaim</code> to construct the user ID. This only takes effect if <code>userNameClaim</code> is specified and the value is present for the claim. When used in combination with <code>fallbackUserNameClaims</code>, it ensures consistent mapping of usernames and client IDs into the same user ID space and prevents name collisions.</p>
</div></div></td>
</tr>
</tbody>
Expand Down Expand Up @@ -10288,11 +10288,11 @@ <h2 id="type-KafkaClientAuthenticationOAuth-reference"><a class="link" href="#ty
</div>
</div>
<div class="listingblock">
<div class="title">An example of OAuth client authentication using an access token provided in the form of the file on the mounted filesystem</div>
<div class="title">Example (service account) access token configuration specifying a mounted file</div>
<div class="content">
<pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">authentication:
type: oauth
accessTokenLocation: `/path/to/token/file`</code></pre>
accessTokenLocation: `/var/run/secrets/kubernetes.io/serviceaccount/token`</code></pre>
</div>
</div>
<div class="paragraph">
Expand Down Expand Up @@ -10559,7 +10559,7 @@ <h3 id="type-KafkaClientAuthenticationOAuth-schema-reference"><a class="link" hr
<td class="tableblock halign-left valign-top"><p class="tableblock">clientAssertion</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#type-GenericSecretSource-reference"><code>GenericSecretSource</code></a></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Link to Kubernetes Secret containing the client assertion which was manually configured for the client.</p>
<p>Link to Kubernetes secret containing the client assertion which was manually configured for the client.</p>
</div></div></td>
</tr>
<tr>
Expand All @@ -10573,7 +10573,7 @@ <h3 id="type-KafkaClientAuthenticationOAuth-schema-reference"><a class="link" hr
<td class="tableblock halign-left valign-top"><p class="tableblock">clientAssertionType</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>The client assertion type. If not set, and <code>clientAssertion</code> or <code>clientAssertionLocation</code> is configured, then this value defaults to <code>urn:ietf:params:oauth:client-assertion-type:jwt-bearer</code>.</p>
<p>The client assertion type. If not set, and either <code>clientAssertion</code> or <code>clientAssertionLocation</code> is configured, this value defaults to <code>urn:ietf:params:oauth:client-assertion-type:jwt-bearer</code>.</p>
</div></div></td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/operators/in-development/contributing-book.html
Original file line number Diff line number Diff line change
Expand Up @@ -1485,7 +1485,7 @@ <h3 id="access_another_writers_unmerged_commits"><a class="link" href="#access_a
</ol>
</div>
<div class="paragraph">
<p><em>Revised on 2024-07-26 14:13:14 UTC</em></p>
<p><em>Revised on 2024-07-26 16:54:32 UTC</em></p>
</div>
</div>
</div>
Expand Down
Loading

0 comments on commit 3509d47

Please sign in to comment.