Skip to content

Document CSI node ID annotations #54035

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

Open
carlory wants to merge 1 commit into
base: dev-1.36
Choose a base branch
from
Open

Document CSI node ID annotations #54035

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 25 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 @@ -354,6 +354,31 @@ The tutorial illustrates using AppArmor to restrict a container's abilities and
The profile specified dictates the set of rules and restrictions that the containerized process must
adhere to. This helps enforce security policies and isolation for your containers.

### csi.alpha.kubernetes.io/node-id (deprecated) {#csi-alpha-kubernetes-io-node-id}

Type: Annotation

Example: `csi.alpha.kubernetes.io/node-id: "node-12345"`

Used on: VolumeAttachments

This annotation is used internally to find the node identifier when it can not be obtained from
the `CSINode` object. It is populated by the CSI external-attacher sidecar container before a volume is attached.

It provides a fallback mechanism for detaching volumes when a `CSINode` object is not present.
Comment on lines +365 to +368
Copy link
Copy Markdown
Member

@lmktfy lmktfy Apr 4, 2026

Choose a reason for hiding this comment

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

Suggested change
This annotation is used internally to find the node identifier when it can not be obtained from
the `CSINode` object. It is populated by the CSI external-attacher sidecar container before a volume is attached.
It provides a fallback mechanism for detaching volumes when a `CSINode` object is not present.
the CSINode object. It is populated by the CSI external-attacher sidecar container before a volume is attached.
It provides a fallback mechanism for detaching volumes when an appropriate CSINode is not present.

(no backticks on API types, per style guide)

Copy link
Copy Markdown
Member

@reylejano reylejano Apr 10, 2026

Choose a reason for hiding this comment

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

@carlory , are you able to address the above suggestion


Copy link
Copy Markdown
Member

@lmktfy lmktfy Apr 4, 2026

Choose a reason for hiding this comment

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

Suggested change
Because this annotation is deprecated, the Kubernetes project recommends that you do
**not** set this on a VolumeAttachment, nor on any other object.

### csi.volume.kubernetes.io/nodeid (deprecated) {#csi-volume-kubernetes-io-nodeid}

Type: Annotation

Example: `csi.volume.kubernetes.io/nodeid: "node-12345"`

Used on: Nodes

This annotation was used internally to specify the identifier for a node as understood by the Container Storage Interface (CSI) driver. kubelet populated this annotation by calling the `NodeGetInfo` gRPC method of the CSI driver to retrieve the node ID during the driver registration. And the external-attacher sidecar container read this annotation to get the node ID when attaching or detaching volumes.

But it has been deprecated in favor of the `CSINode` object, which provides the same functionality via the `spec.drivers[].nodeID` field. And it needs the csi driver to bump the external-attacher sidecar to v2.2 or later.
Copy link
Copy Markdown
Member

@lmktfy lmktfy Apr 4, 2026

Choose a reason for hiding this comment

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

Suggested change
But it has been deprecated in favor of the `CSINode` object, which provides the same functionality via the `spec.drivers[].nodeID` field. And it needs the csi driver to bump the external-attacher sidecar to v2.2 or later.
The annotation has been deprecated in favor of using the CSINode object, which provides the same functionality via the `spec.drivers[].nodeID` field.

Instead of explaining the deprecation, hyperlink to some relevant CSI docs about it.


### deployment.kubernetes.io/desired-replicas

Type: Annotation
Expand Down