[api] reorganize per RFD 619 (#996)

In RFD 619, we've decided on a new way to organize published types; this PR makes the Propolis API conform to the RFD.

Author: sunshowers

Cargo.lock

@@ -56,6 +56,7 @@ nvpair_sys = { path = "crates/nvpair/sys" }
 pbind = { path = "crates/pbind" }
 propolis-config-toml = { path = "crates/propolis-config-toml" }
 propolis_api_types = { path = "crates/propolis-api-types" }
+propolis-api-types-versions = { path = "crates/propolis-api-types-versions" }
 propolis-server-api = { path = "crates/propolis-server-api" }
 propolis_types = { path = "crates/propolis-types" }
 rfb = { path = "crates/rfb" }

Cargo.toml

@@ -28,6 +28,7 @@ futures.workspace = true
 hyper.workspace = true
 serde.workspace = true
 propolis_api_types.workspace = true
+propolis-api-types-versions.workspace = true
 propolis_types.workspace = true
 semver.workspace = true
 serde_json.workspace = true

bin/mock-server/Cargo.toml

@@ -9,7 +9,7 @@ progenitor::generate_api!(
     spec = "../../openapi/propolis-server/propolis-server-latest.json",
     derives = [schemars::JsonSchema],
     replace = {
-        SpecKey = propolis_api_types::instance_spec::SpecKey,
+        SpecKey = propolis_api_types_versions::latest::instance_spec::SpecKey,
     },
     patch = {
         InstanceMetadata = { derives = [Clone, Eq, PartialEq] },

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

@@ -62,6 +62,7 @@ slog-term.workspace = true
 strum = { workspace = true, features = ["derive"] }
 propolis = { workspace = true, features = ["crucible-full", "oximeter"] }
 propolis_api_types = { workspace = true }
+propolis-api-types-versions.workspace = true
 propolis-server-api.workspace = true
 propolis_types.workspace = true
 rgb_frame.workspace = true

bin/propolis-server/Cargo.toml

@@ -46,9 +46,9 @@ use propolis::hw::uart::LpcUart;
 use propolis::hw::{nvme, virtio};
 use propolis::intr_pins;
 use propolis::vmm::{self, Builder, Machine};
+use propolis_api_types::instance::InstanceProperties;
 use propolis_api_types::instance_spec::components::devices::SerialPortNumber;
 use propolis_api_types::instance_spec::{self, SpecKey};
-use propolis_api_types::InstanceProperties;
 use propolis_types::{CpuidIdent, CpuidVendor};
 use slog::info;
 use strum::IntoEnumIterator;

bin/propolis-server/src/lib/initializer.rs

@@ -10,8 +10,8 @@ use propolis::migrate::{
     MigrateCtx, MigrateStateError, Migrator, PayloadOffer, PayloadOffers,
 };
 use propolis::vmm;
+use propolis_api_types::instance::ReplacementComponent;
 use propolis_api_types::instance_spec::SpecKey;
-use propolis_api_types::ReplacementComponent;
 use slog::{error, info, trace, warn};
 use std::collections::BTreeMap;
 use std::convert::TryInto;

bin/propolis-server/src/lib/migrate/destination.rs

@@ -5,7 +5,7 @@
 use bit_field::BitField;
 use dropshot::HttpError;
 use propolis::migrate::MigrateStateError;
-use propolis_api_types::MigrationState;
+use propolis_api_types::migration::MigrationState;
 use serde::{Deserialize, Serialize};
 use slog::error;
 use thiserror::Error;

bin/propolis-server/src/lib/migrate/mod.rs

@@ -4,10 +4,8 @@
 
 use std::collections::BTreeMap;
 
-use propolis_api_types::{
-    instance_spec::{v0::ComponentV0, SpecKey, VersionedInstanceSpec},
-    ReplacementComponent,
-};
+use propolis_api_types::instance::ReplacementComponent;
+use propolis_api_types_versions::v1;
 use serde::{Deserialize, Serialize};
 
 use crate::spec::{api_spec_v0::ApiSpecError, Spec};
@@ -16,12 +14,14 @@ use super::MigrateError;
 
 #[derive(Deserialize, Serialize, Debug)]
 pub(crate) struct Preamble {
-    pub instance_spec: VersionedInstanceSpec,
+    pub instance_spec: v1::instance_spec::VersionedInstanceSpec,
     pub blobs: Vec<Vec<u8>>,
 }
 
 impl Preamble {
-    pub fn new(instance_spec: VersionedInstanceSpec) -> Preamble {
+    pub fn new(
+        instance_spec: v1::instance_spec::VersionedInstanceSpec,
+    ) -> Preamble {
         Preamble { instance_spec, blobs: Vec::new() }
     }
 
@@ -35,15 +35,22 @@ impl Preamble {
     /// not present in the source spec, this routine fails.
     pub fn amend_spec(
         self,
-        replacements: &BTreeMap<SpecKey, ReplacementComponent>,
+        replacements: &BTreeMap<
+            v1::instance_spec::SpecKey,
+            ReplacementComponent,
+        >,
     ) -> Result<Spec, MigrateError> {
-        fn wrong_type_error(id: &SpecKey, kind: &str) -> MigrateError {
+        fn wrong_type_error(
+            id: &v1::instance_spec::SpecKey,
+            kind: &str,
+        ) -> MigrateError {
             let msg =
                 format!("component {id} is not a {kind} in the source spec");
             MigrateError::InstanceSpecsIncompatible(msg)
         }
 
-        let VersionedInstanceSpec::V0(mut source_spec) = self.instance_spec;
+        let v1::instance_spec::VersionedInstanceSpec::V0(mut source_spec) =
+            self.instance_spec;
         for (id, comp) in replacements {
             let Some(to_amend) = source_spec.components.get_mut(id) else {
                 return Err(MigrateError::InstanceSpecsIncompatible(format!(
@@ -64,7 +71,9 @@ impl Preamble {
 
                 #[cfg(feature = "failure-injection")]
                 ReplacementComponent::MigrationFailureInjector(comp) => {
-                    let ComponentV0::MigrationFailureInjector(src) = to_amend
+                    let v1::instance_spec::Component::MigrationFailureInjector(
+                        src,
+                    ) = to_amend
                     else {
                         return Err(wrong_type_error(
                             id,
@@ -75,15 +84,18 @@ impl Preamble {
                     *src = comp.clone();
                 }
                 ReplacementComponent::CrucibleStorageBackend(comp) => {
-                    let ComponentV0::CrucibleStorageBackend(src) = to_amend
+                    let v1::instance_spec::Component::CrucibleStorageBackend(
+                        src,
+                    ) = to_amend
                     else {
                         return Err(wrong_type_error(id, "crucible backend"));
                     };
 
                     *src = comp.clone();
                 }
                 ReplacementComponent::VirtioNetworkBackend(comp) => {
-                    let ComponentV0::VirtioNetworkBackend(src) = to_amend
+                    let v1::instance_spec::Component::VirtioNetworkBackend(src) =
+                        to_amend
                     else {
                         return Err(wrong_type_error(id, "viona backend"));
                     };

bin/propolis-server/src/lib/migrate/preamble.rs

@@ -9,7 +9,7 @@ use propolis::migrate::{
     MigrateCtx, MigrateStateError, Migrator, PayloadOutputs,
 };
 use propolis::vmm;
-use propolis_api_types::instance_spec::VersionedInstanceSpec;
+use propolis_api_types_versions::v1;
 use slog::{debug, error, info, trace, warn};
 use std::collections::HashMap;
 use std::convert::TryInto;
@@ -467,9 +467,10 @@ impl<T: MigrateConn> RonV0Runner<'_, T> {
 
     async fn sync(&mut self) -> Result<(), MigrateError> {
         self.update_state(MigrationState::Sync);
-        let preamble = Preamble::new(VersionedInstanceSpec::V0(
-            self.vm.lock_shared().await.instance_spec().clone().into(),
-        ));
+        let preamble =
+            Preamble::new(v1::instance_spec::VersionedInstanceSpec::V0(
+                self.vm.lock_shared().await.instance_spec().clone().into(),
+            ));
         let s = ron::ser::to_string(&preamble)
             .map_err(codec::ProtocolError::from)?;
         self.send_msg(codec::Message::Serialized(s)).await?;