Support of additional volumes in pod

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## 0.43.0
 
+Added support for additional volumes in CRDs:
+* Users can specify volumes and volumeMounts fields in the Kafka, KafkaConnect, KafkaBridge, KafkaMirrorMaker2, EntityOperator, CruiseControl, KafkaExporter, and Zookeeper CRDs.
+* Supported volume types include Secret, ConfigMap, EmptyDir, and PersistentVolumeClaims.
+* All additional mounted paths is mounted inside /mnt to ensure backwards compatibility for the evolution of kafka and this operator.
+* Example configurations and guidelines have been added to the documentation.
 
 ## 0.42.0
 

api/src/main/java/io/strimzi/api/kafka/model/common/template/AdditionalVolume.java

@@ -0,0 +1,103 @@
+/*
+ * Copyright Strimzi authors.
+ * License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
+ */
+package io.strimzi.api.kafka.model.common.template;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+import io.fabric8.kubernetes.api.model.ConfigMapVolumeSource;
+import io.fabric8.kubernetes.api.model.EmptyDirVolumeSource;
+import io.fabric8.kubernetes.api.model.PersistentVolumeClaimVolumeSource;
+import io.fabric8.kubernetes.api.model.SecretVolumeSource;
+import io.strimzi.api.kafka.model.common.Constants;
+import io.strimzi.api.kafka.model.common.UnknownPropertyPreserving;
+import io.strimzi.crdgenerator.annotations.Description;
+import io.strimzi.crdgenerator.annotations.KubeLink;
+import io.sundr.builder.annotations.Buildable;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Representation of additional volumes for Strimzi resources.
+ */
+@Buildable(editableEnabled = false, builderPackage = Constants.FABRIC8_KUBERNETES_API)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonPropertyOrder({ "name", "path", "subPath", "secret", "configMap", "emptyDir", "persistentVolumeClaim" })
+@EqualsAndHashCode
+@ToString
+public class AdditionalVolume implements UnknownPropertyPreserving {
+    private String name;
+    private SecretVolumeSource secret;
+    private ConfigMapVolumeSource configMap;
+    private EmptyDirVolumeSource emptyDir;
+    private PersistentVolumeClaimVolumeSource persistentVolumeClaim;
+    private Map<String, Object> additionalProperties = new HashMap<>(0);
+
+    @Description("Name to use for the volume. Required.")
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    @Description("Secret to use populate the volume.")
+    @KubeLink(group = "core", version = "v1", kind = "secretvolumesource")
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    public SecretVolumeSource getSecret() {
+        return secret;
+    }
+
+    public void setSecret(SecretVolumeSource secret) {
+        this.secret = secret;
+    }
+
+    @Description("ConfigMap to use to populate the volume.")
+    @KubeLink(group = "core", version = "v1", kind = "configmapvolumesource")
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    public ConfigMapVolumeSource getConfigMap() {
+        return configMap;
+    }
+
+    public void setConfigMap(ConfigMapVolumeSource configMap) {
+        this.configMap = configMap;
+    }
+
+    @Description("EmptyDir to use to populate the volume.")
+    @KubeLink(group = "core", version = "v1", kind = "emptydirvolumesource")
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    public EmptyDirVolumeSource getEmptyDir() {
+        return emptyDir;
+    }
+
+    public void setEmptyDir(EmptyDirVolumeSource emptyDir) {
+        this.emptyDir = emptyDir;
+    }
+
+    @Description("PersistentVolumeClaim object to use to populate the volume.")
+    @KubeLink(group = "core", version = "v1", kind = "persistentvolumeclaimvolumesource")
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    public PersistentVolumeClaimVolumeSource getPersistentVolumeClaim() {
+        return persistentVolumeClaim;
+    }
+
+    public void setPersistentVolumeClaim(PersistentVolumeClaimVolumeSource persistentVolumeClaim) {
+        this.persistentVolumeClaim = persistentVolumeClaim;
+    }
+
+    @Override
+    public Map<String, Object> getAdditionalProperties() {
+        return this.additionalProperties;
+    }
+
+    @Override
+    public void setAdditionalProperty(String name, Object value) {
+        this.additionalProperties.put(name, value);
+    }
+}

