Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Register Annotation resource.kubernetes.io/pod-claim-name #47093

Merged
merged 3 commits into from
Oct 2, 2024
Merged

Register Annotation resource.kubernetes.io/pod-claim-name #47093

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a801e39
fix: register resource.kubernetes.io/pod-claim-name in labels-annotat…
abhilasha2418 Jul 4, 2024
fed4864
nit: add new line
abhilasha2418 Jul 4, 2024
b2bb082
fix: modify description of resource.kubernetes.io/pod-claim-name
abhilasha2418 Jul 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions content/en/docs/reference/labels-annotations-taints/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,19 @@ in the StatefulSet topic for more details.
Note the [PodIndexLabel](/docs/reference/command-line-tools-reference/feature-gates/)
feature gate must be enabled for this label to be added to pods.

### resource.kubernetes.io/pod-claim-name

Type: Annotation

Example: `resource.kubernetes.io/pod-claim-name: "my-pod-claim"`

Used on: ResourceClaim

This annotation is assigned to generated ResourceClaims.
Its value corresponds to the name of the resource claim in the `.spec` of any Pod(s) for which the ResourceClaim was created.
This annotation is an internal implementation detail of [dynamic resource allocation](/docs/concepts/scheduling-eviction/dynamic-resource-allocation/).
You should not need to read or modify the value of this annotation.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's mentioned here that this annotation is used only inside the controller and not documented as part of the Kubernetes API.
It looks like it's intentionally not documented. @pohly is it?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is indeed intentional.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, but per #47044 we don't have a way to register annotations without also documenting them.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(adding such a mechanism is welcome, and it's not actually a huge amount of work, but it'd be bigger than this PR)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can document them here. It just makes less sense to also document it in the public types.go as a const string.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

### cluster-autoscaler.kubernetes.io/safe-to-evict

Type: Annotation
Expand Down