oxidecomputer / oxidecomputer/omicron
Inventory: `SledRole::Gimlet` is misleading w.r.t. Cosmo
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
Our inventory system has this enum: https://github.com/oxidecomputer/omicron/blob/fef36e5bb32ba7fc69cd967680f47377c625df3d/nexus-sled-agent-shared/src/inventory.rs#L970-L976
The doc comments are correct, but the variant names are misleading; in particular, a non-scrimlet Cosmo sled in inventory will report it has a role of Gimlet.
Contributor guide
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 the SledRole enum in nexus-sled-agent-shared/src/inventory.rs at the linked lines, then search for all references to its variants and inventory role reporting. Choose names that distinguish Cosmo from Gimlet while preserving the documented roles, update affected references, and verify the inventory behavior and tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100