Skip to content

cloud-provider: document when HasClusterID is checked and what it gates - #142729

Merged
kubernetes-prow[bot] merged 1 commit into
kubernetes:masterfrom
kpdagrt22:docs/cloud-provider-clusterid-contract
Oct 22, 2026
Merged

cloud-provider: document when HasClusterID is checked and what it gates#142729
kubernetes-prow[bot] merged 1 commit into
kubernetes:masterfrom
kpdagrt22:docs/cloud-provider-clusterid-contract

Conversation

@kpdagrt22

@kpdagrt22 kpdagrt22 commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind documentation
/sig cloud-provider

What this PR does / why we need it:

The HasClusterID doc only said what the method returns. It now says the cloud-controller-manager calls it once at startup, refuses to start on false unless the deprecated --allow-untagged-cloud is set, and that the framework never reads the ID, so storage and use are provider-defined. Comment-only change.

Which issue(s) this PR is related to:

Fixes #128320

Special notes for your reviewer:

Verified against the call sites in cmd/cloud-controller-manager/main.go and staging/src/k8s.io/cloud-provider/sample/basic_main.go. No other code reads the ID. No test added since this is documentation only.

Does this PR introduce a user-facing change?

NONE

AI usage disclosure:

YES - AI drafted the comment after reading the call sites. The human author owns this submission. See AGENTS.md and CONTRIBUTING.md.

🤖 Generated with Claude Code

@kubernetes-prow kubernetes-prow Bot added release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. kind/documentation Categorizes issue or PR as related to documentation. sig/cloud-provider Categorizes an issue or PR as relevant to SIG Cloud Provider. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 6, 2026
@kubernetes-prow

kubernetes-prow Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@kubernetes-prow kubernetes-prow Bot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 6, 2026
@kubernetes-prow

kubernetes-prow Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

Hi @kpdagrt22. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@kubernetes-prow
kubernetes-prow Bot requested review from dims and liggitt October 6, 2026 11:37
@kpdagrt22 kpdagrt22 mentioned this pull request Oct 6, 2026
Closed
@elmiko

elmiko commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

/ok-to-test

@kubernetes-prow kubernetes-prow Bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 7, 2026
@kpdagrt22
cloud-provider: document when HasClusterID is checked and what it gates
86ae00d 
The HasClusterID doc only said what the method returns. It did not say
who calls it, what a false result does, or that the framework never reads
the ID, which left implementers unsure how a ClusterID should be modeled.
@kpdagrt22
kpdagrt22 force-pushed the docs/cloud-provider-clusterid-contract branch from d408177 to 86ae00d Compare October 9, 2026 12:16
@kpdagrt22

kpdagrt22 commented Oct 9, 2026

Copy link
Copy Markdown
Contributor Author

/priority backlog

Sets priority to unblock tide. Docs-only clarification for #128320; no behavior change.

@kubernetes-prow kubernetes-prow Bot added priority/backlog Higher priority than priority/awaiting-more-evidence. and removed needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Oct 9, 2026
elmiko
elmiko reviewed Oct 12, 2026
View reviewed changes

@elmiko elmiko left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this is a nice update for me, thanks.

/lgtm

cc @cheftako or @JoelSpeed for approval

@kubernetes-prow kubernetes-prow Bot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 12, 2026
@kubernetes-prow

kubernetes-prow Bot commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

LGTM label has been added.

DetailsGit tree hash: d56caed5ae6d211ecdfe5a26707934705825d963

@elmiko

elmiko commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

given that this is only docs, i'll give the others a day or two to respond, otherwise i will merge by end of week.

@elmiko

elmiko commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

/approve

@kubernetes-prow

kubernetes-prow Bot commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: elmiko, kpdagrt22

The full list of commands accepted by this bot can be found here.

The pull request process is described 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

@kubernetes-prow kubernetes-prow Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 22, 2026
@kubernetes-prow
kubernetes-prow Bot merged commit 4cc5a2d into kubernetes:master Oct 22, 2026
13 checks passed
@kubernetes-prow kubernetes-prow Bot added this to the v1.38 milestone Oct 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dims dims Awaiting requested review from dims
@liggitt liggitt Awaiting requested review from liggitt
1 more reviewer
@elmiko elmiko elmiko left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@elmiko elmiko

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. area/cloudprovider cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. priority/backlog Higher priority than priority/awaiting-more-evidence. release-note-none Denotes a PR that doesn't merit a release note. sig/cloud-provider Categorizes an issue or PR as relevant to SIG Cloud Provider. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Milestone

v1.38

Development

Successfully merging this pull request may close these issues.

cloud-provider HasClusterID related functionality should have better documentation in the code

2 participants

@kpdagrt22 @elmiko