Skip to content

Commit ad34a63

Browse files
authored
docs(mm2): updates the deployment instructions for MirrorMaker 2 (strimzi#11358)
Signed-off-by: prmellor <pmellor@redhat.com>
1 parent 0f4544c commit ad34a63

2 files changed

Lines changed: 37 additions & 19 deletions

File tree

documentation/modules/configuring/con-config-mirrormaker2.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,8 @@ spec:
216216
<2> Kafka cluster alias for Kafka Connect, which must specify the *target* Kafka cluster. The Kafka cluster is used by Kafka Connect for its internal topics.
217217
<3> Specification for the Kafka clusters being synchronized.
218218
<4> Cluster alias for the source Kafka cluster.
219-
<5> Authentication for the source cluster, specified as mTLS, token-based OAuth, SASL-based SCRAM-SHA-256/SCRAM-SHA-512, or PLAIN.
219+
<5> Authentication for the source cluster, specified as `tls`, `scram-sha-256`, `scram-sha-512`, `plain`, or `oauth`.
220+
For details on configuring authentication, see the link:{BookURLConfiguring}#type-KafkaMirrorMaker2ClusterSpec-schema-reference[`KafkaMirrorMaker2Spec` schema properties^]
220221
<6> Bootstrap address for connection to the source Kafka cluster. The address takes the format `<cluster_name>-kafka-bootstrap:<port_number>`. The Kafka cluster doesn't need to be managed by Strimzi or deployed to a Kubernetes cluster.
221222
<7> TLS configuration for encrypted connections to the Kafka cluster, with trusted certificates stored in X.509 format within the specified secrets.
222223
<8> Cluster alias for the target Kafka cluster.

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

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
= Deploying Kafka MirrorMaker to your Kubernetes cluster
77

88
[role="_abstract"]
9-
This procedure shows how to deploy a Kafka MirrorMaker cluster to your Kubernetes cluster using the Cluster Operator.
9+
This procedure shows how to deploy a Kafka MirrorMaker 2 cluster to your Kubernetes cluster using the Cluster Operator.
1010

1111
The deployment uses a YAML file to provide the specification to create a `KafkaMirrorMaker2` resource.
1212
MirrorMaker 2 is based on Kafka Connect and uses its configuration properties.
@@ -16,46 +16,63 @@ In this procedure, we use the following example file:
1616

1717
* `examples/mirror-maker/kafka-mirror-maker-2.yaml`
1818

19-
IMPORTANT: If deploying MirrorMaker 2 clusters to run in parallel, using the same target Kafka cluster, each instance must use unique names for internal Kafka Connect topics.
20-
To do this, xref:con-config-mm2-multiple-instances-{context}[configure each MirrorMaker 2 instance to replace the defaults].
21-
2219
.Prerequisites
2320

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

2626
.Procedure
2727

28+
. Edit the deployment file to configure connection details (if required).
29+
+
30+
In `examples/mirror-maker/kafka-mirror-maker-2.yaml`, add or update the following properties as needed:
31+
+
32+
* `spec.clusters[].bootstrapServers` to specify the Kafka bootstrap address for the source and target clusters.
33+
* `spec.clusters[].alias` to specify a unique identifier for each cluster.
34+
* `spec.clusters[].authentication` to specify the authentication type for each cluster as `tls`, `scram-sha-256`, `scram-sha-512`, `plain`, or `oauth`. +
35+
See the link:{BookURLConfiguring}#type-KafkaMirrorMaker2ClusterSpec-schema-reference[`KafkaMirrorMaker2Spec` schema properties^] for configuration details.
36+
* `spec.clusters[].tls.trustedCertificates` to configure the TLS certificate for each cluster. +
37+
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.
39+
40+
. Configure the deployment for multiple MirrorMaker 2 clusters (if required).
41+
+
42+
If you plan to run more than one MirrorMaker 2 cluster in the same environment, each instance must use unique internal topic names and a unique group ID.
43+
+
44+
Update the `spec.clusters[].config` properties in `kafka-mirror-maker-2.yaml` to replace the default values.
45+
+
46+
See xref:con-config-mm2-multiple-instances-{context}[Configuring multiple MirrorMaker 2 clusters] for details.
47+
2848
. Deploy Kafka MirrorMaker to your Kubernetes cluster:
2949
+
30-
[source,shell,subs="attributes+"]
50+
[source,shell]
3151
----
3252
kubectl apply -f examples/mirror-maker/kafka-mirror-maker-2.yaml
3353
----
3454

3555
. Check the status of the deployment:
3656
+
37-
[source,shell,subs="+quotes"]
57+
[source,shell]
3858
----
39-
kubectl get pods -n _<my_cluster_operator_namespace>_
59+
kubectl get pods -n <my_cluster_operator_namespace>
4060
----
4161
+
4262
.Output shows the deployment name and readiness
43-
[source,shell,subs="+quotes"]
63+
[source,shell]
4464
----
4565
NAME READY STATUS RESTARTS
4666
my-mm2-cluster-mirrormaker2-<pod_id> 1/1 Running 1
4767
----
4868
+
49-
`my-mm2-cluster` is the name of the Kafka MirrorMaker 2 cluster.
50-
+
51-
A pod ID identifies each pod created.
52-
+
53-
With the default deployment, you install a single MirrorMaker 2 pod.
54-
+
55-
`READY` shows the number of replicas that are ready/expected.
56-
The deployment is successful when the `STATUS` displays as `Running`.
69+
In this example, `my-mm2-cluster` is the name of the Kafka MirrorMaker 2 cluster.
70+
A pod ID identifies each created pod.
71+
By default, the deployment creates a single MirrorMaker 2 pod.
72+
`READY` shows the number of ready versus expected replicas.
73+
The deployment is successful when the `STATUS` is `Running`.
5774

5875
[role="_additional-resources"]
5976
.Additional resources
6077

61-
* xref:con-config-mirrormaker2-str[Kafka MirrorMaker cluster configuration]
78+
* xref:con-config-mirrormaker2-str[Kafka MirrorMaker 2 cluster configuration]

0 commit comments

Comments
 (0)