mirror of
https://github.com/kubernetes/kubernetes.git
synced 2026-10-28 13:45:38 +08:00
Merge pull request #142729 from kpdagrt22/docs/cloud-provider-clusterid-contract
cloud-provider: document when HasClusterID is checked and what it gates
This commit is contained in:
1 file changed
+6
-1
@@ -65,7 +65,12 @@ type Interface interface {
|
||||
Routes() (Routes, bool)
|
||||
// ProviderName returns the cloud provider ID.
|
||||
ProviderName() string
|
||||
// HasClusterID returns true if a ClusterID is required and set
|
||||
// HasClusterID returns true if the cluster has a ClusterID set. The
|
||||
// cloud-controller-manager checks this during cloud initialization at startup
|
||||
// and exits on false unless the deprecated --allow-untagged-cloud flag is set.
|
||||
// The framework only reads this boolean and never reads the ID itself, so how a
|
||||
// provider stores and verifies it (for example, that instances carry the cluster
|
||||
// tag) is up to the provider.
|
||||
HasClusterID() bool
|
||||
}
|
||||
|
||||
|
||||
Reference in new issue
Block a user