[pve-devel] [PATCH pve-manager 3/8] pvestatd: add network resource to status reporting

[Stefan Hanreich]

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

The new network resource will act as the top-level resource for all
SDN / networking entities. The network resource contains a
network_type field, which indicates the type of networking resource -
similar to how the storage plugin handles different types of storages.
For now, it only contains SDN fabrics.

In the future, SDN zones, which are currently contained in the sdn
resource, will move to the network resource as well. To prepare for
this move, add support for the zone type in the API endpoint. To make
extending the resource with additional types easier, we ignore all
unknown network types in the API endpoint, so a node only returns the
types of network resources it can handle. This allows for easily
adding new types of network resources, without having to worry about
backwards-compatibility.

The main reason for moving over to a new resource type is the current
ID schema of the SDN resource, which is 'sdn/{zone_id}'. This makes it
hard to extend without the possibility of ID collisions. Additionally,
since the ID is used in several places throughout the backend / UI,
changing the schema would break compatibility with nodes that are on
an earlier version and would be an API break as well.

Co-authored-by: Stefan Hanreich <s.hanreich at proxmox.com>
Signed-off-by: Gabriel Goller <g.goller at proxmox.com>
Signed-off-by: Stefan Hanreich <s.hanreich at proxmox.com>
---
 PVE/API2/Cluster.pm     | 62 ++++++++++++++++++++++++++++++++++++++++-
 PVE/Service/pvestatd.pm | 17 +++++++++++
 2 files changed, 78 insertions(+), 1 deletion(-)

diff --git a/PVE/API2/Cluster.pm b/PVE/API2/Cluster.pm
index 479803960..34523fd7e 100644
--- a/PVE/API2/Cluster.pm
+++ b/PVE/API2/Cluster.pm
@@ -251,7 +251,8 @@ __PACKAGE__->register_method({
                 type => {
                     description => "Resource type.",
                     type => 'string',
-                    enum => ['node', 'storage', 'pool', 'qemu', 'lxc', 'openvz', 'sdn'],
+                    enum =>
+                        ['node', 'storage', 'pool', 'qemu', 'lxc', 'openvz', 'sdn', 'network'],
                 },
                 status => {
                     description => "Resource type dependent status.",
@@ -431,6 +432,23 @@ __PACKAGE__->register_method({
                     optional => 1,
                     default => 0,
                 },
+                network => {
+                    description => "The name of a Network entity (for type 'network').",
+                    type => "string",
+                    optional => 1,
+                },
+                network_type => {
+                    description => "The type of network resource (for type 'network').",
+                    type => "string",
+                    enum => ["fabric"],
+                    optional => 1,
+                },
+                protocol => {
+                    description =>
+                        "The protocol of a fabric (for type 'network', network_type 'fabric').",
+                    type => "string",
+                    optional => 1,
+                },
             },
         },
     },
@@ -620,6 +638,48 @@ __PACKAGE__->register_method({
             }
         }
 
+        if (!$param->{type} || $param->{type} eq 'network') {
+            my $nodes = PVE::Cluster::get_node_kv("network");
+
+            for my $node (sort keys $nodes->%*) {
+                my $node_config = decode_json($nodes->{$node});
+
+                for my $id (sort keys $node_config->%*) {
+                    my $entry = $node_config->{$id};
+
+                    if ($entry->{network_type} eq 'fabric') {
+                        next
+                            if !$rpcenv->check_any(
+                                $authuser,
+                                "/sdn/fabrics/$entry->{network}",
+                                ['SDN.Audit', 'SDN.Allocate'],
+                                1,
+                            );
+                    } elsif ($entry->{network_type} eq 'zone') {
+                        next
+                            if !$rpcenv->check(
+                                $authuser,
+                                "/sdn/zones/$entry->{network}",
+                                ['SDN.Audit'],
+                                1,
+                            );
+                    } else {
+                        # unknown type, so most likely introduced in a newer
+                        # version - avoid leaking information by suppressing any
+                        # unknown sdn types in the returned array.
+                        next;
+                    }
+
+                    push $res->@*,
+                        {
+                            "id" => "network/$node/$entry->{network_type}/$entry->{network}",
+                            "node" => $node,
+                            $entry->%*,
+                        };
+                }
+            }
+        }
+
         return $res;
     },
 });
diff --git a/PVE/Service/pvestatd.pm b/PVE/Service/pvestatd.pm
index 618d6139a..862bf8b43 100755
--- a/PVE/Service/pvestatd.pm
+++ b/PVE/Service/pvestatd.pm
@@ -15,6 +15,7 @@ use PVE::CpuSet;
 use Filesys::Df;
 use PVE::INotify;
 use PVE::Network;
+use PVE::RS::SDN::Fabrics;
 use PVE::NodeConfig;
 use PVE::Cluster qw(cfs_read_file);
 use PVE::Storage;
@@ -775,6 +776,18 @@ sub update_sdn_status {
     }
 }
 
+sub update_network_status {
+    my ($fabric_status) = PVE::RS::SDN::Fabrics::status();
+
+    my $network_status = {};
+
+    for my $fabric (values $fabric_status->%*) {
+        $network_status->{"fabric/$fabric->{network}"} = $fabric;
+    }
+
+    PVE::Cluster::broadcast_node_kv("network", encode_json($network_status));
+}
+
 my $broadcast_version_info_done = 0;
 my sub broadcast_version_info : prototype() {
     if (
@@ -840,6 +853,10 @@ sub update_status {
     $err = $@;
     syslog('err', "sdn status update error: $err") if $err;
 
+    eval { update_network_status(); };
+    $err = $@;
+    syslog('err', "network status update error: $err") if $err;
+
     eval { broadcast_version_info(); };
     $err = $@;
     syslog('err', "version info update error: $err") if $err;
-- 
2.47.3