Commit updated CRD yaml and adoc files

Signed-off-by: Marko Strukelj <[email protected]>

documentation/modules/appendix_crds.adoc

@@ -263,7 +263,7 @@ It must have the value `oauth` for the type `KafkaListenerAuthenticationOAuth`.
 |Name of the claim from the JWT authentication token, Introspection Endpoint response or User Info Endpoint response which will be used to extract the user id. Defaults to `sub`.
 |fallbackUserNameClaim
 |string
-|The fallback username claim to be used for the user id if the claim specified by `userNameClaim` is not present. This is useful when `client_credentials` authentication only results in the client id being provided in another claim. It only takes effect if `userNameClaim` is set.
+|The fallback username claim to be used for the user ID if the claim specified by `userNameClaim` is not present. This is useful when `client_credentials` authentication only results in the client ID being provided in another claim. It only takes effect if `userNameClaim` is set.
 |fallbackUserNamePrefix
 |string
 |The prefix to use with the value of `fallbackUserNameClaim` to construct the user id. This only takes effect if `fallbackUserNameClaim` is true, and the value is present for the claim. Mapping usernames and client ids into the same user id space is useful in preventing name collisions.
@@ -338,10 +338,10 @@ It must have the value `oauth` for the type `KafkaListenerAuthenticationOAuth`.
 |Whether the Accept header should be set in requests to the authorization servers. The default value is `true`.
 |serverBearerTokenLocation
 |string
-|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.
+|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.
 |userNamePrefix
 |string
-|The prefix to use with the value of `userNameClaim` to construct the user id. This only takes effect if `userNameClaim` is specified, and the value is present for the claim. When used in combination with `fallbackUserNameClaims` it ensures consistent mapping of usernames and client ids into the same user id space and prevents name collisions.
+|The prefix to use with the value of `userNameClaim` to construct the user ID. This only takes effect if `userNameClaim` is specified and the value is present for the claim. When used in combination with `fallbackUserNameClaims`, it ensures consistent mapping of usernames and client IDs into the same user ID space and prevents name collisions.
 |====
 
 [id='type-GenericSecretSource-{context}']
@@ -2522,13 +2522,13 @@ It must have the value `oauth` for the type `KafkaClientAuthenticationOAuth`.
 |Path to the token file containing an access token to be used for authentication.
 |clientAssertion
 |xref:type-GenericSecretSource-{context}[`GenericSecretSource`]
-|Link to Kubernetes Secret containing the client assertion which was manually configured for the client.
+|Link to Kubernetes secret containing the client assertion which was manually configured for the client.
 |clientAssertionLocation
 |string
 |Path to the file containing the client assertion to be used for authentication.
 |clientAssertionType
 |string
-|The client assertion type. If not set, and `clientAssertion` or `clientAssertionLocation` is configured, then this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`.
+|The client assertion type. If not set, and either `clientAssertion` or `clientAssertionLocation` is configured, this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`.
 |saslExtensions
 |map
 |SASL extensions parameters.

packaging/helm-charts/helm3/strimzi-kafka-operator/crds/040-Crd-kafka.yaml

@@ -168,7 +168,7 @@ spec:
                                 description: Enable or disable termination of Kafka broker processes due to potentially recoverable runtime errors during startup. Default value is `true`.
                               fallbackUserNameClaim:
                                 type: string
-                                description: The fallback username claim to be used for the user id if the claim specified by `userNameClaim` is not present. This is useful when `client_credentials` authentication only results in the client id being provided in another claim. It only takes effect if `userNameClaim` is set.
+                                description: The fallback username claim to be used for the user ID if the claim specified by `userNameClaim` is not present. This is useful when `client_credentials` authentication only results in the client ID being provided in another claim. It only takes effect if `userNameClaim` is set.
                               fallbackUserNamePrefix:
                                 type: string
                                 description: "The prefix to use with the value of `fallbackUserNameClaim` to construct the user id. This only takes effect if `fallbackUserNameClaim` is true, and the value is present for the claim. Mapping usernames and client ids into the same user id space is useful in preventing name collisions."
@@ -238,7 +238,7 @@ spec:
                                 description: Secrets to be mounted to /opt/kafka/custom-authn-secrets/custom-listener-_<listener_name>-<port>_/_<secret_name>_.
                               serverBearerTokenLocation:
                                 type: string
