Skip to content

📖 Add ProviderID to Glossary. #12944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 4, 2025
+10 −0
Merged

📖 Add ProviderID to Glossary. #12944

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/book/src/reference/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,16 @@ to refer to any project that can be deployed and provides functionality to the C
See [Bootstrap provider](#bootstrap-provider), [Control plane provider](#control-plane-provider), [Core provider](#core-provider),
[Infrastructure provider](#infrastructure-provider), [IPAM provider](#ipam-provider) [Runtime extension provider](#runtime-extension-provider).

### ProviderID

ProviderID is the provider-specific identifier used to correlate Cluster API objects with the
underlying cloud instance. It appears in three resource types: InfrastructureMachine, Machine
(Cluster API core), and Node (workload cluster). CAPI copies the ProviderID from the
InfrastructureMachine to the Machine. The Node's ProviderID is set by the [Cloud Controller Manager
(CCM)](https://kubernetes.io/docs/concepts/architecture/cloud-controller/) or the kubelet.

The format is a URI-like string: `<provider>://<provider-specific-identifier>`.

### Provider components

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