From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [IPv6:2a0f:8001:1:32::40]) by lore.proxmox.com (Postfix) with ESMTPS id A8E871FF0E1 for ; Mon, 16 Nov 2026 01:51:13 +0100 (CET) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id E249C21653; Mon, 16 Nov 2026 01:48:41 +0100 (CET) From: Thomas Lamprecht To: pve-devel@lists.proxmox.com Subject: [PATCH manager 27/34] api: cluster status: add cluster ID Date: Mon, 16 Nov 2026 01:46:39 +0100 Message-ID: <20261116004703.2908294-28-t.lamprecht@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20261116004703.2908294-1-t.lamprecht@proxmox.com> References: <20261116004703.2908294-1-t.lamprecht@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1794790030428 X-SPAM-LEVEL: Spam detection results: 0 AWL -0.936 Adjusted score from AWL reputation of From: address DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) KAM_MAILER 2 Automated Mailer Tag Left in Email POISEN_SPAM_PILL 0.1 Meta: its spam POISEN_SPAM_PILL_1 0.1 random spam to be learned in bayes POISEN_SPAM_PILL_3 0.1 random spam to be learned in bayes RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: 3L4P27VFDGUKZWXWL7QQ2DBSBTMP24KA X-Message-ID-Hash: 3L4P27VFDGUKZWXWL7QQ2DBSBTMP24KA X-MailFrom: t.lamprecht@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Tools need an identifier of the cluster next to the guest uid, to tell apart guests with the same uid in different clusters. Cluster names are chosen freely and standalone nodes have none, and the existing 'id' fields only identify entries within the response. Return the ID that pmxcfs generates as 'cluster-id' on the cluster entry, or on the node entry for a standalone node. Omit it while no ID exists, for example as long as the cluster member with the lowest node ID runs an older version. Reading the ID requires Sys.Audit on '/', like the rest of this endpoint, while the guest uid and rtime in /cluster/resources only need VM.Audit on the guest. The ID is not a secret; restricting it to this endpoint is a cautious start, as access is easier to widen than to take back. Exposing it to less privileged users remains an option, to be weighed carefully, if a use case needs it. A failure to read the ID only omits the field, so the status stays available. It is not logged, as clients poll this endpoint often. Signed-off-by: Thomas Lamprecht --- PVE/API2/Cluster.pm | 10 ++++ test/ClusterStatus_test.pl | 114 +++++++++++++++++++++++++++++++++++++ test/Makefile | 6 +- 3 files changed, 129 insertions(+), 1 deletion(-) create mode 100755 test/ClusterStatus_test.pl diff --git a/PVE/API2/Cluster.pm b/PVE/API2/Cluster.pm index 346ecdb2..bd023c21 100644 --- a/PVE/API2/Cluster.pm +++ b/PVE/API2/Cluster.pm @@ -933,6 +933,13 @@ __PACKAGE__->register_method({ description => '[cluster] Indicates if there is a majority of nodes online to make decisions', }, + 'cluster-id' => { + type => 'string', + optional => 1, + description => + '[cluster] Random identifier of the cluster. A standalone node' + . ' reports its own identifier on its node entry.', + }, nodeid => { type => 'integer', optional => 1, @@ -973,6 +980,7 @@ __PACKAGE__->register_method({ my $members = PVE::Cluster::get_members(); my $nodename = PVE::INotify::nodename(); my $rrd = PVE::Cluster::rrd_dump(); + my $cluster_id = eval { PVE::Cluster::get_cluster_id() }; if ($members) { my $res = []; @@ -986,6 +994,7 @@ __PACKAGE__->register_method({ version => $d->{version}, name => $d->{name}, quorate => $d->{quorate}, + defined($cluster_id) ? ('cluster-id' => $cluster_id) : (), }; } @@ -1027,6 +1036,7 @@ __PACKAGE__->register_method({ nodeid => 0, online => 1, level => $sublevel, + defined($cluster_id) ? ('cluster-id' => $cluster_id) : (), }]; } }, diff --git a/test/ClusterStatus_test.pl b/test/ClusterStatus_test.pl new file mode 100755 index 00000000..02e9c1d6 --- /dev/null +++ b/test/ClusterStatus_test.pl @@ -0,0 +1,114 @@ +#!/usr/bin/perl + +use v5.36; + +use lib ('.', '..'); + +use Test::MockModule; +use Test::More; + +use PVE::JSONSchema; + +use PVE::API2::Cluster; +use PVE::API2::Subscription; + +my $nodename = 'node1'; +my $cluster_id = 'm4q7z2kd3x6ab5tyw3hc'; + +my $clinfo; +my $cluster_id_result; # code returning the result of reading the cluster ID + +my $cluster_mock = Test::MockModule->new('PVE::Cluster'); +$cluster_mock->redefine( + cfs_update => sub { }, + get_clinfo => sub { return $clinfo }, + get_members => sub { return $clinfo->{nodelist} }, + rrd_dump => sub { return {} }, + remote_node_ip => sub { return '192.0.2.1' }, + get_cluster_id => sub { return $cluster_id_result->() }, +); + +my $inotify_mock = Test::MockModule->new('PVE::INotify'); +$inotify_mock->redefine(nodename => sub { return $nodename }); + +my $subscription_mock = Test::MockModule->new('PVE::API2::Subscription'); +$subscription_mock->redefine(read_etc_subscription => sub { return { level => 'c' } }); + +my $cluster_info = { + cluster => { name => 'testcluster', nodes => 2, version => 3, quorate => 1 }, + nodelist => { + node1 => { id => 1, online => 1, ip => '192.0.2.1' }, + node2 => { id => 2, online => 0, ip => '192.0.2.2' }, + }, +}; +# what pmxcfs reports without a corosync configuration +my $standalone_info = { version => 1 }; + +my $method = PVE::API2::Cluster->map_method_by_name('get_status'); + +sub get_status() { + my $res = PVE::API2::Cluster->handle($method, {}); + PVE::JSONSchema::validate($res, $method->{returns}, "return schema violated\n"); + return $res; +} + +sub cluster_ids($res) { + return { map { $_->{id} => $_->{'cluster-id'} } grep { exists($_->{'cluster-id'}) } @$res }; +} + +for my $case ( + { + name => 'cluster with ID', + clinfo => $cluster_info, + read => sub { return $cluster_id }, + expected => { cluster => $cluster_id }, + }, + { + name => 'cluster without ID', + clinfo => $cluster_info, + read => sub { return undef }, + expected => {}, + }, + { + name => 'cluster, reading the ID fails', + clinfo => $cluster_info, + read => sub { die "Connection refused\n" }, + expected => {}, + }, + { + name => 'standalone node with ID', + clinfo => $standalone_info, + read => sub { return $cluster_id }, + expected => { "node/$nodename" => $cluster_id }, + }, + { + name => 'standalone node without ID', + clinfo => $standalone_info, + read => sub { return undef }, + expected => {}, + }, + { + name => 'standalone node, reading the ID fails', + clinfo => $standalone_info, + read => sub { die "Connection refused\n" }, + expected => {}, + }, +) { + subtest $case->{name} => sub { + $clinfo = $case->{clinfo}; + $cluster_id_result = $case->{read}; + + my $res = eval { get_status() }; + is($@, '', 'status does not fail'); + is_deeply(cluster_ids($res), $case->{expected}, 'cluster ID on the expected entry'); + + my $ids = [sort map { $_->{id} } @$res]; + if ($clinfo->{cluster}) { + is_deeply($ids, ['cluster', 'node/node1', 'node/node2'], 'entry IDs unchanged'); + } else { + is_deeply($ids, ["node/$nodename"], 'entry IDs unchanged'); + } + }; +} + +done_testing(); diff --git a/test/Makefile b/test/Makefile index 7eaa46a2..fea9d711 100644 --- a/test/Makefile +++ b/test/Makefile @@ -5,7 +5,7 @@ all: export PERLLIB=.. .PHONY: check -check: test-replication test-balloon test-vzdump test-osd test-ceph-health test-ceph-services test-ceph-auth test-ceph-key-migration test-ceph-lockbox-migration test-custom-cpu-models test-pvesh test-cluster-resources +check: test-replication test-balloon test-vzdump test-osd test-ceph-health test-ceph-services test-ceph-auth test-ceph-key-migration test-ceph-lockbox-migration test-custom-cpu-models test-pvesh test-cluster-resources test-cluster-status .PHONY: test-balloon test-balloon: @@ -65,6 +65,10 @@ test-pvesh: test-cluster-resources: ./ClusterResources_test.pl +.PHONY: test-cluster-status +test-cluster-status: + ./ClusterStatus_test.pl + .PHONY: install install: -- 2.47.3