feat: support backup and restore parameters (#8472)

(cherry picked from commit a68fb12)

apis/dataprotection/v1alpha1/actionset_types.go

@@ -37,6 +37,11 @@ type ActionSetSpec struct {
 	// +kubebuilder:validation:Required
 	BackupType BackupType `json:"backupType"`
 
+	// Specifies the schema of parameters in backups and restores before their usage.
+	//
+	// +optional
+	ParametersSchema *ActionSetParametersSchema `json:"parametersSchema,omitempty"`
+
 	// Specifies a list of environment variables to be set in the container.
 	//
 	// +kubebuilder:pruning:PreserveUnknownFields
@@ -117,6 +122,11 @@ type BackupActionSpec struct {
 	//
 	// +optional
 	PreDeleteBackup *BaseJobActionSpec `json:"preDelete,omitempty"`
+
+	// Specifies the parameters used by the backup action
+	//
+	// +optional
+	WithParameters []string `json:"withParameters,omitempty"`
 }
 
 // BackupDataActionSpec defines how to back up data.
@@ -162,6 +172,11 @@ type RestoreActionSpec struct {
 	// +optional
 	// +kubebuilder:default=true
 	BaseBackupRequired *bool `json:"baseBackupRequired,omitempty"`
+
+	// Specifies the parameters used by the restore action
+	//
+	// +optional
+	WithParameters []string `json:"withParameters,omitempty"`
 }
 
 // ActionSpec defines an action that should be executed. Only one of the fields may be set.

apis/dataprotection/v1alpha1/backup_types.go

@@ -22,6 +22,7 @@ import (
 )
 
 // BackupSpec defines the desired state of Backup.
+// +kubebuilder:validation:XValidation:rule="has(oldSelf.parameters) == has(self.parameters)",message="forbidden to update spec.parameters"
 type BackupSpec struct {
 	// Specifies the backup policy to be applied for this backup.
 	//
@@ -74,6 +75,16 @@ type BackupSpec struct {
 	// +optional
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="forbidden to update spec.parentBackupName"
 	ParentBackupName string `json:"parentBackupName,omitempty"`
+
+	// Specifies a list of name-value pairs representing parameters and their corresponding values.
+	// Parameters match the schema specified in the `actionset.spec.parametersSchema`
+	//
+	// +listType=map
+	// +listMapKey=name
+	// +kubebuilder:validation:MaxItems=128
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="forbidden to update spec.parameters"
+	// +optional
+	Parameters []ParameterPair `json:"parameters,omitempty"`
 }
 
 // BackupStatus defines the observed state of Backup.

apis/dataprotection/v1alpha1/backupschedule_types.go

@@ -49,6 +49,12 @@ type SchedulePolicy struct {
 	// +optional
 	Enabled *bool `json:"enabled,omitempty"`
 
+	// Specifies the name of the schedule. Names cannot be duplicated.
+	// If the name is empty, it will be considered the same as the value of the backupMethod below.
+	//
+	// +optional
+	Name string `json:"name,omitempty"`
+
 	// Specifies the backup method name that is defined in backupPolicy.
 	//
 	// +kubebuilder:validation:Required
@@ -76,6 +82,17 @@ type SchedulePolicy struct {
 	// +optional
 	// +kubebuilder:default="7d"
 	RetentionPeriod RetentionPeriod `json:"retentionPeriod,omitempty"`
+
+	// Specifies a list of name-value pairs representing parameters and their corresponding values.
+	// Parameters match the schema specified in the `actionset.spec.parametersSchema`
+	//
+	// +patchMergeKey=name
+	// +patchStrategy=merge,retainKeys
+	// +listType=map
+	// +listMapKey=name
+	// +kubebuilder:validation:MaxItems=128
+	// +optional
+	Parameters []ParameterPair `json:"parameters,omitempty"`
 }
 
 // BackupScheduleStatus defines the observed state of BackupSchedule.
@@ -174,3 +191,12 @@ type BackupScheduleList struct {
 func init() {
 	SchemeBuilder.Register(&BackupSchedule{}, &BackupScheduleList{})
 }
+
+// GetScheduleName gets the name of schedulePolicy.
+// If name is empty, return backupMethod.
+func (s *SchedulePolicy) GetScheduleName() string {
+	if len(s.Name) > 0 {
+		return s.Name
+	}
+	return s.BackupMethod
+}

apis/dataprotection/v1alpha1/restore_types.go

@@ -22,6 +22,7 @@ import (
 )
 
 // RestoreSpec defines the desired state of Restore
+// +kubebuilder:validation:XValidation:rule="has(oldSelf.parameters) == has(self.parameters)",message="forbidden to update spec.parameters"
 type RestoreSpec struct {
 	// Specifies the backup to be restored. The restore behavior is based on the backup type:
 	//
@@ -84,6 +85,16 @@ type RestoreSpec struct {
 	// +kubebuilder:validation:Minimum=0
 	// +kubebuilder:validation:Maximum=10
 	BackoffLimit *int32 `json:"backoffLimit,omitempty"`
+
+	// Specifies a list of name-value pairs representing parameters and their corresponding values.
+	// Parameters match the schema specified in the `actionset.spec.parametersSchema`
+	//
+	// +listType=map
+	// +listMapKey=name
+	// +kubebuilder:validation:MaxItems=128
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="forbidden to update spec.parameters"
+	// +optional
+	Parameters []ParameterPair `json:"parameters,omitempty"`
 }
 
 // BackupRef describes the backup info.

apis/dataprotection/v1alpha1/types.go

@@ -24,6 +24,7 @@ import (
 	"unicode"
 
 	corev1 "k8s.io/api/core/v1"
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 )
 
 // Phase defines the BackupPolicy and ActionSet CR .status.phase
@@ -261,3 +262,28 @@ type EncryptionConfig struct {
 	// +kubebuilder:validation:Required
 	PassPhraseSecretKeyRef *corev1.SecretKeySelector `json:"passPhraseSecretKeyRef"`
 }
+
+type ActionSetParametersSchema struct {
+	// Defines the schema for parameters using the OpenAPI v3.
+	// The supported property types include:
+	// - string
+	// - number
+	// - integer
+	// - array: Note that only items of string type are supported.
+	// +kubebuilder:validation:Schemaless
+	// +kubebuilder:validation:Type=object
+	// +kubebuilder:pruning:PreserveUnknownFields
+	// +k8s:conversion-gen=false
+	// +optional
+	OpenAPIV3Schema *apiextensionsv1.JSONSchemaProps `json:"openAPIV3Schema,omitempty"`
+}
+
+type ParameterPair struct {
+	// Represents the name of the parameter.
+	// +kubebuilder:validation:Required
+	Name string `json:"name"`
+
+	// Represents the parameter values.
+	// +kubebuilder:validation:Required
+	Value string `json:"value"`
+}

apis/operations/v1alpha1/opsrequest_types.go

@@ -24,6 +24,7 @@ import (
 
 	appsv1 "github.com/apecloud/kubeblocks/apis/apps/v1"
 	appsv1alpha1 "github.com/apecloud/kubeblocks/apis/apps/v1alpha1"
+	dpv1alpha1 "github.com/apecloud/kubeblocks/apis/dataprotection/v1alpha1"
 )
 
 // OpsRequestSpec defines the desired state of OpsRequest
@@ -205,12 +206,15 @@ type SpecificOpsRequest struct {
 	ExposeList []Expose `json:"expose,omitempty"`
 
 	// Specifies the parameters to back up a Cluster.
+	//
+	// +kubebuilder:validation:XValidation:rule="has(oldSelf.parameters) == has(self.parameters)",message="forbidden to update backup.parameters"
 	// +optional
 	Backup *Backup `json:"backup,omitempty"`
 
 	// Specifies the parameters to restore a Cluster.
 	// Note that this restore operation will roll back cluster services.
 	//
+	// +kubebuilder:validation:XValidation:rule="has(oldSelf.parameters) == has(self.parameters)",message="forbidden to update restore.parameters"
 	// +optional
 	Restore *Restore `json:"restore,omitempty"`
 
@@ -912,6 +916,16 @@ type Backup struct {
 	//
 	// +optional
 	ParentBackupName string `json:"parentBackupName,omitempty"`
+
+	// Specifies a list of name-value pairs representing parameters and their corresponding values.
+	// Parameters match the schema specified in the `actionset.spec.parametersSchema`
+	//
+	// +listType=map
+	// +listMapKey=name
+	// +kubebuilder:validation:MaxItems=128
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="forbidden to update parameters"
+	// +optional
+	Parameters []dpv1alpha1.ParameterPair `json:"parameters,omitempty"`
 }
 
 type Restore struct {
@@ -953,6 +967,16 @@ type Restore struct {
 	//
 	// This setting is useful for coordinating PostReady operations across the Cluster for optimal cluster conditions.
 	DeferPostReadyUntilClusterRunning bool `json:"deferPostReadyUntilClusterRunning,omitempty"`
+
+	// Specifies a list of name-value pairs representing parameters and their corresponding values.
+	// Parameters match the schema specified in the `actionset.spec.parametersSchema`
+	//
+	// +listType=map
+	// +listMapKey=name
+	// +kubebuilder:validation:MaxItems=128
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="forbidden to update parameters"
+	// +optional
+	Parameters []dpv1alpha1.ParameterPair `json:"parameters,omitempty"`
 }
 
 // OpsRequestStatus represents the observed state of an OpsRequest.