-
Notifications
You must be signed in to change notification settings - Fork 773
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add proposal for support progressDeadlineSeconds in CloneSet
Signed-off-by: hantmac <[email protected]> more docs Signed-off-by: hantmac <[email protected]> fix mdl ci Signed-off-by: hantmac <[email protected]> complete the proposal Signed-off-by: hantmac <[email protected]> fix Signed-off-by: hantmac <[email protected]> update Signed-off-by: hantmac <[email protected]> fix typo Signed-off-by: hantmac <[email protected]> Bump crate-ci/typos from 1.22.9 to 1.23.1 (#1658) Bumps [crate-ci/typos](https://github.com/crate-ci/typos) from 1.22.9 to 1.23.1. - [Release notes](https://github.com/crate-ci/typos/releases) - [Changelog](https://github.com/crate-ci/typos/blob/master/CHANGELOG.md) - [Commits](crate-ci/typos@v1.22.9...v1.23.1) --- updated-dependencies: - dependency-name: crate-ci/typos dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Bump actions/upload-artifact from 4.3.3 to 4.3.4 (#1659) Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.3.3 to 4.3.4. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](actions/upload-artifact@6546280...0b2256b) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> changed the scorecard badge link to the standard format and updated the domain (#1657) Signed-off-by: harshitasao <[email protected]>
- Loading branch information
Showing
5 changed files
with
167 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
161 changes: 161 additions & 0 deletions
161
docs/proposals/20240309-cloneset-support-progressDeadlineSeconds.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| --- | ||
| title: CloneSet | ||
| authors: | ||
| - "@hantmac" | ||
| reviewers: | ||
| - "@Fei-Guo" | ||
| - "@furykerry" | ||
| - "@FillZpp" | ||
| creation-date: 2024-03-10 | ||
| last-updated: 2024-03-10 | ||
| status: implementable | ||
| --- | ||
|
|
||
| # Support progressDeadlineSeconds in CloneSet | ||
| Table of Contents | ||
| ================= | ||
|
|
||
| - [Support progressDeadlineSeconds in CloneSet](#Support progressDeadlineSeconds in CloneSet) | ||
| - [Table of Contents](#table-of-contents) | ||
| - [Motivation](#motivation) | ||
| - [Proposal](#proposal) | ||
| - [1. add .spec.progressDeadlineSeconds field](#1add-.spec.progressDeadlineSeconds-field) | ||
| - [2. The behavior of progressDeadlineSeconds](#2the-behavior-of-progressDeadlineSeconds) | ||
| - [3. handle the logic](#2handle-the-logic) | ||
|
|
||
| ## Motivation | ||
|
|
||
| `.spec.progressDeadlineSeconds` is an optional field in Deployment that specifies the number of seconds one wants to wait for their Deployment to progress before the system reports back that the Deployment has failed progressing. | ||
| Once the deadline has been exceeded, the Deployment controller adds a DeploymentCondition with the following attributes to the Deployment's `.status.conditions`: | ||
| ``` | ||
| type: Progressing | ||
| status: "False" | ||
| reason: ProgressDeadlineExceeded | ||
| ``` | ||
|
|
||
| This is useful for users to control the progress of the deployment. | ||
| So we should add support for `progressDeadlineSeconds` in CloneSet as well. | ||
|
|
||
| ## Proposal | ||
| Firstly, add the `progressDeadlineSeconds` field to the CloneSetSpec. | ||
| Then add the handle logic in cloneSet controller to handle the `progressDeadlineSeconds` field. | ||
|
|
||
| ### 1. add .spec.progressDeadlineSeconds field | ||
| The default value of `progressDeadlineSeconds` is 600 seconds according to the [official document](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#progress-deadline-seconds). | ||
| ```yaml | ||
| apiVersion: apps.kruise.io/v1alpha1 | ||
| kind: CloneSet | ||
| metadata: | ||
| name: cloneset-example | ||
| spec: | ||
| replicas: 3 | ||
| progressDeadlineSeconds: 600 | ||
| selector: | ||
| matchLabels: | ||
| app: nginx | ||
| template: | ||
| metadata: | ||
| labels: | ||
| app: nginx | ||
| spec: | ||
| containers: | ||
| - name: nginx | ||
| image: nginx:1.14.2 | ||
| ``` | ||
| ### 2. The behavior of progressDeadlineSeconds | ||
| However, the behavior of `progressDeadlineSeconds` in CloneSet might differ from its behavior in Deployment due to the support of partition in CloneSet. If a CloneSet is paused due to partition, it's debatable whether the paused time should be included in the progress deadline. | ||
| Here are two possible interpretations of `progressDeadlineSeconds` in the context of CloneSet: | ||
| 1. `progressDeadlineSeconds` could be redefined as the time taken for the CloneSet to reach completion or the "paused" state due to partition. In this case, the time during which the CloneSet is paused would NOT be included in the progress deadline. | ||
| 2. Secondly, `progressDeadlineSeconds` could only be supported if the partition is not set. This means that if a partition is set, the `progressDeadlineSeconds` field would not be applicable or has no effect. | ||
|
|
||
| After the discussion of the community, we choose the first interpretation.So we should re-set the progressDeadlineSeconds when the CloneSet reach completion OR "the paused state". | ||
|
|
||
| ### 3. handle the logic | ||
| In cloneset controller, we should add the logic to handle the `progressDeadlineSeconds` field. We firstly add a timer to check the progress of the CloneSet. | ||
| If the progress exceeds the `progressDeadlineSeconds`, we should add a CloneSetCondition to the CloneSet's `.status.conditions`: | ||
| ```go | ||
| // add a timer to check the progress of the CloneSet | ||
| if cloneSet.Spec.ProgressDeadlineSeconds != nil { | ||
| // handle the logic | ||
| starttime := time.Now() | ||
| ... | ||
| if time.Now().After(starttime.Add(time.Duration(*cloneSet.Spec.ProgressDeadlineSeconds) * time.Second)) { | ||
| newStatus.Conditions = append(newStatus.Conditions, appsv1alpha1.CloneSetCondition{ | ||
| Type: appsv1alpha1.CloneSetProgressing, | ||
| Status: corev1.ConditionFalse, | ||
| Reason: appsv1alpha1.CloneSetProgressDeadlineExceeded, | ||
| }) | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| When the CloneSet reaches the "paused" state, we should reset the timer to avoid the progress deadline being exceeded. | ||
| And we check the progress of the CloneSet in the `syncCloneSetStatus` function. If the progress exceeds the `progressDeadlineSeconds`, we should add a CloneSetCondition to the CloneSet's `.status.conditions`: | ||
|
|
||
| ```go | ||
| const ( | ||
| CloneSetProgressDeadlineExceeded CloneSetConditionReason = "ProgressDeadlineExceeded" | ||
| CloneSetConditionTypeProgressing CloneSetConditionType = "Progressing" | ||
| ) | ||
| ``` | ||
|
|
||
| ```go | ||
| func (c *CloneSetController) syncCloneSetStatus(cloneSet *appsv1alpha1.CloneSet, newStatus *appsv1alpha1.CloneSetStatus) error { | ||
| ... | ||
| if cloneSet.Spec.ProgressDeadlineSeconds != nil { | ||
| // handle the logic | ||
| if time.Now().After(starttime.Add(time.Duration(*cloneSet.Spec.ProgressDeadlineSeconds) * time.Second)) { | ||
| newStatus.Conditions = append(newStatus.Conditions, appsv1alpha1.CloneSetCondition{ | ||
| Type: appsv1alpha1.CloneSetProgressing, | ||
| Status: corev1.ConditionFalse, | ||
| Reason: appsv1alpha1.CloneSetProgressDeadlineExceeded, | ||
| }) | ||
| } | ||
| } | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| When the CloneSet reaches the "paused" state, we should reset the timer to avoid the progress deadline being exceeded. | ||
| ```go | ||
| func (c *CloneSetController) syncCloneSetStatus(cloneSet *appsv1alpha1.CloneSet, newStatus *appsv1alpha1.CloneSetStatus) error { | ||
| ... | ||
| // reset the starttime when the CloneSet reaches the "paused" state or complete state | ||
| if cloneSet.Status.UpdatedReadyReplicas == cloneSet.Status.Replicas || replicas - updatedReplicas = partition { | ||
| starttime = time.Now() | ||
| } | ||
| if cloneSet.Spec.Paused { | ||
| starttime = time.Now() | ||
| } | ||
| ... | ||
| } | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| And we can save the starttime in the `LastUpdateTime` in the CloneSet's `.status.conditions`: | ||
| ``` | ||
| status: | ||
| conditions: | ||
| - lastTransitionTime: "2021-11-26T20:52:12Z" | ||
| lastUpdateTime: "2021-11-26T20:52:12Z" | ||
| message: CloneSet has minimum availability. | ||
| reason: MinimumReplicasAvailable | ||
| status: "True" | ||
| type: Available | ||
| - lastTransitionTime: "2021-11-26T20:52:12Z" | ||
| lastUpdateTime: "2021-11-26T20:52:12Z" | ||
| message: 'progress deadline exceeded' | ||
| reason: ProgressDeadlineExceeded | ||
| status: "False" | ||
| type: Progressing | ||
| ``` | ||
|
|
||
| ## Implementation History | ||
|
|
||
| - [ ] 06/07/2024: Proposal submission | ||
|
|
||
|
|