Sled agent views/params shuffling

common/src/api/internal/mod.rs

@@ -1,5 +1,4 @@
 //! Internally facing APIs.
 
-pub mod bootstrap_agent;
 pub mod nexus;
 pub mod sled_agent;

common/src/api/internal/sled_agent.rs

@@ -4,40 +4,6 @@ use crate::api::{external, internal};
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use std::fmt::{Debug, Display, Formatter, Result as FormatResult};
-use uuid::Uuid;
-
-/// Sent from to a sled agent to establish the runtime state of a Disk
-#[derive(Serialize, Deserialize, JsonSchema)]
-pub struct DiskEnsureBody {
-    /// Last runtime state of the Disk known to Nexus (used if the agent has
-    /// never seen this Disk before).
-    pub initial_runtime: internal::nexus::DiskRuntimeState,
-    /// requested runtime state of the Disk
-    pub target: DiskStateRequested,
-}
-
-///Used to request a Disk state change
-#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, JsonSchema)]
-#[serde(rename_all = "lowercase", tag = "state", content = "instance")]
-pub enum DiskStateRequested {
-    Detached,
-    Attached(Uuid),
-    Destroyed,
-    Faulted,
-}
-
-impl DiskStateRequested {
-    /// Returns whether the requested state is attached to an Instance or not.
-    pub fn is_attached(&self) -> bool {
-        match self {
-            DiskStateRequested::Detached => false,
-            DiskStateRequested::Destroyed => false,
-            DiskStateRequested::Faulted => false,
-
-            DiskStateRequested::Attached(_) => true,
-        }
-    }
-}
 
 /// Describes the instance hardware.
 #[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]

common/src/sled_agent_client.rs

@@ -201,27 +201,6 @@ impl From<types::DiskState> for crate::api::external::DiskState {
     }
 }
 
