bootstore type reorg PR 3/?: Split internal/external API types: add ExternalBfdMode

clients/nexus-lockstep-client/src/lib.rs

@@ -32,6 +32,7 @@ progenitor::generate_api!(
     },
     replace = {
         BaseboardId = sled_hardware_types::BaseboardId,
+        BfdMode = omicron_common::api::internal::shared::BfdMode,
         // It's kind of unfortunate to pull in such a complex and unstable type
         // as "blueprint" this way, but we have really useful functionality
         // (e.g., diff'ing) that's implemented on our local type.

common/src/api/external/mod.rs

@@ -3547,25 +3547,6 @@ pub struct BgpImported {
     pub switch: SwitchLocation,
 }
 
-/// BFD connection mode.
-#[derive(
-    Clone,
-    Copy,
-    Debug,
-    Deserialize,
-    Serialize,
-    JsonSchema,
-    PartialEq,
-    Eq,
-    Ord,
-    PartialOrd,
-)]
-#[serde(rename_all = "snake_case")]
-pub enum BfdMode {
-    SingleHop,
-    MultiHop,
-}
-
 /// Configuration of inbound ICMP allowed by API services.
 #[derive(
     Clone,

common/src/api/internal/shared/mod.rs

@@ -50,6 +50,7 @@ pub use external_ip::SourceNatConfigV4;
 pub use external_ip::SourceNatConfigV6;
 
 // Re-export latest version of rack_init types.
+pub use rack_init::BfdMode;
 pub use rack_init::BfdPeerConfig;
 pub use rack_init::BgpConfig;
 pub use rack_init::BgpPeerConfig;

common/src/api/internal/shared/rack_init/mod.rs

@@ -11,6 +11,7 @@ mod impls;
 
 // Re-export latest version types for convenience.
 // Note: New versions of these types will be added to the top-level module.
+pub use v1::BfdMode;
 pub use v1::BfdPeerConfig;
 pub use v1::LldpAdminStatus;
 pub use v1::LldpPortConfig;

common/src/api/internal/shared/rack_init/v1.rs

@@ -4,7 +4,7 @@
 
 //! Version 1 of rack init types.
 
-use crate::api::external::{BfdMode, ImportExportPolicy};
+use crate::api::external::ImportExportPolicy;
 use oxnet::{IpNet, Ipv4Net, Ipv6Net};
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
@@ -107,6 +107,25 @@ pub struct BfdPeerConfig {
     pub switch: SwitchLocation,
 }
 
+/// BFD connection mode.
+#[derive(
+    Clone,
+    Copy,
+    Debug,
+    Deserialize,
+    Serialize,
+    JsonSchema,
+    PartialEq,
+    Eq,
+    Ord,
+    PartialOrd,
+)]
+#[serde(rename_all = "snake_case")]
+pub enum BfdMode {
+    SingleHop,
+    MultiHop,
+}
+
 #[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq, JsonSchema)]
 pub struct RouteConfig {
     /// The destination of the route.

nexus/db-model/src/bfd.rs

@@ -1,8 +1,13 @@
+// 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 crate::{SqlU32, impl_enum_type};
 use chrono::DateTime;
 use chrono::Utc;
 use ipnetwork::IpNetwork;
 use nexus_db_schema::schema::bfd_session;
+use nexus_types::external_api::bfd::ExternalBfdMode;
 use serde::{Deserialize, Serialize};
 use uuid::Uuid;
 
@@ -42,15 +47,11 @@ pub struct BfdSession {
     pub time_deleted: Option<DateTime<Utc>>,
 }
 
-impl From<omicron_common::api::external::BfdMode> for BfdMode {
-    fn from(value: omicron_common::api::external::BfdMode) -> Self {
+impl From<ExternalBfdMode> for BfdMode {
+    fn from(value: ExternalBfdMode) -> Self {
         match value {
-            omicron_common::api::external::BfdMode::SingleHop => {
-                BfdMode::SingleHop
-            }
-            omicron_common::api::external::BfdMode::MultiHop => {
-                BfdMode::MultiHop
-            }
+            ExternalBfdMode::SingleHop => BfdMode::SingleHop,
+            ExternalBfdMode::MultiHop => BfdMode::MultiHop,
         }
     }
 }

nexus/src/app/bfd.rs

@@ -5,6 +5,7 @@
 use mg_admin_client::types::BfdPeerState;
 use nexus_db_queries::context::OpContext;
 use nexus_types::external_api::bfd;
+use nexus_types::external_api::bfd::ExternalBfdMode;
 use nexus_types::external_api::networking;
 use omicron_common::api::{external::Error, internal::shared::SwitchLocation};
 
@@ -95,10 +96,10 @@ impl super::Nexus {
                     required_rx: info.config.required_rx,
                     mode: match info.config.mode {
                         mg_admin_client::types::SessionMode::SingleHop => {
-                            omicron_common::api::external::BfdMode::SingleHop
+                            ExternalBfdMode::SingleHop
                         }
                         mg_admin_client::types::SessionMode::MultiHop => {
-                            omicron_common::api::external::BfdMode::MultiHop
+                            ExternalBfdMode::MultiHop
                         }
                     },
                 })

nexus/tests/integration_tests/endpoints.rs

@@ -21,6 +21,7 @@ use nexus_test_utils::SWITCH_UUID;
 use nexus_test_utils::resource_helpers::test_params;
 use nexus_types::external_api::affinity;
 use nexus_types::external_api::alert;
+use nexus_types::external_api::bfd;
 use nexus_types::external_api::certificate;
 use nexus_types::external_api::disk;
 use nexus_types::external_api::external_subnet;
@@ -1030,7 +1031,7 @@ pub static DEMO_BFD_ENABLE: LazyLock<networking::BfdSessionEnable> =
         detection_threshold: 3,
         required_rx: 1000000,
         switch: "switch0".parse().unwrap(),
-        mode: omicron_common::api::external::BfdMode::MultiHop,
+        mode: bfd::ExternalBfdMode::MultiHop,
     });
 
 pub static DEMO_BFD_DISABLE: LazyLock<networking::BfdSessionDisable> =

