[installinator] add support for fetching an installinator document (#8733)

Prepare for future work where we're going to transmit other kinds of
artifacts over the wire to installinator -- not just host phase 2 and
control plane.

For compatibility, installinator supports repos both with and without
this document. In the future we can clean this up.

Author: sunshowers

Cargo.lock

@@ -969,6 +969,7 @@ opt-level = 3
 # tufaceous-artifact = { path = "../tufaceous/artifact" }
 # tufaceous-brand-metadata = { path = "../tufaceous/brand-metadata" }
 # tufaceous-lib = { path = "../tufaceous/lib" }
+# Extra slash here to pretend to be a different source.
 
 # [patch."https://github.com/oxidecomputer/typify"]
 # typify = { path = "../typify/typify" }

Cargo.toml

@@ -17,6 +17,7 @@ created repo-1.0.0.zip for system version 1.0.0
 > set target-release repo-1.0.0.zip
 INFO extracting uploaded archive to <EXTRACTING_UPLOADED_ARCHIVE_TO_REDACTED>
 INFO created directory to store extracted artifacts, path: <CREATED_DIRECTORY_TO_STORE_EXTRACTED_ARTIFACTS_PATH_REDACTED>
+INFO added artifact, name: installinator_document, kind: installinator_document, version: 1.0.0, hash: c6ae866031d1183094c92cde9d9d1fd5f18356abc81a842ce31471b473fd5582, length: 367
 INFO added artifact, name: SimGimletSp, kind: gimlet_sp, version: 1.0.0, hash: 7e6667e646ad001b54c8365a3d309c03f89c59102723d38d01697ee8079fe670, length: 747
 INFO added artifact, name: fake-gimlet-rot, kind: gimlet_rot_image_a, version: 1.0.0, hash: 04e4a7fdb84acca92c8fd3235e26d64ea61bef8a5f98202589fd346989c5720a, length: 735
 INFO added artifact, name: fake-gimlet-rot, kind: gimlet_rot_image_b, version: 1.0.0, hash: 04e4a7fdb84acca92c8fd3235e26d64ea61bef8a5f98202589fd346989c5720a, length: 735
@@ -818,6 +819,7 @@ set sled 98e6b7c2-2efa-41ca-b20a-0a4d61102fe6 inventory visibility: visible -> h
 > set target-release repo-1.0.0.zip
 INFO extracting uploaded archive to <EXTRACTING_UPLOADED_ARCHIVE_TO_REDACTED>
 INFO created directory to store extracted artifacts, path: <CREATED_DIRECTORY_TO_STORE_EXTRACTED_ARTIFACTS_PATH_REDACTED>
+INFO added artifact, name: installinator_document, kind: installinator_document, version: 1.0.0, hash: c6ae866031d1183094c92cde9d9d1fd5f18356abc81a842ce31471b473fd5582, length: 367
 INFO added artifact, name: SimGimletSp, kind: gimlet_sp, version: 1.0.0, hash: 7e6667e646ad001b54c8365a3d309c03f89c59102723d38d01697ee8079fe670, length: 747
 INFO added artifact, name: fake-gimlet-rot, kind: gimlet_rot_image_a, version: 1.0.0, hash: 04e4a7fdb84acca92c8fd3235e26d64ea61bef8a5f98202589fd346989c5720a, length: 735
 INFO added artifact, name: fake-gimlet-rot, kind: gimlet_rot_image_b, version: 1.0.0, hash: 04e4a7fdb84acca92c8fd3235e26d64ea61bef8a5f98202589fd346989c5720a, length: 735
@@ -1018,6 +1020,7 @@ created repo-2.0.0.zip for system version 2.0.0
 > sled-update-install-dataset serial2 --from-repo repo-2.0.0.zip
 INFO extracting uploaded archive to <EXTRACTING_UPLOADED_ARCHIVE_TO_REDACTED>
 INFO created directory to store extracted artifacts, path: <CREATED_DIRECTORY_TO_STORE_EXTRACTED_ARTIFACTS_PATH_REDACTED>
+INFO added artifact, name: installinator_document, kind: installinator_document, version: 2.0.0, hash: 065b2b7cde09474c9a1bcf98a8f9c93129f617e074404c6aa76164f440a5627f, length: 367
 INFO added artifact, name: fake-gimlet-sp, kind: gimlet_sp, version: 2.0.0, hash: ce1e98a8a9ae541654508f101d59a3ddeba3d28177f1d42d5614248eef0b820b, length: 751
 INFO added artifact, name: fake-gimlet-rot, kind: gimlet_rot_image_a, version: 2.0.0, hash: e7047f500a5391e22cd8e6a8d3ae66c9d9de7a8d021e6e9a10e05bb6d554da77, length: 743
 INFO added artifact, name: fake-gimlet-rot, kind: gimlet_rot_image_b, version: 2.0.0, hash: e7047f500a5391e22cd8e6a8d3ae66c9d9de7a8d021e6e9a10e05bb6d554da77, length: 743
@@ -1714,6 +1717,7 @@ external DNS:
 > set target-release repo-2.0.0.zip
 INFO extracting uploaded archive to <EXTRACTING_UPLOADED_ARCHIVE_TO_REDACTED>
 INFO created directory to store extracted artifacts, path: <CREATED_DIRECTORY_TO_STORE_EXTRACTED_ARTIFACTS_PATH_REDACTED>
+INFO added artifact, name: installinator_document, kind: installinator_document, version: 2.0.0, hash: 065b2b7cde09474c9a1bcf98a8f9c93129f617e074404c6aa76164f440a5627f, length: 367
 INFO added artifact, name: fake-gimlet-sp, kind: gimlet_sp, version: 2.0.0, hash: ce1e98a8a9ae541654508f101d59a3ddeba3d28177f1d42d5614248eef0b820b, length: 751
 INFO added artifact, name: fake-gimlet-rot, kind: gimlet_rot_image_a, version: 2.0.0, hash: e7047f500a5391e22cd8e6a8d3ae66c9d9de7a8d021e6e9a10e05bb6d554da77, length: 743
 INFO added artifact, name: fake-gimlet-rot, kind: gimlet_rot_image_b, version: 2.0.0, hash: e7047f500a5391e22cd8e6a8d3ae66c9d9de7a8d021e6e9a10e05bb6d554da77, length: 743

dev-tools/reconfigurator-cli/tests/output/cmds-mupdate-update-flow-stdout

@@ -39,6 +39,7 @@ created repo-2.0.0.zip for system version 2.0.0
 > set target-release repo-1.0.0.zip
 INFO extracting uploaded archive to <EXTRACTING_UPLOADED_ARCHIVE_TO_REDACTED>
 INFO created directory to store extracted artifacts, path: <CREATED_DIRECTORY_TO_STORE_EXTRACTED_ARTIFACTS_PATH_REDACTED>
+INFO added artifact, name: installinator_document, kind: installinator_document, version: 1.0.0, hash: c6ae866031d1183094c92cde9d9d1fd5f18356abc81a842ce31471b473fd5582, length: 367
 INFO added artifact, name: SimGimletSp, kind: gimlet_sp, version: 1.0.0, hash: 7e6667e646ad001b54c8365a3d309c03f89c59102723d38d01697ee8079fe670, length: 747
 INFO added artifact, name: fake-gimlet-rot, kind: gimlet_rot_image_a, version: 1.0.0, hash: 04e4a7fdb84acca92c8fd3235e26d64ea61bef8a5f98202589fd346989c5720a, length: 735
 INFO added artifact, name: fake-gimlet-rot, kind: gimlet_rot_image_b, version: 1.0.0, hash: 04e4a7fdb84acca92c8fd3235e26d64ea61bef8a5f98202589fd346989c5720a, length: 735
@@ -103,6 +104,7 @@ sled aff6c093-197d-42c5-ad80-9f10ba051a34: install dataset updated: to target re
 > sled-update-install-dataset serial4 --from-repo repo-2.0.0.zip
 INFO extracting uploaded archive to <EXTRACTING_UPLOADED_ARCHIVE_TO_REDACTED>
 INFO created directory to store extracted artifacts, path: <CREATED_DIRECTORY_TO_STORE_EXTRACTED_ARTIFACTS_PATH_REDACTED>
+INFO added artifact, name: installinator_document, kind: installinator_document, version: 2.0.0, hash: 065b2b7cde09474c9a1bcf98a8f9c93129f617e074404c6aa76164f440a5627f, length: 367
 INFO added artifact, name: fake-gimlet-sp, kind: gimlet_sp, version: 2.0.0, hash: ce1e98a8a9ae541654508f101d59a3ddeba3d28177f1d42d5614248eef0b820b, length: 751
 INFO added artifact, name: fake-gimlet-rot, kind: gimlet_rot_image_a, version: 2.0.0, hash: e7047f500a5391e22cd8e6a8d3ae66c9d9de7a8d021e6e9a10e05bb6d554da77, length: 743
 INFO added artifact, name: fake-gimlet-rot, kind: gimlet_rot_image_b, version: 2.0.0, hash: e7047f500a5391e22cd8e6a8d3ae66c9d9de7a8d021e6e9a10e05bb6d554da77, length: 743

dev-tools/reconfigurator-cli/tests/output/cmds-noop-image-source-stdout

@@ -32,6 +32,7 @@ created repo-1.0.0.zip for system version 1.0.0
 > set target-release repo-1.0.0.zip
 INFO extracting uploaded archive to <EXTRACTING_UPLOADED_ARCHIVE_TO_REDACTED>
 INFO created directory to store extracted artifacts, path: <CREATED_DIRECTORY_TO_STORE_EXTRACTED_ARTIFACTS_PATH_REDACTED>
+INFO added artifact, name: installinator_document, kind: installinator_document, version: 1.0.0, hash: c6ae866031d1183094c92cde9d9d1fd5f18356abc81a842ce31471b473fd5582, length: 367
 INFO added artifact, name: SimGimletSp, kind: gimlet_sp, version: 1.0.0, hash: 7e6667e646ad001b54c8365a3d309c03f89c59102723d38d01697ee8079fe670, length: 747
 INFO added artifact, name: fake-gimlet-rot, kind: gimlet_rot_image_a, version: 1.0.0, hash: 04e4a7fdb84acca92c8fd3235e26d64ea61bef8a5f98202589fd346989c5720a, length: 735
 INFO added artifact, name: fake-gimlet-rot, kind: gimlet_rot_image_b, version: 1.0.0, hash: 04e4a7fdb84acca92c8fd3235e26d64ea61bef8a5f98202589fd346989c5720a, length: 735
@@ -70,6 +71,7 @@ internal DNS generations: 1
 external DNS generations: 1
 target number of Nexus instances: default
 target release (generation 2): 1.0.0 (system-update-v1.0.0.zip)
+    artifact: c6ae866031d1183094c92cde9d9d1fd5f18356abc81a842ce31471b473fd5582 installinator_document (installinator_document version 1.0.0)
     artifact: 7e6667e646ad001b54c8365a3d309c03f89c59102723d38d01697ee8079fe670 gimlet_sp (SimGimletSp version 1.0.0)
     artifact: 04e4a7fdb84acca92c8fd3235e26d64ea61bef8a5f98202589fd346989c5720a gimlet_rot_image_a (fake-gimlet-rot version 1.0.0)
     artifact: 04e4a7fdb84acca92c8fd3235e26d64ea61bef8a5f98202589fd346989c5720a gimlet_rot_image_b (fake-gimlet-rot version 1.0.0)
@@ -147,6 +149,7 @@ internal DNS generations: 1
 external DNS generations: 1
 target number of Nexus instances: default
 target release (generation 2): 1.0.0 (system-update-v1.0.0.zip)
+    artifact: c6ae866031d1183094c92cde9d9d1fd5f18356abc81a842ce31471b473fd5582 installinator_document (installinator_document version 1.0.0)
     artifact: 7e6667e646ad001b54c8365a3d309c03f89c59102723d38d01697ee8079fe670 gimlet_sp (SimGimletSp version 1.0.0)
     artifact: 04e4a7fdb84acca92c8fd3235e26d64ea61bef8a5f98202589fd346989c5720a gimlet_rot_image_a (fake-gimlet-rot version 1.0.0)
     artifact: 04e4a7fdb84acca92c8fd3235e26d64ea61bef8a5f98202589fd346989c5720a gimlet_rot_image_b (fake-gimlet-rot version 1.0.0)

dev-tools/reconfigurator-cli/tests/output/cmds-target-release-stdout

@@ -143,6 +143,7 @@ pub(crate) async fn build_tuf_repo(
         manifest,
         keys,
         expiry,
+        true,
         output_dir.join("repo.zip"),
     )
     .build()

dev-tools/releng/src/tuf.rs

@@ -43,6 +43,9 @@ impl StepSpec for InstallinatorSpec {
 )]
 #[serde(rename_all = "snake_case")]
 pub enum InstallinatorComponent {
+    /// The installinator document.
+    InstallinatorDocument,
+
     /// The host phase 2 component.
     HostPhase2,
 

installinator-common/src/progress.rs

@@ -12,14 +12,19 @@ use installinator_common::EventReport;
 use ipcc::{InstallinatorImageId, Ipcc};
 use omicron_uuid_kinds::MupdateUuid;
 use tokio::sync::mpsc;
-use tufaceous_artifact::{ArtifactHash, ArtifactHashId};
+use tufaceous_artifact::{
+    ArtifactHash, ArtifactHashId, ArtifactKind, KnownArtifactKind,
+};
 
 use crate::{errors::HttpError, fetch::FetchReceiver};
 
 #[derive(Clone, Debug, Eq, PartialEq, Args)]
 pub(crate) struct ArtifactIdOpts {
     /// Retrieve artifact ID from IPCC
-    #[clap(long, required_unless_present_any = ["update_id", "host_phase_2", "control_plane"])]
+    #[clap(
+        long,
+        required_unless_present_any = ["update_id", "host_phase_2", "control_plane", "installinator_doc"]
+    )]
     from_ipcc: bool,
 
     #[clap(