api/src/main/java/io/strimzi/api/kafka/model/common/template/ContainerTemplate.java

@@ -5,8 +5,10 @@
 package io.strimzi.api.kafka.model.common.template;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import io.fabric8.kubernetes.api.model.SecurityContext;
+import io.fabric8.kubernetes.api.model.VolumeMount;
 import io.strimzi.api.kafka.model.common.Constants;
 import io.strimzi.api.kafka.model.common.ContainerEnvVar;
 import io.strimzi.api.kafka.model.common.UnknownPropertyPreserving;
@@ -29,14 +31,25 @@
         builderPackage = Constants.FABRIC8_KUBERNETES_API
 )
 @JsonInclude(JsonInclude.Include.NON_NULL)
-@JsonPropertyOrder({"env", "securityContext"})
+@JsonPropertyOrder({"env", "securityContext", "volumeMounts"})
 @DescriptionFile
 @EqualsAndHashCode
 @ToString
 public class ContainerTemplate implements UnknownPropertyPreserving {
     private List<ContainerEnvVar> env;
     private SecurityContext securityContext;
     private Map<String, Object> additionalProperties;
+    private List<VolumeMount> additionalVolumeMounts;
+
+    @Description("Additional volume mounts which should be applied to the container")
+    @JsonProperty("volumeMounts")
+    public List<VolumeMount> getAdditionalVolumeMounts() {
+        return additionalVolumeMounts;
+    }
+
+    public void setAdditionalVolumeMounts(List<VolumeMount> additionalVolumeMounts) {
+        this.additionalVolumeMounts = additionalVolumeMounts;
+    }
 
     @Description("Environment variables which should be applied to the container.")
     public List<ContainerEnvVar> getEnv() {

api/src/main/java/io/strimzi/api/kafka/model/common/template/PodTemplate.java

@@ -38,7 +38,7 @@
 @JsonInclude(JsonInclude.Include.NON_DEFAULT)
 @JsonPropertyOrder({"metadata", "imagePullSecrets", "securityContext", "terminationGracePeriodSeconds", "affinity",
     "tolerations", "topologySpreadConstraints", "priorityClassName", "schedulerName", "hostAliases",
-    "enableServiceLinks", "tmpDirSizeLimit"})
+    "enableServiceLinks", "tmpDirSizeLimit", "volumes"})
 @EqualsAndHashCode
 @ToString
 @DescriptionFile
@@ -55,6 +55,7 @@ public class PodTemplate implements HasMetadataTemplate, UnknownPropertyPreservi
     private List<HostAlias> hostAliases;
     private Boolean enableServiceLinks;
     private String tmpDirSizeLimit;
+    private List<AdditionalVolume> additionalVolumes;
     private Map<String, Object> additionalProperties;
 
     @Description("Metadata applied to the resource.")
@@ -195,6 +196,17 @@ public void setTmpDirSizeLimit(String tmpDirSizeLimit) {
         this.tmpDirSizeLimit = tmpDirSizeLimit;
     }
 