nexus/types/src/external_api/bfd.rs

@@ -5,4 +5,3 @@
 //! BFD (Bidirectional Forwarding Detection) types.
 
 pub use nexus_types_versions::latest::bfd::*;
-pub use omicron_common::api::external::BfdMode;

nexus/types/versions/src/initial/bfd.rs

@@ -6,7 +6,6 @@
 
 use std::net::IpAddr;
 
-use omicron_common::api::external::BfdMode;
 use omicron_common::api::external::Name;
 use schemars::JsonSchema;
 use serde::Deserialize;
@@ -57,5 +56,25 @@ pub struct BfdStatus {
     pub local: Option<IpAddr>,
     pub detection_threshold: u8,
     pub required_rx: u64,
-    pub mode: BfdMode,
+    pub mode: ExternalBfdMode,
+}
+
+/// BFD connection mode.
+#[derive(
+    Clone,
+    Copy,
+    Debug,
+    Deserialize,
+    Serialize,
+    JsonSchema,
+    PartialEq,
+    Eq,
+    Ord,
+    PartialOrd,
+)]
+#[serde(rename_all = "snake_case")]
+#[schemars(rename = "BfdMode")] // don't include "External..." in OpenAPI spec
+pub enum ExternalBfdMode {
+    SingleHop,
+    MultiHop,
 }

nexus/types/versions/src/initial/networking.rs

@@ -7,10 +7,11 @@
 //! This includes address lot, switch port, BGP, BFD, and routing configuration
 //! types.
 
+use super::bfd::ExternalBfdMode;
 use api_identity::ObjectIdentity;
 use omicron_common::api::external;
 use omicron_common::api::external::{
-    AddressLotKind, BfdMode, IdentityMetadata, IdentityMetadataCreateParams,
+    AddressLotKind, IdentityMetadata, IdentityMetadataCreateParams,
     ImportExportPolicy, LinkFec, LinkSpeed, Name, NameOrId, ObjectIdentity,
     SwitchLocation,
 };
@@ -619,7 +620,7 @@ pub struct BfdSessionEnable {
     pub switch: Name,
 
     /// Select either single-hop (RFC 5881) or multi-hop (RFC 5883)
-    pub mode: BfdMode,
+    pub mode: ExternalBfdMode,
 }
 
 /// Information needed to disable a BFD session

nexus/types/versions/src/latest.rs

@@ -66,6 +66,7 @@ pub mod audit {
 pub mod bfd {
     pub use crate::v2025_11_20_00::bfd::BfdState;
     pub use crate::v2025_11_20_00::bfd::BfdStatus;
+    pub use crate::v2025_11_20_00::bfd::ExternalBfdMode;
 }
 
 pub mod device {

sled-agent/src/bootstrap/early_networking.rs

@@ -31,9 +31,9 @@ use mg_admin_client::types::{
 use omicron_common::OMICRON_DPD_TAG;
 use omicron_common::address::DENDRITE_PORT;
 use omicron_common::address::{MGD_PORT, MGS_PORT};
-use omicron_common::api::external::{BfdMode, ImportExportPolicy};
+use omicron_common::api::external::ImportExportPolicy;
 use omicron_common::api::internal::shared::{
-    BgpConfig, BgpPeerConfig, PortConfig, PortFec, PortSpeed,
+    BfdMode, BgpConfig, BgpPeerConfig, PortConfig, PortFec, PortSpeed,
     RackNetworkConfig, SwitchLocation,
 };
 use omicron_common::backoff::{

sled-agent/src/rack_setup/service.rs

@@ -985,22 +985,13 @@ impl ServiceInner {
                 bfd: config
                     .bfd
                     .iter()
-                    .map(|spec| {
-                        NexusTypes::BfdPeerConfig {
-                    detection_threshold: spec.detection_threshold,
-                    local: spec.local,
-                    mode: match spec.mode {
-                        omicron_common::api::external::BfdMode::SingleHop => {
-                            NexusTypes::BfdMode::SingleHop
-                        }
-                        omicron_common::api::external::BfdMode::MultiHop => {
-                            NexusTypes::BfdMode::MultiHop
-                        }
-                    },
-                    remote: spec.remote,
-                    required_rx: spec.required_rx,
-                    switch: spec.switch.into(),
-                }
+                    .map(|spec| NexusTypes::BfdPeerConfig {
+                        detection_threshold: spec.detection_threshold,
+                        local: spec.local,
+                        mode: spec.mode,
+                        remote: spec.remote,
+                        required_rx: spec.required_rx,
+                        switch: spec.switch.into(),
                     })
                     .collect(),
             }