📖 Add update patch apply docs#5620
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: guettli 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 |
|
Hi @guettli. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Tip We noticed you've done this a few times! Consider joining the org to skip this step and gain Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
k8s-ci-robot
added
needs-ok-to-test
Align SUMMARY.md and reference.md nav entries with the page H1
("Choosing Between Update, Patch, and Apply"). Fix missing parentheses
on Status().Update() in the secondary-owned-resources aside.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
One or more co-authors of this pull request were not found. You must specify co-authors in commit message trailer via: Supported
Alternatively, if the co-author should not be included, remove the Please update your commit message(s) by doing |
k8s-ci-robot
added
cncf-cla: no
There was a problem hiding this comment.
Thanks for working on this.
I initially thought this would be about WithFieldValidation (#5208), rather than PUT/PATCH/APPLY methods—but I appreciate you raising this.
That said, this section feels a bit over-described and not fully accurate.
I think this could be simplified to a short note, for example:
Use
PUTfor replacement-style updates andPATCHfor partial updates. In Kubernetes, server-side apply is implemented as a specializedPATCHoperation. See: https://kubernetes.io/docs/reference/using-api/api-concepts/
I am not sure where the note would fit better.
Maybe when we support SSA (#5458) we can add that.
k8s-ci-robot
added
the
needs-rebase
k8s-ci-robot
removed
the
needs-rebase
k8s-ci-robot
added
size/M
There was a problem hiding this comment.
Pull request overview
Adds new reference documentation to help Kubebuilder/controller authors choose between Update, Patch, and server-side Apply when reconciling Kubernetes objects.
Changes:
- Adds a new reference page explaining tradeoffs and recommended usage of
Update,Patch, andApply. - Links the new page from the reference index.
- Adds the new page to the book SUMMARY navigation.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/book/src/reference/update-patch-apply.md | New doc page describing when to use Update vs Patch vs server-side Apply. |
| docs/book/src/reference/reference.md | Adds the new doc page to the Reference section listing. |
| docs/book/src/SUMMARY.md | Adds the new doc page to the book navigation sidebar. |
|
Hi @guettli Based on this #5620 (review) I am closing this one as defered. I hope that you do not mind. If you do not agree please feel free to re-open, Also,see that you need sign CLA to allow us get any contribution merged. Thank you so much for your help and input. Cheers, |
Add docs about when to use Update, Patch, Apply.