Skip to content

Commit 1b3ef84

Browse files
authored
Merge pull request #6967 from enxebre/providerid-docs
🌱 Add providerID workflow clarification
2 parents 7e82b56 + fc24f18 commit 1b3ef84

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/book/src/developer/providers/machine-infrastructure.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@ A machine infrastructure provider must define an API type for "infrastructure ma
1515
4. Must have the standard Kubernetes "type metadata" and "object metadata"
1616
5. Must have a `spec` field with the following:
1717
1. Required fields:
18-
1. `providerID` (string): the identifier for the provider's machine instance
18+
1. `providerID` (string): the identifier for the provider's machine instance. This field is expected to match the value set by the KCM cloud provider in the Nodes.
19+
The Machine controller bubbles it up to the Machine CR, and it's used to find the matching Node.
20+
Any other consumers can use the providerID as the source of truth to match both Machines and Nodes.
21+
1922
2. Optional fields:
2023
1. `failureDomain` (string): the string identifier of the failure domain the instance is running in for the
2124
purposes of backwards compatibility and migrating to the v1alpha3 FailureDomain support (where FailureDomain

0 commit comments

Comments
 (0)