feat: cluster-level resource propagation pause and resume capabilities

api/openapi-spec/swagger.json

@@ -19118,6 +19118,10 @@
         "schedulerName": {
           "description": "SchedulerName represents which scheduler to proceed the scheduling. If specified, the policy will be dispatched by specified scheduler. If not specified, the policy will be dispatched by default scheduler.",
           "type": "string"
+        },
+        "suspension": {
+          "description": "Suspension declares the policy for suspending different aspects of propagation. nil means no suspension. no default values.",
+          "$ref": "#/definitions/com.github.karmada-io.karmada.pkg.apis.policy.v1alpha1.Suspension"
         }
       }
     },
@@ -19256,6 +19260,34 @@
         }
       }
     },
+    "com.github.karmada-io.karmada.pkg.apis.policy.v1alpha1.SuspendClusters": {
+      "description": "SuspendClusters represents a group of clusters that should be suspended from propagating. Note: No plan to introduce the label selector or field selector to select clusters yet, as it would make the system unpredictable.",
+      "type": "object",
+      "properties": {
+        "clusterNames": {
+          "description": "ClusterNames is the list of clusters to be selected.",
+          "type": "array",
+          "items": {
+            "type": "string",
+            "default": ""
+          }
+        }
+      }
+    },
+    "com.github.karmada-io.karmada.pkg.apis.policy.v1alpha1.Suspension": {
+      "description": "Suspension defines the policy for suspending different aspects of propagation.",
+      "type": "object",
+      "properties": {
+        "dispatching": {
+          "description": "Dispatching controls whether dispatching should be suspended. nil means not suspend, no default value, only accepts 'true'. Note: true means stop propagating to all clusters. Can not co-exist with DispatchingOnClusters which is used to suspend particular clusters.",
+          "type": "boolean"
+        },
+        "dispatchingOnClusters": {
+          "description": "DispatchingOnClusters declares a list of clusters to which the dispatching should be suspended. Note: Can not co-exist with Dispatching which is used to suspend all.",
+          "$ref": "#/definitions/com.github.karmada-io.karmada.pkg.apis.policy.v1alpha1.SuspendClusters"
+        }
+      }
+    },
     "com.github.karmada-io.karmada.pkg.apis.remedy.v1alpha1.ClusterAffinity": {
       "description": "ClusterAffinity represents the filter to select clusters.",
       "type": "object",
@@ -19720,6 +19752,10 @@
       "description": "WorkSpec defines the desired state of Work.",
       "type": "object",
       "properties": {
+        "suspendDispatching": {
+          "description": "SuspendDispatching controls whether dispatching should be suspended, nil means not suspend. Note: true means stop propagating to all clusters.",
+          "type": "boolean"
+        },
         "workload": {
           "description": "Workload represents the manifest workload to be deployed on managed cluster.",
           "default": {},
@@ -20171,6 +20207,10 @@
         "schedulerName": {
           "description": "SchedulerName represents which scheduler to proceed the scheduling. It inherits directly from the associated PropagationPolicy(or ClusterPropagationPolicy).",
           "type": "string"
+        },
+        "suspension": {
+          "description": "Suspension declares the policy for suspending different aspects of propagation. nil means no suspension. no default values.",
+          "$ref": "#/definitions/com.github.karmada-io.karmada.pkg.apis.policy.v1alpha1.Suspension"
         }
       }
     },

charts/karmada/_crds/bases/policy/policy.karmada.io_clusterpropagationpolicies.yaml

@@ -806,6 +806,31 @@ spec:
                   If specified, the policy will be dispatched by specified scheduler.
                   If not specified, the policy will be dispatched by default scheduler.
                 type: string
+              suspension:
+                description: |-
+                  Suspension declares the policy for suspending different aspects of propagation.
+                  nil means no suspension. no default values.
+                properties:
+                  dispatching:
+                    description: |-
+                      Dispatching controls whether dispatching should be suspended.
+                      nil means not suspend, no default value, only accepts 'true'.
+                      Note: true means stop propagating to all clusters. Can not co-exist
+                      with DispatchingOnClusters which is used to suspend particular clusters.
+                    type: boolean
+                  dispatchingOnClusters:
+                    description: |-
+                      DispatchingOnClusters declares a list of clusters to which the dispatching
+                      should be suspended.
+                      Note: Can not co-exist with Dispatching which is used to suspend all.
+                    properties:
+                      clusterNames:
+                        description: ClusterNames is the list of clusters to be selected.
+                        items:
+                          type: string
+                        type: array
+                    type: object
+                type: object
             required:
             - resourceSelectors
             type: object

charts/karmada/_crds/bases/policy/policy.karmada.io_propagationpolicies.yaml

@@ -803,6 +803,31 @@ spec:
                   If specified, the policy will be dispatched by specified scheduler.
                   If not specified, the policy will be dispatched by default scheduler.
                 type: string
+              suspension:
+                description: |-
+                  Suspension declares the policy for suspending different aspects of propagation.
+                  nil means no suspension. no default values.
+                properties:
+                  dispatching:
+                    description: |-
+                      Dispatching controls whether dispatching should be suspended.
+                      nil means not suspend, no default value, only accepts 'true'.
+                      Note: true means stop propagating to all clusters. Can not co-exist
+                      with DispatchingOnClusters which is used to suspend particular clusters.
+                    type: boolean
+                  dispatchingOnClusters:
+                    description: |-
+                      DispatchingOnClusters declares a list of clusters to which the dispatching
+                      should be suspended.
+                      Note: Can not co-exist with Dispatching which is used to suspend all.
+                    properties:
+                      clusterNames:
+                        description: ClusterNames is the list of clusters to be selected.
+                        items:
+                          type: string
+                        type: array
+                    type: object
+                type: object
             required:
             - resourceSelectors
             type: object

charts/karmada/_crds/bases/work/work.karmada.io_clusterresourcebindings.yaml

@@ -1187,6 +1187,31 @@ spec:
                   SchedulerName represents which scheduler to proceed the scheduling.
                   It inherits directly from the associated PropagationPolicy(or ClusterPropagationPolicy).
                 type: string
+              suspension:
+                description: |-
+                  Suspension declares the policy for suspending different aspects of propagation.
+                  nil means no suspension. no default values.
+                properties:
+                  dispatching:
+                    description: |-
+                      Dispatching controls whether dispatching should be suspended.
+                      nil means not suspend, no default value, only accepts 'true'.
+                      Note: true means stop propagating to all clusters. Can not co-exist
+                      with DispatchingOnClusters which is used to suspend particular clusters.
+                    type: boolean
+                  dispatchingOnClusters:
+                    description: |-
+                      DispatchingOnClusters declares a list of clusters to which the dispatching
+                      should be suspended.
+                      Note: Can not co-exist with Dispatching which is used to suspend all.
+                    properties:
+                      clusterNames:
+                        description: ClusterNames is the list of clusters to be selected.
+                        items:
+                          type: string
+                        type: array
+                    type: object
+                type: object
             required:
             - resource
             type: object

charts/karmada/_crds/bases/work/work.karmada.io_resourcebindings.yaml

@@ -1187,6 +1187,31 @@ spec:
                   SchedulerName represents which scheduler to proceed the scheduling.
                   It inherits directly from the associated PropagationPolicy(or ClusterPropagationPolicy).
                 type: string
+              suspension:
+                description: |-
+                  Suspension declares the policy for suspending different aspects of propagation.
+                  nil means no suspension. no default values.
+                properties:
+                  dispatching:
+                    description: |-
+                      Dispatching controls whether dispatching should be suspended.
+                      nil means not suspend, no default value, only accepts 'true'.
+                      Note: true means stop propagating to all clusters. Can not co-exist
+                      with DispatchingOnClusters which is used to suspend particular clusters.
+                    type: boolean
+                  dispatchingOnClusters:
+                    description: |-
+                      DispatchingOnClusters declares a list of clusters to which the dispatching
+                      should be suspended.
+                      Note: Can not co-exist with Dispatching which is used to suspend all.
+                    properties:
+                      clusterNames:
+                        description: ClusterNames is the list of clusters to be selected.
+                        items:
+                          type: string
+                        type: array
+                    type: object
+                type: object
             required:
             - resource
             type: object

charts/karmada/_crds/bases/work/work.karmada.io_works.yaml

@@ -54,6 +54,12 @@ spec:
           spec:
             description: Spec represents the desired behavior of Work.
             properties:
+              suspendDispatching:
+                description: |-
+                  SuspendDispatching controls whether dispatching should
+                  be suspended, nil means not suspend.
+                  Note: true means stop propagating to all clusters.
+                type: boolean
               workload:
                 description: Workload represents the manifest workload to be deployed
                   on managed cluster.

pkg/apis/policy/v1alpha1/propagation_types.go

@@ -176,6 +176,11 @@ type PropagationSpec struct {
 	// +kubebuilder:validation:Enum=Lazy
 	// +optional
 	ActivationPreference ActivationPreference `json:"activationPreference,omitempty"`
+
+	// Suspension declares the policy for suspending different aspects of propagation.
+	// nil means no suspension. no default values.
+	// +optional
+	Suspension *Suspension `json:"suspension,omitempty"`
 }
 
 // ResourceSelector the resources will be selected.
@@ -210,6 +215,31 @@ type FieldSelector struct {
 	MatchExpressions []corev1.NodeSelectorRequirement `json:"matchExpressions,omitempty"`
 }
 
+// Suspension defines the policy for suspending different aspects of propagation.
+type Suspension struct {
+	// Dispatching controls whether dispatching should be suspended.
+	// nil means not suspend, no default value, only accepts 'true'.
+	// Note: true means stop propagating to all clusters. Can not co-exist
+	// with DispatchingOnClusters which is used to suspend particular clusters.
+	// +optional
+	Dispatching *bool `json:"dispatching,omitempty"`
+
+	// DispatchingOnClusters declares a list of clusters to which the dispatching
+	// should be suspended.
+	// Note: Can not co-exist with Dispatching which is used to suspend all.
+	// +optional
+	DispatchingOnClusters *SuspendClusters `json:"dispatchingOnClusters,omitempty"`
+}
+
+// SuspendClusters represents a group of clusters that should be suspended from propagating.
+// Note: No plan to introduce the label selector or field selector to select clusters yet, as it
+// would make the system unpredictable.
+type SuspendClusters struct {
+	// ClusterNames is the list of clusters to be selected.
+	// +optional
+	ClusterNames []string `json:"clusterNames,omitempty"`
+}
+
 // PurgeMode represents that how to deal with the legacy applications on the
 // cluster from which the application is migrated.
 type PurgeMode string

pkg/apis/work/v1alpha1/work_types.go

@@ -57,6 +57,12 @@ type Work struct {
 type WorkSpec struct {
 	// Workload represents the manifest workload to be deployed on managed cluster.
 	Workload WorkloadTemplate `json:"workload,omitempty"`
+
+	// SuspendDispatching controls whether dispatching should
+	// be suspended, nil means not suspend.
+	// Note: true means stop propagating to all clusters.
+	// +optional
+	SuspendDispatching *bool `json:"suspendDispatching,omitempty"`
 }
 
 // WorkloadTemplate represents the manifest workload to be deployed on managed cluster.

pkg/apis/work/v1alpha2/binding_types.go

@@ -146,6 +146,11 @@ type ResourceBindingSpec struct {
 	// It is represented in RFC3339 form (like '2006-01-02T15:04:05Z') and is in UTC.
 	// +optional
 	RescheduleTriggeredAt *metav1.Time `json:"rescheduleTriggeredAt,omitempty"`
+
+	// Suspension declares the policy for suspending different aspects of propagation.
+	// nil means no suspension. no default values.
+	// +optional
+	Suspension *policyv1alpha1.Suspension `json:"suspension,omitempty"`
 }
 
 // ObjectReference contains enough information to locate the referenced object inside current cluster.