Add common RolloutStrategy API #244

serngawy · 2023-06-20T18:33:05Z

No description provided.

serngawy · 2023-06-20T18:36:46Z

haoqing0110 · 2023-06-28T06:46:34Z

cluster/v1alpha1/types_rolloutstrategy.go

+}
+
+// MandatoryDecisionGroup set the decision group name or group index.
+type MandatoryDecisionGroup struct {


How to handle the case when both GroupName and GroupIndex are defined in each MandatoryDecisionGroup? Can intorstring make it easier?

When user set GroupName group selection should be based on GroupName even if user set GroupIndex.

Sounds good, is that possible to add this explanation in the API comments?

sure, done.

qiujian16 · 2023-06-28T06:44:51Z

cluster/v1alpha1/types_rolloutstrategy.go

+	// 2) Progressive means apply the workload to the selected clusters progressively per cluster. The workload will not be applied to the next cluster unless one of the current applied clusters reach the successful state or timeout.
+	// 3) ProgressivePerGroup means apply the workload to decisionGroup clusters progressively per group. The workload will not be applied to the next decisionGroup unless all clusters in the current group reach the successful state or timeout.
+	// +kubebuilder:default:=All
+	// +optional


this is need to an enum validation

Still need some const string like after adding enum validation.

const ( //All means apply the workload to all clusters in the decision groups at once. All string = "All" //Progressive means apply the workload to the selected clusters progressively per cluster. Progressive string = "Progressive" //ProgressivePerGroup means apply the workload to the selected clusters progressively per group. ProgressivePerGroup string = "ProgressivePerGroup" )

ops, removed by mistake. done

qiujian16 · 2023-06-28T06:49:30Z

cluster/v1alpha1/types_rolloutstrategy.go

+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +k8s:deepcopy-gen=true
+
+// RolloutStrategy API used by consumer workload applier APIs such as ManifestWorkReplicaSet, Policy, ManagedClusterAddon ...etc


we should only indicate that this is for rolling out workload or configuration across clusters. We do not need to mention ManifestWorkReplicaSet, Policy, ManagedClusterAddon. Otherwise, the doc will be added into each crd definition.

qiujian16 · 2023-06-28T06:50:52Z

cluster/v1alpha1/types_rolloutstrategy.go

+}
+
+// MandatoryDecisionGroup set the decision group name or group index.
+type MandatoryDecisionGroup struct {


can we allow setting GroupName and GroupIndex at the same time?

no, We should consider GroupName first then GroupIndex.

haoqing0110 · 2023-07-13T08:33:18Z

cluster/v1alpha1/types_rolloutstrategy.go

+	// MaxConcurrency is the max number of clusters to deploy workload concurrently. The default value for MaxConcurrency is determined from the clustersPerDecisionGroup defined in the placement->DecisionStrategy.
+	// +kubebuilder:validation:Pattern="^((100|[0-9]{1,2})%|[0-9]+)$"
+	// +optional
+	MaxConcurrency string `json:"maxConcurrency,omitempty"`


Have the below question for maxconcurrency, might need a clearer explanation.

Does the maxconcurrency also work on MandatoryDecisionGroup？

If a placement strategy is defined as below:

DecisionStrategy: numberOfClustersPerDecisionGroup: 150 DecisionGroups: - label: prod-canary-west clusterSelector: matchExpressions: - key: prod-canary-west operator: Exist …. status: numberOfSelectedClusters: 300 decisionGroups: - decisionGroupIndex: 0 decisionGroupLabel: prod-canary-west placementDecisions: - ztp-placement-decision-0 // cluster1 to cluster 100 - ztp-placement-decision-1 // cluster101 to cluster120 clusterCount: 120 - decisionGroupIndex: 1 placementDecisions: - ztp-placement-decision-2 // cluster121 to cluster 220 - ztp-placement-decision-3 // cluster221 to cluster 270 clusterCount: 150 // - decisionGroupIndex: 2 placementDecisions: - ztp-placement-decision-4 // cluster271 to cluster 300 clusterCount: 30

When type is rolloutProgressive and not define any mandatoryDecisionGroups, what’s the expected upgrade behavior, will decision groups be ignored and upgrade cluster1 to cluster 150 first actually?

Yes, based on the example above if the MandatoryDecisionGroup and Maxconcurrency not defined the rolloutProgressive should follow numberOfClustersPerDecisionGroup. Maxconcurrency to give the option override the numberOfClustersPerDecisionGroup.

Should this filed also be the type intorstring to be consistent with clustersPerDecisionGroup?

okay, done.

haoqing0110 · 2023-07-18T08:26:18Z

cluster/v1alpha1/types_rolloutstrategy.go

+
+// Timeout to consider while applying the workload.
+type Timeout struct {
+	// Timeout define how long workload applier controller will wait till workload reach successful state in the cluster. Only considered for Rollout Type Progressive and ProgressivePerGroup.


This comment is inconsistent with the above type RolloutAll which has timeout field.

// RolloutAll is a RolloutStrategy Type type RolloutAll struct { // +optional Timeout Timeout `json:",inline"` }

ops, removed.

haoqing0110 · 2023-07-18T09:41:56Z

LGTM

qiujian16 · 2023-07-18T13:47:26Z

cluster/v1alpha1/types_rolloutstrategy.go

+	"k8s.io/apimachinery/pkg/util/intstr"
+)
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object


this is not a runtime object so line 7 is not needed. see here https://pkg.go.dev/k8s.io/gengo/examples/deepcopy-gen

qiujian16 · 2023-07-18T13:51:12Z

/approve
/lgtm
/hold

@haoqing0110 are we fine if there is no DeepCopy?

openshift-ci · 2023-07-18T13:51:20Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiujian16, serngawy

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~~ [qiujian16]

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

haoqing0110 · 2023-07-18T14:17:37Z

DeepCopy() for the common rollout strategy is needed I think, since we treat it as a duck type and will add library or helper function only for this part.
cc @serngawy, running make update should generate that.

serngawy · 2023-07-18T16:19:03Z

DeepCopy() for the common rollout strategy is needed I think, since we treat it as a duck type and will add library or helper function only for this part. cc @serngawy, running make update should generate that.

$make update didn't generate deepcopy. However, as the rolloutStrategy will be part of others applier APIs spec the deepcopy will be generated with the applier API.

Signed-off-by: melserngawy <melserng@redhat.com>

qiujian16 · 2023-07-19T14:25:18Z

/lgtm
/unhold

dhaiducek · 2023-08-30T20:32:24Z

cluster/v1alpha1/types_rolloutstrategy.go

+	// All define required fields for RolloutStrategy type All
+	// +optional
+	All *RolloutAll `json:"all,omitempty"`
+
+	// Progressive define required fields for RolloutStrategy type Progressive
+	// +optional
+	Progressive *RolloutProgressive `json:"progressive,omitempty"`
+
+	// ProgressivePerGroup define required fields for RolloutStrategy type ProgressivePerGroup
+	// +optional
+	ProgressivePerGroup *RolloutProgressivePerGroup `json:"progressivePerGroup,omitempty"`


Is there a reason behind having these as separate keys? Could it not be streamlined as providing the Type and inlining all of the options? If that's an option, I can work on a PR. At minimum, I think it might be nice to have Timeout at the same level as Type?

type RolloutStrategy struct { // +kubebuilder:validation:Enum=All;Progressive;ProgressivePerGroup // +kubebuilder:default:=All // +optional Type string `json:"type,omitempty"` // +optional Timeout `json:",inline"` // +optional MandatoryDecisionGroups `json:",inline"` // +kubebuilder:validation:Pattern="^((100|[0-9]{1,2})%|[0-9]+)$" // +kubebuilder:validation:XIntOrString // +optional MaxConcurrency intstr.IntOrString `json:"maxConcurrency,omitempty"` }

this is designed as an union type, a certain type is point to the a certain field. see here https://github.com/kubernetes/enhancements/blob/master/keps/sig-api-machinery/1027-api-unions/README.md. This could avoid unexpected wrong configurations. For instance, you would not want user set Type to Progressive and still set the MandatoryDecisionGroups.

It has been done with union type to avoid miss leading the endUser as for ex; when the Type is ALL there is no need to define the MandatoryDecisionGroups and MaxConcurrency. As well as when the Type is ProgressivePerGroup no need to define MaxConcurrency.
So make sense to let each Type has its own field.

Thanks for the comments--it'd be nice if the type could be inferred from the key rather than having an additional type to avoid the stutter, which I think is what feels awkward about this to me, but it seems that's not possible. 🙁

Actually, I don't see the union type even implemented yet in Kubernetes?
Kubebuilder doesn't support OneOf (yet?), but some Kustomize post-processing on the CRD could let consumers use the OneOf in the CRD rather than having a Type field. This would also avoid confusion since it'd be impossible to set the Type to one thing and then provide a set of other options (as I think can be done as it is now)?

oneOf: - required: [ "all" ] - required: [ "progressive" ] - required: [ "progressivePerGroup" ]

Though without Kubebuilder support, it'd have to be implemented by the consumers of the library, unfortunately.

openshift-ci bot requested review from deads2k and qiujian16 June 20, 2023 18:33

serngawy mentioned this pull request Jun 20, 2023

Add placement DecisionStrategy API #242

Merged

serngawy force-pushed the rolloutStrategy branch 3 times, most recently from 39d5981 to e748ae4 Compare June 27, 2023 14:11

haoqing0110 reviewed Jun 28, 2023

View reviewed changes

qiujian16 reviewed Jun 28, 2023

View reviewed changes

haoqing0110 reviewed Jul 13, 2023

View reviewed changes

serngawy force-pushed the rolloutStrategy branch from e748ae4 to ead3cf4 Compare July 17, 2023 09:51

haoqing0110 reviewed Jul 18, 2023

View reviewed changes

serngawy force-pushed the rolloutStrategy branch from ead3cf4 to 70312e5 Compare July 18, 2023 09:19

qiujian16 reviewed Jul 18, 2023

View reviewed changes

openshift-ci bot assigned qiujian16 Jul 18, 2023

openshift-ci bot added do-not-merge/hold lgtm labels Jul 18, 2023

openshift-ci bot added the approved label Jul 18, 2023

Add rolloutStrategy API

a2203e5

Signed-off-by: melserngawy <melserng@redhat.com>

serngawy force-pushed the rolloutStrategy branch from 70312e5 to a2203e5 Compare July 19, 2023 13:29

openshift-ci bot removed the lgtm label Jul 19, 2023

openshift-ci bot added lgtm and removed do-not-merge/hold labels Jul 19, 2023

openshift-merge-robot merged commit f64f0af into open-cluster-management-io:main Jul 19, 2023
7 checks passed

haoqing0110 mentioned this pull request Jul 26, 2023

A common rollout API open-cluster-management-io/ocm#237

Closed

serngawy deleted the rolloutStrategy branch August 23, 2023 10:51

dhaiducek reviewed Aug 30, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add common RolloutStrategy API #244

Add common RolloutStrategy API #244

serngawy commented Jun 20, 2023

serngawy commented Jun 20, 2023

haoqing0110 Jun 28, 2023 •

edited

Loading

serngawy Jul 17, 2023

haoqing0110 Jul 18, 2023

serngawy Jul 18, 2023

qiujian16 Jun 28, 2023

serngawy Jul 17, 2023

haoqing0110 Jul 19, 2023

serngawy Jul 19, 2023

qiujian16 Jun 28, 2023

serngawy Jul 17, 2023

qiujian16 Jun 28, 2023

serngawy Jul 17, 2023

haoqing0110 Jul 13, 2023

serngawy Jul 17, 2023

haoqing0110 Jul 18, 2023

serngawy Jul 18, 2023

haoqing0110 Jul 18, 2023

serngawy Jul 18, 2023

haoqing0110 commented Jul 18, 2023

qiujian16 Jul 18, 2023

qiujian16 commented Jul 18, 2023

openshift-ci bot commented Jul 18, 2023

haoqing0110 commented Jul 18, 2023

serngawy commented Jul 18, 2023

qiujian16 commented Jul 19, 2023

dhaiducek Aug 30, 2023

qiujian16 Aug 31, 2023

serngawy Aug 31, 2023 •

edited

Loading

dhaiducek Aug 31, 2023

dhaiducek Aug 31, 2023 •

edited

Loading

Add common RolloutStrategy API #244

Add common RolloutStrategy API #244

Conversation

serngawy commented Jun 20, 2023

serngawy commented Jun 20, 2023

haoqing0110 Jun 28, 2023 • 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

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

haoqing0110 commented Jul 18, 2023

Choose a reason for hiding this comment

qiujian16 commented Jul 18, 2023

openshift-ci bot commented Jul 18, 2023

haoqing0110 commented Jul 18, 2023

serngawy commented Jul 18, 2023

qiujian16 commented Jul 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

serngawy Aug 31, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dhaiducek Aug 31, 2023 • edited Loading

Choose a reason for hiding this comment

haoqing0110 Jun 28, 2023 •

edited

Loading

serngawy Aug 31, 2023 •

edited

Loading

dhaiducek Aug 31, 2023 •

edited

Loading