[Merged by Bors] - Implement product image selection

.readme/partials/main.md.j2

@@ -27,7 +27,9 @@ kind: KafkaCluster
 metadata:
   name: simple-kafka
 spec:
-  version: 3.2.0-stackable0.2.0
+  image:
+    productVersion: 3.3.1
+    stackableVersion: 0.2.0
   zookeeperConfigMapName: simple-kafka-znode
   config:
     tls: null

CHANGELOG.md

@@ -9,7 +9,9 @@ All notable changes to this project will be documented in this file.
 - Updated stackable image versions ([#513]).
 - operator-rs: 0.26.0 -> 0.27.1 ([#519]).
 - Don't run init container as root and avoid chmod and chowning ([#524]).
+- [BREAKING] Use Product image selection instead of version. `spec.version` has been replaced by `spec.image` ([#482]).
 
+[#482]: https://github.com/stackabletech/kafka-operator/pull/482
 [#513]: https://github.com/stackabletech/kafka-operator/pull/513
 [#519]: https://github.com/stackabletech/kafka-operator/pull/519
 [#524]: https://github.com/stackabletech/kafka-operator/pull/524

README.md

@@ -47,7 +47,9 @@ kind: KafkaCluster
 metadata:
   name: simple-kafka
 spec:
-  version: 3.2.0-stackable0.2.0
+  image:
+    productVersion: 3.3.1
+    stackableVersion: 0.2.0
   zookeeperConfigMapName: simple-kafka-znode
   config:
     tls: null

deploy/crd/kafkacluster.crd.yaml

@@ -562,6 +562,48 @@ spec:
                     - secretClass
                     type: object
                 type: object
+              image:
+                anyOf:
+                - required:
+                  - custom
+                  - productVersion
+                - required:
+                  - productVersion
+                  - stackableVersion
+                properties:
+                  custom:
+                    description: Overwrite the docker image. Specify the full docker image name, e.g. `docker.stackable.tech/stackable/superset:1.4.1-stackable2.1.0`
+                    type: string
+                  productVersion:
+                    description: Version of the product, e.g. `1.4.1`.
+                    type: string
+                  pullPolicy:
+                    default: IfNotPresent
+                    description: '[Pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) used when pulling the Images'
+                    enum:
+                    - IfNotPresent
+                    - Always
+                    - Never
+                    type: string
+                  pullSecrets:
+                    description: '[Image pull secrets](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod) to pull images from a private registry'
+                    items:
+                      description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
+                      properties:
+                        name:
+                          description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+                          type: string
+                      type: object
+                    nullable: true
+                    type: array
+                  repo:
+                    description: Name of the docker repo, e.g. `docker.stackable.tech/stackable`
+                    nullable: true
+                    type: string
+                  stackableVersion:
+                    description: Stackable version of the product, e.g. 2.1.0
+                    type: string
+                type: object
               log4j:
                 nullable: true
                 type: string
@@ -579,12 +621,10 @@ spec:
               stopped:
                 nullable: true
                 type: boolean
-              version:
-                nullable: true
-                type: string
               zookeeperConfigMapName:
                 type: string
             required:
+            - image
             - zookeeperConfigMapName
             type: object
         required:

deploy/helm/kafka-operator/crds/crds.yaml

@@ -564,6 +564,48 @@ spec:
                         - secretClass
                       type: object
                   type: object
+                image:
+                  anyOf:
+                    - required:
+                        - custom
+                        - productVersion
+                    - required:
+                        - productVersion
+                        - stackableVersion
+                  properties:
+                    custom:
+                      description: Overwrite the docker image. Specify the full docker image name, e.g. `docker.stackable.tech/stackable/superset:1.4.1-stackable2.1.0`
+                      type: string
+                    productVersion:
+                      description: Version of the product, e.g. `1.4.1`.
+                      type: string
+                    pullPolicy:
+                      default: IfNotPresent
+                      description: '[Pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) used when pulling the Images'
+                      enum:
+                        - IfNotPresent
+                        - Always
+                        - Never
+                      type: string
+                    pullSecrets:
+                      description: '[Image pull secrets](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod) to pull images from a private registry'
+                      items:
+                        description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
+                        properties:
+                          name:
+                            description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+                            type: string
+                        type: object
+                      nullable: true
+                      type: array
+                    repo:
+                      description: Name of the docker repo, e.g. `docker.stackable.tech/stackable`
+                      nullable: true
+                      type: string
+                    stackableVersion:
+                      description: Stackable version of the product, e.g. 2.1.0
+                      type: string
+                  type: object
                 log4j:
                   nullable: true
                   type: string
@@ -581,12 +623,10 @@ spec:
                 stopped:
                   nullable: true
                   type: boolean
-                version:
-                  nullable: true
-                  type: string
                 zookeeperConfigMapName:
                   type: string
               required:
+                - image
                 - zookeeperConfigMapName
               type: object
           required:

deploy/manifests/crds.yaml

@@ -565,6 +565,48 @@ spec:
                         - secretClass
                       type: object
                   type: object
+                image:
+                  anyOf:
+                    - required:
+                        - custom
+                        - productVersion
+                    - required:
+                        - productVersion
+                        - stackableVersion
+                  properties:
+                    custom:
+                      description: Overwrite the docker image. Specify the full docker image name, e.g. `docker.stackable.tech/stackable/superset:1.4.1-stackable2.1.0`
+                      type: string
+                    productVersion:
+                      description: Version of the product, e.g. `1.4.1`.
+                      type: string
+                    pullPolicy:
+                      default: IfNotPresent
+                      description: '[Pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) used when pulling the Images'
+                      enum:
+                        - IfNotPresent
+                        - Always
+                        - Never
+                      type: string
+                    pullSecrets:
+                      description: '[Image pull secrets](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod) to pull images from a private registry'
+                      items:
+                        description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
+                        properties:
+                          name:
+                            description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+                            type: string
+                        type: object
+                      nullable: true
+                      type: array
+                    repo:
+                      description: Name of the docker repo, e.g. `docker.stackable.tech/stackable`
+                      nullable: true
+                      type: string
+                    stackableVersion:
+                      description: Stackable version of the product, e.g. 2.1.0
+                      type: string
+                  type: object
                 log4j:
                   nullable: true
                   type: string
@@ -582,12 +624,10 @@ spec:
                 stopped:
                   nullable: true
                   type: boolean
-                version:
-                  nullable: true
-                  type: string
                 zookeeperConfigMapName:
                   type: string
               required:
+                - image
                 - zookeeperConfigMapName
               type: object
           required:

docs/modules/ROOT/pages/config_properties.adoc

@@ -2,17 +2,22 @@
 
 The cluster can be configured via a YAML file. This custom resource specifies the amount of replicas for each role group, role group or role specific configuration like port definitions etc.
 
-    apiVersion: kafka.stackable.tech/v1alpha1
-    kind: KafkaCluster
-    metadata:
-      name: simple-kafka
-    spec:
-      version: 3.2.0-stackable0.2.0
-      zookeeperConfigMapName: simple-kafka-znode
-      brokers:
-        roleGroups:
-          default:
-            replicas: 1
+[source,yaml]
+----
+apiVersion: kafka.stackable.tech/v1alpha1
+kind: KafkaCluster
+metadata:
+  name: simple-kafka
+spec:
+  image:
+    productVersion: 3.3.1
+    stackableVersion: 0.2.0
+  zookeeperConfigMapName: simple-kafka-znode
+  brokers:
+    roleGroups:
+      default:
+        replicas: 1
+----
 
 === Structure
 

docs/modules/ROOT/pages/usage.adoc

@@ -23,7 +23,9 @@ kind: KafkaCluster
 metadata:
   name: simple-kafka
 spec:
-  version: 3.2.0-stackable0.2.0
+  image:
+    productVersion: 3.2.0
+    stackableVersion: 0.2.0
   zookeeperConfigMapName: simple-kafka-znode
   brokers:
     roleGroups:
@@ -40,7 +42,9 @@ kind: KafkaCluster
 metadata:
   name: simple-kafka
 spec:
-  version: 3.2.0-stackable0.2.0
+  image:
+    productVersion: 3.2.0
+    stackableVersion: 0.2.0
   zookeeperConfigMapName: simple-kafka-znode
   opa:
     configMapName: simple-opa
@@ -61,7 +65,9 @@ kind: KafkaCluster
 metadata:
   name: simple-kafka
 spec:
-  version: 3.2.0-stackable0.2.0
+  image:
+    productVersion: 3.2.0
+    stackableVersion: 0.2.0
   zookeeperConfigMapName: simple-kafka-znode
   opa:
     configMapName: simple-opa
@@ -96,7 +102,9 @@ kind: KafkaCluster
 metadata:
   name: simple-kafka
 spec:
-  version: 3.2.0-stackable0.2.0
+  image:
+    productVersion: 3.2.0
+    stackableVersion: 0.2.0
   zookeeperConfigMapName: simple-kafka-znode
   log4j: |-
     log4j.rootLogger=INFO, stdout, kafkaAppender
@@ -128,7 +136,9 @@ kind: KafkaCluster
 metadata:
   name: simple-kafka
 spec:
-  version: 3.2.0-stackable0.2.0
+  image:
+    productVersion: 3.2.0
+    stackableVersion: 0.2.0
   zookeeperConfigMapName: simple-kafka-znode
   config:
     tls:
@@ -198,7 +208,9 @@ kind: KafkaCluster
 metadata:
   name: simple-kafka
 spec:
-  version: 3.2.0-stackable0.2.0
+  image:
+    productVersion: 3.2.0
+    stackableVersion: 0.2.0
   zookeeperConfigMapName: simple-kafka-znode
   config:
     tls:

docs/modules/getting_started/examples/code/kafka.yaml

@@ -4,7 +4,9 @@ kind: KafkaCluster
 metadata:
   name: simple-kafka
 spec:
-  version: 3.3.1-stackable0.2.0
+  image:
+    productVersion: 3.3.1
+    stackableVersion: 0.2.0
   zookeeperConfigMapName: simple-kafka-znode
   config:
     tls: null

examples/logging/simple-kafka-cluster-opa-log4j.yaml

@@ -28,7 +28,9 @@ kind: OpaCluster
 metadata:
   name: simple-opa
 spec:
-  version: 0.45.0-stackable0.2.0
+  image:
+    productVersion: 0.45.0
+    stackableVersion: 0.2.0
   servers:
     roleGroups:
       default:
@@ -55,7 +57,9 @@ kind: KafkaCluster
 metadata:
   name: simple-kafka
 spec:
-  version: 3.2.0-stackable0.2.0
+  image:
+    productVersion: 3.3.1
+    stackableVersion: 0.1.0
   zookeeperConfigMapName: simple-kafka-znode
   opa:
     configMapName: simple-opa

examples/opa/simple-kafka-cluster-opa-allow-all.yaml

@@ -28,7 +28,9 @@ kind: OpaCluster
 metadata:
   name: simple-opa
 spec:
-  version: 0.45.0-stackable0.2.0
+  image:
+    productVersion: 0.45.0
+    stackableVersion: 0.2.0
   servers:
     roleGroups:
       default:
@@ -55,7 +57,9 @@ kind: KafkaCluster
 metadata:
   name: simple-kafka
 spec:
-  version: 3.3.1-stackable0.2.0
+  image:
+    productVersion: 3.3.1
+    stackableVersion: 0.1.0
   zookeeperConfigMapName: simple-kafka-znode
   opa:
     configMapName: simple-opa

examples/tls/simple-kafka-cluster-tls.yaml

@@ -64,7 +64,9 @@ kind: KafkaCluster
 metadata:
   name: simple-kafka
 spec:
-  version: 3.3.1-stackable0.2.0
+  image:
+    productVersion: 3.3.1
+    stackableVersion: 0.1.0
   zookeeperConfigMapName: simple-kafka-znode
   config:
     tls: