feat: Supports upper-layer modification of the InstanceSet's UpdateStrategy (#7978)

Signed-off-by: Liang Deng <[email protected]>

Author: YTGhost

apis/apps/v1alpha1/cluster_types.go

@@ -384,6 +384,25 @@ type UserResourceRefs struct {
 	ConfigMapRefs []ConfigMapRef `json:"configMapRefs,omitempty"`
 }
 
+// InstanceUpdateStrategy indicates the strategy that the InstanceSet
+// controller will use to perform updates.
+type InstanceUpdateStrategy struct {
+	// Partition indicates the number of pods that should be updated during a rolling update.
+	// The remaining pods will remain untouched. This is helpful in defining how many pods
+	// should participate in the update process. The update process will follow the order
+	// of pod names in descending lexicographical (dictionary) order. The default value is
+	// ComponentSpec.Replicas (i.e., update all pods).
+	// +optional
+	Partition *int32 `json:"partition,omitempty"`
+	// The maximum number of pods that can be unavailable during the update.
+	// Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
+	// Absolute number is calculated from percentage by rounding up. This can not be 0.
+	// Defaults to 1. The field applies to all pods. That means if there is any unavailable pod,
+	// it will be counted towards MaxUnavailable.
+	// +optional
+	MaxUnavailable *intstr.IntOrString `json:"maxUnavailable,omitempty"`
+}
+
 // InstanceTemplate allows customization of individual replica configurations in a Component.
 type InstanceTemplate struct {
 	// Name specifies the unique name of the instance Pod created using this InstanceTemplate.
@@ -784,6 +803,13 @@ type ClusterComponentSpec struct {
 	// +optional
 	UpdateStrategy *UpdateStrategy `json:"updateStrategy,omitempty"`
 
+	// Indicates the InstanceUpdateStrategy that will be
+	// employed to update Pods in the InstanceSet when a revision is made to
+	// Template.
+	//
+	// +optional
+	InstanceUpdateStrategy *InstanceUpdateStrategy `json:"instanceUpdateStrategy,omitempty"`
+
 	// Controls the concurrency of pods during initial scale up, when replacing pods on nodes,
 	// or when scaling down. It only used when `PodManagementPolicy` is set to `Parallel`.
 	// The default Concurrency is 100%.

apis/apps/v1alpha1/component_types.go

@@ -173,6 +173,13 @@ type ComponentSpec struct {
 	// +optional
 	ServiceAccountName string `json:"serviceAccountName,omitempty"`
 
+	// Indicates the InstanceUpdateStrategy that will be
+	// employed to update Pods in the InstanceSet when a revision is made to
+	// Template.
+	//
+	// +optional
+	InstanceUpdateStrategy *InstanceUpdateStrategy `json:"instanceUpdateStrategy,omitempty"`
+
 	// Controls the concurrency of pods during initial scale up, when replacing pods on nodes,
 	// or when scaling down. It only used when `PodManagementPolicy` is set to `Parallel`.
 	// The default Concurrency is 100%.

apis/apps/v1alpha1/zz_generated.deepcopy.go

@@ -75,6 +75,35 @@ type SchedulingPolicy struct {
 	TopologySpreadConstraints []corev1.TopologySpreadConstraint `json:"topologySpreadConstraints,omitempty"`
 }
 
+// InstanceUpdateStrategy indicates the strategy that the InstanceSet
+// controller will use to perform updates. It includes any additional parameters
+// necessary to perform the update for the indicated strategy.
+type InstanceUpdateStrategy struct {
+	// Partition indicates the number of pods that should be updated during a rolling update.
+	// The remaining pods will remain untouched. This is helpful in defining how many pods
+	// should participate in the update process. The update process will follow the order
+	// of pod names in descending lexicographical (dictionary) order. The default value is
+	// Replicas (i.e., update all pods).
+	// +optional
+	Partition *int32 `json:"partition,omitempty"`
+	// The maximum number of pods that can be unavailable during the update.
+	// Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
+	// Absolute number is calculated from percentage by rounding up. This can not be 0.
+	// Defaults to 1. The field applies to all pods. That means if there is any unavailable pod,
+	// it will be counted towards MaxUnavailable.
+	// +optional
+	MaxUnavailable *intstr.IntOrString `json:"maxUnavailable,omitempty"`
+	// Members(Pods) update strategy.
+	//
+	// - serial: update Members one by one that guarantee minimum component unavailable time.
+	// - bestEffortParallel: update Members in parallel that guarantee minimum component un-writable time.
+	// - parallel: force parallel
+	//
+	// +kubebuilder:validation:Enum={Serial,BestEffortParallel,Parallel}
+	// +optional
+	MemberUpdateStrategy *MemberUpdateStrategy `json:"memberUpdateStrategy,omitempty"`
+}
+
 // Range represents a range with a start and an end value.
 // It is used to define a continuous segment.
 type Range struct {
@@ -326,10 +355,9 @@ type InstanceSetSpec struct {
 	// Indicates the StatefulSetUpdateStrategy that will be
 	// employed to update Pods in the InstanceSet when a revision is made to
 	// Template.
-	// UpdateStrategy.Type will be set to appsv1.OnDeleteStatefulSetStrategyType if MemberUpdateStrategy is not nil
 	//
 	// Note: This field will be removed in future version.
-	UpdateStrategy appsv1.StatefulSetUpdateStrategy `json:"updateStrategy,omitempty"`
+	UpdateStrategy *InstanceUpdateStrategy `json:"updateStrategy,omitempty"`
 
 	// A list of roles defined in the system.
 	//
@@ -348,11 +376,13 @@ type InstanceSetSpec struct {
 
 	// Members(Pods) update strategy.
 	//
+	// Deprecated since v0.9.0
 	// - serial: update Members one by one that guarantee minimum component unavailable time.
 	// - bestEffortParallel: update Members in parallel that guarantee minimum component un-writable time.
 	// - parallel: force parallel
 	//
 	// +kubebuilder:validation:Enum={Serial,BestEffortParallel,Parallel}
+	// +kubebuilder:deprecatedversion:warning="This field has been deprecated since 0.9.0"
 	// +optional
 	MemberUpdateStrategy *MemberUpdateStrategy `json:"memberUpdateStrategy,omitempty"`
 

apis/workloads/v1alpha1/instanceset_types.go

@@ -594,6 +594,33 @@ spec:
                         - name
                         type: object
                       type: array
+                    instanceUpdateStrategy:
+                      description: |-
+                        Indicates the InstanceUpdateStrategy that will be
+                        employed to update Pods in the InstanceSet when a revision is made to
+                        Template.
+                      properties:
+                        maxUnavailable:
+                          anyOf:
+                          - type: integer
+                          - type: string
+                          description: |-
+                            The maximum number of pods that can be unavailable during the update.
+                            Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
+                            Absolute number is calculated from percentage by rounding up. This can not be 0.
+                            Defaults to 1. The field applies to all pods. That means if there is any unavailable pod,
+                            it will be counted towards MaxUnavailable.
+                          x-kubernetes-int-or-string: true
+                        partition:
+                          description: |-
+                            Partition indicates the number of pods that should be updated during a rolling update.
+                            The remaining pods will remain untouched. This is helpful in defining how many pods
+                            should participate in the update process. The update process will follow the order
+                            of pod names in descending lexicographical (dictionary) order. The default value is
+                            ComponentSpec.Replicas (i.e., update all pods).
+                          format: int32
+                          type: integer
+                      type: object
                     instances:
                       description: |-
                         Allows for the customization of configuration values for each instance within a Component.
@@ -7110,6 +7137,33 @@ spec:
                             - name
                             type: object
                           type: array
+                        instanceUpdateStrategy:
+                          description: |-
+                            Indicates the InstanceUpdateStrategy that will be
+                            employed to update Pods in the InstanceSet when a revision is made to
+                            Template.
+                          properties:
+                            maxUnavailable:
+                              anyOf:
+                              - type: integer
+                              - type: string
+                              description: |-
+                                The maximum number of pods that can be unavailable during the update.
+                                Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
+                                Absolute number is calculated from percentage by rounding up. This can not be 0.
+                                Defaults to 1. The field applies to all pods. That means if there is any unavailable pod,
+                                it will be counted towards MaxUnavailable.
+                              x-kubernetes-int-or-string: true
+                            partition:
+                              description: |-
+                                Partition indicates the number of pods that should be updated during a rolling update.
+                                The remaining pods will remain untouched. This is helpful in defining how many pods
+                                should participate in the update process. The update process will follow the order
+                                of pod names in descending lexicographical (dictionary) order. The default value is
+                                ComponentSpec.Replicas (i.e., update all pods).
+                              format: int32
+                              type: integer
+                          type: object
                         instances:
                           description: |-
                             Allows for the customization of configuration values for each instance within a Component.

apis/workloads/v1alpha1/zz_generated.deepcopy.go

@@ -524,6 +524,33 @@ spec:
                   - name
                   type: object
                 type: array
+              instanceUpdateStrategy:
+                description: |-
+                  Indicates the InstanceUpdateStrategy that will be
+                  employed to update Pods in the InstanceSet when a revision is made to
+                  Template.
+                properties:
+                  maxUnavailable:
+                    anyOf:
+                    - type: integer
+                    - type: string
+                    description: |-
+                      The maximum number of pods that can be unavailable during the update.
+                      Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
+                      Absolute number is calculated from percentage by rounding up. This can not be 0.
+                      Defaults to 1. The field applies to all pods. That means if there is any unavailable pod,
+                      it will be counted towards MaxUnavailable.
+                    x-kubernetes-int-or-string: true
+                  partition:
+                    description: |-
+                      Partition indicates the number of pods that should be updated during a rolling update.
+                      The remaining pods will remain untouched. This is helpful in defining how many pods
+                      should participate in the update process. The update process will follow the order
+                      of pod names in descending lexicographical (dictionary) order. The default value is
+                      ComponentSpec.Replicas (i.e., update all pods).
+                    format: int32
+                    type: integer
+                type: object
               instances:
                 description: |-
                   Allows for the customization of configuration values for each instance within a Component.