-                                description: 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.
+                                description: 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.
                               tlsTrustedCertificates:
                                 type: array
                                 items:
@@ -284,7 +284,7 @@ spec:
                                 description: "Name of the claim from the JWT authentication token, Introspection Endpoint response or User Info Endpoint response which will be used to extract the user id. Defaults to `sub`."
                               userNamePrefix:
                                 type: string
-                                description: "The prefix to use with the value of `userNameClaim` to construct the user id. This only takes effect if `userNameClaim` is specified, and the value is present for the claim. When used in combination with `fallbackUserNameClaims` it ensures consistent mapping of usernames and client ids into the same user id space and prevents name collisions."
+                                description: "The prefix to use with the value of `userNameClaim` to construct the user ID. This only takes effect if `userNameClaim` is specified and the value is present for the claim. When used in combination with `fallbackUserNameClaims`, it ensures consistent mapping of usernames and client IDs into the same user ID space and prevents name collisions."
                               validIssuerUri:
                                 type: string
                                 description: URI of the token issuer used for authentication.

packaging/helm-charts/helm3/strimzi-kafka-operator/crds/041-Crd-kafkaconnect.yaml

@@ -150,13 +150,13 @@ spec:
                       required:
                         - key
                         - secretName
-                      description: Link to Kubernetes Secret containing the client assertion which was manually configured for the client.
+                      description: Link to Kubernetes secret containing the client assertion which was manually configured for the client.
                     clientAssertionLocation:
                       type: string
                       description: Path to the file containing the client assertion to be used for authentication.
                     clientAssertionType:
                       type: string
-                      description: "The client assertion type. If not set, and `clientAssertion` or `clientAssertionLocation` is configured, then this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."
+                      description: "The client assertion type. If not set, and either `clientAssertion` or `clientAssertionLocation` is configured, this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."
                     clientId:
                       type: string
                       description: OAuth Client ID which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.

packaging/helm-charts/helm3/strimzi-kafka-operator/crds/045-Crd-kafkamirrormaker.yaml

@@ -144,13 +144,13 @@ spec:
                           required:
                             - key
                             - secretName
-                          description: Link to Kubernetes Secret containing the client assertion which was manually configured for the client.
+                          description: Link to Kubernetes secret containing the client assertion which was manually configured for the client.
                         clientAssertionLocation:
                           type: string
                           description: Path to the file containing the client assertion to be used for authentication.
                         clientAssertionType:
                           type: string
-                          description: "The client assertion type. If not set, and `clientAssertion` or `clientAssertionLocation` is configured, then this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."
+                          description: "The client assertion type. If not set, and either `clientAssertion` or `clientAssertionLocation` is configured, this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."
                         clientId:
                           type: string
                           description: OAuth Client ID which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.
@@ -370,13 +370,13 @@ spec:
                           required:
                             - key
                             - secretName
-                          description: Link to Kubernetes Secret containing the client assertion which was manually configured for the client.
+                          description: Link to Kubernetes secret containing the client assertion which was manually configured for the client.
                         clientAssertionLocation:
                           type: string
                           description: Path to the file containing the client assertion to be used for authentication.
                         clientAssertionType:
                           type: string
-                          description: "The client assertion type. If not set, and `clientAssertion` or `clientAssertionLocation` is configured, then this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."
+                          description: "The client assertion type. If not set, and either `clientAssertion` or `clientAssertionLocation` is configured, this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."
                         clientId:
                           type: string
                           description: OAuth Client ID which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.

packaging/helm-charts/helm3/strimzi-kafka-operator/crds/046-Crd-kafkabridge.yaml

@@ -153,13 +153,13 @@ spec:
                       required:
                         - key
                         - secretName
-                      description: Link to Kubernetes Secret containing the client assertion which was manually configured for the client.
+                      description: Link to Kubernetes secret containing the client assertion which was manually configured for the client.
                     clientAssertionLocation:
                       type: string
                       description: Path to the file containing the client assertion to be used for authentication.
                     clientAssertionType:
                       type: string
