Skip to content

Commit 3c7c1b0

Browse files
authored
docs(review): minor doc edits from review (#12272)
Signed-off-by: prmellor <pmellor@redhat.com>
1 parent 28ef414 commit 3c7c1b0

File tree

6 files changed

+19
-15
lines changed

6 files changed

+19
-15
lines changed

documentation/api/io.strimzi.api.kafka.model.connect.KafkaConnectSpec.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,13 @@ spec:
2525

2626
These fields are required in the `v1` CRD API version.
2727
In the `v1beta2` version, these properties are optional.
28-
If not set, the following default values apply:
2928

30-
* `groupId` will default value `connect-cluster`
31-
* `configStorageTopic` will default to `connect-cluster-configs`
32-
* `offsetStorageTopic` will default to `connect-cluster-offsets`
33-
* `statusStorageTopic` will default to `connect-cluster-status`
29+
If you do not set them, the following default values apply:
30+
31+
* `groupId` defaults to `connect-cluster`
32+
* `configStorageTopic` defaults to `connect-cluster-configs`
33+
* `offsetStorageTopic` defaults to `connect-cluster-offsets`
34+
* `statusStorageTopic` defaults to `connect-cluster-status`
3435

3536
[id='property-kafka-connect-additional-configuration-{context}']
3637
= Additional configuration

documentation/assemblies/metrics/assembly_metrics-prometheus-setup.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ After enabling metrics, you can integrate with Prometheus:
2525
. xref:assembly-metrics-prometheus-{context}[Setting up Prometheus]
2626
. xref:proc-metrics-deploying-prometheus-alertmanager-{context}[Deploying Prometheus Alertmanager]
2727

28-
Strimzi provides an xref:assembly-metrics-config-files-str[example Grafana dashboards] to display visualizations of metrics.
28+
Strimzi provides xref:assembly-metrics-config-files-str[example Grafana dashboards] to display visualizations of metrics.
2929
The exposed metrics provide the monitoring data when you xref:proc-metrics-grafana-dashboard-str[enable the Grafana dashboard].
3030

3131
include::../../modules/metrics/proc-jmx-exporter-metrics-kafka-deploy-options.adoc[leveloffset=+1]

documentation/assemblies/oauth/assembly-oauth-security.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Strimzi supports OAuth 2.0 token-based authentication and authorization for secu
99
With OAuth 2.0 integration you can:
1010

1111
* Enable token-based authentication on Kafka brokers
12-
* Configure Kafka components, such as Kafka Connect, MirrorMaker 2, and the Kafka Bridge, to authenticate using access tokens
12+
* Configure Kafka components, such as Kafka Connect, MirrorMaker 2, and the HTTP Bridge, to authenticate using access tokens
1313
* Use token claims or Keycloak Authorization Services to perform fine-grained authorization
1414

1515
OAuth 2.0 provides centralized identity and access control using access tokens issued by an authorization server.

documentation/modules/metrics/proc_metrics-custom-resource-monitoring.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,6 @@ kubectl apply -f ksm.yaml
5151
+
5252
Metrics are scraped from the `strimzi-kube-state-metrics` service using the `ServiceMonitor` configured for the KSM deployment.
5353
+
54-
For alerting on these metrics, check the provided `PrometheusRule` resources:
54+
For alerting on these metrics, check the provided `PrometheusRule` resource:
5555
+
56-
* `examples/metrics/kube-state-metrics/prometheus-rules/*.yaml`
56+
* `examples/metrics/kube-state-metrics/prometheus-rules.yaml`

documentation/modules/oauth/con-oauth-client-config.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Each component requires:
4646
* `OAUTHBEARER` SASL settings to authenticate to Kafka brokers
4747

4848
The following example shows a simplified OAuth configuration for the HTTP Bridge.
49-
The same structure applies to Kafka Connect and MirrorMaker 2.
49+
The same configuration pattern applies to Kafka Connect and MirrorMaker 2.
5050

5151
[source,yaml]
5252
----

documentation/modules/oauth/con-oauth-server-config.adoc

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,16 +134,19 @@ For more information, see xref:assembly-loading-config-with-providers-{context}[
134134

135135
=== Authenticating brokers to protected authorization-server endpoints
136136

137-
Some authorization servers expose the JWKS endpoint publicly but require authentication when accessing protected endpoints such as the introspection endpoint.
137+
Some authorization servers expose the JWKS endpoint publicly but require authentication when accessing protected endpoints, such as the introspection endpoint.
138138

139-
When a protected endpoint is used, the Kafka broker must authenticate to the authorization server.
139+
When the broker accesses a protected endpoint, it must authenticate to the authorization server.
140140

141141
To configure HTTP Basic authentication, set the following properties:
142142

143143
* `oauth.client.id`
144144
* `oauth.client.secret`
145145

146-
For HTTP Bearer authentication, set one of the following properties:
146+
To configure HTTP Bearer authentication, set one of the following properties:
147147

148-
* `oauth.server.bearer.token.location` to specify the file path on disk containing the bearer token.
149-
* `oauth.server.bearer.token` to specify the bearer token in clear text.
148+
* `oauth.server.bearer.token.location` to specify the file path that contains the bearer token.
149+
* `oauth.server.bearer.token` to specify the bearer token in clear text.
150+
151+
NOTE: In production environments, avoid storing credentials or bearer tokens in clear text.
152+
Use a secure mechanism to provide these values to the broker.

0 commit comments

Comments
 (0)