update api for future bluegreen #214

myname4423 · 2024-05-24T03:54:27Z

Ⅰ. Describe what this PR does

this PR does the following update/modification:

add the bluegreen Strategy and bluegreen status to rollout v1beta1 api
add some helper functions to Get and Set value of strategy and status for strategy-agnostic access
change the BatchRelease.spec.releasePlan.ExtraWorkload field to Rollingstyle to support bluegreen style
add NextStepIndex and FinalisingStep fields to canary status and bluegreen status for later use, with related function added and unit test updated

Ⅱ. Does this pull request fix one issue?

NONE

Ⅲ. Special notes for reviews

codecov · 2024-05-24T08:50:15Z

Codecov Report

Attention: Patch coverage is 35.13514% with 48 lines in your changes missing coverage. Please review.

Project coverage is 43.41%. Comparing base (07c1731) to head (c1676b6).
Report is 2 commits behind head on master.

❗ Current head c1676b6 differs from pull request most recent head 9c50efa

Please upload reports for the commit 9c50efa to get more accurate results.

Files	Patch %	Lines
pkg/controller/rollout/rollout_status.go	0.00%	24 Missing ⚠️
pkg/controller/rollout/rollout_progressing.go	48.00%	11 Missing and 2 partials ⚠️
pkg/util/rollout_utils.go	0.00%	6 Missing ⚠️
...g/controller/batchrelease/batchrelease_executor.go	61.53%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #214      +/-   ##
==========================================
- Coverage   43.63%   43.41%   -0.22%     
==========================================
  Files          52       52              
  Lines        5681     5721      +40     
==========================================
+ Hits         2479     2484       +5     
- Misses       2778     2813      +35     
  Partials      424      424

