v1 API implementation and conversion tool

Signed-off-by: Jakub Scholz <www@scholzj.com>

Author: scholzj

.azure/scripts/push-to-central.sh

@@ -14,6 +14,6 @@ export GPG_TTY=$(tty)
 echo $GPG_SIGNING_KEY | base64 -d > signing.gpg
 gpg --batch --import signing.gpg
 
-GPG_EXECUTABLE=gpg mvn $MVN_ARGS -DskipTests -s ./.azure/scripts/settings.xml -pl ./,crd-annotations,crd-generator,test,api -P central deploy
+GPG_EXECUTABLE=gpg mvn $MVN_ARGS -DskipTests -s ./.azure/scripts/settings.xml -pl ./,crd-annotations,crd-generator,test,api,v1-api-conversion -P central deploy
 
 cleanup

.checkstyle/import-control.xml

@@ -101,4 +101,24 @@ We also control imports only in production classes and not in tests. This is con
         <allow class="io.strimzi.operator.common.ReconciliationLogger" />
         <allow class="io.strimzi.operator.common.Util" />
     </subpackage>
+
+    <subpackage name="kafka.api.conversion.v1" strategyOnMismatch="disallowed">
+        <!-- This enforces the layering between the Strimzi Model and Operator classes in the User Operator. The Model classes are not allowed
+        to import from Operator classes. They should only use the API classes -->
+
+        <!-- Common libraries and Java classes -->
+        <allow pkg="java" />
+        <allow pkg="javax.naming" />
+        <allow pkg="org.apache.kafka.common" />
+        <allow pkg="io.fabric8.kubernetes" />
+        <allow pkg="com.fasterxml.jackson" />
+        <allow pkg="org.yaml.snakeyaml" />
+        <allow pkg="picocli" />
+        <allow pkg="org.apache.logging.log4j" />
+        <allow pkg="edu.umd.cs.findbugs.annotations" />
+
+        <!-- Strimzi Operators classes -->
+        <allow pkg="io.strimzi.api" />
+        <allow pkg="io.strimzi.kafka.api.conversion" />
+    </subpackage>
 </import-control>

CHANGELOG.md

@@ -5,6 +5,8 @@
 * Add support for Kafka 4.0.1
 * Set `blockOwnerDeletion` to `true` in the owner references in Strimzi managed resources.
   Deleting the Strimzi custom resources will now by default wait for the deletion of all the owned Kubernetes resources.
+* Introduce the `v1` API to Strimzi CRDs and move User and Topic Operators to use it.
+  The `v1` APi Conversion Tool can be used to convert the resources in files or in your Kubernetes cluter from the `v1beta2` API to the `v1` API.
 * Make `.spec` sections required in the `v1` version of all Strimzi custom resources.
 * Make `.spec.replicas` properties required in the `v1` of the `KafkaBridge`, `KafkaConnect`, and `KafkaMirrorMaker2` custom resources.
 * New fields `.spec.groupId`, `.spec.configStorageTopic`, `.spec.offsetStorageTopic`, and `.spec.statusStorageTopic` in the `KafkaConnect` custom resource for configuring Connect's group ID and internal topics.
@@ -14,6 +16,9 @@
 
 ### Major changes, deprecations, and removals
 
+* **This version introduces a new API version to our CRDs.**
+  **Before upgrading to Strimzi 0.49 or newer, make sure that you update your `KafkaUser` resources to use the `.spec.authorization.acls[]operations` field instead of the deprecated `.spec.authorization.acls[]operation`.**
+  **Especially when using Helm, make sure that the CRDs are updated when you upgrade the operator.**
 * The `.status.kafkaMetadataState` field in the `Kafka` custom resource is deprecated and not used anymore.
 * The `type: oauth` authentication in Kafka brokers and Kafka clients (Kafka Connect, MirrorMaker 2, and Strimzi HTTP Bridge) has been deprecated.
   Please use the `type: custom` authentication instead.

Makefile

@@ -14,7 +14,7 @@ ifneq ($(RELEASE_VERSION),latest)
   GITHUB_VERSION = $(RELEASE_VERSION)
 endif
 
