Skip to content

Commit c85a756

Browse files
committed
📖 Add ProviderID to Glossary.
1 parent 4d7fffc commit c85a756

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/book/src/reference/glossary.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -374,6 +374,16 @@ to refer to any project that can be deployed and provides functionality to the C
374374
See [Bootstrap provider](#bootstrap-provider), [Control plane provider](#control-plane-provider), [Core provider](#core-provider),
375375
[Infrastructure provider](#infrastructure-provider), [IPAM provider](#ipam-provider) [Runtime extension provider](#runtime-extension-provider).
376376

377+
### ProviderID
378+
379+
ProviderID is the provider-specific identifier used to correlate Cluster API objects with the
380+
underlying cloud instance. It appears in three resource types: InfrastructureMachine, Machine
381+
(Cluster API core), and Node (workload cluster). CAPI copies the ProviderID from the
382+
InfrastructureMachine to the Machine. The Node's ProviderID is set by the [Cloud Controller Manager
383+
(CCM)](https://kubernetes.io/docs/concepts/architecture/cloud-controller/) or the kubelet.
384+
385+
The format is a URI-like string: `<provider>://<provider-specific-identifier>`.
386+
377387
### Provider components
378388

379389
Refers to the YAML artifact published as part of the release process for [providers](#provider);

0 commit comments

Comments
 (0)