-
Notifications
You must be signed in to change notification settings - Fork 14.7k
Clarify that custom finalizer names must be publicly qualified finalizer names #50702
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Clarify that custom finalizer names must be publicly qualified finalizer names #50702
Conversation
Welcome @ramalabeysekera! |
[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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
{{<note>}} | ||
* Custom finalizer names must be fully qualified names, such as example.com/finalizer-name. Kubernetes enforces this format, and will reject resources that do not use qualified finalizer names. | ||
{{</note>}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. We don't normally use "fully qualified"; our jargon terms are public (known across multiple clusters) and private (eg for label keys).
Try this (also fixing style nits):
{{<note>}} | |
* Custom finalizer names must be fully qualified names, such as example.com/finalizer-name. Kubernetes enforces this format, and will reject resources that do not use qualified finalizer names. | |
{{</note>}} | |
{{< note >}} | |
Custom finalizer names **must** be publicly qualified finalizer names, such as `example.com/finalizer-name`. | |
Kubernetes enforces this format; the API server rejects writes to objects where the change does not use qualified finalizer names for any custom finalizer. | |
{{< /note >}} |
If you accept this change, please also update the commit message and PR title.
(nit)
This note is important, but it should appear later in the page. It is not so important that it should be part of the page overview.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for reviewing this, I've made the requested changes just now
Description
This PR updates the Finalizers concept documentation to clearly state that custom finalizer names must be fully qualified names.
While the Kubernetes API server enforces this validation at runtime, the current documentation does not explicitly mention the requirement, which can lead to confusion for users manually adding finalizers to objects.
This clarification helps users avoid validation errors when creating or updating resources with custom finalizers.