oxidecomputer / oxidecomputer/oxide-cloud-controller-manager
Document the node-name-must-match-instance-name requirement
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 6
- Forks
- 2
- Avg merge
- 2h 5m
- Merged PRs (30d)
- 14
Description
Context
When a node has no provider ID yet, getInstance (internal/provider/instances_v2.go) falls back to looking up the Oxide instance by the Kubernetes node name. If the node name doesn't match the Oxide instance name, nodes never initialize — and nothing in the docs or logs tells the user why.
Scope
- Document the requirement in
README.adoc(node name must equal Oxide instance name for bootstrap). - Small code change in the same PR: when the name lookup returns not-found, wrap the error with a hint that the node name must match the instance name, so the failure is diagnosable from logs.
Done when
The requirement is in the README and the failure mode is diagnosable from CCM logs.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with getInstance in internal/provider/instances_v2.go and trace the no-provider-ID name lookup, then inspect README.adoc for the node bootstrap requirements. Document that the Kubernetes node name must match the Oxide instance name, and make the not-found failure diagnosable in CCM logs with that requirement. Done means both the README and logs explain the failure mode.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, kubernetes
- Domain
- backend, cloud
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 74/100