Add cosmo ignition support

Author: labbott

Cargo.lock

@@ -461,9 +461,9 @@ gateway-client = { path = "clients/gateway-client" }
 # compatibility, but will mean that faux-mgs might be missing new
 # functionality.)
 #
-gateway-ereport-messages = { git = "https://github.com/oxidecomputer/management-gateway-service", rev = "77e316c812aa057b9714d0d99c4a7bdd36d45be2", default-features = false, features = ["debug-impls"] }
-gateway-messages = { git = "https://github.com/oxidecomputer/management-gateway-service", rev = "77e316c812aa057b9714d0d99c4a7bdd36d45be2", default-features = false, features = ["std"] }
-gateway-sp-comms = { git = "https://github.com/oxidecomputer/management-gateway-service", rev = "77e316c812aa057b9714d0d99c4a7bdd36d45be2" }
+gateway-ereport-messages = { git = "https://github.com/oxidecomputer/management-gateway-service", rev = "ad5f86ce59029dbc9154d1ec65e2e988ed50628a", default-features = false, features = ["debug-impls"] }
+gateway-messages = { git = "https://github.com/oxidecomputer/management-gateway-service", rev = "ad5f86ce59029dbc9154d1ec65e2e988ed50628a", default-features = false, features = ["std"] }
+gateway-sp-comms = { git = "https://github.com/oxidecomputer/management-gateway-service", rev = "ad5f86ce59029dbc9154d1ec65e2e988ed50628a" }
 gateway-test-utils = { path = "gateway-test-utils" }
 gateway-types = { path = "gateway-types" }
 gethostname = "0.5.0"

Cargo.toml

@@ -236,6 +236,9 @@ fn show_sps_from_ignition(
                         id: SpIgnitionSystemType::Gimlet,
                         ..
                     } => "Gimlet".to_string(),
+                    SpIgnition::Yes {
+                        id: SpIgnitionSystemType::Cosmo, ..
+                    } => "Cosmo".to_string(),
                     SpIgnition::Yes {
                         id: SpIgnitionSystemType::Sidecar,
                         ..

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

@@ -17,7 +17,8 @@ use gateway_types::{
     },
     component_details::SpComponentDetails,
     host::{ComponentFirmwareHashStatus, HostStartupOptions},
-    ignition::{IgnitionCommand, SpIgnitionInfo},
+    ignition,
+    //ignition::{IgnitionCommand, SpIgnitionInfo},
     rot::{RotCfpa, RotCfpaSlot, RotCmpa, RotState},
     sensor::SpSensorReading,
     task_dump::TaskDump,
@@ -45,6 +46,7 @@ api_versions!([
     // |  example for the next person.
     // v
     // (next_int, IDENT),
+    (2, COSMO),
     (1, INITIAL),
 ]);
 
@@ -407,10 +409,43 @@ pub trait GatewayApi {
     #[endpoint {
         method = GET,
         path = "/ignition",
+        operation_id = "ignition_list",
+        versions = VERSION_INITIAL..VERSION_COSMO
     }]
-    async fn ignition_list(
+    async fn ignition_list_v1(
         rqctx: RequestContext<Self::Context>,
-    ) -> Result<HttpResponseOk<Vec<SpIgnitionInfo>>, HttpError>;
+    ) -> Result<HttpResponseOk<Vec<ignition::v1::SpIgnitionInfo>>, HttpError>;
+
+    /// List SPs via Ignition
+    ///
+    /// Retreive information for all SPs via the Ignition controller. This is
+    /// lower latency and has fewer possible failure modes than querying the SP
+    /// over the management network.
+    #[endpoint {
+        method = GET,
+        path = "/ignition",
+        operation_id = "ignition_list",
+        versions = VERSION_COSMO..
+    }]
+    async fn ignition_list_v2(
+        rqctx: RequestContext<Self::Context>,
+    ) -> Result<HttpResponseOk<Vec<ignition::v2::SpIgnitionInfo>>, HttpError>;
+
+    /// Get SP info via Ignition
+    ///
+    /// Retreive information for an SP via the Ignition controller. This is
+    /// lower latency and has fewer possible failure modes than querying the SP
+    /// over the management network.
+    #[endpoint {
+        method = GET,
+        path = "/ignition/{type}/{slot}",
+        operation_id = "ignition_get",
+        versions = VERSION_INITIAL..VERSION_COSMO
+    }]
+    async fn ignition_get_v1(
+        rqctx: RequestContext<Self::Context>,
+        path: Path<PathSp>,
+    ) -> Result<HttpResponseOk<ignition::v1::SpIgnitionInfo>, HttpError>;
 
     /// Get SP info via Ignition
     ///