-impl From<crate::api::internal::sled_agent::DiskStateRequested>
-    for types::DiskStateRequested
-{
-    fn from(s: crate::api::internal::sled_agent::DiskStateRequested) -> Self {
-        match s {
-            crate::api::internal::sled_agent::DiskStateRequested::Detached => {
-                Self::Detached
-            }
-            crate::api::internal::sled_agent::DiskStateRequested::Attached(
-                u,
-            ) => Self::Attached(u),
-            crate::api::internal::sled_agent::DiskStateRequested::Destroyed => {
-                Self::Destroyed
-            }
-            crate::api::internal::sled_agent::DiskStateRequested::Faulted => {
-                Self::Faulted
-            }
-        }
-    }
-}
-
 impl From<crate::api::internal::sled_agent::InstanceHardware>
     for types::InstanceHardware
 {

nexus/src/nexus.rs

@@ -52,11 +52,11 @@ use omicron_common::api::external::VpcSubnetUpdateParams;
 use omicron_common::api::external::VpcUpdateParams;
 use omicron_common::api::internal::nexus;
 use omicron_common::api::internal::nexus::DiskRuntimeState;
-use omicron_common::api::internal::sled_agent::DiskStateRequested;
 use omicron_common::api::internal::sled_agent::InstanceRuntimeStateRequested;
 use omicron_common::api::internal::sled_agent::InstanceStateRequested;
 use omicron_common::backoff;
 use omicron_common::bail_unless;
+use omicron_common::sled_agent_client;
 use omicron_common::OximeterClient;
 use omicron_common::SledAgentClient;
 use oximeter_producer::register;
@@ -1060,16 +1060,17 @@ impl Nexus {
         // TODO: Populate this with an appropriate NIC.
         // See also: sic_create_instance_record in sagas.rs for a similar
         // construction.
-        let instance_hardware =
-            omicron_common::sled_agent_client::types::InstanceHardware {
-                runtime: omicron_common::sled_agent_client::types::InstanceRuntimeState::from(runtime),
-                nics: vec![],
-            };
+        let instance_hardware = sled_agent_client::types::InstanceHardware {
+            runtime: sled_agent_client::types::InstanceRuntimeState::from(
+                runtime,
+            ),
+            nics: vec![],
+        };
 
         let new_runtime = sa
             .instance_put(
                 &instance.id(),
-                &omicron_common::sled_agent_client::types::InstanceEnsureBody {
+                &sled_agent_client::types::InstanceEnsureBody {
                     initial: instance_hardware,
                     target: requested.into(),
                 },
@@ -1266,7 +1267,9 @@ impl Nexus {
         self.disk_set_runtime(
             &disk,
             self.instance_sled(&instance).await?,
-            DiskStateRequested::Attached(*instance_id),
+            sled_agent_client::types::DiskStateRequested::Attached(
+                *instance_id,
+            ),
         )
         .await?;
         let disk = self.db_datastore.disk_fetch(&disk.id()).await?;
@@ -1336,7 +1339,7 @@ impl Nexus {
         self.disk_set_runtime(
             &disk,
             self.instance_sled(&instance).await?,
-            DiskStateRequested::Detached,
+            sled_agent_client::types::DiskStateRequested::Detached,
         )
         .await?;
         Ok(())
@@ -1350,7 +1353,7 @@ impl Nexus {
         &self,
         disk: &db::model::Disk,
         sa: Arc<SledAgentClient>,
-        requested: DiskStateRequested,
+        requested: sled_agent_client::types::DiskStateRequested,
     ) -> Result<(), Error> {
         let runtime: DiskRuntimeState = disk.runtime().into();
 
@@ -1361,9 +1364,12 @@ impl Nexus {
         let new_runtime = sa
             .disk_put(
                 &disk.id(),
-                &omicron_common::sled_agent_client::types::DiskEnsureBody {
-                    initial_runtime: omicron_common::sled_agent_client::types::DiskRuntimeState::from(runtime),
-                    target: omicron_common::sled_agent_client::types::DiskStateRequested::from(requested),
+                &sled_agent_client::types::DiskEnsureBody {
+                    initial_runtime:
+                        sled_agent_client::types::DiskRuntimeState::from(
+                            runtime,
+                        ),
+                    target: requested,
                 },
             )
             .await

sled-agent/src/bootstrap/agent.rs

@@ -2,8 +2,8 @@
 
 use super::client::types as bootstrap_types;
 use super::client::Client as BootstrapClient;
+use super::views::ShareResponse;
 use omicron_common::api::external::Error;
-use omicron_common::api::internal::bootstrap_agent::ShareResponse;
 use omicron_common::packaging::sha256_digest;
 
 use slog::Logger;

sled-agent/src/bootstrap/http_entrypoints.rs

@@ -6,12 +6,10 @@ use dropshot::HttpError;
 use dropshot::HttpResponseOk;
 use dropshot::RequestContext;
 use dropshot::TypedBody;
-use omicron_common::api::internal::bootstrap_agent::{
-    ShareRequest, ShareResponse,
-};
 use std::sync::Arc;
 
 use super::agent::Agent;
+use super::{params::ShareRequest, views::ShareResponse};
 
 /// Returns a description of the bootstrap agent API
 pub fn ba_api() -> ApiDescription<Arc<Agent>> {

sled-agent/src/bootstrap/mod.rs

@@ -4,4 +4,6 @@ pub mod agent;
 mod client;
 pub mod config;
 mod http_entrypoints;
+mod params;
 pub mod server;
+mod views;

sled-agent/src/bootstrap/params.rs

@@ -0,0 +1,11 @@
+//! Request body types for the bootstrap agent
+
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+
+/// Identity signed by local RoT and Oxide certificate chain.
+#[derive(Serialize, Deserialize, JsonSchema)]
+pub struct ShareRequest {
+    // TODO-completeness: format TBD; currently opaque.
+    pub identity: Vec<u8>,
+}

common/src/api/internal/bootstrap_agent.rs → sled-agent/src/bootstrap/views.rs

@@ -1,15 +1,8 @@
-//! APIs exposed by the bootstrap agent
+//! Response types for the bootstrap agent
 
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
-/// Identity signed by local RoT and Oxide certificate chain.
-#[derive(Serialize, Deserialize, JsonSchema)]
-pub struct ShareRequest {
-    // TODO-completeness: format TBD; currently opaque.
-    pub identity: Vec<u8>,
-}
-
 /// Sent between bootstrap agents to establish trust quorum.
 #[derive(Serialize, Deserialize, JsonSchema)]
 pub struct ShareResponse {

sled-agent/src/common/disk.rs

@@ -1,10 +1,10 @@
 //! Describes the states of network-attached storage.
 
+use crate::params::DiskStateRequested;
 use chrono::Utc;
 use omicron_common::api::external::DiskState;
 use omicron_common::api::external::Error;
 use omicron_common::api::internal::nexus::DiskRuntimeState;
-use omicron_common::api::internal::sled_agent::DiskStateRequested;
 use propolis_client::api::DiskAttachmentState as PropolisDiskState;
 use uuid::Uuid;
 

sled-agent/src/http_entrypoints.rs

@@ -1,5 +1,6 @@
 //! HTTP entrypoint functions for the sled agent's exposed API
 
+use super::params::DiskEnsureBody;
 use dropshot::endpoint;
 use dropshot::ApiDescription;
 use dropshot::HttpError;
@@ -9,7 +10,6 @@ use dropshot::RequestContext;
 use dropshot::TypedBody;
 use omicron_common::api::internal::nexus::DiskRuntimeState;
 use omicron_common::api::internal::nexus::InstanceRuntimeState;
-use omicron_common::api::internal::sled_agent::DiskEnsureBody;
 use omicron_common::api::internal::sled_agent::InstanceEnsureBody;
 use schemars::JsonSchema;
 use serde::Deserialize;

sled-agent/src/lib.rs

@@ -19,6 +19,7 @@ mod http_entrypoints;
 mod illumos;
 mod instance;
 mod instance_manager;
+mod params;
 pub mod server;
 mod sled_agent;
 

sled-agent/src/params.rs

@@ -0,0 +1,37 @@
+use omicron_common::api::internal::nexus::DiskRuntimeState;
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+use uuid::Uuid;
+
+///Used to request a Disk state change
+#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, JsonSchema)]
+#[serde(rename_all = "lowercase", tag = "state", content = "instance")]
+pub enum DiskStateRequested {
+    Detached,
+    Attached(Uuid),
+    Destroyed,
+    Faulted,
+}
+
+impl DiskStateRequested {
+    /// Returns whether the requested state is attached to an Instance or not.
+    pub fn is_attached(&self) -> bool {
+        match self {
+            DiskStateRequested::Detached => false,
+            DiskStateRequested::Destroyed => false,
+            DiskStateRequested::Faulted => false,
+
+            DiskStateRequested::Attached(_) => true,
+        }
+    }
+}
+
+/// Sent from to a sled agent to establish the runtime state of a Disk
+#[derive(Serialize, Deserialize, JsonSchema)]
+pub struct DiskEnsureBody {
+    /// Last runtime state of the Disk known to Nexus (used if the agent has
+    /// never seen this Disk before).
+    pub initial_runtime: DiskRuntimeState,
+    /// requested runtime state of the Disk
+    pub target: DiskStateRequested,
+}

sled-agent/src/sim/collection.rs

@@ -329,6 +329,7 @@ impl<S: Simulatable + 'static> SimCollection<S> {
 
 #[cfg(test)]
 mod test {
+    use crate::params::DiskStateRequested;
     use crate::sim::collection::SimObject;
     use crate::sim::disk::SimDisk;
     use crate::sim::instance::SimInstance;
@@ -344,7 +345,6 @@ mod test {
     use omicron_common::api::external::InstanceState;
     use omicron_common::api::internal::nexus::DiskRuntimeState;
     use omicron_common::api::internal::nexus::InstanceRuntimeState;
-    use omicron_common::api::internal::sled_agent::DiskStateRequested;
     use omicron_common::api::internal::sled_agent::InstanceRuntimeStateRequested;
     use omicron_common::api::internal::sled_agent::InstanceStateRequested;
     use omicron_test_utils::dev::test_setup_log;

sled-agent/src/sim/disk.rs

@@ -2,13 +2,13 @@
  * Simulated sled agent implementation
  */
 
+use crate::params::DiskStateRequested;
 use crate::sim::simulatable::Simulatable;
 use async_trait::async_trait;
 use omicron_common::api::external::DiskState;
 use omicron_common::api::external::Error;
 use omicron_common::api::external::Generation;
 use omicron_common::api::internal::nexus::DiskRuntimeState;
-use omicron_common::api::internal::sled_agent::DiskStateRequested;
 use omicron_common::NexusClient;
 use propolis_client::api::DiskAttachmentState as PropolisDiskState;
 use std::sync::Arc;

sled-agent/src/sim/http_entrypoints.rs

@@ -2,6 +2,7 @@
  * HTTP entrypoint functions for the sled agent's exposed API
  */
 
+use crate::params::DiskEnsureBody;
 use dropshot::endpoint;
 use dropshot::ApiDescription;
 use dropshot::HttpError;
@@ -12,7 +13,6 @@ use dropshot::RequestContext;
 use dropshot::TypedBody;
 use omicron_common::api::internal::nexus::DiskRuntimeState;
 use omicron_common::api::internal::nexus::InstanceRuntimeState;
-use omicron_common::api::internal::sled_agent::DiskEnsureBody;
 use omicron_common::api::internal::sled_agent::InstanceEnsureBody;
 use schemars::JsonSchema;
 use serde::Deserialize;

sled-agent/src/sim/sled_agent.rs

@@ -2,10 +2,10 @@
  * Simulated sled agent implementation
  */
 
+use crate::params::DiskStateRequested;
 use omicron_common::api::external::Error;
 use omicron_common::api::internal::nexus::DiskRuntimeState;
 use omicron_common::api::internal::nexus::InstanceRuntimeState;
-use omicron_common::api::internal::sled_agent::DiskStateRequested;
 use omicron_common::api::internal::sled_agent::InstanceHardware;
 use omicron_common::api::internal::sled_agent::InstanceRuntimeStateRequested;
 use omicron_common::NexusClient;

sled-agent/src/sled_agent.rs

@@ -1,9 +1,9 @@
 //! Sled agent implementation
 
+use crate::params::DiskStateRequested;
 use omicron_common::api::{
     external::Error, internal::nexus::DiskRuntimeState,
     internal::nexus::InstanceRuntimeState,
-    internal::sled_agent::DiskStateRequested,
     internal::sled_agent::InstanceHardware,
     internal::sled_agent::InstanceRuntimeStateRequested,
 };