Skip to content

Commit da7a70a

Browse files
carloryclaude
andcommitted
Document CSI node ID annotations
Adds documentation for csi.alpha.kubernetes.io/node-id annotation used on VolumeAttachments for finding node identifiers when CSINode object is unavailable, and csi.volume.kubernetes.io/nodeid deprecated annotation previously used on Nodes. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> Signed-off-by: carlory <baofa.fan@daocloud.io>
1 parent 06f2285 commit da7a70a

File tree

1 file changed

+25
-0
lines changed
  • content/en/docs/reference/labels-annotations-taints

1 file changed

+25
-0
lines changed

content/en/docs/reference/labels-annotations-taints/_index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,31 @@ The tutorial illustrates using AppArmor to restrict a container's abilities and
354354
The profile specified dictates the set of rules and restrictions that the containerized process must
355355
adhere to. This helps enforce security policies and isolation for your containers.
356356

357+
### csi.alpha.kubernetes.io/node-id (deprecated) {#csi-alpha-kubernetes-io-node-id}
358+
359+
Type: Annotation
360+
361+
Example: `csi.alpha.kubernetes.io/node-id: "node-12345"`
362+
363+
Used on: VolumeAttachments
364+
365+
This annotation is used internally to find the node identifier when it can not be obtained from
366+
the `CSINode` object. It is populated by the CSI external-attacher sidecar container before a volume is attached.
367+
368+
It provides a fallback mechanism for detaching volumes when a `CSINode` object is not present.
369+
370+
### csi.volume.kubernetes.io/nodeid (deprecated) {#csi-volume-kubernetes-io-nodeid}
371+
372+
Type: Annotation
373+
374+
Example: `csi.volume.kubernetes.io/nodeid: "node-12345"`
375+
376+
Used on: Nodes
377+
378+
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.
379+
380+
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.
381+
357382
### deployment.kubernetes.io/desired-replicas
358383

359384
Type: Annotation

0 commit comments

Comments
 (0)