oxidecomputer / oxidecomputer/omicron
need API documentation on disk attach/detach slot impact
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
Today when we are attaching an detaching disks from the API, we have unspecified behavior on the impact of the disk order and slot assignment. This can lead to issues like #5112. There is some current policy that is here. While I think we should be able to specify the slot for attachment, in particular here we want to document:
- How slots are picked on attach? Are holes used, does it append to the end, does it do something else?
- What happens when a disk is removed and holes are created?
- What other impacts this have on the system such as what the current boot disk is?
- Probably a link to a guide or broader in-system documentation about how to understand these different concepts.
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 by reviewing the current disk attachment policy referenced in the issue and tracing the API behavior for disk attach and detach. Document how slots are selected, how removal creates or reuses holes, and the effects on boot-disk or related system behavior. Link the broader in-system guide if one is found, and ensure each listed question has an explicit answer.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100