public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Stefan Hanreich <s.hanreich@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH proxmox-ve-rs v3 07/21] frr: add ospf types
Date: Thu, 22 May 2025 18:16:28 +0200	[thread overview]
Message-ID: <20250522161731.537011-13-s.hanreich@proxmox.com> (raw)
In-Reply-To: <20250522161731.537011-1-s.hanreich@proxmox.com>

From: Gabriel Goller <g.goller@proxmox.com>

Add OSPF-specific FRR types. This also reuses the types from
proxmox-network-types.

The NetworkType FRR option is implemented here, but not exposed to the
interface, as we want to keep it simple for the users. If they do not
set an IP, then the interface is considered to be unnumbered and uses
the Point-to-Point network type.

Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
---
 proxmox-frr/src/lib.rs  |  25 ++++++
 proxmox-frr/src/ospf.rs | 179 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 204 insertions(+)
 create mode 100644 proxmox-frr/src/ospf.rs

diff --git a/proxmox-frr/src/lib.rs b/proxmox-frr/src/lib.rs
index ba9eedf..0d94aef 100644
--- a/proxmox-frr/src/lib.rs
+++ b/proxmox-frr/src/lib.rs
@@ -1,4 +1,5 @@
 pub mod openfabric;
+pub mod ospf;
 use std::{fmt::Display, str::FromStr};
 
 use serde::{Deserialize, Serialize};
@@ -31,6 +32,30 @@ impl Display for InterfaceName {
     }
 }
 
