Skip to content

Commit

Permalink
Unify use of MirrorMaker and Mirror Maker in the docs (strimzi#10331
Browse files Browse the repository at this point in the history
)

Signed-off-by: Jakub Scholz <www@scholzj.com>
  • Loading branch information
scholzj authored and mstruk committed Jul 15, 2024
1 parent 82a59a8 commit c5da580
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ public void setTracing(Tracing tracing) {
this.tracing = tracing;
}

@Description("Template for Kafka Connect and Kafka Mirror Maker 2 resources. " +
@Description("Template for Kafka Connect and Kafka MirrorMaker 2 resources. " +
"The template allows users to specify how the `Pods`, `Service`, and other services are generated.")
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public KafkaConnectTemplate getTemplate() {
Expand Down
4 changes: 2 additions & 2 deletions documentation/modules/appendix_crds.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2283,7 +2283,7 @@ include::../api/io.strimzi.api.kafka.model.connect.KafkaConnectSpec.adoc[levelof
|The configuration of tracing in Kafka Connect.
|template
|xref:type-KafkaConnectTemplate-{context}[`KafkaConnectTemplate`]
|Template for Kafka Connect and Kafka Mirror Maker 2 resources. The template allows users to specify how the `Pods`, `Service`, and other services are generated.
|Template for Kafka Connect and Kafka MirrorMaker 2 resources. The template allows users to specify how the `Pods`, `Service`, and other services are generated.
|externalConfiguration
|xref:type-ExternalConfiguration-{context}[`ExternalConfiguration`]
|Pass data from Secrets or ConfigMaps to the Kafka Connect pods and use them to configure connectors.
Expand Down Expand Up @@ -4051,7 +4051,7 @@ Used in: xref:type-KafkaMirrorMaker2-{context}[`KafkaMirrorMaker2`]
|The configuration of tracing in Kafka Connect.
|template
|xref:type-KafkaConnectTemplate-{context}[`KafkaConnectTemplate`]
|Template for Kafka Connect and Kafka Mirror Maker 2 resources. The template allows users to specify how the `Pods`, `Service`, and other services are generated.
|Template for Kafka Connect and Kafka MirrorMaker 2 resources. The template allows users to specify how the `Pods`, `Service`, and other services are generated.
|externalConfiguration
|xref:type-ExternalConfiguration-{context}[`ExternalConfiguration`]
|Pass data from Secrets or ConfigMaps to the Kafka Connect pods and use them to configure connectors.
Expand Down
8 changes: 4 additions & 4 deletions documentation/modules/configuring/con-config-examples.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,18 @@ examples
├── mirror-maker <4>
├── metrics <5>
├── kafka <6>
│ └── nodepools <7>
│ └── kraft <7>
├── cruise-control <8>
├── connect <9>
└── bridge <10>
--
<1> `KafkaUser` custom resource configuration, which is managed by the User Operator.
<2> `KafkaTopic` custom resource configuration, which is managed by Topic Operator.
<3> Authentication and authorization configuration for Kafka components. Includes example configuration for TLS and SCRAM-SHA-512 authentication. The Keycloak example includes `Kafka` custom resource configuration and a Keycloak realm specification. You can use the example to try Keycloak authorization services. There is also an example with enabled `oauth` authentication and `keycloak` authorization metrics.
<4> `Kafka` custom resource configuration for a deployment of Mirror Maker. Includes example configuration for replication policy and synchronization frequency.
<4> `KafkaMirrorMaker` and `KafkaMirrorMaker2` custom resource configurations for a deployment of MirrorMaker. Includes example configuration for replication policy and synchronization frequency.
<5> xref:assembly-metrics-config-files-{context}[Metrics configuration], including Prometheus installation and Grafana dashboard files.
<6> `Kafka` custom resource configuration for a deployment of Kafka. Includes example configuration for an ephemeral or persistent single or multi-node deployment.
<7> `KafkaNodePool` configuration for Kafka nodes in a Kafka cluster. Includes example configuration for nodes in clusters that use KRaft (Kafka Raft metadata) mode or ZooKeeper.
<6> `Kafka` and `KafkaNodePool` custom resource configurations for a deployment of Kafka clusters that use ZooKeeper mode. Includes example configuration for an ephemeral or persistent single or multi-node deployment.
<7> `Kafka` and `KafkaNodePool` configurations for a deployment of Kafka clusters that use KRaft (Kafka Raft metadata) mode.
<8> `Kafka` custom resource with a deployment configuration for Cruise Control. Includes `KafkaRebalance` custom resources to generate optimization proposals from Cruise Control, with example configurations to use the default or user optimization goals.
<9> `KafkaConnect` and `KafkaConnector` custom resource configuration for a deployment of Kafka Connect. Includes example configurations for a single or multi-node deployment.
<10> `KafkaBridge` custom resource configuration for a deployment of Kafka Bridge.
4 changes: 2 additions & 2 deletions documentation/modules/managing/con-custom-resources-info.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ m|Strimzi resource |Long name |Short name
| Kafka User | kafkauser | ku
| Kafka Connect | kafkaconnect | kc
| Kafka Connector | kafkaconnector | kctr
| Kafka Mirror Maker | kafkamirrormaker | kmm
| Kafka Mirror Maker 2 | kafkamirrormaker2 | kmm2
| Kafka MirrorMaker | kafkamirrormaker | kmm
| Kafka MirrorMaker 2 | kafkamirrormaker2 | kmm2
| Kafka Bridge | kafkabridge | kb
| Kafka Rebalance | kafkarebalance | kr

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1962,7 +1962,7 @@ spec:
description: Annotations added to the Kubernetes resource.
description: Metadata applied to the resource.
description: Template for Secret of the Kafka Connect Cluster JMX authentication.
description: "Template for Kafka Connect and Kafka Mirror Maker 2 resources. The template allows users to specify how the `Pods`, `Service`, and other services are generated."
description: "Template for Kafka Connect and Kafka MirrorMaker 2 resources. The template allows users to specify how the `Pods`, `Service`, and other services are generated."
externalConfiguration:
type: object
properties:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2107,7 +2107,7 @@ spec:
description: Annotations added to the Kubernetes resource.
description: Metadata applied to the resource.
description: Template for Secret of the Kafka Connect Cluster JMX authentication.
description: "Template for Kafka Connect and Kafka Mirror Maker 2 resources. The template allows users to specify how the `Pods`, `Service`, and other services are generated."
description: "Template for Kafka Connect and Kafka MirrorMaker 2 resources. The template allows users to specify how the `Pods`, `Service`, and other services are generated."
externalConfiguration:
type: object
properties:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1961,7 +1961,7 @@ spec:
description: Annotations added to the Kubernetes resource.
description: Metadata applied to the resource.
description: Template for Secret of the Kafka Connect Cluster JMX authentication.
description: "Template for Kafka Connect and Kafka Mirror Maker 2 resources. The template allows users to specify how the `Pods`, `Service`, and other services are generated."
description: "Template for Kafka Connect and Kafka MirrorMaker 2 resources. The template allows users to specify how the `Pods`, `Service`, and other services are generated."
externalConfiguration:
type: object
properties:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2106,7 +2106,7 @@ spec:
description: Annotations added to the Kubernetes resource.
description: Metadata applied to the resource.
description: Template for Secret of the Kafka Connect Cluster JMX authentication.
description: "Template for Kafka Connect and Kafka Mirror Maker 2 resources. The template allows users to specify how the `Pods`, `Service`, and other services are generated."
description: "Template for Kafka Connect and Kafka MirrorMaker 2 resources. The template allows users to specify how the `Pods`, `Service`, and other services are generated."
externalConfiguration:
type: object
properties:
Expand Down

0 comments on commit c5da580

Please sign in to comment.