oxidecomputer / oxidecomputer/omicron
instance_view API should include sled ID in response
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
When debugging an instance, it can be helpful to know which sled the instance is running on to determine if the problem appears limited to a given sled. The VM's sled is exposed to operators today via the /v1/system/hardware/sleds/{sled_id}/instances, but to find it the user must iterate over each sled in inventory and search the responses.
$ for sled in $(oxide system hardware sled list | jq -r '.[].id'); do
oxide system hardware sled instance-list --sled-id $sled | jq '.[] | select(.name == "FOOBAR")'
done
Directly exposing the sled ID as part of the response to /v1/instances/{instance} would make this much more convenient.
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 tracing the /v1/instances/{instance} API entry point and compare its response with the sled instance-list endpoint shown in the issue. The work is done when the instance response exposes the sled ID needed to identify its host without iterating over every sled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100