feat: add support for extraPVCs

This commit introduces the `extraPVCs` field in CRD,
allowing users to attach additional PVC to main container. #2126

Signed-off-by: Emin Aktas <[email protected]>

Author: eminaktas

config/crd/bases/pxc.percona.com_perconaxtradbclusters.yaml

@@ -547,22 +547,31 @@ type PodSpec struct {
 	// Deprecated: Use ServiceExpose.Labels instead
 	ReplicasServiceLabels map[string]string `json:"replicasServiceLabels,omitempty"`
 
-	SchedulerName                string                            `json:"schedulerName,omitempty"`
-	ReadinessInitialDelaySeconds *int32                            `json:"readinessDelaySec,omitempty"`
-	ReadinessProbes              corev1.Probe                      `json:"readinessProbes,omitempty"`
-	LivenessInitialDelaySeconds  *int32                            `json:"livenessDelaySec,omitempty"`
-	LivenessProbes               corev1.Probe                      `json:"livenessProbes,omitempty"`
-	PodSecurityContext           *corev1.PodSecurityContext        `json:"podSecurityContext,omitempty"`
-	ContainerSecurityContext     *corev1.SecurityContext           `json:"containerSecurityContext,omitempty"`
-	ServiceAccountName           string                            `json:"serviceAccountName,omitempty"`
-	ImagePullPolicy              corev1.PullPolicy                 `json:"imagePullPolicy,omitempty"`
-	Sidecars                     []corev1.Container                `json:"sidecars,omitempty"`
-	SidecarVolumes               []corev1.Volume                   `json:"sidecarVolumes,omitempty"`
-	SidecarPVCs                  []corev1.PersistentVolumeClaim    `json:"sidecarPVCs,omitempty"`
-	RuntimeClassName             *string                           `json:"runtimeClassName,omitempty"`
-	HookScript                   string                            `json:"hookScript,omitempty"`
-	Lifecycle                    corev1.Lifecycle                  `json:"lifecycle,omitempty"`
-	TopologySpreadConstraints    []corev1.TopologySpreadConstraint `json:"topologySpreadConstraints,omitempty"`
+	SchedulerName                string                     `json:"schedulerName,omitempty"`
+	ReadinessInitialDelaySeconds *int32                     `json:"readinessDelaySec,omitempty"`
+	ReadinessProbes              corev1.Probe               `json:"readinessProbes,omitempty"`
+	LivenessInitialDelaySeconds  *int32                     `json:"livenessDelaySec,omitempty"`
+	LivenessProbes               corev1.Probe               `json:"livenessProbes,omitempty"`
+	PodSecurityContext           *corev1.PodSecurityContext `json:"podSecurityContext,omitempty"`
+	ContainerSecurityContext     *corev1.SecurityContext    `json:"containerSecurityContext,omitempty"`
+	ServiceAccountName           string                     `json:"serviceAccountName,omitempty"`
+	ImagePullPolicy              corev1.PullPolicy          `json:"imagePullPolicy,omitempty"`
+	Sidecars                     []corev1.Container         `json:"sidecars,omitempty"`
+	SidecarVolumes               []corev1.Volume            `json:"sidecarVolumes,omitempty"`
+	// +kubebuilder:validation:items:XEmbeddedResource
+	SidecarPVCs               []corev1.PersistentVolumeClaim    `json:"sidecarPVCs,omitempty"`
+	RuntimeClassName          *string                           `json:"runtimeClassName,omitempty"`
+	HookScript                string                            `json:"hookScript,omitempty"`
+	Lifecycle                 corev1.Lifecycle                  `json:"lifecycle,omitempty"`
+	TopologySpreadConstraints []corev1.TopologySpreadConstraint `json:"topologySpreadConstraints,omitempty"`
+	ExtraPVCs                 []ExtraPVC                        `json:"extraPVCs,omitempty"`
+}
+
+type ExtraPVC struct {
+	// +kubebuilder:validation:EmbeddedResource
+	VolumeClaimTemplate corev1.PersistentVolumeClaim `json:"volumeClaimTemplate,omitempty"`
+	MountPath           string                       `json:"mountPath,omitempty"`
+	ReadOnly            *bool                        `json:"readOnly,omitempty"`
 }
 
 func (spec *PodSpec) HasSidecarInternalSecret(secret *corev1.Secret) bool {
@@ -1522,6 +1531,14 @@ func AddSidecarContainers(log logr.Logger, existing, sidecars []corev1.Container
 	return existing
 }
 
+func AddExtraVolumes(log logr.Logger, existing []corev1.Volume, extraVolumes []ExtraPVC) []corev1.Volume {
+	if len(extraVolumes) == 0 {
+		return existing
+	}
+
+	return existing
+}
+
 func AddSidecarVolumes(log logr.Logger, existing, sidecarVolumes []corev1.Volume) []corev1.Volume {
 	if len(sidecarVolumes) == 0 {
 		return existing

deploy/bundle.yaml

@@ -48,6 +48,19 @@ func StatefulSet(ctx context.Context, cl client.Client, sfs api.StatefulApp, pod
 		return nil, fmt.Errorf("failed to get volumes %v", err)
 	}
 
+	var extraPVCMounts []corev1.VolumeMount
+	if cr.Spec.PXC.ExtraPVCs != nil {
+		for _, extraPVC := range cr.Spec.PXC.ExtraPVCs {
+			sfsVolume.PVCs = append(sfsVolume.PVCs, extraPVC.VolumeClaimTemplate)
+			pvcMount := corev1.VolumeMount{
+				Name:      extraPVC.VolumeClaimTemplate.GetName(),
+				MountPath: extraPVC.MountPath,
+				ReadOnly:  *extraPVC.ReadOnly,
+			}
+			extraPVCMounts = append(extraPVCMounts, pvcMount)
+		}
+	}
+
 	if sfsVolume != nil && sfsVolume.Volumes != nil {
 		pod.Volumes = sfsVolume.Volumes
 	}
@@ -57,6 +70,11 @@ func StatefulSet(ctx context.Context, cl client.Client, sfs api.StatefulApp, pod
 		return nil, errors.Wrap(err, "app container")
 	}
 
+	// Attach extraPVCs mounts
+	if extraPVCMounts != nil {
+		appC.VolumeMounts = append(appC.VolumeMounts, extraPVCMounts...)
+	}
+
 	pmmC, err := sfs.PMMContainer(ctx, cl, cr.Spec.PMM, secret, cr)
 	if err != nil {
 		log.Info(`"pmm container error"`, "secrets", cr.Spec.SecretsName, "internalSecrets", "internal-"+cr.Name, "error", err)