@@ -31,31 +36,100 @@ pub(crate) struct ArtifactIdOpts {
 
     #[clap(
         long,
-        conflicts_with = "from_ipcc",
-        required_unless_present = "from_ipcc"
+        conflicts_with_all = ["from_ipcc", "installinator_doc"],
+        required_unless_present_any = ["from_ipcc", "installinator_doc"],
     )]
     host_phase_2: Option<ArtifactHash>,
 
     #[clap(
         long,
-        conflicts_with = "from_ipcc",
-        required_unless_present = "from_ipcc"
+        conflicts_with_all = ["from_ipcc", "installinator_doc"],
+        required_unless_present_any = ["from_ipcc", "installinator_doc"],
     )]
     control_plane: Option<ArtifactHash>,
+
+    #[clap(
+        long,
+        conflicts_with_all = ["from_ipcc", "host_phase_2", "control_plane"],
+        required_unless_present_any = ["from_ipcc", "host_phase_2", "control_plane"],
+    )]
+    installinator_doc: Option<ArtifactHash>,
 }
 
 impl ArtifactIdOpts {
-    pub(crate) fn resolve(&self) -> Result<InstallinatorImageId> {
+    pub(crate) fn resolve(&self) -> Result<LookupId> {
         if self.from_ipcc {
             let ipcc = Ipcc::new().context("error opening IPCC")?;
-            ipcc.installinator_image_id()
-                .context("error retrieving installinator image ID")
+            let image_id = ipcc
+                .installinator_image_id()
+                .context("error retrieving installinator image ID")?;
+            Ok(LookupId::from_image_id(&image_id))
         } else {
             let update_id = self.update_id.unwrap();
-            let host_phase_2 = self.host_phase_2.unwrap();
-            let control_plane = self.control_plane.unwrap();
+            let kind =
+                if let Some(installinator_doc_hash) = self.installinator_doc {
+                    LookupIdKind::Document(installinator_doc_hash)
+                } else {
+                    LookupIdKind::Hashes {
+                        host_phase_2: self.host_phase_2.unwrap(),
+                        control_plane: self.control_plane.unwrap(),
+                    }
+                };
+
+            Ok(LookupId { update_id, kind })
+        }
+    }
+}
+
+/// Identifiers used by installinator to retrieve artifacts.
+pub(crate) struct LookupId {
+    pub(crate) update_id: MupdateUuid,
+    pub(crate) kind: LookupIdKind,
+}
+
+impl LookupId {
+    fn from_image_id(image_id: &InstallinatorImageId) -> Self {
+        // This sentinel hash is used to indicate that the host phase 2 hash is
+        // actually the hash to the installinator document.
+        let kind = if image_id.control_plane == ArtifactHash([0; 32]) {
+            LookupIdKind::Document(image_id.host_phase_2)
+        } else {
+            LookupIdKind::Hashes {
+                host_phase_2: image_id.host_phase_2,
+                control_plane: image_id.control_plane,
+            }
+        };
+
+        Self { update_id: image_id.update_id, kind }
+    }
+}
+
+/// Either an installinator document hash, or host phase 2 and control plane
+/// hashes.
+pub(crate) enum LookupIdKind {
+    Document(ArtifactHash),
+    Hashes { host_phase_2: ArtifactHash, control_plane: ArtifactHash },
+}
+
+/// The host phase 2 and control plane hashes to download.
+#[derive(Clone, Debug)]
+pub(crate) struct ArtifactsToDownload {
+    pub(crate) host_phase_2: ArtifactHash,
+    pub(crate) control_plane: ArtifactHash,
+}
+
+impl ArtifactsToDownload {
+    pub(crate) fn host_phase_2_id(&self) -> ArtifactHashId {
+        ArtifactHashId {
+            kind: ArtifactKind::HOST_PHASE_2,
+            hash: self.host_phase_2,
+        }
+    }
 
-            Ok(InstallinatorImageId { update_id, host_phase_2, control_plane })
+    pub(crate) fn control_plane_id(&self) -> ArtifactHashId {
+        ArtifactHashId {
+            kind: KnownArtifactKind::ControlPlane.into(),
+            hash: self.control_plane,
         }
     }
 }