@@ -420,11 +455,13 @@ pub trait GatewayApi {
     #[endpoint {
         method = GET,
         path = "/ignition/{type}/{slot}",
+        operation_id = "ignition_get",
+        versions = VERSION_COSMO..
     }]
-    async fn ignition_get(
+    async fn ignition_get_v2(
         rqctx: RequestContext<Self::Context>,
         path: Path<PathSp>,
-    ) -> Result<HttpResponseOk<SpIgnitionInfo>, HttpError>;
+    ) -> Result<HttpResponseOk<ignition::v2::SpIgnitionInfo>, HttpError>;
 
     /// Send an ignition command targeting a specific SP.
     ///
@@ -437,10 +474,31 @@ pub trait GatewayApi {
     #[endpoint {
         method = POST,
         path = "/ignition/{type}/{slot}/{command}",
+        operation_id = "ignition_command",
+        versions = VERSION_INITIAL..VERSION_COSMO
     }]
-    async fn ignition_command(
+    async fn ignition_command_v1(
         rqctx: RequestContext<Self::Context>,
-        path: Path<PathSpIgnitionCommand>,
+        path: Path<ignition::v1::PathSpIgnitionCommand>,
+    ) -> Result<HttpResponseUpdatedNoContent, HttpError>;
+
+    /// Send an ignition command targeting a specific SP.
+    ///
+    /// This endpoint can be used to transition a target between A2 and A3 (via
+    /// power-on / power-off) or reset it.
+    ///
+    /// The management network traffic caused by requests to this endpoint is
+    /// between this MGS instance and its local ignition controller, _not_ the
+    /// SP targeted by the command.
+    #[endpoint {
+        method = POST,
+        path = "/ignition/{type}/{slot}/{command}",
+        operation_id = "ignition_command",
+        versions = VERSION_COSMO..
+    }]
+    async fn ignition_command_v2(
+        rqctx: RequestContext<Self::Context>,
+        path: Path<ignition::v2::PathSpIgnitionCommand>,
     ) -> Result<HttpResponseUpdatedNoContent, HttpError>;
 
     /// Get the current power state of a sled via its SP.
@@ -683,13 +741,3 @@ pub struct GetCfpaParams {
 pub struct GetRotBootInfoParams {
     pub version: u8,
 }
-
-#[derive(Deserialize, JsonSchema)]
-pub struct PathSpIgnitionCommand {
-    /// ID for the SP that the gateway service translates into the appropriate
-    /// port for communicating with the given SP.
-    #[serde(flatten)]
-    pub sp: SpIdentifier,
-    /// Ignition command to perform on the targeted SP.
-    pub command: IgnitionCommand,
-}

gateway-api/src/lib.rs

@@ -36,7 +36,7 @@ pub async fn current_simulator_state(simrack: &SimRack) -> Vec<SpInfo> {
         };
         let typ = match target_state.system_type {
             SystemType::Sidecar => SpType::Switch,
-            SystemType::Gimlet => SpType::Sled,
+            SystemType::Gimlet | SystemType::Cosmo => SpType::Sled,
             SystemType::Psc => {
                 todo!("testing simulated PSC not yet implemented")
             }

gateway-test-utils/src/sim_state.rs

@@ -0,0 +1,8 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+pub mod v1;
+pub mod v2;
+
+pub use v2::*;

gateway-types/src/ignition/mod.rs

@@ -7,6 +7,16 @@ use serde::{Deserialize, Serialize};
 
 use crate::component::SpIdentifier;
 
+#[derive(Deserialize, JsonSchema)]
+pub struct PathSpIgnitionCommand {
+    /// ID for the SP that the gateway service translates into the appropriate
+    /// port for communicating with the given SP.
+    #[serde(flatten)]
+    pub sp: SpIdentifier,
+    /// Ignition command to perform on the targeted SP.
+    pub command: IgnitionCommand,
+}
+
 #[derive(
     Debug,
     Clone,
@@ -135,6 +145,7 @@ impl From<gateway_messages::ignition::SystemType> for SpIgnitionSystemType {
             SystemType::Sidecar => Self::Sidecar,
             SystemType::Psc => Self::Psc,
             SystemType::Unknown(id) => Self::Unknown { id },
+            SystemType::Cosmo => Self::Unknown { id: 0x4 },
         }
     }
 }

