Refactor Network Operator APIs

common/src/api/external/mod.rs

@@ -2113,9 +2113,6 @@ impl std::fmt::Display for Digest {
 pub struct AddressLotCreateResponse {
     /// The address lot that was created.
     pub lot: AddressLot,
-
-    /// The address lot blocks that were created.
-    pub blocks: Vec<AddressLotBlock>,
 }
 
 /// Represents an address lot object, containing the id of the lot that can be
@@ -2241,7 +2238,7 @@ pub struct SwitchPortSettingsView {
     pub routes: Vec<SwitchPortRouteConfig>,
 
     /// BGP peer settings.
-    pub bgp_peers: Vec<BgpPeer>,
+    pub bgp_peers: Vec<BgpPeerCombined>,
 
     /// Layer 3 IP address settings.
     pub addresses: Vec<SwitchPortAddressConfig>,
@@ -2520,12 +2517,12 @@ pub struct SwitchPortBgpPeerConfig {
 /// parameter is a reference to global BGP parameters. The `interface_name`
 /// indicates what interface the peer should be contacted on.
 #[derive(Clone, Debug, Deserialize, Serialize, JsonSchema, PartialEq)]
-pub struct BgpPeer {
+pub struct BgpPeerCombined {
     /// The global BGP configuration used for establishing a session with this
     /// peer.
     pub bgp_config: NameOrId,
 
-    /// The name of interface to peer on. This is relative to the port
+    /// The name of the interface to peer on. This is relative to the port
     /// configuration this BGP peer configuration is a part of. For example this
     /// value could be phy0 to refer to a primary physical interface. Or it
     /// could be vlan47 to refer to a VLAN interface.
@@ -2551,19 +2548,19 @@ pub struct BgpPeer {
     /// How often to send keepalive requests (seconds).
     pub keepalive: u32,
 
-    /// Require that a peer has a specified ASN.
+    /// Require that this peer has a specified ASN.
     pub remote_asn: Option<u32>,
 
-    /// Require messages from a peer have a minimum IP time to live field.
+    /// Require messages from this peer have a minimum IP time to live field.
     pub min_ttl: Option<u8>,
 
-    /// Use the given key for TCP-MD5 authentication with the peer.
+    /// Use the given key for TCP-MD5 authentication with this peer.
     pub md5_auth_key: Option<String>,
 
-    /// Apply the provided multi-exit discriminator (MED) updates sent to the peer.
+    /// Apply a multi-exit discriminator (MED) in updates sent to this peer.
     pub multi_exit_discriminator: Option<u32>,
 
-    /// Include the provided communities in updates sent to the peer.
+    /// Include the provided communities in updates sent to this peer.
     pub communities: Vec<u32>,
 
     /// Apply a local preference to routes received from this peer.
@@ -2572,16 +2569,120 @@ pub struct BgpPeer {
     /// Enforce that the first AS in paths received from this peer is the peer's AS.
     pub enforce_first_as: bool,
 
-    /// Define import policy for a peer.
+    /// Define import policy for this peer.
     pub allowed_import: ImportExportPolicy,
 
-    /// Define export policy for a peer.
+    /// Define export policy for this peer.
     pub allowed_export: ImportExportPolicy,
 
-    /// Associate a VLAN ID with a peer.
+    /// Associate a VLAN ID with this peer.
+    pub vlan_id: Option<u16>,
+}
+
+/// The information required to configure a BGP peer.
+#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema, PartialEq)]
+pub struct BgpPeer {
+    /// The global BGP configuration used for establishing a session with this
+    /// peer.
+    pub bgp_config: NameOrId,
+
+    /// The name of the interface to peer on. This is relative to the port
+    /// configuration this BGP peer configuration is a part of. For example this
+    /// value could be phy0 to refer to a primary physical interface. Or it
+    /// could be vlan47 to refer to a VLAN interface.
+    pub interface_name: String,
+
+    /// The address of the host to peer with.
+    pub addr: oxnet::IpNet,
+
+    /// How long to hold peer connections between keepalives (seconds).
+    pub hold_time: u32,
+
+    /// How long to hold this peer in idle before attempting a new session
+    /// (seconds).
+    pub idle_hold_time: u32,
+
+    /// How long to delay sending an open request after establishing a TCP
+    /// session (seconds).
+    pub delay_open: u32,
+
+    /// How long to to wait between TCP connection retries (seconds).
+    pub connect_retry: u32,
+
+    /// How often to send keepalive requests (seconds).
+    pub keepalive: u32,
+
+    /// Require that this peer have a specified ASN.
+    pub remote_asn: Option<u32>,
+
+    /// Require messages from this peer to have a minimum IP time to live field.
+    pub min_ttl: Option<u8>,
+
+    /// Use the given key for TCP-MD5 authentication with this peer.
+    pub md5_auth_key: Option<String>,
+
+    /// Apply a multi-exit discriminator (MED) in updates sent to this peer.
+    pub multi_exit_discriminator: Option<u32>,
+
+    /// Apply a local preference to routes received from this peer.
+    pub local_pref: Option<u32>,
+
+    /// Enforce that the first AS in paths received from this peer is the peer's AS.
+    pub enforce_first_as: bool,
+
+    /// Enable import policies
+    pub allow_import_list_active: bool,
+
+    /// Enable export policies
+    pub allow_export_list_active: bool,
+
+    /// Associate a VLAN ID with this peer.
     pub vlan_id: Option<u16>,
 }
 
+/// A BGP peer configuration to remove from an interface
+#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema, PartialEq)]
+pub struct BgpPeerRemove {
+    /// The global BGP configuration used for establishing a session with this
+    /// peer.
+    pub bgp_config: NameOrId,
+
+    /// The name of the interface to peer on. This is relative to the port
+    /// configuration this BGP peer configuration is a part of. For example this
+    /// value could be phy0 to refer to a primary physical interface. Or it
+    /// could be vlan47 to refer to a VLAN interface.
+    pub interface_name: String,
+
+    /// The address of the host to peer with.
+    pub addr: IpAddr,
+}
+
+/// A BGP allowed prefix entry
+#[derive(Clone, Debug, Deserialize, JsonSchema, Serialize, PartialEq)]
+pub struct BgpAllowedPrefix {
+    /// Parent switch port configuration
+    pub port_settings_id: Uuid,
+    /// Interface peer is reachable on
+    pub interface_name: String,
+    /// Peer Address
+    pub addr: oxnet::IpNet,
+    /// Allowed Prefix
+    pub prefix: oxnet::IpNet,
+}
+
+/// A BGP community
+#[derive(Clone, Debug, Deserialize, JsonSchema, Serialize, PartialEq)]
+pub struct BgpCommunity {
+    /// Parent switch port configuration
+    pub port_settings_id: Uuid,
+    /// Interface peer is reachable on
+    pub interface_name: String,
+    /// Peer Address
+    pub addr: oxnet::IpNet,
+    /// Community
+    pub community: u32,
+}
+
 /// A base BGP configuration.
 #[derive(
     ObjectIdentity, Clone, Debug, Deserialize, JsonSchema, Serialize, PartialEq,

nexus/db-model/src/schema.rs

@@ -1904,3 +1904,15 @@ joinable!(instance_ssh_key -> instance (instance_id));
 allow_tables_to_appear_in_same_query!(sled, sled_instance);
 
 joinable!(network_interface -> probe (parent_id));
+
+allow_tables_to_appear_in_same_query!(
+    switch_port_settings,
+    switch_port_settings_port_config,
+    switch_port_settings_link_config,
+    switch_port_settings_address_config,
+    switch_port_settings_route_config,
+    switch_port_settings_bgp_peer_config,
+    switch_port_settings_bgp_peer_config_allow_export,
+    switch_port_settings_bgp_peer_config_allow_import,
+    switch_port_settings_bgp_peer_config_communities,
+);

nexus/db-model/src/schema_versions.rs

@@ -17,7 +17,7 @@ use std::collections::BTreeMap;
 ///
 /// This must be updated when you change the database schema.  Refer to
 /// schema/crdb/README.adoc in the root of this repository for details.
-pub const SCHEMA_VERSION: SemverVersion = SemverVersion::new(90, 0, 0);
+pub const SCHEMA_VERSION: SemverVersion = SemverVersion::new(91, 0, 0);
 
 /// List of all past database schema versions, in *reverse* order
 ///
@@ -29,6 +29,7 @@ static KNOWN_VERSIONS: Lazy<Vec<KnownVersion>> = Lazy::new(|| {
         // |  leaving the first copy as an example for the next person.
         // v
         // KnownVersion::new(next_int, "unique-dirname-with-the-sql-files"),
+        KnownVersion::new(91, "refactor-network-apis"),
         KnownVersion::new(90, "lookup-bgp-config-by-asn"),
         KnownVersion::new(89, "collapse_lldp_settings"),
         KnownVersion::new(88, "route-local-pref"),

nexus/db-model/src/switch_port.rs

@@ -20,8 +20,10 @@ use diesel::AsChangeset;
 use ipnetwork::IpNetwork;
 use nexus_types::external_api::params;
 use nexus_types::identity::Resource;
-use omicron_common::api::external;
-use omicron_common::api::external::{BgpPeer, ImportExportPolicy};
+use omicron_common::api::external::{
+    self, BgpAllowedPrefix, BgpCommunity, NameOrId,
+};
+use omicron_common::api::external::{BgpPeerCombined, ImportExportPolicy};
 use omicron_common::api::internal::shared::{PortFec, PortSpeed};
 use serde::{Deserialize, Serialize};
 use uuid::Uuid;
@@ -620,6 +622,32 @@ pub struct SwitchPortBgpPeerConfig {
     pub vlan_id: Option<SqlU16>,
 }
 
+impl Into<external::BgpPeer> for SwitchPortBgpPeerConfig {
+    fn into(self) -> external::BgpPeer {
+        external::BgpPeer {
+            bgp_config: NameOrId::Id(self.bgp_config_id),
+            interface_name: self.interface_name,
+            addr: self.addr.into(),
+            hold_time: self.hold_time.into(),
+            idle_hold_time: self.idle_hold_time.into(),
+            delay_open: self.delay_open.into(),
+            connect_retry: self.connect_retry.into(),
+            keepalive: self.keepalive.into(),
+            remote_asn: self.remote_asn.map(Into::into),
+            min_ttl: self.min_ttl.map(Into::into),
+            md5_auth_key: self.md5_auth_key,
+            multi_exit_discriminator: self
+                .multi_exit_discriminator
+                .map(Into::into),
+            local_pref: self.local_pref.map(Into::into),
+            enforce_first_as: self.enforce_first_as,
+            allow_import_list_active: self.allow_import_list_active,
+            allow_export_list_active: self.allow_export_list_active,
+            vlan_id: self.vlan_id.map(Into::into),
+        }
+    }
+}
+
 #[derive(
     Queryable,
     Insertable,
@@ -638,6 +666,17 @@ pub struct SwitchPortBgpPeerConfigCommunity {
     pub community: SqlU32,
 }
 
+impl Into<BgpCommunity> for SwitchPortBgpPeerConfigCommunity {
+    fn into(self) -> BgpCommunity {
+        BgpCommunity {
+            port_settings_id: self.port_settings_id,
+            interface_name: self.interface_name,
+            addr: self.addr.into(),
+            community: self.community.into(),
+        }
+    }
+}
+
 #[derive(
     Queryable,
     Insertable,
@@ -660,6 +699,17 @@ pub struct SwitchPortBgpPeerConfigAllowExport {
     pub prefix: IpNetwork,
 }
 
+impl Into<BgpAllowedPrefix> for SwitchPortBgpPeerConfigAllowExport {
+    fn into(self) -> BgpAllowedPrefix {
+        BgpAllowedPrefix {
+            port_settings_id: self.port_settings_id,
+            interface_name: self.interface_name,
+            addr: self.addr.into(),
+            prefix: self.prefix.into(),
+        }
+    }
+}
+
 #[derive(
     Queryable,
     Insertable,
@@ -688,7 +738,7 @@ impl SwitchPortBgpPeerConfig {
         port_settings_id: Uuid,
         bgp_config_id: Uuid,
         interface_name: String,
-        p: &BgpPeer,
+        p: &BgpPeerCombined,
     ) -> Self {
         Self {
             port_settings_id,
@@ -721,6 +771,17 @@ impl SwitchPortBgpPeerConfig {
     }
 }
 
+impl Into<BgpAllowedPrefix> for SwitchPortBgpPeerConfigAllowImport {
+    fn into(self) -> BgpAllowedPrefix {
+        BgpAllowedPrefix {
+            port_settings_id: self.port_settings_id,
+            interface_name: self.interface_name,
+            addr: self.addr.into(),
+            prefix: self.prefix.into(),
+        }
+    }
+}
+
 #[derive(
     Queryable,
     Insertable,