[pdm-devel] [PATCH proxmox-datacenter-manager 05/13] api: sdn: add create_vnet endpoint

Stefan Hanreich s.hanreich at proxmox.com
Fri Feb 28 16:17:55 CET 2025


This endpoint is used for creating a new EVPN VNet on multiple
remotes. It does the following actions when creating a new EVPN VNet:

* lock the sdn configuration of all involved remotes
  * if it fails, release the lock on all remotes and return
    unsuccessfully
* invoke the API endpoints to create the new EVPN VNet
  * if it fails, no further changes will be made to the remote and the
    configuration will stay locked, no rollbacks
* apply the configuration on all remotes where the changes were
  successful
  * any errors during applying the configuration on a remote will be
    logged
  * the configuration will stay locked if applying the configuration
    fails
* reload the network configuration on all nodes where applying was
  successful

Signed-off-by: Stefan Hanreich <s.hanreich at proxmox.com>
---
 lib/pdm-api-types/src/sdn.rs | 45 ++++++++++++++++++
 lib/pdm-client/src/lib.rs    |  8 +++-
 server/src/api/sdn/vnets.rs  | 89 ++++++++++++++++++++++++++++++++++--
 3 files changed, 136 insertions(+), 6 deletions(-)

diff --git a/lib/pdm-api-types/src/sdn.rs b/lib/pdm-api-types/src/sdn.rs
index e944d60..5aaeb49 100644
--- a/lib/pdm-api-types/src/sdn.rs
+++ b/lib/pdm-api-types/src/sdn.rs
@@ -65,6 +65,51 @@ pub struct CreateZoneParams {
     pub remotes: Vec<CreateZoneRemote>,
 }
 
+#[api(
+    properties: {
+        remote: {
+            schema: REMOTE_ID_SCHEMA,
+        },
+        zone: {
+            schema: SDN_ID_SCHEMA,
+        },
+    }
+)]
+/// Describes the remote-specific informations for creating a new vnet.
+#[derive(Clone, Debug, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub struct CreateVnetRemote {
+    pub remote: String,
+    pub zone: String,
+}
+
+#[api(
+    properties: {
+        tag: {
+            schema: VXLAN_ID_SCHEMA,
+        },
+        remotes: {
+            type: Array,
+            description: "List of remotes and the zones in which the vnet should get created.",
+            items: {
+                type: CreateVnetRemote,
+            }
+        },
+        vnet: {
+            schema: SDN_ID_SCHEMA,
+        },
+    }
+)]
+/// Contains the information for creating a new vnet as well as information about the remotes where
+/// the vnet should get created.
+#[derive(Clone, Debug, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub struct CreateVnetParams {
+    pub tag: u32,
+    pub vnet: String,
+    pub remotes: Vec<CreateVnetRemote>,
+}
+
 #[api(
     properties: {
         remote: {
diff --git a/lib/pdm-client/src/lib.rs b/lib/pdm-client/src/lib.rs
index 42ea7b1..7ed6c62 100644
--- a/lib/pdm-client/src/lib.rs
+++ b/lib/pdm-client/src/lib.rs
@@ -58,7 +58,7 @@ pub mod types {
 
     pub use pve_api_types::PveUpid;
 
-    pub use pdm_api_types::sdn::{CreateZoneParams, ListZone};
+    pub use pdm_api_types::sdn::{CreateVnetParams, CreateZoneParams, ListVnet, ListZone};
     pub use pve_api_types::ListZonesType;
 }
 
@@ -882,6 +882,12 @@ impl<T: HttpApiClient> PdmClient<T> {
 
         Ok(self.0.post(path, &params).await?.expect_json()?.data)
     }
+
+    pub async fn pve_sdn_create_vnet(&self, params: CreateVnetParams) -> Result<String, Error> {
+        let path = "/api2/extjs/sdn/vnets";
+
+        Ok(self.0.post(path, &params).await?.expect_json()?.data)
+    }
 }
 
 /// Builder for migration parameters.
diff --git a/server/src/api/sdn/vnets.rs b/server/src/api/sdn/vnets.rs
index 2ac2956..58a1ba4 100644
--- a/server/src/api/sdn/vnets.rs
+++ b/server/src/api/sdn/vnets.rs
@@ -1,12 +1,23 @@
-use anyhow::Error;
+use anyhow::{format_err, Error};
 use pbs_api_types::REMOTE_ID_SCHEMA;
-use pdm_api_types::{remotes::RemoteType, sdn::ListVnet};
-use proxmox_router::Router;
+use pdm_api_types::{
+    remotes::RemoteType,
+    sdn::{CreateVnetRemote, ListVnet, SDN_ID_SCHEMA, VXLAN_ID_SCHEMA},
+    Authid,
+};
+use proxmox_rest_server::WorkerTask;
+use proxmox_router::{Router, RpcEnvironment};
 use proxmox_schema::api;
+use pve_api_types::{CreateVnet, SdnVnetType};
 
-use crate::api::pve::{connect, get_remote};
+use crate::{
+    api::pve::{connect, get_remote},
+    sdn_client::{apply_sdn_configuration, create_locked_clients},
+};
 
-pub const ROUTER: Router = Router::new().get(&API_METHOD_LIST_VNETS);
+pub const ROUTER: Router = Router::new()
+    .get(&API_METHOD_LIST_VNETS)
+    .post(&API_METHOD_CREATE_VNET);
 
 #[api(
     input: {
@@ -70,3 +81,71 @@ async fn list_vnets(
 
     Ok(result)
 }
+
+#[api(
+    input: {
+        properties: {
+            vnet: { schema: SDN_ID_SCHEMA },
+            tag: { schema: VXLAN_ID_SCHEMA, optional: true },
+            remotes: {
+                type: Array,
+                description: "List of remotes with the zone in which the VNet should get created.",
+                items: {
+                    type: CreateVnetRemote,
+                }
+            },
+        },
+    },
+    returns: { type: String, description: "Worker UPID" },
+)]
+/// Create a VNet across multiple remotes
+async fn create_vnet(
+    vnet: String,
+    tag: Option<u32>,
+    remotes: Vec<CreateVnetRemote>,
+    rpcenv: &mut dyn RpcEnvironment,
+) -> Result<String, Error> {
+    let auth_id: Authid = rpcenv
+        .get_auth_id()
+        .ok_or_else(|| format_err!("no authid available"))?
+        .parse()?;
+
+    let upid = WorkerTask::spawn(
+        "create_vnet",
+        None,
+        auth_id.to_string(),
+        false,
+        move |_worker| async move {
+            let mut locked_clients =
+                create_locked_clients(remotes.iter().map(|remote| remote.remote.clone())).await?;
+
+            for CreateVnetRemote { remote, zone } in &remotes {
+                let create_vnet = CreateVnet {
+                    alias: None,
+                    isolate_ports: None,
+                    tag,
+                    ty: Some(SdnVnetType::Vnet),
+                    vlanaware: None,
+                    vnet: vnet.to_string(),
+                    zone: zone.clone(),
+                    lock_secret: None,
+                };
+
+                let client = locked_clients
+                    .get(remote)
+                    .expect("client has been created for remote");
+
+                proxmox_log::info!("creating vnet {vnet} on remote {remote}");
+
+                if let Err(error) = client.create_vnet(create_vnet).await {
+                    proxmox_log::error!("could not create vnet for remote {remote}: {error:#}",);
+                    locked_clients.remove(remote);
+                }
+            }
+
+            apply_sdn_configuration(locked_clients).await
+        },
+    )?;
+
+    Ok(upid)
+}
-- 
2.39.5




More information about the pdm-devel mailing list