openapi

Author: jgallagher

dev-tools/omdb/src/bin/omdb/db.rs

@@ -7579,8 +7579,8 @@ fn inv_collection_print_sled_config(label: &str, config: &OmicronSledConfig) {
         HostPhase2DesiredContents::CurrentContents => {
             Cow::Borrowed("keep existing current contents")
         }
-        HostPhase2DesiredContents::Artifact(artifact) => {
-            Cow::Owned(format!("artifact {artifact}"))
+        HostPhase2DesiredContents::Artifact { hash } => {
+            Cow::Owned(format!("artifact {hash}"))
         }
     };
     println!(

nexus-sled-agent-shared/src/inventory.rs

@@ -581,6 +581,7 @@ pub enum SledRole {
 #[derive(
     Clone, Copy, Debug, Deserialize, Serialize, JsonSchema, PartialEq, Eq,
 )]
+#[serde(tag = "type", rename_all = "snake_case")]
 pub enum HostPhase2DesiredContents {
     /// Do not change the current contents.
     ///
@@ -593,11 +594,12 @@ pub enum HostPhase2DesiredContents {
     /// Set the phase 2 slot to the given artifact.
     ///
     /// The artifact will come from an unpacked and distributed TUF repo.
-    Artifact(ArtifactHash),
+    Artifact { hash: ArtifactHash },
 }
 
 /// Describes the desired contents for both host phase 2 slots.
 #[derive(Clone, Debug, Deserialize, Serialize, JsonSchema, PartialEq, Eq)]
+#[serde(rename_all = "snake_case")]
 pub struct HostPhase2DesiredSlots {
     pub slot_a: HostPhase2DesiredContents,
     pub slot_b: HostPhase2DesiredContents,

nexus/db-model/src/inventory.rs

@@ -1980,8 +1980,8 @@ impl From<HostPhase2DesiredSlots> for DbHostPhase2DesiredSlots {
     fn from(value: HostPhase2DesiredSlots) -> Self {
         let remap = |desired| match desired {
             HostPhase2DesiredContents::CurrentContents => None,
-            HostPhase2DesiredContents::Artifact(artifact) => {
-                Some(ArtifactHash(artifact))
+            HostPhase2DesiredContents::Artifact { hash } => {
+                Some(ArtifactHash(hash))
             }
         };
         Self {
@@ -1995,8 +1995,8 @@ impl From<DbHostPhase2DesiredSlots> for HostPhase2DesiredSlots {
     fn from(value: DbHostPhase2DesiredSlots) -> Self {
         let remap = |maybe_artifact| match maybe_artifact {
             None => HostPhase2DesiredContents::CurrentContents,
-            Some(ArtifactHash(artifact)) => {
-                HostPhase2DesiredContents::Artifact(artifact)
+            Some(ArtifactHash(hash)) => {
+                HostPhase2DesiredContents::Artifact { hash }
             }
         };
         Self {

openapi/sled-agent.json

@@ -4722,6 +4722,62 @@
           }
         ]
       },
+      "HostPhase2DesiredContents": {
+        "description": "Describes the desired contents of a host phase 2 slot (i.e., the boot partition on one of the internal M.2 drives).",
+        "oneOf": [
+          {
+            "description": "Do not change the current contents.\n\nWe use this value when we've detected a sled has been mupdated (and we don't want to overwrite phase 2 images until we understand how to recover from that mupdate) and as the default value when reading an [`OmicronSledConfig`] that was ledgered before this concept existed.",
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "current_contents"
+                ]
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          {
+            "description": "Set the phase 2 slot to the given artifact.\n\nThe artifact will come from an unpacked and distributed TUF repo.",
+            "type": "object",
+            "properties": {
+              "hash": {
+                "type": "string",
+                "format": "hex string (32 bytes)"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "artifact"
+                ]
+              }
+            },
+            "required": [
+              "hash",
+              "type"
+            ]
+          }
+        ]
+      },
+      "HostPhase2DesiredSlots": {
+        "description": "Describes the desired contents for both host phase 2 slots.",
+        "type": "object",
+        "properties": {
+          "slot_a": {
+            "$ref": "#/components/schemas/HostPhase2DesiredContents"
+          },
+          "slot_b": {
+            "$ref": "#/components/schemas/HostPhase2DesiredContents"
+          }
+        },
+        "required": [
+          "slot_a",
+          "slot_b"
+        ]
+      },
       "HostPortConfig": {
         "type": "object",
         "properties": {
@@ -5874,6 +5930,21 @@
           "generation": {
             "$ref": "#/components/schemas/Generation"
           },
+          "host_phase_2": {
+            "default": {
+              "slot_a": {
+                "type": "current_contents"
+              },
+              "slot_b": {
+                "type": "current_contents"
+              }
+            },
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/HostPhase2DesiredSlots"
+              }
+            ]
+          },
           "remove_mupdate_override": {
             "nullable": true,
             "allOf": [