+/// Generic FRR Interface.
+///
+/// In FRR config it looks like this:
+/// ```text
+/// interface <name>
+/// ! ...
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize, PartialOrd, Ord)]
+pub enum Interface {
+    Openfabric(openfabric::OpenfabricInterface),
+    Ospf(ospf::OspfInterface),
+}
+
+impl From<openfabric::OpenfabricInterface> for Interface {
+    fn from(value: openfabric::OpenfabricInterface) -> Self {
+        Self::Openfabric(value)
+    }
+}
+
+impl From<ospf::OspfInterface> for Interface {
+    fn from(value: ospf::OspfInterface) -> Self {
+        Self::Ospf(value)
+    }
+}
+
 #[derive(Error, Debug)]
 pub enum FrrWordError {
     #[error("word is empty")]
diff --git a/proxmox-frr/src/ospf.rs b/proxmox-frr/src/ospf.rs
new file mode 100644
index 0000000..bebbd59
--- /dev/null
+++ b/proxmox-frr/src/ospf.rs
@@ -0,0 +1,179 @@
+use std::fmt::Debug;
+use std::fmt::Display;
+use std::net::Ipv4Addr;
+
+use serde::{Deserialize, Serialize};
+
+use thiserror::Error;
+
+use crate::{FrrWord, FrrWordError};
+
+/// The name of the ospf frr router. 
+/// 
+/// We can only have a single ospf router (ignoring multiple invocations of the ospfd daemon)
+/// because the router-id needs to be the same between different routers on a single node.
+/// We can still have multiple fabrics by separating them using areas. Still, different areas have
+/// the same frr router, so the name of the router is just "ospf" in "router ospf".
+///
+/// This serializes roughly to:
+/// ```text
+/// router ospf
+/// !...
+/// ```
+#[derive(Clone, Debug, PartialEq, Eq, Hash, Deserialize, Serialize, PartialOrd, Ord)]
+pub struct OspfRouterName;
+
+impl Display for OspfRouterName {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "ospf")
+    }
+}
+
+#[derive(Error, Debug)]
+pub enum AreaParsingError {
+    #[error("Invalid area idenitifier. Area must be a number or an ipv4 address.")]
+    InvalidArea,
+    #[error("Invalid area idenitifier. Missing 'area' prefix.")]
+    MissingPrefix,
+    #[error("Error parsing to FrrWord")]
+    FrrWordError(#[from] FrrWordError),
+}
+
+/// The OSPF Area.
+///
+/// The OSPF area is a pseud-ipaddress (so it looks like an ip-address but isn't set on any
+/// interface or even pingable), but can also be specified by a simple number. So you can use "5"
+/// or "0" as an area, which then gets translated to "0.0.0.5" and "0.0.0.0" by FRR. We allow both
+/// a number or an ip-address. Note that the area "0" (or "0.0.0.0") is a special area - it creates
+/// a OSPF "backbone" area.
+#[derive(Clone, Debug, PartialEq, Eq, Hash, Deserialize, Serialize, PartialOrd, Ord)]
+pub struct Area(FrrWord);
+
+impl TryFrom<FrrWord> for Area {
+    type Error = AreaParsingError;
+
+    fn try_from(value: FrrWord) -> Result<Self, Self::Error> {
+        Area::new(value)
+    }
+}
+
+impl Area {
+    pub fn new(name: FrrWord) -> Result<Self, AreaParsingError> {
+        if name.as_ref().parse::<u32>().is_ok() || name.as_ref().parse::<Ipv4Addr>().is_ok() {
+            Ok(Self(name))
+        } else {
+            Err(AreaParsingError::InvalidArea)
+        }
+    }
+}
+
+impl Display for Area {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "area {}", self.0)
+    }
+}
+
+/// The OSPF router properties.
+///
+/// Currently the only property of a OSPF router is the router_id. The router_id is used to
+/// differentiate between nodes and every node in the same area must have a different router_id.
+/// The router_id must also be the same on the different fabrics on the same node. The OSPFv2
+/// daemon only supports IPv4.
+/// Note that these properties also serialize with a space prefix (" ") as they are inside the OSPF
+/// router block. It serializes roughly to:
+///
+/// ```text
+/// router ospf
+///  router-id <ipv4-address>
+/// ```
+#[derive(Clone, Debug, PartialEq, Eq, Hash, Deserialize, Serialize, PartialOrd, Ord)]
+pub struct OspfRouter {
+    pub router_id: Ipv4Addr,
+}
+
+impl OspfRouter {
+    pub fn new(router_id: Ipv4Addr) -> Self {
+        Self { router_id }
+    }
+
+    pub fn router_id(&self) -> &Ipv4Addr {
+        &self.router_id
+    }
+}
+
+#[derive(Error, Debug)]
+pub enum OspfInterfaceError {
+    #[error("Error parsing area")]
+    AreaParsingError(#[from] AreaParsingError),
+    #[error("Error parsing frr word")]
+    FrrWordParse(#[from] FrrWordError),
+}
+
+/// The NetworkType of the interface.
+///
+/// The most important options here are Broadcast (which is the default) and PointToPoint.
+/// When PointToPoint is set, then the interface has to have a /32 address and will be treated as
+/// unnumbered.
+///
+/// This roughly serializes to:
+/// ```text
+/// ip ospf network point-to-point
+/// ! or
+/// ip ospf network broadcast
+/// ```
+#[derive(Clone, Debug, PartialEq, Eq, Hash, Deserialize, Serialize, PartialOrd, Ord)]
+pub enum NetworkType {
+    Broadcast,
+    NonBroadcast,
+    /// If the interface is unnumbered (i.e. the router-id /32 ip-address is set on the interface).
+    ///
+    /// If OSPF is used in an unnumbered way, you don't need to configure peer-to-peer (e.g. /31)
+    /// addresses at every interface, but you just need to set the router-id at the interface
+    /// (/32). You also need to configure the `ip ospf network point-to-point` FRR option.
+    PointToPoint,
+    PointToMultipoint,
+}
+
+impl Display for NetworkType {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        match self {
+            NetworkType::Broadcast => write!(f, "broadcast"),
+            NetworkType::NonBroadcast => write!(f, "non-broadcast"),
+            NetworkType::PointToPoint => write!(f, "point-to-point"),
+            NetworkType::PointToMultipoint => write!(f, "point-to-multicast"),
+        }
+    }
+}
+
+/// The OSPF interface properties.
+///
+/// The interface gets tied to its fabric by the area property and the FRR `ip ospf area <area>`
+/// command.
+///
+/// This serializes to:
+///
+/// ```text
+/// router ospf
+///  ip ospf area <area>
+///  ip ospf passive <value>
+///  ip ospf network <value>
+/// ```
+#[derive(Clone, Debug, PartialEq, Eq, Hash, Deserialize, Serialize, PartialOrd, Ord)]
+pub struct OspfInterface {
+    // Note: an interface can only be a part of a single area(so no vec needed here)
+    pub area: Area,
+    pub passive: Option<bool>,
+    pub network_type: Option<NetworkType>,
+}
+
+impl OspfInterface {
+    pub fn area(&self) -> &Area {
+        &self.area
+    }
+    pub fn passive(&self) -> &Option<bool> {
+        &self.passive
+    }
+    pub fn network_type(&self) -> &Option<NetworkType> {
+        &self.network_type
+    }
+}
-- 
2.39.5


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel


  parent reply	other threads:[~2025-05-22 16:18 UTC|newest]

Thread overview: 79+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-22 16:16 [pve-devel] [PATCH access-control/cluster/docs/gui-tests/manager/network/proxmox{, -firewall, -ve-rs, -perl-rs, -widget-toolkit} v3 00/75] Add SDN Fabrics Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox v3 1/4] network-types: initial commit Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox v3 2/4] network-types: make cidr and mac-address types usable by the api Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox v3 3/4] network-types: add api types for ipv4/6 Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox v3 4/4] api-macro: add allof schema to enum Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-firewall v3 1/1] firewall: nftables: migrate to proxmox-network-types Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 01/21] config: use proxmox_serde perl helpers Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 02/21] ve-config: move types to proxmox-network-types Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 03/21] sdn-types: initial commit Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 04/21] frr: create proxmox-frr crate Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 05/21] frr: add common frr types Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 06/21] frr: add openfabric types Stefan Hanreich
2025-05-22 16:16 ` Stefan Hanreich [this message]
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 08/21] frr: add route-map types Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 09/21] frr: add generic types over openfabric and ospf Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 10/21] config: sdn: fabrics: add section types Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 11/21] config: sdn: fabrics: add node " Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 12/21] config: sdn: fabrics: add interface name struct Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 13/21] config: sdn: fabrics: add openfabric properties Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 14/21] config: sdn: fabrics: add ospf properties Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 15/21] config: sdn: fabrics: add api types Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 16/21] config: sdn: fabrics: add section config Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 17/21] config: sdn: fabrics: add fabric config Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 18/21] common: sdn: fabrics: implement validation Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 19/21] sdn: fabrics: config: add conversion from / to section config Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 20/21] sdn: fabrics: implement FRR configuration generation Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-ve-rs v3 21/21] ve-config: add integrations tests Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-perl-rs v3 1/5] pve-rs: Add PVE::RS::SDN::Fabrics module Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-perl-rs v3 2/5] pve-rs: sdn: fabrics: add api methods Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-perl-rs v3 3/5] pve-rs: sdn: fabrics: add frr config generation Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-perl-rs v3 4/5] pve-rs: sdn: fabrics: add helper to generate ifupdown2 configuration Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH proxmox-perl-rs v3 5/5] pve-rs: sdn: fabrics: add helper for network API endpoint Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH pve-cluster v3 1/1] cfs: add fabrics.cfg to observed files Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH pve-access-control v3 1/1] permissions: add ACL paths for SDN fabrics Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH pve-network v3 01/21] sdn: fix value returned by pending_config Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH pve-network v3 02/21] debian: add dependency to proxmox-perl-rs Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH pve-network v3 03/21] fabrics: add fabrics module Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH pve-network v3 04/21] refactor: controller: move frr methods into helper Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH pve-network v3 05/21] frr: add new helpers for reloading frr configuration Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH pve-network v3 06/21] controllers: define new api for frr config generation Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH pve-network v3 07/21] sdn: add frr config generation helpers Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH pve-network v3 08/21] sdn: api: add check for rewriting frr configuration Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH pve-network v3 09/21] test: isis: add test for standalone configuration Stefan Hanreich
2025-05-22 16:16 ` [pve-devel] [PATCH pve-network v3 10/21] sdn: frr: add daemon status to frr helper Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-network v3 11/21] sdn: commit fabrics config to running configuration Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-network v3 12/21] fabrics: generate ifupdown configuration Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-network v3 13/21] fabrics: add jsonschema for fabrics and nodes Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-network v3 14/21] api: fabrics: add root-level module Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-network v3 15/21] api: fabrics: add fabric submodule Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-network v3 16/21] api: fabrics: add node submodule Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-network v3 17/21] api: fabrics: add fabricnode submodule Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-network v3 18/21] controller: evpn: add fabrics integration Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-network v3 19/21] zone: vxlan: " Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-network v3 20/21] test: fabrics: add test cases for ospf and openfabric + evpn Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-network v3 21/21] frr: bump frr config version to 10.2.2 Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH proxmox-widget-toolkit v3 1/1] network selector: add type parameter Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 01/18] api: use new sdn config generation functions Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 02/18] ui: fabrics: add model definitions for fabrics Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 03/18] fabric: add common interface panel Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 04/18] fabric: add OpenFabric interface properties Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 05/18] fabric: add OSPF " Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 06/18] fabric: add generic node edit panel Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 07/18] fabric: add OpenFabric node edit Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 08/18] fabric: add OSPF " Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 09/18] fabric: add generic fabric edit panel Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 10/18] fabric: add OpenFabric " Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 11/18] fabric: add OSPF " Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 12/18] fabrics: Add main FabricView Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 13/18] utils: avoid line-break in pending changes message Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 14/18] ui: permissions: add ACL path for fabrics Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 15/18] api: network: add include_sdn / fabric type Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 16/18] ui: add sdn networks to ceph / migration Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 17/18] ui: sdn: add evpn controller fabric integration Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-manager v3 18/18] ui: sdn: vxlan: add fabric property Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-gui-tests v3 1/1] pve: add sdn/fabrics screenshots Stefan Hanreich
2025-05-22 16:17 ` [pve-devel] [PATCH pve-docs v3 1/1] fabrics: add initial documentation for sdn fabrics Stefan Hanreich
2025-06-12 15:01 ` [pve-devel] [PATCH access-control/cluster/docs/gui-tests/manager/network/proxmox{, -firewall, -ve-rs, -perl-rs, -widget-toolkit} v3 00/75] Add SDN Fabrics Hannes Duerr
2025-06-26  7:04   ` Gabriel Goller
2025-06-26  8:02     ` Stefan Hanreich

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250522161731.537011-13-s.hanreich@proxmox.com \
    --to=s.hanreich@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal