Skip to content

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ramalabeysekera
Copy link

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.

Copy link

linux-foundation-easycla bot commented Apr 27, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Apr 27, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @ramalabeysekera!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign salaxander for approval. For more information see the Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Apr 27, 2025
Copy link

netlify bot commented Apr 27, 2025

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit bbd9b90
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/680ea99bb2a17200089c329b
😎 Deploy Preview https://deploy-preview-50702--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Comment on lines 20 to 22
{{<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>}}
Copy link
Contributor

@lmktfy lmktfy Apr 27, 2025

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):

Suggested change
{{<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.

Copy link
Author

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

@ramalabeysekera ramalabeysekera changed the title Clarify that custom finalizers must use fully qualified names Clarify that custom finalizer names must be publicly qualified finalizer names Apr 27, 2025
@ramalabeysekera ramalabeysekera requested a review from lmktfy April 28, 2025 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants