[3/3] Add `omdb support-bundle collect` subcommand by smklein · Pull Request #10376 · oxidecomputer/omicron

smklein · 2026-05-05T20:46:04Z

Wires a new subcommand on omdb that calls into the support-bundle-collection crate to gather a bundle locally. Unlike the Nexus background task, this path does not register a row in the support_bundle table, does not transfer the bundle to a sled agent, and does not require Nexus to be up — it only needs CRDB, internal DNS, MGS, and sled-agents reachable on the underlay.

When Nexus is down (an important time to gather a bundle), an operator can still produce one locally.

Builds on #10374 and #10375

Fixes #10371

Replaces `BundleCollection.bundle: SupportBundle` with a slim `BundleInfo { id, reason_for_creation }`. Moves the sled-storage chunked transfer (`store_bundle_on_sled`), zip helpers (`bundle_to_zipfile`, `recursively_add_directory_to_zipfile`, `sha2_hash`), the `CHUNK_SIZE` and `TEMPDIR` constants, and the DB-polling cancellation (`check_for_cancellation`) out of the inner `support_bundle/` module and into `support_bundle_collector.rs`. After this change the inner layer is a pure mechanism: it never reads the `support_bundle` DB row, never talks to a sled-agent's bundle storage endpoints, and treats CRDB only as a source of facts about sleds, ereports, and blueprints. The outer collector remains the manager of the bundle lifecycle. This is the first step toward a future shared crate that omdb can use to collect bundles when Nexus is down.

Lifts `nexus/src/app/background/tasks/support_bundle/` (the mechanism layer) into a new top-level crate `support-bundle-collection` so that both Nexus and omdb can call it. No logic changes; pure relocation plus import rewriting.

Wires a new subcommand on omdb that calls into the `support-bundle-collection` crate to gather a bundle locally. Unlike the Nexus background task, this path does not register a row in the `support_bundle` table, does not transfer the bundle to a sled agent, and does not require Nexus to be up — it only needs CRDB, internal DNS, MGS, and sled-agents reachable on the underlay. This is intended for incident response: when Nexus is down (the most important time to gather a bundle), an operator can still produce one locally.

wfchandler

Thanks for putting this together! Just a couple questions.

wfchandler · 2026-05-20T02:34:57Z

+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, ValueEnum)]
+enum BundleCategory {
+    Reconfigurator,
+    HostInfo,
+    SledCubbyInfo,
+    SpDumps,
+    Ereports,
+}


This seems like something that could fall out of sync pretty easily. Could we add a test asserting our copy has the same variants as the original?

I think our dependencies line up in such a way that it's actually not too bad to just "directly use the nexus_types type". I'll do that instead.

Done in e3e45e4

wfchandler · 2026-05-20T02:46:06Z

+    /// Path where the resulting bundle zip will be written.
+    #[clap(long, short = 'o')]
+    output: Utf8PathBuf,


It would be useful to have an option for streaming the bytes of the bundle directly to stdout. I think we had discussed the possibility of in our meeting a few weeks ago.

Using the switch zone to store both the final archive bundle and its constituent parts in tempdir feels like a bit of a risk when requesting a full bundle.

Sure thing, added the ability to stream to stdout in c1a72bb (avoiding the intermediate file)

wfchandler · 2026-05-20T02:56:01Z

+        if let Some(ereports) = &report.ereports {
+            eprintln!(
+                "ereports: {} found, {} collected, {} errors",
+                ereports.n_found,
+                ereports.n_collected,
+                ereports.errors.len(),
+            );
+        }


I'm not necessarily opposed to this, but I'm curious why ereports merit a special call-out here, versus, say, the number of SP dumps.

it is a little arbitrary - ereports are currently the only support bundle collection step that can silently skip individual items (where "n_found != n_collected", with ereport.errors justifying "why"). Other collection steps are more pass/fail, so their steps describe them.

I could try to store this some other way, if we want, but it's currently describing the format of SupportBundleCollectionReport.

I could try to save this summary info within the bundle itself, but maybe that should be a follow-up PR, as it changes the contents of bundles themselves?

Thanks for explaining. Agree nothing needs to change here, should we file an issue for adding a bundle summary?

wfchandler

Thanks again! Nothing further from me

wfchandler · 2026-05-26T17:43:36Z

+        if let Some(ereports) = &report.ereports {
+            eprintln!(
+                "ereports: {} found, {} collected, {} errors",
+                ereports.n_found,
+                ereports.n_collected,
+                ereports.errors.len(),
+            );
+        }


Thanks for explaining. Agree nothing needs to change here, should we file an issue for adding a bundle summary?

smklein force-pushed the move-support-bundle-collection-crate branch 2 times, most recently from b8d58f2 to adecbd6 Compare May 5, 2026 22:04

smklein force-pushed the omdb-support-bundle-collect branch from 5eefdfd to 9022f6d Compare May 5, 2026 22:04

smklein force-pushed the move-support-bundle-collection-crate branch from adecbd6 to d20d559 Compare May 8, 2026 00:03

smklein force-pushed the omdb-support-bundle-collect branch from 9022f6d to 046faaa Compare May 8, 2026 00:03

smklein added 2 commits May 7, 2026 17:09

Move support bundle collection into a shared crate

863c24b

Lifts `nexus/src/app/background/tasks/support_bundle/` (the mechanism layer) into a new top-level crate `support-bundle-collection` so that both Nexus and omdb can call it. No logic changes; pure relocation plus import rewriting.

smklein force-pushed the move-support-bundle-collection-crate branch from d20d559 to 863c24b Compare May 8, 2026 00:13

smklein force-pushed the omdb-support-bundle-collect branch 2 times, most recently from 1310da4 to b26398c Compare May 8, 2026 00:33

smklein marked this pull request as ready for review May 8, 2026 00:51

smklein mentioned this pull request May 8, 2026

[4/3] Place SP task dumps under sp_task_dumps/ in support bundles #10411

Open

smklein force-pushed the omdb-support-bundle-collect branch from b26398c to d180d48 Compare May 8, 2026 01:08

smklein requested review from papertigers and wfchandler May 8, 2026 01:10

wfchandler reviewed May 20, 2026

View reviewed changes

Base automatically changed from move-support-bundle-collection-crate to main May 20, 2026 22:59

smklein added 4 commits May 22, 2026 10:00

merge

641724e

Re-use BundleDataCategory enum

e3e45e4

Allow streaming to stdout, avoid intermediate file

c1a72bb

Add destructive argument

7e4e6bb

wfchandler approved these changes May 26, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[3/3] Add `omdb support-bundle collect` subcommand#10376

[3/3] Add `omdb support-bundle collect` subcommand#10376
smklein wants to merge 7 commits into
mainfrom
omdb-support-bundle-collect

smklein commented May 5, 2026 •

edited

Loading

Uh oh!

wfchandler left a comment

Uh oh!

wfchandler May 20, 2026

Uh oh!

smklein May 22, 2026

Uh oh!

smklein May 22, 2026

Uh oh!

wfchandler May 20, 2026

Uh oh!

smklein May 22, 2026

Uh oh!

Uh oh!

wfchandler May 20, 2026

Uh oh!

smklein May 22, 2026

Uh oh!

wfchandler May 26, 2026

Uh oh!

Uh oh!

wfchandler left a comment

Uh oh!

wfchandler May 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

smklein commented May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wfchandler left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wfchandler left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

smklein commented May 5, 2026 •

edited

Loading