Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(build): updates for warnings highlighted in build #9725

Merged
merged 1 commit into from
Feb 21, 2024
Merged

docs(build): updates for warnings highlighted in build #9725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions api/src/main/java/io/strimzi/api/kafka/model/kafka/PersistentClaimStorage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ public void setId(Integer id) {
super.setId(id);
}

@Description("When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). " +
"Mandatory when type=persistent-claim.")
@Description("When `type=persistent-claim`, defines the size of the persistent volume claim, such as 100Gi. " +
"Mandatory when `type=persistent-claim`.")
public String getSize() {
return size;
}
Expand Down
2 changes: 1 addition & 1 deletion documentation/modules/appendix_crds.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,7 +602,7 @@ It must have the value `persistent-claim` for the type `PersistentClaimStorage`.
|Must be `persistent-claim`.
|size
|string
|When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). Mandatory when type=persistent-claim.
|When `type=persistent-claim`, defines the size of the persistent volume claim, such as 100Gi. Mandatory when `type=persistent-claim`.
|selector
|map
|Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
Expand Down
8 changes: 6 additions & 2 deletions documentation/modules/oauth/proc-oauth-authentication-broker-config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,9 @@ The examples here show the configuration options as configured for external list
<8> The duration the JWKS certificates are considered valid before they expire. Default is `360` seconds. If you specify a longer time, consider the risk of allowing access to revoked certificates.
<9> The period between refreshes of JWKS certificates. The interval must be at least 60 seconds shorter than the expiry interval. Default is `300` seconds.
<10> The minimum pause in seconds between consecutive attempts to refresh JWKS public keys. When an unknown signing key is encountered, the JWKS keys refresh is scheduled outside the regular periodic schedule with at least the specified pause since the last refresh attempt. The refreshing of keys follows the rule of exponential backoff, retrying on unsuccessful refreshes with ever increasing pause, until it reaches `jwksRefreshSeconds`. The default value is 1.

--
+
--
[[example-2]]
.Example 2: Configuring token validation using an introspection endpoint
[source,yaml,subs="+quotes,attributes"]
Expand All @@ -99,15 +101,16 @@ The examples here show the configuration options as configured for external list
userNameClaim: preferred_username # <4>
maxSecondsWithoutReauthentication: 3600 # <5>
----
--
<1> URI of the token introspection endpoint.
<2> Client ID to identify the client.
<3> Client Secret and client ID is used for authentication.
<4> The token claim (or key) that contains the actual username used to identify the user. Its value depends on the authorization server. If necessary, a JsonPath expression like `"['user.info'].['user.id']"` can be used to retrieve the username from nested JSON attributes within a token.
<5> (Optional) Activates the Kafka re-authentication mechanism that enforces session expiry to the same length of time as the access token. If the specified value is less than the time left for the access token to expire, then the client will have to re-authenticate before the actual token expiry. By default, the session does not expire when the access token expires, and the client does not attempt re-authentication.
--
+
Depending on how you apply OAuth 2.0 authentication, and the type of authorization server, there are additional (optional) configuration settings you can use:
+
--
[source,yaml,subs="+quotes,attributes"]
----
# ...
Expand Down Expand Up @@ -154,6 +157,7 @@ For production, always use `https://` urls.
<17> A JsonPath query that is used to extract groups information from either the JWT token or the introspection endpoint response. This option is not set by default. By configuring this option, a custom authorizer can make authorization decisions based on user groups.
<18> A delimiter used to parse groups information when it is returned as a single delimited string. The default value is ',' (comma).
<19> Some authorization servers have issues with client sending `Accept: application/json` header. By setting `includeAcceptHeader: false` the header will not be sent. Default is `true`.
--

. Save and exit the editor, then wait for rolling updates to complete.

Expand Down
5 changes: 5 additions & 0 deletions documentation/modules/oauth/proc-oauth-kafka-config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ For OAuth 2.0 authentication, you can use the following options:
+
For example, here OAuth 2.0 is assigned to the Kafka Bridge client using a client ID and secret, and TLS:
+
--
[source,yaml,subs="+quotes,attributes"]
----
apiVersion: {KafkaApiVersion}
Expand All @@ -80,9 +81,11 @@ spec:
<1> Authentication type set to `oauth`.
<2> URI of the token endpoint for authentication.
<3> Trusted certificates for TLS connection to the authorization server.
--
+
Depending on how you apply OAuth 2.0 authentication, and the type of authorization server, there are additional configuration options you can use:
+
--
[source,yaml,subs="+quotes,attributes"]
----
# ...
Expand Down Expand Up @@ -115,6 +118,8 @@ In this case it is `kafka`.
<8> (Optional) The maximum number of times to retry a failed HTTP request to the authorization server. The default value is `0`, meaning that no retries are performed. To use this option effectively, consider reducing the timeout times for the `connectTimeoutSeconds` and `readTimeoutSeconds` options. However, note that retries may prevent the current worker thread from being available to other requests, and if too many requests stall, it could make the Kafka broker unresponsive.
<9> (Optional) The time to wait before attempting another retry of a failed HTTP request to the authorization server. By default, this time is set to zero, meaning that no pause is applied. This is because many issues that cause failed requests are per-request network glitches or proxy issues that can be resolved quickly. However, if your authorization server is under stress or experiencing high traffic, you may want to set this option to a value of 100 ms or more to reduce the load on the server and increase the likelihood of successful retries.
<10> (Optional) Some authorization servers have issues with client sending `Accept: application/json` header. By setting `includeAcceptHeader: false` the header will not be sent. Default is `true`.
--

