Skip to content

Commit 8220c7d

Browse files
authored
docs(bridge): updates the deployment instructions for Kafka Bridge (#11382)
Signed-off-by: prmellor <pmellor@redhat.com>
1 parent 33c45f8 commit 8220c7d

File tree

4 files changed

+31
-19
lines changed

4 files changed

+31
-19
lines changed

documentation/modules/configuring/con-config-kafka-bridge.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,9 @@ spec:
116116
<4> CORS access specifying selected resources and access methods. Additional HTTP headers in requests describe the origins that are permitted access to the Kafka cluster.
117117
<5> Requests for reservation of supported resources, currently `cpu` and `memory`, and limits to specify the maximum resources that can be consumed.
118118
<6> TLS configuration for encrypted connections to the Kafka cluster, with trusted certificates stored in X.509 format within the specified secrets.
119-
<7> Authentication for the Kafka Bridge cluster, specified as mTLS, token-based OAuth, SASL-based SCRAM-SHA-256/SCRAM-SHA-512, or PLAIN.
119+
<7> Authentication for the Kafka Bridge cluster, specified as `tls`, `scram-sha-256`, `scram-sha-512`, `plain`, or `oauth`.
120120
By default, the Kafka Bridge connects to Kafka brokers without authentication.
121+
For details on configuring authentication, see the link:{BookURLConfiguring}#type-KafkaBridgeSpec-schema-reference[`KafkaBridgeSpec` schema properties^]
121122
<8> Consumer configuration options.
122123
<9> Producer configuration options.
123124
<10> Kafka Bridge loggers and log levels added directly (`inline`) or indirectly (`external`) through a `ConfigMap`. Custom Log4j configuration must be placed under the `log4j2.properties` key in the `ConfigMap`. You can set log levels to `INFO`, `ERROR`, `WARN`, `TRACE`, `DEBUG`, `FATAL` or `OFF`.

documentation/modules/deploying/proc-deploy-kafka-bridge.adoc

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// deploying/assembly_deploy-kafka-bridge.adoc
44

55
[id='deploying-kafka-bridge-{context}']
6-
= Deploying Kafka Bridge to your Kubernetes cluster
6+
= Deploying Kafka Bridge
77

88
[role="_abstract"]
99
This procedure shows how to deploy a Kafka Bridge cluster to your Kubernetes cluster using the Cluster Operator.
@@ -17,39 +17,50 @@ In this procedure, we use the following example file:
1717

1818
.Prerequisites
1919

20-
* xref:deploying-cluster-operator-str[The Cluster Operator must be deployed.]
20+
* Cluster Operator is deployed.
21+
* Kafka cluster is running.
22+
+
23+
This procedure assumes that the Kafka cluster was deployed using Strimzi.
2124

2225
.Procedure
2326

27+
. Edit the deployment file to configure connection details (if required).
28+
+
29+
In `examples/bridge/kafka-bridge.yaml`, add or update the following properties as needed:
30+
+
31+
* `spec.bootstrapServers` to specify the Kafka bootstrap address.
32+
* `spec.authentication` to specify the authentication type as `tls`, `scram-sha-256`, `scram-sha-512`, `plain`, or `oauth`. +
33+
See the link:{BookURLConfiguring}#type-KafkaBridgeSpec-schema-reference[`KafkaBridgeSpec` schema properties^] for configuration details.
34+
* `spec.tls.trustedCertificates` to configure the TLS certificate. +
35+
Use `[]` (an empty array) to trust the default Java CAs, or specify secrets containing trusted certificates. +
36+
See the link:{BookURLConfiguring}#con-common-configuration-trusted-certificates-reference[`trustedCertificates` properties^] for configuration details.
37+
2438
. Deploy Kafka Bridge to your Kubernetes cluster:
2539
+
26-
[source,shell,subs="attributes+"]
40+
[source,shell]
2741
----
2842
kubectl apply -f examples/bridge/kafka-bridge.yaml
2943
----
3044

3145
. Check the status of the deployment:
3246
+
33-
[source,shell,subs="+quotes"]
47+
[source,shell]
3448
----
35-
kubectl get pods -n _<my_cluster_operator_namespace>_
49+
kubectl get pods -n <my_cluster_operator_namespace>
3650
----
3751
+
3852
.Output shows the deployment name and readiness
39-
[source,shell,subs="+quotes"]
53+
[source,shell]
4054
----
4155
NAME READY STATUS RESTARTS
4256
my-bridge-bridge-<pod_id> 1/1 Running 0
4357
----
4458
+
45-
`my-bridge` is the name of the Kafka Bridge cluster.
46-
+
47-
A pod ID identifies each pod created.
48-
+
49-
With the default deployment, you install a single Kafka Bridge pod.
50-
+
51-
`READY` shows the number of replicas that are ready/expected.
52-
The deployment is successful when the `STATUS` displays as `Running`.
59+
In this example, `my-bridge` is the name of the Kafka Bridge cluster.
60+
A pod ID identifies each created pod.
61+
By default, the deployment creates a single Kafka Bridge pod.
62+
`READY` shows the number of ready versus expected replicas.
63+
The deployment is successful when the `STATUS` is `Running`.
5364

5465
[role="_additional-resources"]
5566
.Additional resources

documentation/modules/deploying/proc-deploy-kafka-connect.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// deploying/assembly_deploy-kafka-connect.adoc
44

55
[id='deploying-kafka-connect-{context}']
6-
= Deploying Kafka Connect to your Kubernetes cluster
6+
= Deploying Kafka Connect
77

88
[role="_abstract"]
99
This procedure shows how to deploy a Kafka Connect cluster to your Kubernetes cluster using the Cluster Operator.
@@ -36,7 +36,7 @@ In `examples/connect/kafka-connect.yaml`, add or update the following properties
3636
See the link:{BookURLConfiguring}#type-KafkaConnectSpec-schema-reference[`KafkaConnectSpec` schema properties^] for configuration details.
3737
* `spec.tls.trustedCertificates` to configure the TLS certificate. +
3838
Use `[]` (an empty array) to trust the default Java CAs, or specify secrets containing trusted certificates. +
39-
See link:{BookURLConfiguring}#con-common-configuration-trusted-certificates-reference[`trustedCertificates` properties^] for configuration details.
39+
See the link:{BookURLConfiguring}#con-common-configuration-trusted-certificates-reference[`trustedCertificates` properties^] for configuration details.
4040

4141
. Configure the deployment for multiple Kafka Connect clusters (if required).
4242
+

documentation/modules/deploying/proc-deploy-kafka-mirror-maker.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// deploying/assembly_deploy-kafka-mirror-maker.adoc
44

55
[id='deploying-kafka-mirror-maker-{context}']
6-
= Deploying Kafka MirrorMaker to your Kubernetes cluster
6+
= Deploying Kafka MirrorMaker
77

88
[role="_abstract"]
99
This procedure shows how to deploy a Kafka MirrorMaker 2 cluster to your Kubernetes cluster using the Cluster Operator.
@@ -35,7 +35,7 @@ In `examples/mirror-maker/kafka-mirror-maker-2.yaml`, add or update the followin
3535
See the link:{BookURLConfiguring}#type-KafkaMirrorMaker2ClusterSpec-schema-reference[`KafkaMirrorMaker2Spec` schema properties^] for configuration details.
3636
* `spec.clusters[].tls.trustedCertificates` to configure the TLS certificate for each cluster. +
3737
Use `[]` (an empty array) to trust the default Java CAs, or specify secrets containing trusted certificates. +
38-
See link:{BookURLConfiguring}#con-common-configuration-trusted-certificates-reference[`trustedCertificates` properties^] for configuration details.
38+
See the link:{BookURLConfiguring}#con-common-configuration-trusted-certificates-reference[`trustedCertificates` properties^] for configuration details.
3939

4040
. Configure the deployment for multiple MirrorMaker 2 clusters (if required).
4141
+

0 commit comments

Comments
 (0)