oxidecomputer / oxidecomputer/omicron

`omdb` command to better summarize what update is currently doing

Open
#10,540 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
572
Forks
97
Avg merge
2d 12h
Merged PRs (30d)
96

Description

The Reconfigurator ops guide describes how to figure out what's going on when an update is stuck:
https://github.com/oxidecomputer/omicron/blob/main/docs/reconfigurator-ops-guide.adoc#debug-stuck

but it does involve a few different commands to query a few different components. It'd be handy to have a command like omdb reconfigurator update-activity (that's a terrible name) that reports a bunch of it together. It could report:

  • whether an update is in progress
  • similar output as update-status: counts of components at various versions
  • the last blueprint (or the last few), what time they were, and what they did (i.e., their comment and/or a diff)
  • (a warning if the last blueprint was too long ago and the update is not finished)
  • any errors or warnings from relevant tasks: blueprint planner, blueprint execution, rendezvous, etc.
  • the latest planning report from some Nexus
  • the latest execution report from some Nexus

It's worth spending some time figuring out how to best present this information so that it's as clear as possible what the current status is.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/reconfigurator-ops-guide.adoc#debug-stuck and the existing update-status command to identify the current queries and components involved. Determine how omdb reconfigurator update-activity should combine update progress, blueprint history, task warnings, and Nexus reports. Done means the command presents the relevant current status clearly in one place.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.