+    @Description("Additional volumes that can be mounted to the pod.")
+    @JsonProperty("volumes")
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    public List<AdditionalVolume> getAdditionalVolumes() {
+        return additionalVolumes;
+    }
+
+    public void setAdditionalVolumes(List<AdditionalVolume> additionalVolumes) {
+        this.additionalVolumes = additionalVolumes;
+    }
+
     @Override
     public Map<String, Object> getAdditionalProperties() {
         return this.additionalProperties != null ? this.additionalProperties : Map.of();

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

@@ -30,7 +30,23 @@ spec:
         runAsUser: 1000001
         runAsGroup: 1000001
         fsGroup: 0
+      volumes:
+        - name: example-secret
+          secret: 
+            secretName: secret-name
+        - name: example-configmap
+          configMap:
+            name: config-map-name
       terminationGracePeriodSeconds: 30
+    bridgeContainer:
+      volumeMounts:
+        - name: example-secret
+          mountPath: /path/to/mount/secret-volume
+          subPath: subPath1
+    initContainer:
+      volumeMounts:
+        - name: example-configmap
+          mountPath: /path/to/mount/cm-volume
     podDisruptionBudget:
       metadata:
         labels:
@@ -39,4 +55,4 @@ spec:
         annotations:
           key1: label1
           key2: label2
-      maxUnavailable: 1
+      maxUnavailable: 1

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

@@ -31,6 +31,22 @@ spec:
         runAsGroup: 1000001
         fsGroup: 0
       terminationGracePeriodSeconds: 30
+      volumes:
+        - name: example-secret
+          secret: 
+            secretName: secret-name
+        - name: example-configmap
+          configMap:
+            name: config-map-name
+    connectContainer:
+      volumeMounts:
+        - name: example-secret
+          mountPath: /path/to/mount/secret-volume
+          subPath: subPath1
+    initContainer:
+      volumeMounts:
+        - name: example-configmap
+          mountPath: /path/to/mount/cm-volume
     podDisruptionBudget:
       metadata:
         labels:
@@ -47,4 +63,4 @@ spec:
           key2: label2
         annotations:
           key1: label1
-          key2: label2
+          key2: label2

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

@@ -42,6 +42,28 @@ spec:
           runAsGroup: 1000001
           fsGroup: 0
         terminationGracePeriodSeconds: 30
+        volumes:
+          - name: example-secret
+            secret: 
+              secretName: secret-name
+          - name: example-configmap
+            configMap:
+              name: config-map-name
+          - name: temp
+            emptyDir: {}
+          - name: example-pvc-volume
+            persistentVolumeClaim:
+              claimName: myclaim
+      kafkaContainer:
+        volumeMounts:
+          - name: example-secret
+            mountPath: /mnt/secret-volume
+          - name: example-configmap
+            mountPath: /mnt/cm-volume
+          - name: temp
+            mountPath: /tmp/logs
+          - name: example-pvc-volume
+            mountPath: "/mnt/data"
       bootstrapService:
         metadata:
           labels:
@@ -120,6 +142,27 @@ spec:
           annotations:
             key1: label1
             key2: label2
+        volumes:
+          - name: example-secret
+            secret: 
+              secretName: secret-name
+          - name: example-configmap
+            configMap:
+              name: config-map-name
+          - name: temp
+            emptyDir: {}
+          - name: example-pvc-volume
+            persistentVolumeClaim:
+              claimName: example-pvc-volume
+      zookeeperContainer:
+        volumeMounts:
+          - name: example-secret
+            mountPath: /mnt/secret-volume
+            subPath: subPath1
+          - name: example-configmap
+            mountPath: /mnt/cm-volume
+          - name: example-pvc-volume
+            mountPath: "/mnt/data"
       clientService:
         metadata:
           labels:
@@ -156,4 +199,16 @@ spec:
           annotations:
             key1: label1
             key2: label2
+        volumes:
+          - name: example-secret
+            secret: 
+              secretName: secret-name
+          - name: example-configmap
+            configMap:
+              name: config-map-name
+          - name: temp
+            emptyDir: {}
+          - name: example-pvc-volume
+            persistentVolumeClaim:
+              claimName: example-pvc-volume
 

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

@@ -41,6 +41,22 @@ spec:
         runAsGroup: 1000001
         fsGroup: 0
       terminationGracePeriodSeconds: 30
+      volumes:
+        - name: example-secret
+          secret: 
+            secretName: secret-name
+        - name: example-configmap
+          configMap:
+            name: config-map-name
+    connectContainer:
+      volumeMounts:
+        - name: example-secret
+          mountPath: /path/to/mount/secret-volume
+          subPath: subPath1
+    initContainer:
+      volumeMounts:
+        - name: example-configmap
+          mountPath: /path/to/mount/cm-volume
     podDisruptionBudget:
       metadata:
         labels:
@@ -57,4 +73,4 @@ spec:
           key2: label2
         annotations:
           key1: label1
-          key2: label2
+          key2: label2