Skip to content
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.

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

🌱 Add providerID workflow clarification #6967

Merged
merged 1 commit into from
Jul 22, 2022
Merged
Changes from all commits
Commits
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
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