📖 Fix typo in docs for TopologyDryRunAnnotation #10265
Conversation
k8s-ci-robot
added
area/documentation
|
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 Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions 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/test-infra repository. |
k8s-ci-robot
added
needs-ok-to-test
| // only during a server side dry run apply operation. It is used for validating | ||
| // update webhooks for objects which get updated by template rotation (e.g. InfrastructureMachineTemplate). | ||
| // When the annotation is set and the admission request is a dry run, the webhook should | ||
| // deny validation due to immutability. By that the request will succeed (without | ||
| // skip validation due to immutability. By that the request will succeed (without | ||
| // any changes to the actual object because it is a dry run) and the topology controller | ||
| // will receive the resulting object. |
There was a problem hiding this comment.
Maybe rephrase it even more, so it's clearer?
TopologyDryRunAnnotation is an annotation that gets set on objects by the topology controller when performing a dry-run server side apply in order to apply defaulting to resources. It instructs the validating web hook to skip validation of immutable fields, which allows the request to succeed. The annotation must not be respected for regular (not dry-run) requests, so no invalid modifications to the resources are applied.
The topology controller uses this feature when processing immutable resources (usually templates) to decide whether a new revision of a immutable resource needs to be created.
|
/ok-to-test |
k8s-ci-robot
added
ok-to-test
|
/test pull-cluster-api-test-main |
|
Thanks @guettli are you still planning to address the suggestion here #10265 (comment)? |
|
@enxebre I think I am not familiar enough with it, to write a better comment. Feel free to adapt the comment/PR, so that it makes more sense. |
|
Ok, thanks! We can always follow up. |
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: 82074ec28d171b3b40e8c9ea99288074e9acdc88
|
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: enxebre 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:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
What this PR does / why we need it:
In the docstring of
TopologyDryRunAnnotationthe word "deny" was used, although it should be "skip"./area documentation