api: add coordination api for rbg #84
Open
Conversation
This file contains hidden or 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
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new coordination mechanism for RoleBasedGroup resources, enabling coordinated rollout strategies across multiple roles. The coordination feature allows defining constraints for rolling updates, such as maximum skew, partition, and maximum unavailable replicas between roles.
Key changes:
- Added new
CoordinationandCoordinationRolloutStrategytypes to the API schema - Updated CRDs for both RoleBasedGroup and RoleBasedGroupSet resources to include the coordination field
- Generated corresponding client-go apply configurations and deep copy methods
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| api/workloads/v1alpha1/rolebasedgroup_types.go | Defines new Coordination and CoordinationRolloutStrategy types with rollout coordination fields |
| config/crd/bases/workloads.x-k8s.io_rolebasedgroups.yaml | Updates RoleBasedGroup CRD schema to include coordination field as required |
| config/crd/bases/workloads.x-k8s.io_rolebasedgroupsets.yaml | Updates RoleBasedGroupSet CRD schema to include coordination field in template as required |
| deploy/helm/rbgs/crds/workloads.x-k8s.io_rolebasedgroups.yaml | Helm CRD update mirroring config changes for RoleBasedGroup |
| deploy/helm/rbgs/crds/workloads.x-k8s.io_rolebasedgroupsets.yaml | Helm CRD update mirroring config changes for RoleBasedGroupSet |
| client-go/applyconfiguration/workloads/v1alpha1/rolebasedgroupspec.go | Adds Coordination field and WithCoordination method to apply configuration |
| client-go/applyconfiguration/workloads/v1alpha1/coordination.go | Generated apply configuration for Coordination type |
| client-go/applyconfiguration/workloads/v1alpha1/coordinationrolloutstrategy.go | Generated apply configuration for CoordinationRolloutStrategy type |
| client-go/applyconfiguration/utils.go | Registers new Coordination and CoordinationRolloutStrategy types in ForKind function |
| api/workloads/v1alpha1/zz_generated.deepcopy.go | Generated deep copy methods for new Coordination types |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: veophi <[email protected]>
veophi
force-pushed
the
api/coordination
branch
from
b4e23ff to
d512730
Compare
3 tasks
Contributor
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 10 out of 10 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+67
to
+77
| // Only support percentage value, and defaults to nil. | ||
| MaxSkew *intstr.IntOrString `json:"maxSkew,omitempty"` | ||
|
|
||
| // Partition indicates the replicas at which the role should be partitioned for rolling update. | ||
| // If Partition is not nil, the Partition of the roles' rolloutStrategy will be overridden by this field. | ||
| // Only support percentage value, and defaults to nil. | ||
| Partition *intstr.IntOrString `json:"partition,omitempty"` | ||
|
|
||
| // MaxUnavailable defines the updating step during rolling. If MaxUnavailable is not nil, | ||
| // the MaxUnavailable of the roles' rolloutStrategy will be overridden by this field. | ||
| // Only support percentage value, and defaults to nil. |
There was a problem hiding this comment.
The comment states 'Only support percentage value' but the field type is *intstr.IntOrString which accepts both integer and string values. Consider adding validation (e.g., +kubebuilder:validation:Pattern) to enforce percentage format if only percentages are truly supported, or update the documentation to clarify what formats are accepted.
Suggested change
| // Only support percentage value, and defaults to nil. | |
| MaxSkew *intstr.IntOrString `json:"maxSkew,omitempty"` | |
| // Partition indicates the replicas at which the role should be partitioned for rolling update. | |
| // If Partition is not nil, the Partition of the roles' rolloutStrategy will be overridden by this field. | |
| // Only support percentage value, and defaults to nil. | |
| Partition *intstr.IntOrString `json:"partition,omitempty"` | |
| // MaxUnavailable defines the updating step during rolling. If MaxUnavailable is not nil, | |
| // the MaxUnavailable of the roles' rolloutStrategy will be overridden by this field. | |
| // Only support percentage value, and defaults to nil. | |
| // Only support percentage value, and defaults to nil. | |
| // +kubebuilder:validation:Pattern=`^[0-9]+%$` | |
| MaxSkew *intstr.IntOrString `json:"maxSkew,omitempty"` | |
| // Partition indicates the replicas at which the role should be partitioned for rolling update. | |
| // If Partition is not nil, the Partition of the roles' rolloutStrategy will be overridden by this field. | |
| // Only support percentage value, and defaults to nil. | |
| // +kubebuilder:validation:Pattern=`^[0-9]+%$` | |
| Partition *intstr.IntOrString `json:"partition,omitempty"` | |
| // MaxUnavailable defines the updating step during rolling. If MaxUnavailable is not nil, | |
| // the MaxUnavailable of the roles' rolloutStrategy will be overridden by this field. | |
| // Only support percentage value, and defaults to nil. | |
| // +kubebuilder:validation:Pattern=`^[0-9]+%$` |
Comment on lines
+67
to
+77
| // Only support percentage value, and defaults to nil. | ||
| MaxSkew *intstr.IntOrString `json:"maxSkew,omitempty"` | ||
|
|
||
| // Partition indicates the replicas at which the role should be partitioned for rolling update. | ||
| // If Partition is not nil, the Partition of the roles' rolloutStrategy will be overridden by this field. | ||
| // Only support percentage value, and defaults to nil. | ||
| Partition *intstr.IntOrString `json:"partition,omitempty"` | ||
|
|
||
| // MaxUnavailable defines the updating step during rolling. If MaxUnavailable is not nil, | ||
| // the MaxUnavailable of the roles' rolloutStrategy will be overridden by this field. | ||
| // Only support percentage value, and defaults to nil. |
There was a problem hiding this comment.
The comment states 'Only support percentage value' but the field type is *intstr.IntOrString which accepts both integer and string values. Consider adding validation (e.g., +kubebuilder:validation:Pattern) to enforce percentage format if only percentages are truly supported, or update the documentation to clarify what formats are accepted.
Suggested change
| // Only support percentage value, and defaults to nil. | |
| MaxSkew *intstr.IntOrString `json:"maxSkew,omitempty"` | |
| // Partition indicates the replicas at which the role should be partitioned for rolling update. | |
| // If Partition is not nil, the Partition of the roles' rolloutStrategy will be overridden by this field. | |
| // Only support percentage value, and defaults to nil. | |
| Partition *intstr.IntOrString `json:"partition,omitempty"` | |
| // MaxUnavailable defines the updating step during rolling. If MaxUnavailable is not nil, | |
| // the MaxUnavailable of the roles' rolloutStrategy will be overridden by this field. | |
| // Only support percentage value, and defaults to nil. | |
| // Only support percentage value, and defaults to nil. | |
| // +kubebuilder:validation:Pattern=`^\d+%$` | |
| MaxSkew *intstr.IntOrString `json:"maxSkew,omitempty"` | |
| // Partition indicates the replicas at which the role should be partitioned for rolling update. | |
| // If Partition is not nil, the Partition of the roles' rolloutStrategy will be overridden by this field. | |
| // Only support percentage value, and defaults to nil. | |
| // +kubebuilder:validation:Pattern=`^\d+%$` | |
| Partition *intstr.IntOrString `json:"partition,omitempty"` | |
| // MaxUnavailable defines the updating step during rolling. If MaxUnavailable is not nil, | |
| // the MaxUnavailable of the roles' rolloutStrategy will be overridden by this field. | |
| // Only support percentage value, and defaults to nil. | |
| // +kubebuilder:validation:Pattern=`^\d+%$` |
Comment on lines
+67
to
+77
| // Only support percentage value, and defaults to nil. | ||
| MaxSkew *intstr.IntOrString `json:"maxSkew,omitempty"` | ||
|
|
||
| // Partition indicates the replicas at which the role should be partitioned for rolling update. | ||
| // If Partition is not nil, the Partition of the roles' rolloutStrategy will be overridden by this field. | ||
| // Only support percentage value, and defaults to nil. | ||
| Partition *intstr.IntOrString `json:"partition,omitempty"` | ||
|
|
||
| // MaxUnavailable defines the updating step during rolling. If MaxUnavailable is not nil, | ||
| // the MaxUnavailable of the roles' rolloutStrategy will be overridden by this field. | ||
| // Only support percentage value, and defaults to nil. |
There was a problem hiding this comment.
The comment states 'Only support percentage value' but the field type is *intstr.IntOrString which accepts both integer and string values. Consider adding validation (e.g., +kubebuilder:validation:Pattern) to enforce percentage format if only percentages are truly supported, or update the documentation to clarify what formats are accepted.
Suggested change
| // Only support percentage value, and defaults to nil. | |
| MaxSkew *intstr.IntOrString `json:"maxSkew,omitempty"` | |
| // Partition indicates the replicas at which the role should be partitioned for rolling update. | |
| // If Partition is not nil, the Partition of the roles' rolloutStrategy will be overridden by this field. | |
| // Only support percentage value, and defaults to nil. | |
| Partition *intstr.IntOrString `json:"partition,omitempty"` | |
| // MaxUnavailable defines the updating step during rolling. If MaxUnavailable is not nil, | |
| // the MaxUnavailable of the roles' rolloutStrategy will be overridden by this field. | |
| // Only support percentage value, and defaults to nil. | |
| // Only support percentage value, and defaults to nil. | |
| // +kubebuilder:validation:Pattern=^\d+%$ | |
| MaxSkew *intstr.IntOrString `json:"maxSkew,omitempty"` | |
| // Partition indicates the replicas at which the role should be partitioned for rolling update. | |
| // If Partition is not nil, the Partition of the roles' rolloutStrategy will be overridden by this field. | |
| // Only support percentage value, and defaults to nil. | |
| // +kubebuilder:validation:Pattern=^\d+%$ | |
| Partition *intstr.IntOrString `json:"partition,omitempty"` | |
| // MaxUnavailable defines the updating step during rolling. If MaxUnavailable is not nil, | |
| // the MaxUnavailable of the roles' rolloutStrategy will be overridden by this field. | |
| // Only support percentage value, and defaults to nil. | |
| // +kubebuilder:validation:Pattern=^\d+%$ |
Comment on lines
+52
to
+55
| // Name of the coordination. | ||
| Name string `json:"name"` | ||
|
|
||
| // Roles that should be constrained by this coordination. |
There was a problem hiding this comment.
The Coordination struct has required fields Name and Roles but lacks kubebuilder validation markers (e.g., +kubebuilder:validation:Required, +kubebuilder:validation:MinItems=1 for Roles). Consider adding these to ensure proper validation at the API level.
Suggested change
| // Name of the coordination. | |
| Name string `json:"name"` | |
| // Roles that should be constrained by this coordination. | |
| // Name of the coordination. | |
| // +kubebuilder:validation:Required | |
| Name string `json:"name"` | |
| // Roles that should be constrained by this coordination. | |
| // +kubebuilder:validation:Required | |
| // +kubebuilder:validation:MinItems=1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ⅰ. Motivation
more details in KEP #59.
Ⅱ. Modifications
add coordination api for rbg.
Ⅲ. Does this pull request fix one issue?
fixes #45
Ⅳ. List the added test cases (unit test/integration test) if any, please explain if no tests are needed.
Ⅴ. Describe how to verify it
VI. Special notes for reviews
Checklist
make fmt.