add disk create or attach params to InstanceCreate

Author: jmpesp

nexus/src/external_api/params.rs

@@ -125,6 +125,22 @@ impl Default for InstanceNetworkInterfaceAttachment {
     }
 }
 
+/// Describe the instance's disks at creation time
+#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
+#[serde(tag = "type")]
+pub enum InstanceDiskAttachment {
+    /// During instance creation, create and attach disks
+    Create(DiskCreate),
+
+    /// During instance creation, attach this disk
+    Attach(InstanceDiskAttach),
+}
+
+#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema, Default)]
+pub struct InstanceDiskAttach {
+    disks: Vec<Uuid>,
+}
+
 /**
  * Create-time parameters for an [`Instance`](omicron_common::api::external::Instance)
  */
@@ -139,6 +155,10 @@ pub struct InstanceCreate {
     /// The network interfaces to be created for this instance.
     #[serde(default)]
     pub network_interfaces: InstanceNetworkInterfaceAttachment,
+
+    /// The disks to be created or attached for this instance.
+    #[serde(default)]
+    pub disks: Vec<InstanceDiskAttachment>,
 }
 
 /**

nexus/test-utils/src/resource_helpers.rs

@@ -143,6 +143,7 @@ pub async fn create_instance(
             hostname: String::from("the_host"),
             network_interfaces:
                 params::InstanceNetworkInterfaceAttachment::Default,
+            disks: vec![],
         },
     )
     .await

nexus/tests/integration_tests/instances.rs

@@ -146,6 +146,7 @@ async fn test_instances_create_reboot_halt(
                 hostname: instance.hostname.clone(),
                 network_interfaces:
                     params::InstanceNetworkInterfaceAttachment::Default,
+                disks: vec![],
             }))
             .expect_status(Some(StatusCode::BAD_REQUEST)),
     )
@@ -577,6 +578,7 @@ async fn test_instance_with_single_explicit_ip_address(
         memory: ByteCount::from_mebibytes_u32(4),
         hostname: String::from("nic-test"),
         network_interfaces: interface_params,
+        disks: vec![],
     };
     let response =
         NexusRequest::objects_post(client, &url_instances, &instance_params)
@@ -692,6 +694,7 @@ async fn test_instance_with_new_custom_network_interfaces(
         memory: ByteCount::from_mebibytes_u32(4),
         hostname: String::from("nic-test"),
         network_interfaces: interface_params,
+        disks: vec![],
     };
     let response =
         NexusRequest::objects_post(client, &url_instances, &instance_params)
@@ -784,6 +787,7 @@ async fn test_instance_create_delete_network_interface(
         memory: ByteCount::from_mebibytes_u32(4),
         hostname: String::from("nic-test"),
         network_interfaces: params::InstanceNetworkInterfaceAttachment::None,
+        disks: vec![],
     };
     let response =
         NexusRequest::objects_post(client, &url_instances, &instance_params)
@@ -966,6 +970,7 @@ async fn test_instance_with_multiple_nics_unwinds_completely(
         memory: ByteCount::from_mebibytes_u32(4),
         hostname: String::from("nic-test"),
         network_interfaces: interface_params,
+        disks: vec![],
     };
     let builder =
         RequestBuilder::new(client, http::Method::POST, &url_instances)

nexus/tests/integration_tests/subnet_allocation.rs

@@ -42,6 +42,7 @@ async fn create_instance_expect_failure(
         memory: ByteCount::from_mebibytes_u32(256),
         hostname: name.to_string(),
         network_interfaces: params::InstanceNetworkInterfaceAttachment::Default,
+        disks: vec![],
     };
 
     NexusRequest::new(

nexus/tests/integration_tests/unauthorized.rs

@@ -234,6 +234,7 @@ lazy_static! {
             memory: ByteCount::from_gibibytes_u32(16),
             hostname: String::from("demo-instance"),
             network_interfaces: params::InstanceNetworkInterfaceAttachment::Default,
+            disks: vec![],
         };
 }
 

openapi/nexus.json

@@ -4333,6 +4333,13 @@
           "description": {
             "type": "string"
           },
+          "disks": {
+            "description": "The disks to be created or attached for this instance.",
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/InstanceDiskAttachment"
+            }
+          },
           "hostname": {
             "type": "string"
           },
@@ -4362,6 +4369,72 @@
           "ncpus"
         ]
       },
+      "InstanceDiskAttachment": {
+        "description": "Describe the instance's disks at creation time",
+        "oneOf": [
+          {
+            "description": "During instance creation, create and attach disks",
+            "type": "object",
+            "properties": {
+              "description": {
+                "type": "string"
+              },
+              "name": {
+                "$ref": "#/components/schemas/Name"
+              },
+              "size": {
+                "description": "size of the Disk",
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/ByteCount"
+                  }
+                ]
+              },
+              "snapshot_id": {
+                "nullable": true,
+                "description": "id for snapshot from which the Disk should be created, if any",
+                "type": "string",
+                "format": "uuid"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "Create"
+                ]
+              }
+            },
+            "required": [
+              "description",
+              "name",
+              "size",
+              "type"
+            ]
+          },
+          {
+            "description": "During instance creation, attach this disk",
+            "type": "object",
+            "properties": {
+              "disks": {
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "format": "uuid"
+                }
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "Attach"
+                ]
+              }
+            },
+            "required": [
+              "disks",
+              "type"
+            ]
+          }
+        ]
+      },
       "InstanceMigrate": {
         "description": "Migration parameters for an [`Instance`](omicron_common::api::external::Instance)",
         "type": "object",