From: Stefan Hanreich <s.hanreich@proxmox.com>
To: pdm-devel@lists.proxmox.com
Subject: [pdm-devel] [PATCH proxmox-datacenter-manager 03/13] api: sdn: add create_zone endpoint
Date: Fri, 28 Feb 2025 16:17:53 +0100 [thread overview]
Message-ID: <20250228151803.158984-17-s.hanreich@proxmox.com> (raw)
In-Reply-To: <20250228151803.158984-1-s.hanreich@proxmox.com>
This endpoint is used for creating a new EVPN zone on multiple
remotes. It does the following actions when creating a new EVPN zone:
* 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 zone
* 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@proxmox.com>
---
lib/pdm-api-types/src/sdn.rs | 61 +++++++++++++++++++
lib/pdm-client/src/lib.rs | 7 +++
server/src/api/sdn/zones.rs | 111 +++++++++++++++++++++++++++++++++--
3 files changed, 173 insertions(+), 6 deletions(-)
diff --git a/lib/pdm-api-types/src/sdn.rs b/lib/pdm-api-types/src/sdn.rs
index 28b20c5..2f72bca 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-Z]{0,7}";
+}
+
+pub const SDN_ID_SCHEMA: Schema = StringSchema::new("The name for an SDN object.")
+ .min_length(1)
+ .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 355d3ac..bd6ca63 100644
--- a/lib/pdm-client/src/lib.rs
+++ b/lib/pdm-client/src/lib.rs
@@ -58,6 +58,7 @@ pub mod types {
pub use pve_api_types::PveUpid;
+ pub use pdm_api_types::sdn::{CreateZoneParams, ListZone};
pub use pve_api_types::ListZonesType;
}
@@ -861,6 +862,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..abdc737 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::{apply_sdn_configuration, create_locked_clients},
+};
-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,92 @@ 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 {
+ let mut locked_clients =
+ create_locked_clients(remotes.iter().map(|remote| remote.remote.clone())).await?;
+
+ for CreateZoneRemote { remote, controller } in remotes {
+ let create_zone = CreateZone {
+ zone: zone.clone(),
+ vrf_vxlan,
+ controller: Some(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_secret: None,
+ };
+
+ let client = locked_clients
+ .get(&remote)
+ .expect("client has been created for remote");
+
+ proxmox_log::info!("creating zone {zone} on remote {remote}");
+
+ if let Err(error) = client.create_zone(create_zone).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
_______________________________________________
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-02-28 15:25 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-02-28 15:17 [pdm-devel] [RFC proxmox{-api-types, -yew-comp, -datacenter-manager} 00/26] Add initial SDN / EVPN integration Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-api-types 01/12] sdn: add list/create zone endpoints Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-api-types 02/12] sdn: generate zones endpoints Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-api-types 03/12] sdn: add list/create vnet endpoints Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-api-types 04/12] sdn: generate " Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-api-types 05/12] sdn: add list/create controller endpoints Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-api-types 06/12] sdn: generate " Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-api-types 07/12] sdn: add acquire/release lock endpoints Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-api-types 08/12] sdn: generate " Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-api-types 09/12] sdn: add apply configuration endpoint Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-api-types 10/12] sdn: generate " Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-api-types 11/12] tasks: add helper for querying successfully finished tasks Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-api-types 12/12] sdn: add helpers for pending values Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-yew-comp 1/1] sdn: add descriptions for sdn tasks Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-datacenter-manager 01/13] server: add locked sdn client and helper methods Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-datacenter-manager 02/13] api: sdn: add list_zones endpoint Stefan Hanreich
2025-02-28 15:17 ` Stefan Hanreich [this message]
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-datacenter-manager 04/13] api: sdn: add list_vnets endpoint Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-datacenter-manager 05/13] api: sdn: add create_vnet endpoint Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-datacenter-manager 06/13] api: sdn: add list_controllers endpoint Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-datacenter-manager 07/13] ui: add VrfTree component Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-datacenter-manager 08/13] ui: sdn: add RouterTable component Stefan Hanreich
2025-02-28 15:17 ` [pdm-devel] [PATCH proxmox-datacenter-manager 09/13] ui: sdn: add AddVnetWindow component Stefan Hanreich
2025-02-28 15:18 ` [pdm-devel] [PATCH proxmox-datacenter-manager 10/13] ui: sdn: add AddZoneWindow component Stefan Hanreich
2025-02-28 15:18 ` [pdm-devel] [PATCH proxmox-datacenter-manager 11/13] ui: sdn: add EvpnPanel Stefan Hanreich
2025-02-28 15:18 ` [pdm-devel] [PATCH proxmox-datacenter-manager 12/13] ui: sdn: add EvpnPanel to main menu Stefan Hanreich
2025-02-28 15:18 ` [pdm-devel] [PATCH proxmox-datacenter-manager 13/13] pve: sdn: add descriptions for sdn tasks 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=20250228151803.158984-17-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.