Flag	Coverage Δ
unittests	`43.41% <35.13%> (-0.22%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

furykerry · 2024-05-27T11:01:13Z

api/v1beta1/rollout_types.go

+	CanaryReplicas int32 `json:"updatedReplicas"`
+	// CanaryReadyReplicas the numbers of ready canary revision pods
+	CanaryReadyReplicas int32 `json:"updatedReadyReplicas"`
+	// FinalisingStep the step of finalising


plz also change the internal field name

api/v1beta1/rollout_types.go

furykerry · 2024-05-27T11:05:42Z

api/v1beta1/rollout_types.go

@@ -231,10 +328,22 @@ const (
 	// Terminating Reason
 	TerminatingReasonInTerminating = "InTerminating"
 	TerminatingReasonCompleted     = "Completed"
+
+	// Finalise Reason
+	FinaliseReasonSuccess    = "Success"


plz comment each FinalizeReason

furykerry · 2024-05-27T11:27:40Z

api/v1beta1/rollout_types.go

+type FinalisingStepType string
+
+const (
+	FinalisingStepTypePreparing     FinalisingStepType = "Preparing"


plz comment about each step and the common workflow that involves multiple steps

done, and workflow related comment will be referenced in the upcoming pull request (PR) and included in
a documentation as well.

furykerry · 2024-05-27T11:30:08Z

pkg/util/rollout_utils.go

+	}
+	allSteps := int32(len(rollout.Spec.Strategy.GetSteps()))
+	if CurrentStepIndex >= allSteps {
+		return 0


plz comment about the wrapping logic, why the next index of last step is 0

can we set the NextStepIndex of last step to -1, so as to avoid confusion

furykerry · 2024-05-27T11:32:02Z

api/v1alpha1/conversion.go

-		}
+		dst.Annotations[RolloutStyleAnnotation] = strings.ToLower(string(srcV1beta1.Spec.ReleasePlan.RollingStyle))
+		dst.Spec.ReleasePlan.RollingStyle = RollingStyleType(srcV1beta1.Spec.ReleasePlan.RollingStyle)
+		// if srcV1beta1.Spec.ReleasePlan.EnableExtraWorkloadForCanary {


remove unused code

api/v1alpha1/rollout_types.go

furykerry · 2024-06-07T05:47:32Z

api/v1beta1/deployment_types.go

+// It is only used for BlueGreen Release
+// Similar to DeploymentStrategy, it is stored in workload annotation
+// However, unlike DeploymentStrategy, it is only used to storage and restore
+type OriginalSetting struct {


OriginalSetting -> DeploymentStrategy?

furykerry · 2024-06-07T05:48:00Z

api/v1beta1/deployment_types.go

+
+	// OriginalSettingAnnotation is annotation for workload in BlueGreen Release,
+	// it will storage the original setting of the workload, which will be used to restore the workload
+	OriginalSettingAnnotation = "rollouts.kruise.io/original-setting"


rollouts.kruise.io/original-setting -> rollouts.kruise.io/original-deployment-strategy

furykerry · 2024-06-07T05:48:35Z

api/v1beta1/deployment_types.go

@@ -52,13 +62,42 @@ type DeploymentStrategy struct {
 	Partition intstr.IntOrString `json:"partition,omitempty"`
 }

+// OriginalSetting storages part of the fileds of a workload,


// DeploymentStrategy stores deployment strategy related fields of a workload

furykerry · 2024-06-07T05:49:10Z

api/v1beta1/deployment_types.go

@@ -37,6 +37,16 @@ const (
 	// AdvancedDeploymentControlLabel is label for deployment,
 	// which labels whether the deployment is controlled by advanced-deployment-controller.
 	AdvancedDeploymentControlLabel = "rollouts.kruise.io/controlled-by-advanced-deployment-controller"
+
+	// OriginalSettingAnnotation is annotation for workload in BlueGreen Release,
+	// it will storage the original setting of the workload, which will be used to restore the workload


plz replace all storage vb with store

furykerry · 2024-06-07T05:53:20Z

api/v1beta1/rollout_types.go

+// Get the rolling style based on the strategy
+func (r *RolloutStrategy) GetRollingStyle() RollingStyleType {
+	if r.BlueGreen == nil && r.Canary == nil {
+		return EmptyRollingStyle


we should include a webhook to ensure that either bluegreen or canary field is set

furykerry · 2024-06-07T05:55:37Z

pkg/util/rollout_utils.go

+	}
+	allSteps := int32(len(rollout.Spec.Strategy.GetSteps()))
+	if CurrentStepIndex >= allSteps {
+		return 0


can we set the NextStepIndex of last step to -1, so as to avoid confusion

api/v1alpha1/rollout_types.go

api/v1beta1/batchrelease_plan_types.go

furykerry · 2024-06-11T05:48:25Z

api/v1beta1/rollout_types.go

@@ -243,27 +348,123 @@ type CanaryStatus struct {
 	RolloutHash string `json:"rolloutHash,omitempty"`
 	// StableRevision indicates the revision of stable pods
 	StableRevision string `json:"stableRevision,omitempty"`
+	// pod template hash is used as service selector label
+	PodTemplateHash string `json:"podTemplateHash"`
+	// CurrentStepIndex defines the current step of the rollout is on. If the current step index is null, the


current step index is int, it cannot be null, maybe you mean is zero here ?

api/v1beta1/rollout_types.go

pkg/util/rollout_utils.go

furykerry · 2024-06-11T05:59:28Z

pkg/webhook/rollout/validating/rollout_create_update_handler.go

+				return field.ErrorList{field.Invalid(fldPath.Index(i).Child("steps"), steps, `traffic must be percentage with "0%" <= traffic <= "100%" in blueGreen strategy`)}
+			}
+		default:
+			// traffic "0%" is not allowed in canary strategy


is it possible to allow set 0% for canary strategy?

we didn't allow set 0% from the beginning. i indeed tried to allow this for canary strategy, however, we need consider much more scenarios about traffic, which make the code complex and hard to maintain

furykerry · 2024-06-11T09:49:18Z

pkg/controller/rollout/rollout_canary_test.go

 				return br
 			},
 		},
 	}

-	for _, cs := range cases {
+	for i, cs := range cases {


why only select one case ?

my miss, updated

furykerry · 2024-06-11T09:54:36Z

api/v1alpha1/batchrelease_plan_types.go

+	// RollingStyle can be "Canary", "Partiton" or "BlueGreen"
+	RollingStyle RollingStyleType `json:"rollingStyle,omitempty"`
+	// When user verifies that the canary version is ready, we will remove the canary deployment and release the deployment workload-demo in full.
+	// Current only support k8s native deployment


plz comment the relationship with rollingStyle and enableExtraWorkloadForCanary

furykerry · 2024-06-11T12:35:13Z

plz squash commits into one

Signed-off-by: yunbo <[email protected]> add status conversion Signed-off-by: yunbo <[email protected]> nextStepIndex default value from 0 to -1 Signed-off-by: yunbo <[email protected]> restore the enableExtra field in BR Signed-off-by: yunbo <[email protected]>

zmberg · 2024-06-12T05:26:23Z

/lgtm

zmberg · 2024-06-12T05:26:33Z

/approve

kruise-bot · 2024-06-12T05:26:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zmberg

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [zmberg]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

kruise-bot requested review from furykerry and zmberg May 24, 2024 03:54

kruise-bot added the size/XXL label May 24, 2024

myname4423 force-pushed the bluegreen branch 2 times, most recently from 0a5cc67 to c1676b6 Compare May 24, 2024 08:47

myname4423 force-pushed the bluegreen branch from c1676b6 to b19ec81 Compare May 27, 2024 09:20

furykerry reviewed May 27, 2024

View reviewed changes

myname4423 force-pushed the bluegreen branch 2 times, most recently from fc3e5e1 to 36d5d43 Compare May 27, 2024 13:40

myname4423 mentioned this pull request May 28, 2024

Allow jumping between canary steps #216

Closed

myname4423 force-pushed the bluegreen branch 2 times, most recently from 2d045c9 to ba359f3 Compare May 29, 2024 09:47

furykerry reviewed Jun 7, 2024

View reviewed changes

myname4423 force-pushed the bluegreen branch from b18dbe5 to 3b03486 Compare June 7, 2024 07:39

furykerry reviewed Jun 11, 2024

View reviewed changes

myname4423 force-pushed the bluegreen branch 3 times, most recently from 7de1c40 to f3b29f3 Compare June 11, 2024 09:07

furykerry reviewed Jun 11, 2024

View reviewed changes

myname4423 force-pushed the bluegreen branch from f3b29f3 to 6894467 Compare June 11, 2024 11:15

myname4423 force-pushed the bluegreen branch from 6894467 to 9c50efa Compare June 12, 2024 02:15

kruise-bot assigned zmberg Jun 12, 2024

kruise-bot added the lgtm label Jun 12, 2024

kruise-bot added the approved label Jun 12, 2024

kruise-bot merged commit 1e8af4a into openkruise:master Jun 12, 2024
19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update api for future bluegreen #214

update api for future bluegreen #214

myname4423 commented May 24, 2024 •

edited

Loading

codecov bot commented May 24, 2024 •

edited

Loading

furykerry May 27, 2024

myname4423 May 27, 2024

furykerry May 27, 2024

myname4423 May 27, 2024

furykerry May 27, 2024

myname4423 May 27, 2024

furykerry May 27, 2024

myname4423 May 27, 2024

furykerry Jun 7, 2024

furykerry May 27, 2024

myname4423 May 27, 2024

furykerry Jun 7, 2024

myname4423 Jun 7, 2024

furykerry Jun 7, 2024

myname4423 Jun 7, 2024

furykerry Jun 7, 2024

myname4423 Jun 7, 2024 •

edited

Loading

furykerry Jun 7, 2024

myname4423 Jun 7, 2024

furykerry Jun 7, 2024

myname4423 Jun 7, 2024 •

edited

Loading

furykerry Jun 7, 2024

furykerry Jun 11, 2024

furykerry Jun 11, 2024

myname4423 Jun 11, 2024

furykerry Jun 11, 2024

myname4423 Jun 11, 2024

furykerry Jun 11, 2024

myname4423 Jun 11, 2024

furykerry commented Jun 11, 2024

zmberg commented Jun 12, 2024

zmberg commented Jun 12, 2024

kruise-bot commented Jun 12, 2024

update api for future bluegreen #214

update api for future bluegreen #214

Conversation

myname4423 commented May 24, 2024 • edited Loading

Ⅰ. Describe what this PR does

Ⅱ. Does this pull request fix one issue?

Ⅲ. Special notes for reviews

codecov bot commented May 24, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

myname4423 Jun 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

myname4423 Jun 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

furykerry commented Jun 11, 2024

zmberg commented Jun 12, 2024

zmberg commented Jun 12, 2024

kruise-bot commented Jun 12, 2024

myname4423 commented May 24, 2024 •

edited

Loading

codecov bot commented May 24, 2024 •

edited

Loading

myname4423 Jun 7, 2024 •

edited

Loading

myname4423 Jun 7, 2024 •

edited

Loading