server: consolidate VM creation APIs

.github/buildomat/phd-run-with-args.sh

@@ -65,8 +65,7 @@ failcount=$?
 set -e
 
 tar -czvf /tmp/phd-tmp-files.tar.gz \
-	-C /tmp/propolis-phd /tmp/propolis-phd/*.log \
-	-C /tmp/propolis-phd /tmp/propolis-phd/*.toml
+	-C /tmp/propolis-phd /tmp/propolis-phd/*.log
 
 exitcode=0
 if [ $failcount -eq 0 ]; then

Cargo.toml

@@ -46,7 +46,7 @@ bhyve_api_sys = { path = "crates/bhyve-api/sys" }
 cpuid_utils = { path = "crates/cpuid-utils" }
 cpuid_profile_config = { path = "crates/cpuid-profile-config" }
 dladm = { path = "crates/dladm" }
-propolis-server-config = { path = "crates/propolis-server-config" }
+propolis-config-toml = { path = "crates/propolis-config-toml" }
 propolis_api_types = { path = "crates/propolis-api-types" }
 propolis_types = { path = "crates/propolis-types" }
 rfb = { path = "crates/rfb" }
@@ -145,6 +145,7 @@ serde_arrays = "0.1"
 serde_derive = "1.0"
 serde_json = "1.0"
 serde_test = "1.0.138"
+serde_with = "3.11.0"
 slog = "2.7"
 slog-async = "2.8"
 slog-bunyan = "2.4.0"

README.md

@@ -36,7 +36,8 @@ implementation details, consumed by Propolis components.
 
 - bhyve-api: API (ioctls & structs) for the illumos bhyve kernel VMM
 - dladm: Some thin wrappers around `dladm` queries
-- propolis-server-config: Type definitions for `propolis-server` config file
+- propolis-config-toml: Type definitions for expressing static Propolis server
+  configurations in TOML format
 - propolis-types: Publically exposed (via `propolis-server`) types, intergral
   to the `propolis` library
 - viona-api: API (ioctls & structs) for the illumos viona driver

bin/mock-server/src/lib/api_types.rs

@@ -22,7 +22,6 @@ impl TryFrom<types::PciPath> for propolis_types::PciPath {
             .map_err(|e| e.to_string())
     }
 }
-pub use propolis_types::PciPath;
 
 // Duplicate the parameter types for the endpoints related to the serial console
 

bin/mock-server/src/lib/lib.rs

@@ -4,28 +4,24 @@
 
 //! Implementation of a mock Propolis server
 
-use std::io::{Error as IoError, ErrorKind};
 use std::sync::Arc;
 
-use base64::Engine;
 use dropshot::{
     channel, endpoint, ApiDescription, HttpError, HttpResponseCreated,
     HttpResponseOk, HttpResponseUpdatedNoContent, Query, RequestContext,
     TypedBody, WebsocketConnection,
 };
 use futures::SinkExt;
-use slog::{error, info, Logger};
+use slog::{error, Logger};
 use thiserror::Error;
 use tokio::sync::{watch, Mutex};
 use tokio_tungstenite::tungstenite::protocol::{Role, WebSocketConfig};
 use tokio_tungstenite::tungstenite::Message;
 use tokio_tungstenite::WebSocketStream;
 
 mod api_types;
-mod copied;
 
-use crate::copied::{slot_to_pci_path, SlotType};
-use api_types::types as api;
+use api_types::types::{self as api, InstanceEnsureRequest};
 
 #[derive(Debug, Eq, PartialEq, Error)]
 pub enum Error {
@@ -140,13 +136,7 @@ async fn instance_ensure(
     request: TypedBody<api::InstanceEnsureRequest>,
 ) -> Result<HttpResponseCreated<api::InstanceEnsureResponse>, HttpError> {
     let server_context = rqctx.context();
-    let request = request.into_inner();
-    let (properties, nics, disks, cloud_init_bytes) = (
-        request.properties,
-        request.nics,
-        request.disks,
-        request.cloud_init_bytes,
-    );
+    let InstanceEnsureRequest { properties, .. } = request.into_inner();
 
     // Handle an already-initialized instance
     let mut instance = server_context.instance.lock().await;
@@ -160,58 +150,6 @@ async fn instance_ensure(
             migrate: None,
         }));
     }
-
-    // Perform some basic validation of the requested properties
-    for nic in &nics {
-        info!(server_context.log, "Creating NIC: {:#?}", nic);
-        slot_to_pci_path(nic.slot, SlotType::Nic).map_err(|e| {
-            let err = IoError::new(
-                ErrorKind::InvalidData,
-                format!("Cannot parse vnic PCI: {}", e),
-            );
-            HttpError::for_internal_error(format!(
-                "Cannot build instance: {}",
-                err
-            ))
-        })?;
-    }
-
-    for disk in &disks {
-        info!(server_context.log, "Creating Disk: {:#?}", disk);
-        slot_to_pci_path(disk.slot, SlotType::Disk).map_err(|e| {
-            let err = IoError::new(
-                ErrorKind::InvalidData,
-                format!("Cannot parse disk PCI: {}", e),
-            );
-            HttpError::for_internal_error(format!(
-                "Cannot build instance: {}",
-                err
-            ))
-        })?;
-        info!(server_context.log, "Disk {} created successfully", disk.name);
-    }
-
-    if let Some(cloud_init_bytes) = &cloud_init_bytes {
-        info!(server_context.log, "Creating cloud-init disk");
-        slot_to_pci_path(api::Slot(0), SlotType::CloudInit).map_err(|e| {
-            let err = IoError::new(ErrorKind::InvalidData, e.to_string());
-            HttpError::for_internal_error(format!(
-                "Cannot build instance: {}",
-                err
-            ))
-        })?;
-        base64::engine::general_purpose::STANDARD
-            .decode(cloud_init_bytes)
-            .map_err(|e| {
-                let err = IoError::new(ErrorKind::InvalidInput, e.to_string());
-                HttpError::for_internal_error(format!(
-                    "Cannot build instance: {}",
-                    err
-                ))
-            })?;
-        info!(server_context.log, "cloud-init disk created");
-    }
-
     *instance = Some(InstanceContext::new(properties, &server_context.log));
     Ok(HttpResponseCreated(api::InstanceEnsureResponse { migrate: None }))
 }

bin/propolis-cli/Cargo.toml

@@ -7,9 +7,11 @@ edition = "2021"
 [dependencies]
 anyhow.workspace = true
 clap = { workspace = true, features = ["derive"] }
+crucible-client-types.workspace = true
 futures.workspace = true
 libc.workspace = true
 newtype-uuid.workspace = true
+propolis-config-toml.workspace = true
 propolis-client.workspace = true
 slog.workspace = true
 slog-async.workspace = true

bin/propolis-cli/README.md

@@ -0,0 +1,43 @@
+# Propolis CLI
+
+The `propolis-cli` utility provides a user-friendly frontend to the
+[`propolis-server`](../propolis-server) REST API.
+
+## Getting started
+
+The easiest way to launch a VM via the CLI is to write a TOML file describing
+the VM's configuration. An example of such a file might be the following:
+
+```toml
+bootrom = "/path/to/bootrom/OVMF_CODE.fd"
+
+[block_dev.alpine_iso]
+type = "file"
+path = "/path/to/alpine-extended-3.12.0-x86_64.iso"
+
+[dev.block0]
+driver = "pci-virtio-block"
+block_dev = "alpine_iso"
+pci-path = "0.4.0"
+
+[dev.net0]
+driver = "pci-virtio-viona"
+vnic = "vnic_name"
+pci-path = "0.5.0"
+```
+
+To create and run a Propolis VM using this configuration:
+
+```
+# propolis-cli -s <server ip> -p <port> new --config-toml <path> <VM name>
+# propolis-cli -s <server ip> -p <port> state run
+```
+
+To connect to the VM's serial console:
+
+```
+# propolis-cli -s <server ip> -p <port> serial
+```
+
+Run `propolis-cli --help` to see the full list of supported commands and their
+arguments.