-SUBDIRS=kafka-agent tracing-agent crd-annotations test crd-generator api mockkube certificate-manager operator-common config-model config-model-generator cluster-operator topic-operator user-operator kafka-init systemtest docker-images/artifacts packaging/helm-charts/helm3 packaging/install packaging/examples
+SUBDIRS=kafka-agent tracing-agent crd-annotations test crd-generator api v1-api-conversion mockkube certificate-manager operator-common config-model config-model-generator cluster-operator topic-operator user-operator kafka-init systemtest docker-images/artifacts packaging/helm-charts/helm3 packaging/install packaging/examples
 DOCKERDIRS=docker-images/base docker-images/operator docker-images/kafka-based docker-images/maven-builder docker-images/kaniko-executor docker-images/buildah
 DOCKER_TARGETS=docker_build docker_push docker_tag docker_load docker_save docker_amend_manifest docker_push_manifest docker_sign_manifest docker_delete_manifest docker_delete_archive docker_sbom docker_push_sbom docker_e2e docker_gha_sign_manifest docker_gha_sbom docker_gha_push_sbom
 JAVA_TARGETS=java_build java_install java_clean

api/pom.xml

@@ -39,7 +39,8 @@
         group = KafkaBridge.RESOURCE_GROUP,
         scope = KafkaBridge.SCOPE,
         versions = {
-            @Crd.Spec.Version(name = Constants.V1BETA2, served = true, storage = true)
+            @Crd.Spec.Version(name = Constants.V1, served = true, storage = false),
+            @Crd.Spec.Version(name = Constants.V1BETA2, served = true, storage = true, deprecated = true, deprecationWarning = "Version v1beta2 of the KafkaBridge API is deprecated. Please use the v1 version instead.")
         },
         subresources = @Crd.Spec.Subresources(
             status = @Crd.Spec.Subresources.Status(),
@@ -84,7 +85,7 @@ public class KafkaBridge extends CustomResource<KafkaBridgeSpec, KafkaBridgeStat
     private static final long serialVersionUID = 1L;
 
     public static final String SCOPE = Constants.SCOPE_NAMESPACED;
-    public static final List<String> VERSIONS = List.of(Constants.V1BETA2);
+    public static final List<String> VERSIONS = List.of(Constants.V1, Constants.V1BETA2);
     public static final String RESOURCE_KIND = "KafkaBridge";
     public static final String RESOURCE_LIST_KIND = RESOURCE_KIND + "List";
     public static final String RESOURCE_GROUP = Constants.RESOURCE_GROUP_NAME;

api/src/main/java/io/strimzi/api/kafka/model/bridge/KafkaBridge.java

@@ -39,7 +39,8 @@
         group = KafkaConnect.RESOURCE_GROUP,
         scope = KafkaConnect.SCOPE,
         versions = {
-            @Crd.Spec.Version(name = Constants.V1BETA2, served = true, storage = true)
+            @Crd.Spec.Version(name = Constants.V1, served = true, storage = false),
+            @Crd.Spec.Version(name = Constants.V1BETA2, served = true, storage = true, deprecated = true, deprecationWarning = "Version v1beta2 of the KafkaConnect API is deprecated. Please use the v1 version instead.")
         },
         subresources = @Crd.Spec.Subresources(
             status = @Crd.Spec.Subresources.Status(),
@@ -78,7 +79,7 @@ public class KafkaConnect extends CustomResource<KafkaConnectSpec, KafkaConnectS
     private static final long serialVersionUID = 1L;
 
     public static final String SCOPE = Constants.SCOPE_NAMESPACED;
-    public static final List<String> VERSIONS = List.of(Constants.V1BETA2);
+    public static final List<String> VERSIONS = List.of(Constants.V1, Constants.V1BETA2);
     public static final String RESOURCE_KIND = "KafkaConnect";
     public static final String RESOURCE_LIST_KIND = RESOURCE_KIND + "List";
     public static final String RESOURCE_GROUP = Constants.RESOURCE_GROUP_NAME;

api/src/main/java/io/strimzi/api/kafka/model/connect/KafkaConnect.java

@@ -37,7 +37,8 @@
         group = KafkaConnector.RESOURCE_GROUP,
         scope = KafkaConnector.SCOPE,
         versions = {
-            @Crd.Spec.Version(name = Constants.V1BETA2, served = true, storage = true)
+            @Crd.Spec.Version(name = Constants.V1, served = true, storage = false),
+            @Crd.Spec.Version(name = Constants.V1BETA2, served = true, storage = true, deprecated = true, deprecationWarning = "Version v1beta2 of the KafkaConnector API is deprecated. Please use the v1 version instead.")
         },
         subresources = @Crd.Spec.Subresources(
             status = @Crd.Spec.Subresources.Status(),
@@ -84,7 +85,7 @@
 public class KafkaConnector extends CustomResource<KafkaConnectorSpec, KafkaConnectorStatus> implements Namespaced, UnknownPropertyPreserving {
     private static final long serialVersionUID = 1L;
 
-    public static final List<String> VERSIONS = List.of(Constants.V1BETA2);
+    public static final List<String> VERSIONS = List.of(Constants.V1, Constants.V1BETA2);
     public static final String SCOPE = Constants.SCOPE_NAMESPACED;
     public static final String RESOURCE_PLURAL = "kafkaconnectors";
     public static final String RESOURCE_SINGULAR = "kafkaconnector";

api/src/main/java/io/strimzi/api/kafka/model/connector/KafkaConnector.java

@@ -39,7 +39,8 @@
         group = Kafka.RESOURCE_GROUP,
         scope = Kafka.SCOPE,
         versions = {
-            @Crd.Spec.Version(name = Constants.V1BETA2, served = true, storage = true)
+            @Crd.Spec.Version(name = Constants.V1, served = true, storage = false),
+            @Crd.Spec.Version(name = Constants.V1BETA2, served = true, storage = true, deprecated = true, deprecationWarning = "Version v1beta2 of the Kafka API is deprecated. Please use the v1 version instead.")
         },
         subresources = @Crd.Spec.Subresources(
             status = @Crd.Spec.Subresources.Status()
@@ -78,7 +79,7 @@ public class Kafka extends CustomResource<KafkaSpec, KafkaStatus> implements Nam
     private static final long serialVersionUID = 1L;
 
     public static final String SCOPE = Constants.SCOPE_NAMESPACED;
-    public static final List<String> VERSIONS = List.of(Constants.V1BETA2);
+    public static final List<String> VERSIONS = List.of(Constants.V1, Constants.V1BETA2);
     public static final String RESOURCE_KIND = "Kafka";
     public static final String RESOURCE_LIST_KIND = RESOURCE_KIND + "List";
     public static final String RESOURCE_GROUP = Constants.RESOURCE_GROUP_NAME;

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

@@ -39,7 +39,8 @@
         group = KafkaMirrorMaker2.RESOURCE_GROUP,
         scope = KafkaMirrorMaker2.SCOPE,
         versions = {
-            @Crd.Spec.Version(name = Constants.V1BETA2, served = true, storage = true)
+            @Crd.Spec.Version(name = Constants.V1, served = true, storage = false),
+            @Crd.Spec.Version(name = Constants.V1BETA2, served = true, storage = true, deprecated = true, deprecationWarning = "Version v1beta2 of the KafkaMirrorMaker2 API is deprecated. Please use the v1 version instead.")
         },
         subresources = @Crd.Spec.Subresources(
             status = @Crd.Spec.Subresources.Status(),
@@ -78,7 +79,7 @@ public class KafkaMirrorMaker2 extends CustomResource<KafkaMirrorMaker2Spec, Kaf
     private static final long serialVersionUID = 1L;
 
     public static final String SCOPE = Constants.SCOPE_NAMESPACED;
-    public static final List<String> VERSIONS = List.of(Constants.V1BETA2);
+    public static final List<String> VERSIONS = List.of(Constants.V1, Constants.V1BETA2);
     public static final String RESOURCE_KIND = "KafkaMirrorMaker2";
     public static final String RESOURCE_LIST_KIND = RESOURCE_KIND + "List";
     public static final String RESOURCE_GROUP = Constants.RESOURCE_GROUP_NAME;