Skip to content

Document CSI node ID annotations#54035

Open
carlory wants to merge 1 commit intokubernetes:dev-1.36from
carlory:follow-up-kk-135676
Open

Document CSI node ID annotations#54035
carlory wants to merge 1 commit intokubernetes:dev-1.36from
carlory:follow-up-kk-135676

Conversation

@carlory
Copy link
Copy Markdown
Member

@carlory carlory commented Jan 16, 2026

Summary

  • Documents csi.alpha.kubernetes.io/node-id annotation used on VolumeAttachments for finding node identifiers when CSINode object is unavailable
  • Documents csi.volume.kubernetes.io/nodeid deprecated annotation previously used on Nodes

related to kubernetes/kubernetes#135676

🤖 Generated with Claude Code

@k8s-ci-robot k8s-ci-robot added this to the 1.36 milestone Jan 16, 2026
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 16, 2026
@k8s-ci-robot
Copy link
Copy Markdown
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.

Details 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/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 16, 2026
@carlory
Copy link
Copy Markdown
Member Author

carlory commented Jan 16, 2026

/cc @lmktfy @jsafrane

@carlory
Copy link
Copy Markdown
Member Author

carlory commented Jan 16, 2026

/hold
util kubernetes/kubernetes#135676 is merged

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 16, 2026
@netlify
Copy link
Copy Markdown

netlify bot commented Jan 16, 2026

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit da7a70a
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/69a1045e4c176c0008c8b4e0
😎 Deploy Preview https://deploy-preview-54035--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 project configuration.

@lmktfy
Copy link
Copy Markdown
Member

lmktfy commented Jan 16, 2026

It's actually OK to mark both of these deprecated right away, because the paradigm of putting "alpha" or "beta" in the key is deprecated, and any label or annotation using the old way can be marked deprecated on those grounds.

Also we can mark things deprecated even if we don't have a plan to migrate to a different key.


The text should briefly explain the situation to readers though; they might wonder what persistent storage to use if non-CSI is deprecated and CSI depends on using a deprecated annotation.

I think this is fine though; various important subparts of Kubernetes were technically in alpha at the 1.0 release and were still alpha come (eg) v1.17, and the world Did Not End.

@carlory
Copy link
Copy Markdown
Member Author

carlory commented Jan 16, 2026

It's actually OK to mark both of these deprecated right away

@lmktfy we can not deprecated the csi.alpha.kubernetes.io/node-id annotation because the external attacher still uses it.
See kubernetes-csi/external-attacher#83 and https://github.com/kubernetes-csi/external-attacher/blob/master/pkg/controller/csi_handler.go#L755-L784

/cc @jsafrane
for double check.

@carlory carlory force-pushed the follow-up-kk-135676 branch 2 times, most recently from 01dc368 to 4ad3801 Compare January 19, 2026 04:12
@carlory
Copy link
Copy Markdown
Member Author

carlory commented Jan 19, 2026

The text should briefly explain the situation to readers though; they might wonder what persistent storage to use if non-CSI is deprecated and CSI depends on using a deprecated annotation.

updated.

@k8s-ci-robot k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jan 30, 2026
@carlory carlory force-pushed the follow-up-kk-135676 branch from 1544bd7 to e427b89 Compare February 2, 2026 02:29
@lmktfy
Copy link
Copy Markdown
Member

lmktfy commented Feb 23, 2026

It's actually OK to mark both of these deprecated right away

@lmktfy we can not deprecated the csi.alpha.kubernetes.io/node-id annotation because the external attacher still uses it. See kubernetes-csi/external-attacher#83 and https://github.com/kubernetes-csi/external-attacher/blob/master/pkg/controller/csi_handler.go#L755-L784

You really can; you can deprecate ("ask people not to do") a thing even when it still works.

@carlory carlory force-pushed the follow-up-kk-135676 branch from e427b89 to e08a839 Compare February 24, 2026 02:42
@carlory
Copy link
Copy Markdown
Member Author

carlory commented Feb 24, 2026

You really can; you can deprecate ("ask people not to do") a thing even when it still works.

Added.

@jsafrane
Copy link
Copy Markdown
Member

/lgtm
from sig-storage perspective. csi.volume.kubernetes.io/nodeid is not used anywhere, I think, but as @lmktfy wrote elsewhere, we should document even the unused ones.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 25, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

LGTM label has been added.

DetailsGit tree hash: 251ee83316a18e4e48e23ee547f07fdbf1a7cc3d

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>
@carlory carlory force-pushed the follow-up-kk-135676 branch from e08a839 to da7a70a Compare February 27, 2026 02:41
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 27, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

New changes are detected. LGTM label has been removed.

@carlory
Copy link
Copy Markdown
Member Author

carlory commented Feb 27, 2026

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. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. language/en Issues or PRs related to English language size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants