From: Thomas Lamprecht <t.lamprecht@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH manager v2 28/36] api: cluster status: add cluster ID
Date: Tue, 17 Nov 2026 23:34:38 +0100 [thread overview]
Message-ID: <20261117223945.862914-29-t.lamprecht@proxmox.com> (raw)
In-Reply-To: <20261117223945.862914-1-t.lamprecht@proxmox.com>
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 <t.lamprecht@proxmox.com>
---
changes v1 -> v2:
* rebase only
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 940dbbee..831984c8 100644
--- a/PVE/API2/Cluster.pm
+++ b/PVE/API2/Cluster.pm
@@ -923,6 +923,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,
@@ -963,6 +970,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 = [];
@@ -976,6 +984,7 @@ __PACKAGE__->register_method({
version => $d->{version},
name => $d->{name},
quorate => $d->{quorate},
+ defined($cluster_id) ? ('cluster-id' => $cluster_id) : (),
};
}
@@ -1017,6 +1026,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 a43d7da7..84dd46cc 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-report 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-report test-cluster-resources test-cluster-status
.PHONY: test-balloon
test-balloon:
@@ -69,6 +69,10 @@ test-report:
test-cluster-resources:
./ClusterResources_test.pl
+.PHONY: test-cluster-status
+test-cluster-status:
+ ./ClusterStatus_test.pl
+
.PHONY: install
install:
--
2.47.3
next prev parent reply other threads:[~2026-11-17 22:43 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-17 22:34 [PATCH cluster/guest-common/qemu-server/container/manager/docs v2 00/36] fix #7846: guest identity (uid) and cluster ID Thomas Lamprecht
2026-11-17 22:34 ` [PATCH cluster v2 01/36] pmxcfs: reject changes to the cluster ID file from user space Thomas Lamprecht
2026-11-17 22:34 ` [PATCH cluster v2 02/36] pmxcfs: generate a cluster ID on standalone nodes Thomas Lamprecht
2026-11-17 22:34 ` [PATCH cluster v2 03/36] pmxcfs: dfsm: add a callback that runs once all members are in sync Thomas Lamprecht
2026-11-17 22:34 ` [PATCH cluster v2 04/36] pmxcfs: quorum: pass the corosync membership to an optional listener Thomas Lamprecht
2026-11-17 22:34 ` [PATCH cluster v2 05/36] pmxcfs: dcdb: generate the cluster ID once the cluster is in sync Thomas Lamprecht
2026-11-17 22:34 ` [PATCH cluster v2 06/36] cluster: add helper to read the cluster ID Thomas Lamprecht
2026-11-17 22:34 ` [PATCH cluster v2 07/36] pmxcfs: allow removing the cluster ID file in forced local mode Thomas Lamprecht
2026-11-17 22:34 ` [PATCH guest-common v2 08/36] guest identity: add helpers for the guest uid and registration time Thomas Lamprecht
2026-11-17 22:34 ` [PATCH guest-common v2 09/36] abstract config: assign a guest identity and keep it on config writes Thomas Lamprecht
2026-11-17 22:34 ` [PATCH guest-common v2 10/36] abstract config: let the VMID reservation return the previous state Thomas Lamprecht
2026-11-17 22:34 ` [PATCH guest-common v2 11/36] guest identity: allow taking over a uid that is unused in the cluster Thomas Lamprecht
2026-11-17 22:34 ` [PATCH qemu-server v2 12/36] api: restore: release the VMID if a restore to an unused VMID fails Thomas Lamprecht
2026-11-17 22:34 ` [PATCH qemu-server v2 13/36] api: migrate, clone: refuse targets that would drop the guest identity Thomas Lamprecht
2026-11-17 22:34 ` [PATCH qemu-server v2 14/36] fix #7846: config: add a guest identity to the 'meta' property Thomas Lamprecht
2026-11-17 22:34 ` [PATCH qemu-server v2 15/36] restore: take over the guest uid from the backup where possible Thomas Lamprecht
2026-11-17 22:34 ` [PATCH qemu-server v2 16/36] api: remote migration: take over the guest uid from the source Thomas Lamprecht
2026-11-17 22:34 ` [PATCH qemu-server v2 17/36] api: status: return the guest uid Thomas Lamprecht
2026-11-17 22:34 ` [PATCH qemu-server v2 18/36] tests: remote migration: check a failed command and an early tunnel end Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 19/36] config: add read-only meta property with the creation time Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 20/36] fix #7846: config: add a guest identity to the 'meta' property Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 21/36] api: migrate, clone: refuse targets that would drop the guest identity Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 22/36] restore: take over the guest uid from the backup where possible Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 23/36] restore: refuse overwriting a container with another guest's backup Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 24/36] test: remote migration: check the cleanup of the target after failures Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 25/36] api: remote migration: take over the guest uid from the source Thomas Lamprecht
2026-11-17 22:34 ` [PATCH container v2 26/36] api: status: return the guest uid Thomas Lamprecht
2026-11-17 22:34 ` [PATCH manager v2 27/36] api: cluster resources: add guest uid and registration time Thomas Lamprecht
2026-11-17 22:34 ` Thomas Lamprecht [this message]
2026-11-17 22:34 ` [PATCH manager v2 29/36] ui: restore: allow overwriting a guest with a backup of another guest Thomas Lamprecht
2026-11-17 22:34 ` [PATCH manager v2 30/36] ui: migrate: refuse target nodes that would drop the guest identity Thomas Lamprecht
2026-11-17 22:34 ` [PATCH manager v2 31/36] ui: guest summary: show " Thomas Lamprecht
2026-11-17 22:34 ` [PATCH manager v2 32/36] api: migrate all: refuse targets that would drop " Thomas Lamprecht
2026-11-17 22:34 ` [PATCH docs v2 33/36] vzdump: describe the guest identity of VMs and containers Thomas Lamprecht
2026-11-17 22:34 ` [PATCH docs v2 34/36] pvecm: document the cluster ID and how to get a new one Thomas Lamprecht
2026-11-17 22:34 ` [PATCH docs v2 35/36] qm: configuration: describe the read-only meta property Thomas Lamprecht
2026-11-17 22:34 ` [PATCH docs v2 36/36] pct: " Thomas Lamprecht
2026-11-18 5:57 ` superseded: [PATCH cluster/guest-common/qemu-server/container/manager/docs v2 00/36] fix #7846: guest identity (uid) and cluster ID Thomas Lamprecht
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=20261117223945.862914-29-t.lamprecht@proxmox.com \
--to=t.lamprecht@proxmox.com \
--cc=pve-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