gateway-types/src/ignition.rs renamed to gateway-types/src/ignition/v1.rs

@@ -0,0 +1,151 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+
+use crate::component::SpIdentifier;
+
+#[derive(Deserialize, JsonSchema)]
+pub struct PathSpIgnitionCommand {
+    /// ID for the SP that the gateway service translates into the appropriate
+    /// port for communicating with the given SP.
+    #[serde(flatten)]
+    pub sp: SpIdentifier,
+    /// Ignition command to perform on the targeted SP.
+    pub command: IgnitionCommand,
+}
+
+#[derive(
+    Debug,
+    Clone,
+    PartialEq,
+    Eq,
+    PartialOrd,
+    Ord,
+    Deserialize,
+    Serialize,
+    JsonSchema,
+)]
+pub struct SpIgnitionInfo {
+    pub id: SpIdentifier,
+    pub details: SpIgnition,
+}
+
+/// Ignition command.
+#[derive(
+    Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema,
+)]
+#[serde(rename_all = "snake_case")]
+pub enum IgnitionCommand {
+    PowerOn,
+    PowerOff,
+    PowerReset,
+}
+
+impl From<IgnitionCommand> for gateway_messages::IgnitionCommand {
+    fn from(cmd: IgnitionCommand) -> Self {
+        match cmd {
+            IgnitionCommand::PowerOn => {
+                gateway_messages::IgnitionCommand::PowerOn
+            }
+            IgnitionCommand::PowerOff => {
+                gateway_messages::IgnitionCommand::PowerOff
+            }
+            IgnitionCommand::PowerReset => {
+                gateway_messages::IgnitionCommand::PowerReset
+            }
+        }
+    }
+}
+
+/// State of an ignition target.
+///
+/// TODO: Ignition returns much more information than we're reporting here: do
+/// we want to expand this?
+#[derive(
+    Debug,
+    Clone,
+    PartialEq,
+    Eq,
+    PartialOrd,
+    Ord,
+    Deserialize,
+    Serialize,
+    JsonSchema,
+)]
+#[serde(tag = "present")]
+pub enum SpIgnition {
+    #[serde(rename = "no")]
+    Absent,
+    #[serde(rename = "yes")]
+    Present {
+        id: SpIgnitionSystemType,
+        power: bool,
+        ctrl_detect_0: bool,
+        ctrl_detect_1: bool,
+        flt_a3: bool,
+        flt_a2: bool,
+        flt_rot: bool,
+        flt_sp: bool,
+    },
+}
+
+impl From<gateway_messages::IgnitionState> for SpIgnition {
+    fn from(state: gateway_messages::IgnitionState) -> Self {
+        use gateway_messages::ignition::SystemPowerState;
+
+        if let Some(target_state) = state.target {
+            Self::Present {
+                id: target_state.system_type.into(),
+                power: matches!(
+                    target_state.power_state,
+                    SystemPowerState::On | SystemPowerState::PoweringOn
+                ),
+                ctrl_detect_0: target_state.controller0_present,
+                ctrl_detect_1: target_state.controller1_present,
+                flt_a3: target_state.faults.power_a3,
+                flt_a2: target_state.faults.power_a2,
+                flt_rot: target_state.faults.rot,
+                flt_sp: target_state.faults.sp,
+            }
+        } else {
+            Self::Absent
+        }
+    }
+}
+
+#[derive(
+    Debug,
+    Clone,
+    Copy,
+    PartialEq,
+    Eq,
+    PartialOrd,
+    Ord,
+    Deserialize,
+    Serialize,
+    JsonSchema,
+)]
+#[serde(tag = "system_type", rename_all = "snake_case")]
+pub enum SpIgnitionSystemType {
+    Gimlet,
+    Sidecar,
+    Psc,
+    Unknown { id: u16 },
+    Cosmo,
+}
+
+impl From<gateway_messages::ignition::SystemType> for SpIgnitionSystemType {
+    fn from(st: gateway_messages::ignition::SystemType) -> Self {
+        use gateway_messages::ignition::SystemType;
+        match st {
+            SystemType::Gimlet => Self::Gimlet,
+            SystemType::Sidecar => Self::Sidecar,
+            SystemType::Psc => Self::Psc,
+            SystemType::Unknown(id) => Self::Unknown { id },
+            SystemType::Cosmo => Self::Cosmo,
+        }
+    }
+}