unify PVC data and additional PVC reconciliation loop

Author: GrigoryPervakov

api/v1alpha1/clickhousecluster_types.go

@@ -49,12 +49,12 @@ type ClickHouseClusterSpec struct {
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Data Volume Claim Spec"
 	DataVolumeClaimSpec *corev1.PersistentVolumeClaimSpec `json:"dataVolumeClaimSpec,omitempty"`
 
-	// Additional persistent volume claims attached to each ClickHouse pod.
-	// Each entry creates a volumeClaimTemplate on the StatefulSet, producing
-	// per-pod PVCs named <name>-<statefulset>-<ordinal>.
-	// Use for JBOD / multi-disk storage layouts.
+	// Additional per-pod PVC templates for JBOD / multi-disk storage.
+	// Each entry is propagated in StatefulSet volumeClaimTemplate, mounted at /var/lib/clickhouse/disks/<name> and
+	// added to the generated JBOD storage policy.
+	// The set of disks is fixed at creation.
 	// +optional
-	AdditionalDataVolumeClaimSpecs []AdditionalVolumeClaimSpec `json:"additionalDataVolumeClaimSpecs,omitempty"`
+	AdditionalVolumeClaimTemplates []PersistentVolumeClaimTemplate `json:"additionalVolumeClaimTemplates,omitempty"`
 
 	// Additional labels that are added to resources.
 	// +optional
@@ -116,22 +116,6 @@ type AdditionalPort struct {
 	Port int32 `json:"port"`
 }
 
-// AdditionalVolumeClaimSpec defines an additional persistent volume claim for a ClickHouse pod.
-type AdditionalVolumeClaimSpec struct {
-	// Name used as the volumeClaimTemplate name and the volume/volumeMount name.
-	// Must be unique and not collide with the primary data volume name.
-	// Must consist of lowercase alphanumeric characters or hyphens, and start and end with an alphanumeric character.
-	// Hyphens are automatically converted to underscores in the ClickHouse disk configuration.
-	// +kubebuilder:validation:Pattern=`^[a-z0-9]([a-z0-9-]*[a-z0-9])?$`
-	Name string `json:"name"`
-	// PVC spec for this additional volume.
-	Spec corev1.PersistentVolumeClaimSpec `json:"spec"`
-	// MountPath inside the ClickHouse container.
-	// If empty, defaults to /var/lib/clickhouse/disks/<name>.
-	// +optional
-	MountPath string `json:"mountPath,omitempty"`
-}
-
 // WithDefaults sets default values for ClickHouseClusterSpec fields.
 func (s *ClickHouseClusterSpec) WithDefaults() {
 	defaultSpec := ClickHouseClusterSpec{
@@ -181,14 +165,9 @@ func (s *ClickHouseClusterSpec) WithDefaults() {
 		s.DataVolumeClaimSpec.AccessModes = []corev1.PersistentVolumeAccessMode{DefaultAccessMode}
 	}
 
-	for i := range s.AdditionalDataVolumeClaimSpecs {
-		if len(s.AdditionalDataVolumeClaimSpecs[i].Spec.AccessModes) == 0 {
-			s.AdditionalDataVolumeClaimSpecs[i].Spec.AccessModes = []corev1.PersistentVolumeAccessMode{DefaultAccessMode}
-		}
-
-		if s.AdditionalDataVolumeClaimSpecs[i].MountPath == "" {
-			// Keep in sync with internal.AdditionalDiskBasePath.
-			s.AdditionalDataVolumeClaimSpecs[i].MountPath = "/var/lib/clickhouse/disks/" + s.AdditionalDataVolumeClaimSpecs[i].Name
+	for i, t := range s.AdditionalVolumeClaimTemplates {
+		if len(t.Spec.AccessModes) == 0 {
+			s.AdditionalVolumeClaimTemplates[i].Spec.AccessModes = []corev1.PersistentVolumeAccessMode{DefaultAccessMode}
 		}
 	}
 }

api/v1alpha1/common.go

@@ -562,3 +562,26 @@ type VersionProbeContainer struct {
 	// +optional
 	SecurityContext *corev1.SecurityContext `json:"securityContext,omitempty"`
 }
+
+// NamedTemplateMeta defines supported metadata settings for template objects that require a name.
+type NamedTemplateMeta struct {
+	// Name is the resource identifier.
+	// +kubebuilder:validation:Pattern=`^[a-z]([-a-z0-9]*[a-z0-9])?$`
+	Name string `json:"name"`
+	// Labels are labels applied to the template objects.
+	// +optional
+	Labels map[string]string `json:"labels,omitempty"`
+	// Annotations are annotations applied to the template objects.
+	// +optional
+	Annotations map[string]string `json:"annotations,omitempty"`
+}
+
+// PersistentVolumeClaimTemplate is a named template for a per-replica PersistentVolumeClaim.
+type PersistentVolumeClaimTemplate struct {
+	// Metadata template of the volume claim.
+	NamedTemplateMeta `json:"metadata,omitempty"`
+
+	// Spec defines the desired characteristics of a volume requested by a pod author.
+	// More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+	Spec corev1.PersistentVolumeClaimSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
+}

api/v1alpha1/zz_generated.deepcopy.go

@@ -66,31 +66,70 @@ spec:
           spec:
             description: ClickHouseClusterSpec defines the desired state of ClickHouseCluster.
             properties:
-              additionalDataVolumeClaimSpecs:
+              additionalPorts:
                 description: |-
-                  Additional persistent volume claims attached to each ClickHouse pod.
-                  Each entry creates a volumeClaimTemplate on the StatefulSet, producing
-                  per-pod PVCs named <name>-<statefulset>-<ordinal>.
-                  Use for JBOD / multi-disk storage layouts.
+                  AdditionalPorts declares extra TCP ports to expose on the ClickHouse Pod and the operator-managed headless Service.
+                  The operator only adds the ports to the Kubernetes resources, it does not configure the ClickHouse server to listen on them.
                 items:
-                  description: AdditionalVolumeClaimSpec defines an additional persistent
-                    volume claim for a ClickHouse pod.
+                  description: AdditionalPort declares one extra TCP port to expose
+                    on the ClickHouse Pod and the operator-managed headless Service.
                   properties:
-                    mountPath:
-                      description: |-
-                        MountPath inside the ClickHouse container.
-                        If empty, defaults to /var/lib/clickhouse/disks/<name>.
-                      type: string
                     name:
                       description: |-
-                        Name used as the volumeClaimTemplate name and the volume/volumeMount name.
-                        Must be unique and not collide with the primary data volume name.
-                        Must consist of lowercase alphanumeric characters or hyphens, and start and end with an alphanumeric character.
-                        Hyphens are automatically converted to underscores in the ClickHouse disk configuration.
-                      pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
+                        Name uniquely identifies the port within the list. Used as both the container port name and the Service port name.
+                        This must be a DNS_LABEL.
+                      maxLength: 63
+                      pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
                       type: string
+                    port:
+                      description: Port is the TCP port number to expose.
+                      format: int32
+                      maximum: 65535
+                      minimum: 1
+                      type: integer
+                  required:
+                  - name
+                  - port
+                  type: object
+                type: array
+                x-kubernetes-list-map-keys:
+                - name
+                x-kubernetes-list-type: map
+              additionalVolumeClaimTemplates:
+                description: |-
+                  Additional per-pod PVC templates for JBOD / multi-disk storage.
+                  Each entry is propagated in StatefulSet volumeClaimTemplate, mounted at /var/lib/clickhouse/disks/<name> and
+                  added to the generated JBOD storage policy.
+                  The set of disks is fixed at creation.
+                items:
+                  description: PersistentVolumeClaimTemplate is a named template for
+                    a per-replica PersistentVolumeClaim.
+                  properties:
+                    metadata:
+                      description: Metadata template of the volume claim.
+                      properties:
+                        annotations:
+                          additionalProperties:
+                            type: string
+                          description: Annotations are annotations applied to the
+                            template objects.
+                          type: object
+                        labels:
+                          additionalProperties:
+                            type: string
+                          description: Labels are labels applied to the template objects.
+                          type: object
+                        name:
+                          description: Name is the resource identifier.
+                          pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
+                          type: string
+                      required:
+                      - name
+                      type: object
                     spec:
-                      description: PVC spec for this additional volume.
+                      description: |-
+                        Spec defines the desired characteristics of a volume requested by a pod author.
+                        More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
                       properties:
                         accessModes:
                           description: |-
@@ -284,40 +323,8 @@ spec:
                             PersistentVolume backing this claim.
                           type: string
                       type: object
-                  required:
-                  - name
-                  - spec
                   type: object
                 type: array
-              additionalPorts:
-                description: |-
-                  AdditionalPorts declares extra TCP ports to expose on the ClickHouse Pod and the operator-managed headless Service.
-                  The operator only adds the ports to the Kubernetes resources, it does not configure the ClickHouse server to listen on them.
-                items:
-                  description: AdditionalPort declares one extra TCP port to expose
-                    on the ClickHouse Pod and the operator-managed headless Service.
-                  properties:
-                    name:
-                      description: |-
-                        Name uniquely identifies the port within the list. Used as both the container port name and the Service port name.
-                        This must be a DNS_LABEL.
-                      maxLength: 63
-                      pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
-                      type: string
-                    port:
-                      description: Port is the TCP port number to expose.
-                      format: int32
-                      maximum: 65535
-                      minimum: 1
-                      type: integer
-                  required:
-                  - name
-                  - port
-                  type: object
-                type: array
-                x-kubernetes-list-map-keys:
-                - name
-                x-kubernetes-list-type: map
               annotations:
                 additionalProperties:
                   type: string

config/crd/bases/clickhouse.com_clickhouseclusters.yaml

@@ -49,16 +49,16 @@ clickhouse:
   # ClickHouseCluster.spec — passed verbatim into the CR.
   spec:
 
-    # Additional persistent volume claims attached to each ClickHouse pod.
-    # Each entry creates a volumeClaimTemplate on the StatefulSet, producing
-    # per-pod PVCs named <name>-<statefulset>-<ordinal>.
-    # Use for JBOD / multi-disk storage layouts.
-    # additionalDataVolumeClaimSpecs: []
-
     # AdditionalPorts declares extra TCP ports to expose on the ClickHouse Pod and the operator-managed headless Service.
     # The operator only adds the ports to the Kubernetes resources, it does not configure the ClickHouse server to listen on them.
     # additionalPorts: []
 
+    # Additional per-pod PVC templates for JBOD / multi-disk storage.
+    # Each entry is propagated in StatefulSet volumeClaimTemplate, mounted at /var/lib/clickhouse/disks/<name> and
+    # added to the generated JBOD storage policy.
+    # The set of disks is fixed at creation.
+    # additionalVolumeClaimTemplates: []
+
     # Additional annotations that are added to resources.
     # annotations: {}