use lifecycle label manager to support dynamic label management (#79)

Author: AnnaYue

xset/api/opslifecycle_types.go

@@ -20,6 +20,40 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
+type OperationLabelEnum int
+
+const (
+	// OperatingLabelPrefix indicates a target is under operation
+	// set by xset controller
+	OperatingLabelPrefix OperationLabelEnum = iota
+
+	// OperationTypeLabelPrefix indicates the type of operation
+	// set by xset controller
+	OperationTypeLabelPrefix
+
+	// OperateLabelPrefix indicates a target could start operation
+	// set by related opsLifecycle controller.
+	// xset controller will start operation only after this label is set
+	OperateLabelPrefix
+
+	// UndoOperationTypeLabelPrefix indicates a type of operation has been canceled.
+	// need to be handled by related opsLifecycle controller
+	UndoOperationTypeLabelPrefix
+
+	// ServiceAvailableLabel indicates a target is available for service.
+	// set by related opsLifecycle controller.
+	ServiceAvailableLabel
+
+	// PreparingDeleteLabel indicates a target is preparing to be deleted.
+	// set by xset controller,
+	// handle by related opsLifecycle controller if needed.
+	PreparingDeleteLabel
+)
+
+type LifeCycleLabelManager interface {
+	Get(labelType OperationLabelEnum) string
+}
+
 type OperationType string
 
 var (
@@ -28,8 +62,6 @@ var (
 	OpsLifecycleTypeDelete  OperationType = "delete"
 )
 
-type UpdateFunc func(object client.Object) (bool, error)
-
 // LifecycleAdapter helps CRD Operators to easily access TargetOpsLifecycle
 type LifecycleAdapter interface {
 	// GetID indicates ID of one TargetOpsLifecycle

xset/api/xset_controller_types.go

@@ -39,6 +39,7 @@ type XSetController interface {
 	GetXSetStatus(object XSetObject) *XSetStatus
 	SetXSetStatus(object XSetObject, status *XSetStatus)
 
+	GetLifeCycleLabelManager() LifeCycleLabelManager
 	GetScaleInOpsLifecycleAdapter() LifecycleAdapter
 	GetUpdateOpsLifecycleAdapter() LifecycleAdapter
 

xset/opslifecycle/const.go

@@ -24,7 +24,9 @@ import (
 
 var _ api.LifecycleAdapter = &DefaultUpdateLifecycleAdapter{}
 
-type DefaultUpdateLifecycleAdapter struct{}
+type DefaultUpdateLifecycleAdapter struct {
+	LabelManager api.LifeCycleLabelManager
+}
 
 func (d *DefaultUpdateLifecycleAdapter) GetID() string {
 	return "xset"
@@ -39,7 +41,7 @@ func (d *DefaultUpdateLifecycleAdapter) AllowMultiType() bool {
 }
 
 func (d *DefaultUpdateLifecycleAdapter) WhenBegin(target client.Object) (bool, error) {
-	setOperate(d, target)
+	setOperate(d.LabelManager, d, target)
 	return true, nil
 }
 
@@ -49,7 +51,9 @@ func (d *DefaultUpdateLifecycleAdapter) WhenFinish(target client.Object) (bool,
 
 var _ api.LifecycleAdapter = &DefaultScaleInLifecycleAdapter{}
 
-type DefaultScaleInLifecycleAdapter struct{}
+type DefaultScaleInLifecycleAdapter struct {
+	LabelManager api.LifeCycleLabelManager
+}
 
 func (d *DefaultScaleInLifecycleAdapter) GetID() string {
 	return "xset"
@@ -64,7 +68,7 @@ func (d *DefaultScaleInLifecycleAdapter) AllowMultiType() bool {
 }
 
 func (d *DefaultScaleInLifecycleAdapter) WhenBegin(target client.Object) (bool, error) {
-	setOperate(d, target)
+	setOperate(d.LabelManager, d, target)
 	return true, nil
 }
 

xset/opslifecycle/default_opslifecycle.go xset/opslifecycle/default_adapters.goxset/opslifecycle/default_opslifecycle.go renamed to xset/opslifecycle/default_adapters.go

@@ -0,0 +1,72 @@
+/*
+ * 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 opslifecycle
+
+import (
+	"kusionstack.io/kube-utils/xset/api"
+)
+
+// OpsLifecycle default labels
+var (
+	defaultOperatingLabelPrefix         = "operating.opslifecycle.kusionstack.io"
+	defaultOperationTypeLabelPrefix     = "operation-type.opslifecycle.kusionstack.io"
+	defaultOperateLabelPrefix           = "operate.opslifecycle.kusionstack.io"
+	defaultUndoOperationTypeLabelPrefix = "undo-operation-type.opslifecycle.kusionstack.io"
+	defaultServiceAvailableLabel        = "opslifecycle.kusionstack.io/service-available"
+	defaultPreparingDeleteLabel         = "opslifecycle.kusionstack.io/preparing-to-delete"
+)
+
+var defaultLables = map[api.OperationLabelEnum]string{
+	api.OperatingLabelPrefix:         defaultOperatingLabelPrefix,
+	api.OperationTypeLabelPrefix:     defaultOperationTypeLabelPrefix,
+	api.OperateLabelPrefix:           defaultOperateLabelPrefix,
+	api.UndoOperationTypeLabelPrefix: defaultUndoOperationTypeLabelPrefix,
+	api.ServiceAvailableLabel:        defaultServiceAvailableLabel,
+	api.PreparingDeleteLabel:         defaultPreparingDeleteLabel,
+}
+
+type LabelManagerImpl struct {
+	labels                       map[api.OperationLabelEnum]string
+	wellKnownLabelPrefixesWithID []string
+}
+
+func NewLabelManager(overwrite map[api.OperationLabelEnum]string) api.LifeCycleLabelManager {
+	labelKeys := make(map[api.OperationLabelEnum]string)
+	for k, v := range defaultLables {
+		labelKeys[k] = v
+	}
+	if len(overwrite) > 0 {
+		for k, v := range overwrite {
+			labelKeys[k] = v
+		}
+	}
+
+	wellKnownLabelPrefilxesWithID := []string{
+		labelKeys[api.OperatingLabelPrefix],
+		labelKeys[api.OperationTypeLabelPrefix],
+		labelKeys[api.UndoOperationTypeLabelPrefix],
+		labelKeys[api.OperatingLabelPrefix],
+	}
+	return &LabelManagerImpl{
+		labels:                       labelKeys,
+		wellKnownLabelPrefixesWithID: wellKnownLabelPrefilxesWithID,
+	}
+}
+
+func (m *LabelManagerImpl) Get(labelType api.OperationLabelEnum) string {
+	return m.labels[labelType]
+}