. Apply the changes to the deployment of your Kafka resource.
+
[source,yaml,subs="+quotes,attributes"]
Expand Down
6 changes: 3 additions & 3 deletions packaging/helm-charts/helm3/strimzi-kafka-operator/crds/040-Crd-kafka.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ spec:
description: Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
size:
type: string
description: "When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). Mandatory when type=persistent-claim."
description: "When `type=persistent-claim`, defines the size of the persistent volume claim, such as 100Gi. Mandatory when `type=persistent-claim`."
sizeLimit:
type: string
pattern: "^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"
Expand Down Expand Up @@ -565,7 +565,7 @@ spec:
description: Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
size:
type: string
description: "When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). Mandatory when type=persistent-claim."
description: "When `type=persistent-claim`, defines the size of the persistent volume claim, such as 100Gi. Mandatory when `type=persistent-claim`."
sizeLimit:
type: string
pattern: "^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"
Expand Down Expand Up @@ -1892,7 +1892,7 @@ spec:
description: Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
size:
type: string
description: "When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). Mandatory when type=persistent-claim."
description: "When `type=persistent-claim`, defines the size of the persistent volume claim, such as 100Gi. Mandatory when `type=persistent-claim`."
sizeLimit:
type: string
pattern: "^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"
Expand Down
4 changes: 2 additions & 2 deletions packaging/helm-charts/helm3/strimzi-kafka-operator/crds/04A-Crd-kafkanodepool.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ spec:
description: Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
size:
type: string
description: "When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). Mandatory when type=persistent-claim."
description: "When `type=persistent-claim`, defines the size of the persistent volume claim, such as 100Gi. Mandatory when `type=persistent-claim`."
sizeLimit:
type: string
pattern: "^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"
Expand Down Expand Up @@ -131,7 +131,7 @@ spec:
description: Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
size:
type: string
description: "When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). Mandatory when type=persistent-claim."
description: "When `type=persistent-claim`, defines the size of the persistent volume claim, such as 100Gi. Mandatory when `type=persistent-claim`."
sizeLimit:
type: string
pattern: "^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"
Expand Down
6 changes: 3 additions & 3 deletions packaging/install/cluster-operator/040-Crd-kafka.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,7 +518,7 @@ spec:
description: Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
size:
type: string
description: "When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). Mandatory when type=persistent-claim."
description: "When `type=persistent-claim`, defines the size of the persistent volume claim, such as 100Gi. Mandatory when `type=persistent-claim`."
sizeLimit:
type: string
pattern: "^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"
Expand Down Expand Up @@ -564,7 +564,7 @@ spec:
description: Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
size:
type: string
description: "When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). Mandatory when type=persistent-claim."
description: "When `type=persistent-claim`, defines the size of the persistent volume claim, such as 100Gi. Mandatory when `type=persistent-claim`."
sizeLimit:
type: string
pattern: "^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"
Expand Down Expand Up @@ -1891,7 +1891,7 @@ spec:
description: Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
size:
type: string
description: "When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). Mandatory when type=persistent-claim."
description: "When `type=persistent-claim`, defines the size of the persistent volume claim, such as 100Gi. Mandatory when `type=persistent-claim`."
sizeLimit:
type: string
pattern: "^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"
Expand Down
4 changes: 2 additions & 2 deletions packaging/install/cluster-operator/04A-Crd-kafkanodepool.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ spec:
description: Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
size:
type: string
description: "When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). Mandatory when type=persistent-claim."
description: "When `type=persistent-claim`, defines the size of the persistent volume claim, such as 100Gi. Mandatory when `type=persistent-claim`."
sizeLimit:
type: string
pattern: "^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"
Expand Down Expand Up @@ -131,7 +131,7 @@ spec:
description: Specifies a specific persistent volume to use. It contains key:value pairs representing labels for selecting such a volume.
size:
type: string
description: "When type=persistent-claim, defines the size of the persistent volume claim (i.e 1Gi). Mandatory when type=persistent-claim."
description: "When `type=persistent-claim`, defines the size of the persistent volume claim, such as 100Gi. Mandatory when `type=persistent-claim`."
sizeLimit:
type: string
pattern: "^([0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"
Expand Down