Store PlanningReports in database for debugging only (PR 1/2) (#9029)

#8631 introduced `PlanningReport`s for blueprints. We've wanted to store
them in the database all along, but have punted on doing so because:

1. They're highly structured, making them difficult to map to SQL /
diesel
2. We expect to want to change them pretty frequently at least in the
near/mid term, which compounds problem 1

Chatting with @davepacheco, we came up with a compromise:

* These reports are not intended for programmatic consumption, and are
primarily useful as a debugging aid. (We want to report _something_ to
operators, but not at this level of detail. More on this momentarily.)
* Therefore, it seems okay to punt on the diesel / SQL problem by
storing these as serialized JSON blobs, under the condition that we
never attempt to parse them in Nexus proper, and therefore don't have to
deal with versioning.
* We can (and this PR does) add an `omdb` subcommand that _attempts_ to
parse them; if omdb and the Nexus that produced the report are out of
sync, this parsing may fail, but that's okay in that we can still at
least dump the raw JSON out. This PR hedges on this a bit by storing the
git commit in the JSON blob, so at least omdb can warn if it's expected
that it can't parse it (and note the git commit from which the support
operator would need an omdb to parse it successfully).

Author: jgallagher

Cargo.lock

@@ -768,6 +768,7 @@ url = "2.5.4"
 usdt = "0.5.0"
 uuid = { version = "1.17.0", features = ["serde", "v4"] }
 uzers = "0.12"
+vergen-gitcl = { version = "1.0.8" }
 walkdir = "2.5"
 whoami = "1.5"
 wicket = { path = "wicket" }

Cargo.toml

@@ -9,6 +9,7 @@ workspace = true
 
 [build-dependencies]
 omicron-rpaths.workspace = true
+vergen-gitcl.workspace = true
 
 [dependencies]
 anyhow.workspace = true

dev-tools/omdb/Cargo.toml

@@ -2,9 +2,28 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-// See omicron-rpaths for documentation.
-// NOTE: This file MUST be kept in sync with the other build.rs files in this
-// repository.
+use vergen_gitcl::Emitter;
+use vergen_gitcl::GitclBuilder;
+
 fn main() {
+    // See omicron-rpaths for documentation. NOTE: This file MUST be kept in
+    // sync with the other build.rs files in this repository.
     omicron_rpaths::configure_default_omicron_rpaths();
+
+    // Define the `VERGEN_GIT_SHA` and `VERGEN_GIT_DIRTY` environment variables
+    // (accessible via `env!()`) that note the current git commit and whether
+    // the working tree is dirty at the time of this build.
+    //
+    // We use this to check our own git SHA against the git SHA of the Nexus
+    // that generated blueprint planner debug logs.
+    let gitcl = GitclBuilder::default()
+        .sha(/* short= */ false)
+        .dirty(/* include_untracked= */ false)
+        .build()
+        .expect("valid GitclBuilder configuration");
+    Emitter::default()
+        .add_instructions(&gitcl)
+        .expect("valid instructions")
+        .emit()
+        .expect("emitted version information");
 }

dev-tools/omdb/build.rs

@@ -19,6 +19,7 @@
 
 use crate::Omdb;
 use crate::check_allow_destructive::DestructiveOperationToken;
+use crate::db::blueprints::cmd_db_blueprints;
 use crate::db::ereport::cmd_db_ereport;
 use crate::helpers::CONNECTION_OPTIONS_HEADING;
 use crate::helpers::DATABASE_OPTIONS_HEADING;
@@ -173,6 +174,7 @@ use tabled::Tabled;
 use uuid::Uuid;
 
 mod alert;
+mod blueprints;
 mod db_metadata;
 mod ereport;
 mod saga;
@@ -342,6 +344,10 @@ pub struct DbFetchOptions {
 /// Subcommands that query or update the database
 #[derive(Debug, Subcommand, Clone)]
 enum DbCommands {
+    /// Print information about blueprints
+    ///
+    /// Most blueprint information is available via `omdb nexus`, not `omdb db`.
+    Blueprints(blueprints::BlueprintsArgs),
     /// Commands for database metadata
     DbMetadata(DbMetadataArgs),
     /// Commands relevant to Crucible datasets
@@ -1134,6 +1140,9 @@ impl DbArgs {
         self.db_url_opts.with_datastore(omdb, log, |opctx, datastore| {
             async move {
                 match &self.command {
+                    DbCommands::Blueprints(args) => {
+                        cmd_db_blueprints(&opctx, &datastore, &fetch_opts, &args).await
+                    }
                     DbCommands::DbMetadata(DbMetadataArgs {
                         command: DbMetadataCommands::ListNexus,
                     }) => {