From: Stefan Hanreich <s.hanreich@proxmox.com>
To: pdm-devel@lists.proxmox.com
Subject: [pdm-devel] [PATCH proxmox-datacenter-manager 04/16] api: sdn: add create_zone endpoint
Date: Wed, 27 Aug 2025 13:33:53 +0200 [thread overview]
Message-ID: <20250827113427.199253-21-s.hanreich@proxmox.com> (raw)
In-Reply-To: <20250827113427.199253-1-s.hanreich@proxmox.com>
This endpoint is used for creating a new EVPN zone on multiple
remotes. It utilizes the newly introduced LockSdnClients helper for
performing the action simultaneously across all remotes and rolling
back in case of failure.
Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
---
lib/pdm-api-types/src/sdn.rs | 61 ++++++++++++++++++++
lib/pdm-client/src/lib.rs | 7 +++
server/src/api/sdn/zones.rs | 108 +++++++++++++++++++++++++++++++++--
3 files changed, 170 insertions(+), 6 deletions(-)
diff --git a/lib/pdm-api-types/src/sdn.rs b/lib/pdm-api-types/src/sdn.rs
index 28b20c5..2fd988f 100644
--- a/lib/pdm-api-types/src/sdn.rs
+++ b/lib/pdm-api-types/src/sdn.rs
@@ -4,6 +4,67 @@ use serde::{Deserialize, Serialize};
use crate::remotes::REMOTE_ID_SCHEMA;
+pub const VXLAN_ID_SCHEMA: Schema = IntegerSchema::new("VXLAN VNI")
+ .minimum(1)
+ .maximum(16777215)
+ .schema();
+
+const_regex! {
+ SDN_ID_FORMAT = "[a-zA-Z][a-zA-Z0-9]*[a-zA-Z0-9]";
+}
+
+pub const SDN_ID_SCHEMA: Schema = StringSchema::new("The name for an SDN object.")
+ .min_length(2)
+ .max_length(8)
+ .format(&ApiStringFormat::Pattern(&SDN_ID_FORMAT))
+ .schema();
+
+#[api(
+ properties: {
+ remote: {
+ schema: REMOTE_ID_SCHEMA,
+ },
+ controller: {
+ schema: SDN_ID_SCHEMA,
+ },
+ }
+)]
+/// Describes the remote-specific informations for creating a new zone.
+#[derive(Clone, Debug, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub struct CreateZoneRemote {
+ pub remote: String,
+ pub controller: String,
+}
+
+#[api(
+ properties: {
+ "vrf-vxlan": {
+ schema: VXLAN_ID_SCHEMA,
+ optional: true,
+ },
+ remotes: {
+ type: Array,
+ description: "List of remotes and the controllers with which the zone should get created.",
+ items: {
+ type: CreateZoneRemote,
+ }
+ },
+ zone: {
+ schema: SDN_ID_SCHEMA,
+ },
+ }
+)]
+/// Contains the information for creating a new zone as well as information about the remotes where
+/// the zone should get created.
+#[derive(Clone, Debug, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub struct CreateZoneParams {
+ pub zone: String,
+ pub vrf_vxlan: Option<u32>,
+ pub remotes: Vec<CreateZoneRemote>,
+}
+
#[api(
properties: {
remote: {
diff --git a/lib/pdm-client/src/lib.rs b/lib/pdm-client/src/lib.rs
index 7489cac..ec48250 100644
--- a/lib/pdm-client/src/lib.rs
+++ b/lib/pdm-client/src/lib.rs
@@ -59,6 +59,7 @@ pub mod types {
pub use pve_api_types::PveUpid;
+ pub use pdm_api_types::sdn::{CreateZoneParams, ListZone};
pub use pve_api_types::ListZonesType;
}
@@ -928,6 +929,12 @@ impl<T: HttpApiClient> PdmClient<T> {
Ok(self.0.get(&path).await?.expect_json()?.data)
}
+
+ pub async fn pve_sdn_create_zone(&self, params: CreateZoneParams) -> Result<String, Error> {
+ let path = "/api2/extjs/sdn/zones";
+
+ Ok(self.0.post(path, ¶ms).await?.expect_json()?.data)
+ }
}
/// Builder for migration parameters.
diff --git a/server/src/api/sdn/zones.rs b/server/src/api/sdn/zones.rs
index 4b08736..a0227d3 100644
--- a/server/src/api/sdn/zones.rs
+++ b/server/src/api/sdn/zones.rs
@@ -1,13 +1,23 @@
-use anyhow::Error;
+use anyhow::{format_err, Error};
use pbs_api_types::REMOTE_ID_SCHEMA;
-use pdm_api_types::{remotes::RemoteType, sdn::ListZone};
-use proxmox_router::Router;
+use pdm_api_types::{
+ remotes::RemoteType,
+ sdn::{CreateZoneRemote, ListZone, 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::ListZonesType;
+use pve_api_types::{CreateZone, ListZonesType};
-use crate::api::pve::{connect, get_remote};
+use crate::{
+ api::pve::{connect, get_remote},
+ sdn_client::LockedSdnClients,
+};
-pub const ROUTER: Router = Router::new().get(&API_METHOD_LIST_ZONES);
+pub const ROUTER: Router = Router::new()
+ .get(&API_METHOD_LIST_ZONES)
+ .post(&API_METHOD_CREATE_ZONE);
#[api(
input: {
@@ -76,3 +86,89 @@ pub async fn list_zones(
Ok(result)
}
+
+#[api(
+ input: {
+ properties: {
+ zone: { schema: SDN_ID_SCHEMA },
+ "vrf-vxlan": {
+ schema: VXLAN_ID_SCHEMA,
+ optional: true,
+ },
+ remotes: {
+ type: Array,
+ description: "List of remotes with their controller where zone should get created.",
+ items: {
+ type: CreateZoneRemote
+ }
+ },
+ },
+ },
+ returns: { type: String, description: "Worker UPID" },
+)]
+/// Create a zone across multiple remotes
+async fn create_zone(
+ zone: String,
+ vrf_vxlan: Option<u32>,
+ remotes: Vec<CreateZoneRemote>,
+ 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_zone",
+ None,
+ auth_id.to_string(),
+ false,
+ move |_worker| async move {
+ LockedSdnClients::from_remote_names(
+ remotes
+ .into_iter()
+ .map(|remote| (remote.remote.clone(), remote)),
+ false,
+ )
+ .await?
+ .for_each(async move |client, ctx| {
+ let params = CreateZone {
+ zone: zone.clone(),
+ vrf_vxlan,
+ controller: Some(ctx.data().controller.clone()),
+ ty: ListZonesType::Evpn,
+ advertise_subnets: None,
+ bridge: None,
+ bridge_disable_mac_learning: None,
+ dhcp: None,
+ disable_arp_nd_suppression: None,
+ dns: None,
+ dnszone: None,
+ dp_id: None,
+ exitnodes: None,
+ exitnodes_local_routing: None,
+ exitnodes_primary: None,
+ ipam: None,
+ mac: None,
+ mtu: None,
+ nodes: None,
+ peers: None,
+ reversedns: None,
+ rt_import: None,
+ tag: None,
+ vlan_protocol: None,
+ vxlan_port: None,
+ lock_token: None,
+ fabric: None,
+ };
+
+ client.create_zone(params).await
+ })
+ .await?
+ .apply_and_release()
+ .await
+ },
+ )?;
+
+ Ok(upid)
+}
--
2.47.2
_______________________________________________
pdm-devel mailing list
pdm-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pdm-devel
next prev parent reply other threads:[~2025-08-27 11:34 UTC|newest]
Thread overview: 57+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-27 11:33 [pdm-devel] [PATCH network/proxmox{, -backup, -api-types, -datacenter-manager} 00/32] Add initial SDN / EVPN integration Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox 1/2] schema: use i64 for minimum / maximum / default integer values Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox 2/2] pbs-api-types: fix values for integer schemas Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-backup 1/1] api: change integer schema parameters to i64 Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH pve-network 1/6] sdn: api: return null for rollback / lock endpoints Stefan Hanreich
2025-08-28 7:56 ` Dominik Csapak
2025-08-28 9:22 ` Stefan Hanreich
2025-08-28 19:46 ` Thomas Lamprecht
2025-08-27 11:33 ` [pdm-devel] [PATCH pve-network 2/6] controllers: fix maximum value for ASN Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH pve-network 3/6] api: add state standard option Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH pve-network 4/6] api: controllers: update schema of endpoints Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH pve-network 5/6] api: vnets: " Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH pve-network 6/6] api: zones: " Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-api-types 1/7] add QemuMigratePreconditionsNotAllowedNodesBlockingHaResources struct Stefan Hanreich
2025-08-27 11:58 ` Dominik Csapak
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-api-types 2/7] sdn: add list/create zone endpoints Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-api-types 3/7] sdn: add list/create vnet endpoints Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-api-types 4/7] sdn: add list/create controller endpoints Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-api-types 5/7] sdn: add sdn configuration locking endpoints Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-api-types 6/7] tasks: add helper for querying successfully finished tasks Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-api-types 7/7] sdn: add helpers for pending values Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-datacenter-manager 01/16] server: add locked sdn client helpers Stefan Hanreich
2025-08-27 12:27 ` Dominik Csapak
2025-08-27 13:04 ` Stefan Hanreich
2025-08-27 13:10 ` Dominik Csapak
2025-08-27 13:22 ` Stefan Hanreich
2025-08-27 13:29 ` Dominik Csapak
2025-08-27 13:34 ` Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-datacenter-manager 02/16] ui: tasks: add descriptions for SDN tasks Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-datacenter-manager 03/16] api: sdn: add list_zones endpoint Stefan Hanreich
2025-08-27 11:33 ` Stefan Hanreich [this message]
2025-08-27 13:44 ` [pdm-devel] [PATCH proxmox-datacenter-manager 04/16] api: sdn: add create_zone endpoint Dominik Csapak
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-datacenter-manager 05/16] api: sdn: add list_vnets endpoint Stefan Hanreich
2025-08-27 13:45 ` Dominik Csapak
2025-08-28 9:01 ` Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-datacenter-manager 06/16] api: sdn: add create_vnet endpoint Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-datacenter-manager 07/16] api: sdn: add list_controllers endpoint Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-datacenter-manager 08/16] ui: sdn: add EvpnRouteTarget type Stefan Hanreich
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-datacenter-manager 09/16] ui: sdn: add vnet icon Stefan Hanreich
2025-08-27 14:06 ` Dominik Csapak
2025-08-28 9:04 ` Stefan Hanreich
2025-08-28 9:10 ` Dominik Csapak
2025-08-27 11:33 ` [pdm-devel] [PATCH proxmox-datacenter-manager 10/16] ui: sdn: add remote tree component Stefan Hanreich
2025-08-27 14:48 ` Dominik Csapak
2025-08-27 11:34 ` [pdm-devel] [PATCH proxmox-datacenter-manager 11/16] ui: add view for showing ip vrfs Stefan Hanreich
2025-08-28 7:15 ` Dominik Csapak
2025-08-27 11:34 ` [pdm-devel] [PATCH proxmox-datacenter-manager 12/16] ui: sdn: add AddVnetWindow component Stefan Hanreich
2025-08-28 7:49 ` Dominik Csapak
2025-08-27 11:34 ` [pdm-devel] [PATCH proxmox-datacenter-manager 13/16] ui: sdn: add AddZoneWindow component Stefan Hanreich
2025-08-28 7:50 ` Dominik Csapak
2025-08-27 11:34 ` [pdm-devel] [PATCH proxmox-datacenter-manager 14/16] ui: sdn: add EvpnPanel Stefan Hanreich
2025-08-28 7:54 ` Dominik Csapak
2025-08-27 11:34 ` [pdm-devel] [PATCH proxmox-datacenter-manager 15/16] ui: sdn: add EvpnPanel to main menu Stefan Hanreich
2025-08-27 14:07 ` Dominik Csapak
2025-08-27 11:34 ` [pdm-devel] [PATCH proxmox-datacenter-manager 16/16] pve: sdn: add descriptions for sdn tasks Stefan Hanreich
2025-08-28 8:06 ` [pdm-devel] [PATCH network/proxmox{, -backup, -api-types, -datacenter-manager} 00/32] Add initial SDN / EVPN integration Dominik Csapak
2025-08-29 14:54 ` [pdm-devel] superseded: " 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=20250827113427.199253-21-s.hanreich@proxmox.com \
--to=s.hanreich@proxmox.com \
--cc=pdm-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