-                      description: "The client assertion type. If not set, and `clientAssertion` or `clientAssertionLocation` is configured, then this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."
+                      description: "The client assertion type. If not set, and either `clientAssertion` or `clientAssertionLocation` is configured, this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."
                     clientId:
                       type: string
                       description: OAuth Client ID which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.

packaging/helm-charts/helm3/strimzi-kafka-operator/crds/048-Crd-kafkamirrormaker2.yaml

@@ -162,13 +162,13 @@ spec:
                             required:
                               - key
                               - secretName
-                            description: Link to Kubernetes Secret containing the client assertion which was manually configured for the client.
+                            description: Link to Kubernetes secret containing the client assertion which was manually configured for the client.
                           clientAssertionLocation:
                             type: string
                             description: Path to the file containing the client assertion to be used for authentication.
                           clientAssertionType:
                             type: string
-                            description: "The client assertion type. If not set, and `clientAssertion` or `clientAssertionLocation` is configured, then this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."
+                            description: "The client assertion type. If not set, and either `clientAssertion` or `clientAssertionLocation` is configured, this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."
                           clientId:
                             type: string
                             description: OAuth Client ID which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.

packaging/install/cluster-operator/040-Crd-kafka.yaml

@@ -167,7 +167,7 @@ spec:
                               description: Enable or disable termination of Kafka broker processes due to potentially recoverable runtime errors during startup. Default value is `true`.
                             fallbackUserNameClaim:
                               type: string
-                              description: The fallback username claim to be used for the user id if the claim specified by `userNameClaim` is not present. This is useful when `client_credentials` authentication only results in the client id being provided in another claim. It only takes effect if `userNameClaim` is set.
+                              description: The fallback username claim to be used for the user ID if the claim specified by `userNameClaim` is not present. This is useful when `client_credentials` authentication only results in the client ID being provided in another claim. It only takes effect if `userNameClaim` is set.
                             fallbackUserNamePrefix:
                               type: string
                               description: "The prefix to use with the value of `fallbackUserNameClaim` to construct the user id. This only takes effect if `fallbackUserNameClaim` is true, and the value is present for the claim. Mapping usernames and client ids into the same user id space is useful in preventing name collisions."
@@ -237,7 +237,7 @@ spec:
                               description: Secrets to be mounted to /opt/kafka/custom-authn-secrets/custom-listener-_<listener_name>-<port>_/_<secret_name>_.
                             serverBearerTokenLocation:
                               type: string
-                              description: 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.
+                              description: 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.
                             tlsTrustedCertificates:
                               type: array
                               items:
@@ -283,7 +283,7 @@ spec:
                               description: "Name of the claim from the JWT authentication token, Introspection Endpoint response or User Info Endpoint response which will be used to extract the user id. Defaults to `sub`."
                             userNamePrefix:
                               type: string
-                              description: "The prefix to use with the value of `userNameClaim` to construct the user id. This only takes effect if `userNameClaim` is specified, and the value is present for the claim. When used in combination with `fallbackUserNameClaims` it ensures consistent mapping of usernames and client ids into the same user id space and prevents name collisions."
+                              description: "The prefix to use with the value of `userNameClaim` to construct the user ID. This only takes effect if `userNameClaim` is specified and the value is present for the claim. When used in combination with `fallbackUserNameClaims`, it ensures consistent mapping of usernames and client IDs into the same user ID space and prevents name collisions."
                             validIssuerUri:
                               type: string
                               description: URI of the token issuer used for authentication.

packaging/install/cluster-operator/041-Crd-kafkaconnect.yaml

@@ -149,13 +149,13 @@ spec:
                     required:
                     - key
                     - secretName
-                    description: Link to Kubernetes Secret containing the client assertion which was manually configured for the client.
+                    description: Link to Kubernetes secret containing the client assertion which was manually configured for the client.
                   clientAssertionLocation:
                     type: string
                     description: Path to the file containing the client assertion to be used for authentication.
                   clientAssertionType:
                     type: string
-                    description: "The client assertion type. If not set, and `clientAssertion` or `clientAssertionLocation` is configured, then this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."
+                    description: "The client assertion type. If not set, and either `clientAssertion` or `clientAssertionLocation` is configured, this value defaults to `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`."
                   clientId:
                     type: string
                     description: OAuth Client ID which the Kafka client can use to authenticate against the OAuth server and use the token endpoint URI.