add pvc adapter

Author: ColdsteelRail

xset/api/well_knowns.go

@@ -88,6 +88,12 @@ const (
 	// XExcludeIndicationLabelKey is used to indicate a target is excluded by xset
 	XExcludeIndicationLabelKey
 
+	// SubResourcePvcTemplateLabelKey is used to attach pvc template name to pvc resources
+	SubResourcePvcTemplateLabelKey
+
+	// SubResourcePvcTemplateHashLabelKey is used to attach hash of pvc template to pvc subresource
+	SubResourcePvcTemplateHashLabelKey
+
 	// LastXStatusAnnotationKey is used to record the last status of a target by xset
 	LastXStatusAnnotationKey
 
@@ -110,18 +116,20 @@ var defaultXSetLabelAnnotationManager = map[XSetLabelAnnotationEnum]string{
 	ServiceAvailableLabel:        appsv1alpha1.PodServiceAvailableLabel,
 	PreparingDeleteLabel:         appsv1alpha1.PodPreparingDeleteLabel,
 
-	ControlledByXSetLabel:           appsv1alpha1.ControlledByKusionStackLabelKey,
-	XInstanceIdLabelKey:             appsv1alpha1.PodInstanceIDLabelKey,
-	XSetUpdateIndicationLabelKey:    appsv1alpha1.CollaSetUpdateIndicateLabelKey,
-	XDeletionIndicationLabelKey:     appsv1alpha1.PodDeletionIndicationLabelKey,
-	XReplaceIndicationLabelKey:      appsv1alpha1.PodReplaceIndicationLabelKey,
-	XReplacePairNewId:               appsv1alpha1.PodReplacePairNewId,
-	XReplacePairOriginName:          appsv1alpha1.PodReplacePairOriginName,
-	XReplaceByReplaceUpdateLabelKey: appsv1alpha1.PodReplaceByReplaceUpdateLabelKey,
-	XOrphanedIndicationLabelKey:     appsv1alpha1.PodOrphanedIndicateLabelKey,
-	XCreatingLabel:                  appsv1alpha1.PodCreatingLabel,
-	XCompletingLabel:                appsv1alpha1.PodCompletingLabel,
-	XExcludeIndicationLabelKey:      appsv1alpha1.PodExcludeIndicationLabelKey,
+	ControlledByXSetLabel:              appsv1alpha1.ControlledByKusionStackLabelKey,
+	XInstanceIdLabelKey:                appsv1alpha1.PodInstanceIDLabelKey,
+	XSetUpdateIndicationLabelKey:       appsv1alpha1.CollaSetUpdateIndicateLabelKey,
+	XDeletionIndicationLabelKey:        appsv1alpha1.PodDeletionIndicationLabelKey,
+	XReplaceIndicationLabelKey:         appsv1alpha1.PodReplaceIndicationLabelKey,
+	XReplacePairNewId:                  appsv1alpha1.PodReplacePairNewId,
+	XReplacePairOriginName:             appsv1alpha1.PodReplacePairOriginName,
+	XReplaceByReplaceUpdateLabelKey:    appsv1alpha1.PodReplaceByReplaceUpdateLabelKey,
+	XOrphanedIndicationLabelKey:        appsv1alpha1.PodOrphanedIndicateLabelKey,
+	XCreatingLabel:                     appsv1alpha1.PodCreatingLabel,
+	XCompletingLabel:                   appsv1alpha1.PodCompletingLabel,
+	XExcludeIndicationLabelKey:         appsv1alpha1.PodExcludeIndicationLabelKey,
+	SubResourcePvcTemplateLabelKey:     appsv1alpha1.PvcTemplateLabelKey,
+	SubResourcePvcTemplateHashLabelKey: appsv1alpha1.PvcTemplateHashLabelKey,
 
 	LastXStatusAnnotationKey: appsv1alpha1.LastPodStatusAnnotationKey,
 }

xset/api/xset_controller_types.go

@@ -61,14 +61,6 @@ type XOperation interface {
 	GetXOpsPriority(ctx context.Context, c client.Client, object client.Object) (*OpsPriority, error)
 }
 
-type SubResourcePvcAdapter interface {
-	RetainPvcWhenXSetDeleted(object XSetObject) bool
-	RetainPvcWhenXSetScaled(object XSetObject) bool
-	GetXSetPvcTemplate(object XSetObject) []corev1.PersistentVolumeClaim
-	GetXMountedPvcs(object client.Object) []corev1.Volume
-	MountXPvcs(object client.Object, pvcs []corev1.Volume)
-}
-
 // LifecycleAdapterGetter is used to get lifecycle adapters.
 type LifecycleAdapterGetter interface {
 	GetScaleInOpsLifecycleAdapter() LifecycleAdapter
@@ -84,3 +76,22 @@ type ResourceContextAdapterGetter interface {
 type LabelAnnotationManagerGetter interface {
 	GetLabelManagerAdapter() XSetLabelAnnotationManager
 }
+
+// SubResourcePvcAdapter is used to manage pvc subresource for X, which are declared on XSet, e.g., spec.volumeClaimTemplate.
+// Once adapter is implemented, XSetController will automatically manage pvc: (1) create pvcs from GetXSetPvcTemplate for each
+// X object and attach theses pvcs with same instance-id, (2) upgrade pvcs and recreate X object pvcs when PvcTemplateChanged,
+// (3) retain pvcs when XSet is deleted or scaledIn according to RetainPvcWhenXSetDeleted and RetainPvcWhenXSetScaled.
+type SubResourcePvcAdapter interface {
+	// RetainPvcWhenXSetDeleted returns true if pvc should be retained when XSet is deleted.
+	RetainPvcWhenXSetDeleted(object XSetObject) bool
+	// RetainPvcWhenXSetScaled returns true if pvc should be retained when XSet replicas is scaledIn.
+	RetainPvcWhenXSetScaled(object XSetObject) bool
+	// GetXSetPvcTemplate returns pvc template from XSet object.
+	GetXSetPvcTemplate(object XSetObject) []corev1.PersistentVolumeClaim
+	// GetXSpecVolumes returns spec.volumes from X object.
+	GetXSpecVolumes(object client.Object) []corev1.Volume
+	// GetXVolumeMounts returns containers volumeMounts from X (pod) object.
+	GetXVolumeMounts(object client.Object) []corev1.VolumeMount
+	// SetXSpecVolumes sets spec.volumes to X object.
+	SetXSpecVolumes(object client.Object, pvcs []corev1.Volume)
+}

xset/subresources/getter.go

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2024-2025 KusionStack Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package subresources
+
+import "kusionstack.io/kube-utils/xset/api"
+
+func GetSubresourcePvcAdapter(control api.XSetController) (adapter api.SubResourcePvcAdapter, enabled bool) {
+	adapter, enabled = control.(api.SubResourcePvcAdapter)
+	return adapter, enabled
+}