Inclusive Language Initiative - Mirror Maker 1 (strimzi#5031)

Signed-off-by: Jakub Scholz <[email protected]>

Author: scholzj

CHANGELOG.md

@@ -7,9 +7,15 @@
 * Support for patching of service accounts and configuring their labels and annotations. The feature is disabled by default and enabled using the new `ServiceAccountPatching` feature gate.
 * Added support for configuring cluster-operator's worker thread pool size that is used for various sync and async tasks
 * Add Kafka Quotas plugin with produce, consume, and storage quotas
-* Remove topics and groups "blacklist" pattern from KafkaMirrorMaker2 CRD
 * Support pausing reconciliation of KafkaTopic CR with annotation `strimzi.io/pause-reconciliation`
 
+### Changes, deprecations and removals
+
+* The fields `topicsBlacklistPattern` and `groupsBlacklistPattern` in the `KafkaMirrorMaker2` resource are deprecated and will be removed in the future. 
+  They are replaced by new fields `topicsExcludePattern` and `groupsExcludePattern`.
+* The field `whitelist` in the `KafkaMirrorMaker` resource is deprecated and will be removed in the future.
+  It is replaced with a new field `include`. 
+
 ## 0.23.0
 
 * Add support for Kafka 2.8.0 and 2.6.2, remove support for Kafka 2.5.x

api-conversion/src/test/resources/io/strimzi/kafka/api/conversion/cli/mm-affinity-tolerations.out

@@ -19,7 +19,7 @@ spec:
       trustedCertificates:
       - secretName: my-target-cluster-cluster-ca-cert
         certificate: ca.crt
-  whitelist: .*
+  include: .*
   template:
     pod:
       affinity:

api-conversion/src/test/resources/io/strimzi/kafka/api/conversion/cli/mm-affinity-tolerations.yaml

@@ -18,7 +18,7 @@ spec:
       trustedCertificates:
         - secretName: my-target-cluster-cluster-ca-cert
           certificate: ca.crt
-  whitelist: ".*"
+  include: ".*"
   affinity:
     nodeAffinity:
       requiredDuringSchedulingIgnoredDuringExecution:

api-conversion/src/test/resources/io/strimzi/kafka/api/conversion/cli/mm-logging.out

@@ -19,7 +19,7 @@ spec:
       trustedCertificates:
       - secretName: my-target-cluster-cluster-ca-cert
         certificate: ca.crt
-  whitelist: .*
+  include: .*
   logging:
     type: external
     valueFrom:

api-conversion/src/test/resources/io/strimzi/kafka/api/conversion/cli/mm-logging.yaml

@@ -18,7 +18,7 @@ spec:
       trustedCertificates:
         - secretName: my-target-cluster-cluster-ca-cert
           certificate: ca.crt
-  whitelist: ".*"
+  include: ".*"
   logging:
     type: external
     name: my-config-map

api-conversion/src/test/resources/io/strimzi/kafka/api/conversion/cli/mm-metrics.out

@@ -19,7 +19,7 @@ spec:
       trustedCertificates:
       - secretName: my-target-cluster-cluster-ca-cert
         certificate: ca.crt
-  whitelist: .*
+  include: .*
   metricsConfig:
     type: jmxPrometheusExporter
     valueFrom:

api-conversion/src/test/resources/io/strimzi/kafka/api/conversion/cli/mm-metrics.yaml

@@ -18,7 +18,7 @@ spec:
       trustedCertificates:
         - secretName: my-target-cluster-cluster-ca-cert
           certificate: ca.crt
-  whitelist: ".*"
+  include: ".*"
   metrics:
     some: config
     someOther: config

api-conversion/src/test/resources/io/strimzi/kafka/api/conversion/cli/mm-v1alpha1.out

@@ -19,4 +19,4 @@ spec:
       trustedCertificates:
       - secretName: my-target-cluster-cluster-ca-cert
         certificate: ca.crt
-  whitelist: .*
+  include: .*

api-conversion/src/test/resources/io/strimzi/kafka/api/conversion/cli/mm-v1alpha1.yaml

@@ -18,4 +18,4 @@ spec:
       trustedCertificates:
         - secretName: my-target-cluster-cluster-ca-cert
           certificate: ca.crt
-  whitelist: ".*"
+  include: ".*"

api-conversion/src/test/resources/io/strimzi/kafka/api/conversion/cli/mm-v1beta1.out

@@ -19,4 +19,4 @@ spec:
       trustedCertificates:
       - secretName: my-target-cluster-cluster-ca-cert
         certificate: ca.crt
-  whitelist: .*
+  include: .*

api-conversion/src/test/resources/io/strimzi/kafka/api/conversion/cli/mm-v1beta1.yaml

@@ -18,4 +18,4 @@ spec:
       trustedCertificates:
         - secretName: my-target-cluster-cluster-ca-cert
           certificate: ca.crt
-  whitelist: ".*"
+  include: ".*"

api/src/main/java/io/strimzi/api/kafka/model/KafkaMirrorMakerSpec.java

@@ -17,6 +17,7 @@
 import io.strimzi.crdgenerator.annotations.DescriptionFile;
 import io.strimzi.crdgenerator.annotations.KubeLink;
 import io.strimzi.crdgenerator.annotations.Minimum;
+import io.strimzi.crdgenerator.annotations.OneOf;
 import io.strimzi.crdgenerator.annotations.PresentInVersions;
 import io.sundr.builder.annotations.Buildable;
 import lombok.EqualsAndHashCode;
@@ -32,9 +33,10 @@
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder({
         "version", "replicas", "image", "consumer",
-        "producer", "resources", "whitelist",
+        "producer", "resources", "whitelist", "include",
         "affinity", "tolerations", "jvmOptions",
         "logging", "metrics", "metricsConfig", "tracing", "template"})
+@OneOf({@OneOf.Alternative(@OneOf.Alternative.Property("whitelist")), @OneOf.Alternative(@OneOf.Alternative.Property("include"))})
 @EqualsAndHashCode
 public class KafkaMirrorMakerSpec extends Spec implements HasConfigurableMetrics {
     private static final long serialVersionUID = 1L;
@@ -46,6 +48,7 @@ public class KafkaMirrorMakerSpec extends Spec implements HasConfigurableMetrics
     private String version;
     private String image;
     private String whitelist;
+    private String include;
     private KafkaMirrorMakerConsumerSpec consumer;
     private KafkaMirrorMakerProducerSpec producer;
     private ResourceRequirements resources;
@@ -92,9 +95,11 @@ public void setImage(String image) {
     }
 
     @Description("List of topics which are included for mirroring. This option allows any regular expression using Java-style regular expressions. " +
-            "Mirroring two topics named A and B is achieved by using the whitelist `'A|B'`. Or, as a special case, you can mirror all topics using the whitelist '*'. " +
+            "Mirroring two topics named A and B is achieved by using the expression `'A|B'`. Or, as a special case, you can mirror all topics using the regular expression '*'. " +
             "You can also specify multiple regular expressions separated by commas.")
-    @JsonProperty(required = true)
+    @DeprecatedProperty(movedToPath = "spec.include")
+    @PresentInVersions("v1alpha1-v1beta2")
+    @Deprecated
     public String getWhitelist() {
         return whitelist;
     }
@@ -103,6 +108,17 @@ public void setWhitelist(String whitelist) {
         this.whitelist = whitelist;
     }
 
+    @Description("List of topics which are included for mirroring. This option allows any regular expression using Java-style regular expressions. " +
+            "Mirroring two topics named A and B is achieved by using the expression `'A|B'`. Or, as a special case, you can mirror all topics using the regular expression '*'. " +
+            "You can also specify multiple regular expressions separated by commas.")
+    public String getInclude() {
+        return include;
+    }
+
+    public void setInclude(String include) {
+        this.include = include;
+    }
+
     @Description("Configuration of source cluster.")
     @JsonProperty(required = true)
     public KafkaMirrorMakerConsumerSpec getConsumer() {

api/src/test/java/io/strimzi/api/kafka/model/KafkaMirrorMakerCrdIT.java

@@ -55,8 +55,7 @@ void testKafkaMirrorMakerWithMissingRequired() {
 
         assertMissingRequiredPropertiesMessage(exception.getMessage(),
                 "bootstrapServers",
-                "producer",
-                "whitelist");
+                "producer");
     }
 
     @Test
@@ -77,8 +76,7 @@ void testKafkaMirrorMakerWithTlsAuthWithMissingRequired() {
 
         assertMissingRequiredPropertiesMessage(exception.getMessage(),
                 "spec.producer.authentication.certificateAndKey.certificate",
-                "spec.producer.authentication.certificateAndKey.key",
-                "spec.whitelist");
+                "spec.producer.authentication.certificateAndKey.key");
     }
 
     @Test

api/src/test/resources/io/strimzi/api/kafka/model/045-Crd-kafkamirrormaker.yaml

@@ -475,10 +475,18 @@ spec:
                 type: string
                 description: List of topics which are included for mirroring. This
                   option allows any regular expression using Java-style regular expressions.
-                  Mirroring two topics named A and B is achieved by using the whitelist
+                  Mirroring two topics named A and B is achieved by using the expression
                   `'A\|B'`. Or, as a special case, you can mirror all topics using
-                  the whitelist '*'. You can also specify multiple regular expressions
-                  separated by commas.
+                  the regular expression '*'. You can also specify multiple regular
+                  expressions separated by commas.
+              include:
+                type: string
+                description: List of topics which are included for mirroring. This
+                  option allows any regular expression using Java-style regular expressions.
+                  Mirroring two topics named A and B is achieved by using the expression
+                  `'A\|B'`. Or, as a special case, you can mirror all topics using
+                  the regular expression '*'. You can also specify multiple regular
+                  expressions separated by commas.
               jvmOptions:
                 type: object
                 properties:
@@ -1176,11 +1184,19 @@ spec:
                     description: The timeout for each attempted health check. Default
                       to 5 seconds. Minimum value is 1.
                 description: Pod readiness checking.
+            oneOf:
+            - properties:
+                whitelist: {}
+              required:
+              - whitelist
+            - properties:
+                include: {}
+              required:
+              - include
             required:
             - replicas
             - consumer
             - producer
-            - whitelist
             description: The specification of Kafka MirrorMaker.
           status:
             type: object
@@ -1654,10 +1670,18 @@ spec:
                 type: string
                 description: List of topics which are included for mirroring. This
                   option allows any regular expression using Java-style regular expressions.
-                  Mirroring two topics named A and B is achieved by using the whitelist
+                  Mirroring two topics named A and B is achieved by using the expression
+                  `'A\|B'`. Or, as a special case, you can mirror all topics using
+                  the regular expression '*'. You can also specify multiple regular
+                  expressions separated by commas.
+              include:
+                type: string
+                description: List of topics which are included for mirroring. This
+                  option allows any regular expression using Java-style regular expressions.
+                  Mirroring two topics named A and B is achieved by using the expression
                   `'A\|B'`. Or, as a special case, you can mirror all topics using
-                  the whitelist '*'. You can also specify multiple regular expressions
-                  separated by commas.
+                  the regular expression '*'. You can also specify multiple regular
+                  expressions separated by commas.
               affinity:
                 type: object
                 properties:
@@ -2588,11 +2612,19 @@ spec:
                     description: The timeout for each attempted health check. Default
                       to 5 seconds. Minimum value is 1.
                 description: Pod readiness checking.
+            oneOf:
+            - properties:
+                whitelist: {}
+              required:
+              - whitelist
+            - properties:
+                include: {}
+              required:
+              - include
             required:
             - replicas
             - consumer
             - producer
-            - whitelist
             description: The specification of Kafka MirrorMaker.
           status:
             type: object
@@ -3066,10 +3098,18 @@ spec:
                 type: string
                 description: List of topics which are included for mirroring. This
                   option allows any regular expression using Java-style regular expressions.
-                  Mirroring two topics named A and B is achieved by using the whitelist
+                  Mirroring two topics named A and B is achieved by using the expression
+                  `'A\|B'`. Or, as a special case, you can mirror all topics using
+                  the regular expression '*'. You can also specify multiple regular
+                  expressions separated by commas.
+              include:
+                type: string
+                description: List of topics which are included for mirroring. This
+                  option allows any regular expression using Java-style regular expressions.
+                  Mirroring two topics named A and B is achieved by using the expression
                   `'A\|B'`. Or, as a special case, you can mirror all topics using
-                  the whitelist '*'. You can also specify multiple regular expressions
-                  separated by commas.
+                  the regular expression '*'. You can also specify multiple regular
+                  expressions separated by commas.
               affinity:
                 type: object
                 properties:
@@ -4000,11 +4040,19 @@ spec:
                     description: The timeout for each attempted health check. Default
                       to 5 seconds. Minimum value is 1.
                 description: Pod readiness checking.
+            oneOf:
+            - properties:
+                whitelist: {}
+              required:
+              - whitelist
+            - properties:
+                include: {}
+              required:
+              - include
             required:
             - replicas
             - consumer
             - producer
-            - whitelist
             description: The specification of Kafka MirrorMaker.
           status:
             type: object

api/src/test/resources/io/strimzi/api/kafka/model/KafkaMirrorMaker-minimal.yaml

@@ -4,7 +4,7 @@ metadata:
   name: test-kafka-mirror-maker
 spec:
   replicas: 1
-  whitelist: "*"
+  include: "*"
   consumer:
     bootstrapServers: my-source-kafka:9092
     groupId: my-source-group-id

api/src/test/resources/io/strimzi/api/kafka/model/KafkaMirrorMaker-with-commit-and-abort.yaml

@@ -5,7 +5,7 @@ metadata:
 spec:
   image: foo
   replicas: 1
-  whitelist: "*"
+  include: "*"
   consumer:
     numStreams: 2
     groupId: my-source-group-id

api/src/test/resources/io/strimzi/api/kafka/model/KafkaMirrorMaker-with-extra-property.yaml

@@ -9,6 +9,6 @@ spec:
     groupId: my-source-group-id
   producer:
     bootstrapServers: my-target-kafka:9092
-  whitelist: "*"
+  include: "*"
   extra: true
 extra: true

api/src/test/resources/io/strimzi/api/kafka/model/KafkaMirrorMaker-with-scram-sha-512-auth.yaml

@@ -4,7 +4,7 @@ metadata:
   name: test-kafka-mirror-maker
 spec:
   replicas: 1
-  whitelist: "*"
+  include: "*"
   consumer:
     bootstrapServers: my-source-kafka:9092
     groupId: my-source-group-id

api/src/test/resources/io/strimzi/api/kafka/model/KafkaMirrorMaker-with-template.yaml

@@ -5,7 +5,7 @@ metadata:
 spec:
   image: foo
   replicas: 1
-  whitelist: "*"
+  include: "*"
   consumer:
     numStreams: 2
     groupId: my-source-group-id

api/src/test/resources/io/strimzi/api/kafka/model/KafkaMirrorMaker-with-tls-auth.yaml

@@ -4,7 +4,7 @@ metadata:
   name: test-kafka-mirror-maker
 spec:
   replicas: 1
-  whitelist: "*"
+  include: "*"
   consumer:
     bootstrapServers: my-source-kafka:9093
     groupId: my-source-group-id

api/src/test/resources/io/strimzi/api/kafka/model/KafkaMirrorMaker-with-tls.yaml

@@ -4,7 +4,7 @@ metadata:
   name: test-kafka-mirror-maker
 spec:
   replicas: 1
-  whitelist: "*"
+  include: "*"
   consumer:
     bootstrapServers: my-source-kafka:9093
     groupId: my-source-group-id

api/src/test/resources/io/strimzi/api/kafka/model/KafkaMirrorMaker.out.yaml

@@ -16,4 +16,4 @@ spec:
     bootstrapServers: "my-target-kafka:9092"
     config:
       foo: "buz"
-  whitelist: "*"
+  include: "*"

api/src/test/resources/io/strimzi/api/kafka/model/KafkaMirrorMaker.yaml

@@ -5,7 +5,7 @@ metadata:
 spec:
   image: foo
   replicas: 1
-  whitelist: "*"
+  include: "*"
   consumer:
     numStreams: 2
     groupId: my-source-group-id