docs: add UnitedDeployment v1beta1 promotion proposal#2392
docs: add UnitedDeployment v1beta1 promotion proposal#2392Kunal1522 wants to merge 1 commit intoopenkruise:masterfrom
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Signed-off-by: Kunal1522 <kunalkashyap8024@gmail.com>
2a7af8f to
3143f4e
Compare
There was a problem hiding this comment.
Pull request overview
Adds a design/proposal document to guide promoting UnitedDeployment from v1alpha1 to v1beta1, focusing on API contract clarifications and cleanup items needed prior to serving the beta API.
Changes:
- Introduces a promotion proposal covering API surface gaps (e.g.,
subsets[].patchcontract, status field ownership). - Documents validation/defaulting inconsistencies and rollout/revision semantics that need resolution before
v1beta1. - Lists concrete promotion plumbing steps (new
v1beta1types, conversions, CRD serving changes, tests, and migration notes) plus review questions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - [`uniteddeployment_types.go:220-226`](../../apis/apps/v1alpha1/uniteddeployment_types.go) | ||
|
|
||
| But the adapters apply it to `spec.template` only: | ||
|
|
||
| - [`statefulset_adapter.go:170-184`](../../pkg/controller/uniteddeployment/adapter/statefulset_adapter.go) | ||
| - [`advanced_statefulset_adapter.go:184-199`](../../pkg/controller/uniteddeployment/adapter/advanced_statefulset_adapter.go) | ||
| - [`cloneset_adapter.go:149-163`](../../pkg/controller/uniteddeployment/adapter/cloneset_adapter.go) | ||
| - [`deployment_adapter.go:164-179`](../../pkg/controller/uniteddeployment/adapter/deployment_adapter.go) |
There was a problem hiding this comment.
Several references include specific line ranges in the link text (e.g., uniteddeployment_types.go:220-226), but the Markdown link target points only to the file path without a #Lx-Ly anchor. This makes the line-range references non-clickable/misleading; consider adding GitHub line anchors (or removing the line-range from the visible text) consistently throughout the doc.
| - [`uniteddeployment_types.go:220-226`](../../apis/apps/v1alpha1/uniteddeployment_types.go) | |
| But the adapters apply it to `spec.template` only: | |
| - [`statefulset_adapter.go:170-184`](../../pkg/controller/uniteddeployment/adapter/statefulset_adapter.go) | |
| - [`advanced_statefulset_adapter.go:184-199`](../../pkg/controller/uniteddeployment/adapter/advanced_statefulset_adapter.go) | |
| - [`cloneset_adapter.go:149-163`](../../pkg/controller/uniteddeployment/adapter/cloneset_adapter.go) | |
| - [`deployment_adapter.go:164-179`](../../pkg/controller/uniteddeployment/adapter/deployment_adapter.go) | |
| - [`uniteddeployment_types.go:220-226`](../../apis/apps/v1alpha1/uniteddeployment_types.go#L220-L226) | |
| But the adapters apply it to `spec.template` only: | |
| - [`statefulset_adapter.go:170-184`](../../pkg/controller/uniteddeployment/adapter/statefulset_adapter.go#L170-L184) | |
| - [`advanced_statefulset_adapter.go:184-199`](../../pkg/controller/uniteddeployment/adapter/advanced_statefulset_adapter.go#L184-L199) | |
| - [`cloneset_adapter.go:149-163`](../../pkg/controller/uniteddeployment/adapter/cloneset_adapter.go#L149-L163) | |
| - [`deployment_adapter.go:164-179`](../../pkg/controller/uniteddeployment/adapter/deployment_adapter.go#L164-L179) |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2392 +/- ##
==========================================
+ Coverage 48.68% 48.77% +0.09%
==========================================
Files 324 324
Lines 27920 27928 +8
==========================================
+ Hits 13592 13623 +31
+ Misses 12787 12775 -12
+ Partials 1541 1530 -11
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Summary