Skip to content

Commit

Permalink
Merge pull request #6967 from enxebre/providerid-docs
Browse files Browse the repository at this point in the history
🌱 Add providerID workflow clarification
  • Loading branch information
k8s-ci-robot authored Jul 22, 2022
2 parents 7e82b56 + fc24f18 commit 1b3ef84
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/book/src/developer/providers/machine-infrastructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@ A machine infrastructure provider must define an API type for "infrastructure ma
4. Must have the standard Kubernetes "type metadata" and "object metadata"
5. Must have a `spec` field with the following:
1. Required fields:
1. `providerID` (string): the identifier for the provider's machine instance
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.
The Machine controller bubbles it up to the Machine CR, and it's used to find the matching Node.
Any other consumers can use the providerID as the source of truth to match both Machines and Nodes.

2. Optional fields:
1. `failureDomain` (string): the string identifier of the failure domain the instance is running in for the
purposes of backwards compatibility and migrating to the v1alpha3 FailureDomain support (where FailureDomain
Expand Down

0 comments on commit 1b3ef84

Please sign in to comment.