oxidecomputer / oxidecomputer/omicron
Nexus should have an API endpoint to return Oxide version
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
The External API should have an endpoint that allows a user/operator to query what version of software is running on the Oxide system.
At the very least, this should return the major release for the whole system (e.g. r13 / r14) but it would be useful if it could also return versions of specific components like omicron (perhaps even displaying the current versions of software running on each sled/SP where appropriate).
This would make it easier to understand what code you're interacting with, especially when trying to replicate a customer environment... that way you don't need to know in advance what version they are running or what you have installed in your environment.
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 surveying the External API entry points and how Oxide system and component versions are represented. Clarify whether the endpoint must return only the major release or also versions for omicron and software running on each sled/SP. Done means an agreed response exposes the running system version for customer-environment identification.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100