[pdm-devel] [PATCH datacenter-manager 5/9] server: api: pve: add remote cluster-status api call

Dominik Csapak d.csapak at proxmox.com
Mon Jan 13 16:45:46 CET 2025


so we can query the cluster status. Currently very useful to determine
the nodename of a target endpoint, since the cluster status contains
that information. For this reason we also include an explicit target_endpoint
parameter.

Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
---
 server/src/api/pve/mod.rs | 41 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 40 insertions(+), 1 deletion(-)

diff --git a/server/src/api/pve/mod.rs b/server/src/api/pve/mod.rs
index 48e16b2..2cefbb4 100644
--- a/server/src/api/pve/mod.rs
+++ b/server/src/api/pve/mod.rs
@@ -21,7 +21,9 @@ use pdm_api_types::{
 };
 
 use pve_api_types::client::PveClient;
-use pve_api_types::{ClusterResourceKind, ClusterResourceType, ListRealm, PveUpid};
+use pve_api_types::{
+    ClusterNodeStatus, ClusterResourceKind, ClusterResourceType, ListRealm, PveUpid,
+};
 
 use super::resources::{map_pve_lxc, map_pve_node, map_pve_qemu, map_pve_storage};
 
@@ -59,6 +61,7 @@ const REMOTE_SUBDIRS: SubdirMap = &sorted!([
     ("nodes", &NODES_ROUTER),
     ("qemu", &qemu::ROUTER),
     ("resources", &RESOURCES_ROUTER),
+    ("cluster-status", &STATUS_ROUTER),
     ("tasks", &tasks::ROUTER),
 ]);
 
@@ -68,6 +71,8 @@ const NODES_ROUTER: Router = Router::new()
 
 const RESOURCES_ROUTER: Router = Router::new().get(&API_METHOD_CLUSTER_RESOURCES);
 
+const STATUS_ROUTER: Router = Router::new().get(&API_METHOD_CLUSTER_STATUS);
+
 // converts a remote + PveUpid into a RemoteUpid and starts tracking it
 fn new_remote_upid(remote: String, upid: PveUpid) -> Result<RemoteUpid, Error> {
     let remote_upid: RemoteUpid = (remote, upid.to_string()).try_into()?;
@@ -175,6 +180,40 @@ pub async fn cluster_resources(
     Ok(cluster_resources.collect())
 }
 
+#[api(
+    input: {
+        properties: {
+            remote: { schema: REMOTE_ID_SCHEMA },
+            "target-endpoint": {
+                type: String,
+                optional: true,
+                description: "The target endpoint to use for the connection.",
+            },
+        },
+    },
+    returns: {
+        type: Array,
+        description: "Get all nodes Cluster Status",
+        items: { type: ClusterNodeStatus },
+    },
+    access: {
+        permission: &Permission::Privilege(&["resource", "{remote}"], PRIV_RESOURCE_AUDIT, false),
+    },
+)]
+/// Query the cluster nodes status.
+// FIXME: Use more fine grained permissions and filter on:
+//   - `/resource/{remote-id}/{resource-type=node}/{resource-id}`
+pub async fn cluster_status(
+    remote: String,
+    target_endpoint: Option<String>,
+) -> Result<Vec<ClusterNodeStatus>, Error> {
+    let (remotes, _) = pdm_config::remotes::config()?;
+    let remote = get_remote(&remotes, &remote)?;
+    let client = connection::make_pve_client_with_endpoint(remote, target_endpoint.as_deref())?;
+    let status = client.cluster_status().await?;
+    Ok(status)
+}
+
 fn map_pve_resource(remote: &str, resource: pve_api_types::ClusterResource) -> Option<PveResource> {
     match resource.ty {
         ClusterResourceType::Node => map_pve_node(remote, resource).map(PveResource::Node),
-- 
2.39.5





More information about the pdm-devel mailing list