From: Thomas Lamprecht <t.lamprecht@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH manager v5 29/41] api: cluster status: add cluster ID
Date: Thu, 19 Nov 2026 20:19:01 +0100 [thread overview]
Message-ID: <20261119191914.2336934-30-t.lamprecht@proxmox.com> (raw)
In-Reply-To: <20261119191914.2336934-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>
Reviewed-by: Dominik Csapak <d.csapak@proxmox.com>
Tested-by: Dominik Csapak <d.csapak@proxmox.com>
---
no changes since v4
changes v3 -> v4:
* rebase only (test Makefile)
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 d3ea77aa..f68a6717 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 5d7c0db3..64bf8e4e 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-access-log 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-access-log test-cluster-resources test-cluster-status
.PHONY: test-balloon
test-balloon:
@@ -73,6 +73,10 @@ test-access-log:
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-19 19:22 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-19 19:18 [PATCH cluster/guest-common/qemu-server/container/manager/docs v5 00/41] fix #7846: guest identity (uid) and cluster ID Thomas Lamprecht
2026-11-19 19:18 ` [PATCH cluster v5 01/41] pmxcfs: reject changes to the cluster ID file from user space Thomas Lamprecht
2026-11-19 19:18 ` [PATCH cluster v5 02/41] pmxcfs: generate a cluster ID on standalone nodes Thomas Lamprecht
2026-11-19 19:18 ` [PATCH cluster v5 03/41] pmxcfs: dfsm: add a callback that runs once all members are in sync Thomas Lamprecht
2026-11-19 19:18 ` [PATCH cluster v5 04/41] pmxcfs: quorum: record the corosync membership Thomas Lamprecht
2026-11-19 19:18 ` [PATCH cluster v5 05/41] pmxcfs: dcdb: generate the cluster ID once the cluster is in sync Thomas Lamprecht
2026-11-19 19:18 ` [PATCH cluster v5 06/41] cluster: add helper to read the cluster ID Thomas Lamprecht
2026-11-19 19:18 ` [PATCH cluster v5 07/41] pmxcfs: allow removing the cluster ID file in forced local mode Thomas Lamprecht
2026-11-19 19:18 ` [PATCH guest-common v5 08/41] guest identity: add helpers for the guest uid and registration time Thomas Lamprecht
2026-11-19 19:18 ` [PATCH guest-common v5 09/41] abstract config: assign a guest identity and keep it on config writes Thomas Lamprecht
2026-11-19 19:18 ` [PATCH guest-common v5 10/41] abstract config: let the VMID reservation return the previous state Thomas Lamprecht
2026-11-19 19:18 ` [PATCH guest-common v5 11/41] guest identity: allow adopting a uid that is unused in the cluster Thomas Lamprecht
2026-11-19 19:18 ` [PATCH guest-common v5 12/41] migrate: add shared helpers for the identity command of the migration tunnel Thomas Lamprecht
2026-11-19 19:18 ` [PATCH guest-common v5 13/41] vzdump: notes template: list the uid variable Thomas Lamprecht
2026-11-19 19:18 ` [PATCH qemu-server v5 14/41] api: restore: release the VMID if a restore to an unused VMID fails Thomas Lamprecht
2026-11-19 19:18 ` [PATCH qemu-server v5 15/41] api: migrate, clone: refuse targets that would drop the guest identity Thomas Lamprecht
2026-11-19 19:18 ` [PATCH qemu-server v5 16/41] fix #7846: config: add a guest identity to the 'meta' property Thomas Lamprecht
2026-11-19 19:18 ` [PATCH qemu-server v5 17/41] restore: adopt the guest uid from the backup where possible Thomas Lamprecht
2026-11-19 19:18 ` [PATCH qemu-server v5 18/41] api: remote migration: adopt the guest uid from the source Thomas Lamprecht
2026-11-19 19:18 ` [PATCH qemu-server v5 19/41] api: status: return the guest uid Thomas Lamprecht
2026-11-19 19:18 ` [PATCH container v5 20/41] restore: decide by the reservation whether the container is new Thomas Lamprecht
2026-11-19 19:18 ` [PATCH container v5 21/41] config: add read-only meta property with the creation time Thomas Lamprecht
2026-11-19 19:18 ` [PATCH container v5 22/41] fix #7846: config: add a guest identity to the 'meta' property Thomas Lamprecht
2026-11-19 19:18 ` [PATCH container v5 23/41] api: migrate, clone: refuse targets that would drop the guest identity Thomas Lamprecht
2026-11-19 19:18 ` [PATCH container v5 24/41] restore: adopt the guest uid from the backup where possible Thomas Lamprecht
2026-11-19 19:18 ` [PATCH container v5 25/41] restore: refuse overwriting a container with another guest's backup Thomas Lamprecht
2026-11-19 19:18 ` [PATCH container v5 26/41] api: remote migration: adopt the guest uid from the source Thomas Lamprecht
2026-11-19 19:18 ` [PATCH container v5 27/41] api: status: return the guest uid Thomas Lamprecht
2026-11-19 19:19 ` [PATCH manager v5 28/41] api: cluster resources: add guest uid and registration time Thomas Lamprecht
2026-11-19 19:19 ` Thomas Lamprecht [this message]
2026-11-19 19:19 ` [PATCH manager v5 30/41] ui: datacenter summary: show the cluster ID Thomas Lamprecht
2026-11-19 19:19 ` [PATCH manager v5 31/41] ui: restore: allow overwriting a guest with a backup of another guest Thomas Lamprecht
2026-11-19 19:19 ` [PATCH manager v5 32/41] ui: migrate: refuse target nodes that would drop the guest identity Thomas Lamprecht
2026-11-19 19:19 ` [PATCH manager v5 33/41] ui: guest summary: show " Thomas Lamprecht
2026-11-19 19:19 ` [PATCH manager v5 34/41] api: bulk migrate: refuse targets that would drop " Thomas Lamprecht
2026-11-19 19:19 ` [PATCH manager v5 35/41] vzdump: notes template: add the guest uid as variable Thomas Lamprecht
2026-11-19 19:19 ` [PATCH docs v5 36/41] vzdump: restore: describe what a failed restore can leave behind Thomas Lamprecht
2026-11-19 19:19 ` [PATCH docs v5 37/41] vzdump: describe the guest identity of VMs and containers Thomas Lamprecht
2026-11-19 19:19 ` [PATCH docs v5 38/41] pvecm: document the cluster ID and how to get a new one Thomas Lamprecht
2026-11-19 19:19 ` [PATCH docs v5 39/41] qm: configuration: describe the read-only meta property Thomas Lamprecht
2026-11-19 19:19 ` [PATCH docs v5 40/41] pct: " Thomas Lamprecht
2026-11-19 19:19 ` [PATCH docs v5 41/41] vzdump: notes: document the uid template variable Thomas Lamprecht
2026-11-20 3:07 ` [PATCH cluster/guest-common/qemu-server/container/manager/docs v5 00/41] 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=20261119191914.2336934-30-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