all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Thomas Lamprecht <t.lamprecht@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH cluster v2 06/36] cluster: add helper to read the cluster ID
Date: Tue, 17 Nov 2026 23:34:16 +0100	[thread overview]
Message-ID: <20261117223945.862914-7-t.lamprecht@proxmox.com> (raw)
In-Reply-To: <20261117223945.862914-1-t.lamprecht@proxmox.com>

Consumers such as the API should not need to know the cluster ID file
format. Add get_cluster_id() with the same validation rules as pmxcfs.
It returns undef for missing, empty, or invalid content, treating those
cases as "no ID yet".

Register the file for version tracking so cfs_read_file() refreshes its
cached value when the file changes. Do not provide a writer: pmxcfs
owns the file.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
---

changes v1 -> v2:
* use v5.36 in the new test script

 src/PVE/Cluster.pm          | 16 +++++++++++++
 src/pmxcfs/status.c         |  1 +
 src/test/Makefile           |  6 ++++-
 src/test/test_cluster_id.pl | 46 +++++++++++++++++++++++++++++++++++++
 4 files changed, 68 insertions(+), 1 deletion(-)
 create mode 100644 src/test/test_cluster_id.pl

diff --git a/src/PVE/Cluster.pm b/src/PVE/Cluster.pm
index 6ace846..076e49f 100644
--- a/src/PVE/Cluster.pm
+++ b/src/PVE/Cluster.pm
@@ -54,6 +54,7 @@ my $observed = {
     'replication.cfg' => 1,
     'corosync.conf' => 1,
     'corosync.conf.new' => 1,
+    'cluster-id' => 1,
     'firewall/cluster.fw' => 1,
     'user.cfg' => 1,
     'domains.cfg' => 1,
@@ -604,6 +605,21 @@ sub cfs_write_file {
     PVE::Tools::file_set_contents($fsname, $raw, undef, $force_utf8);
 }
 
+my $parse_cluster_id = sub {
+    my ($filename, $raw) = @_;
+
+    return undef if !defined($raw);
+    return $raw =~ m/^([a-z2-7]{20})\n?\z/ ? $1 : undef;
+};
+
+cfs_register_file('cluster-id', $parse_cluster_id);
+
+# Returns the ID of the cluster, or of the node if it is standalone, undef if there is none yet. IPC
+# errors other than a missing file are raised, like for other pmxcfs reads.
+sub get_cluster_id {
+    return cfs_read_file('cluster-id');
+}
+
 my $cfs_lock = sub {
     my ($lockid, $timeout, $code, @param) = @_;
 
diff --git a/src/pmxcfs/status.c b/src/pmxcfs/status.c
index f16dc20..bf69524 100644
--- a/src/pmxcfs/status.c
+++ b/src/pmxcfs/status.c
@@ -80,6 +80,7 @@ typedef struct {
 static memdb_change_t memdb_change_array[] = {
     {.path = "corosync.conf"},
     {.path = "corosync.conf.new"},
+    {.path = "cluster-id"},
     {.path = "storage.cfg"},
     {.path = "user.cfg"},
     {.path = "domains.cfg"},
diff --git a/src/test/Makefile b/src/test/Makefile
index cdd37d0..c84c435 100644
--- a/src/test/Makefile
+++ b/src/test/Makefile
@@ -4,7 +4,7 @@ cpgtest: cpgtest.c
 	gcc -Wall cpgtest.c $(shell pkg-config --cflags --libs libcpg libqb) -o cpgtest
 
 .PHONY: check install clean distclean
-check: corosync-parser-test test-mac-prefix
+check: corosync-parser-test test-mac-prefix test-cluster-id
 
 .PHONY: corosync-parser-test
 corosync-parser-test:
@@ -14,5 +14,9 @@ corosync-parser-test:
 test-mac-prefix:
 	perl test_mac_prefix.pl
 
+.PHONY: test-cluster-id
+test-cluster-id:
+	perl test_cluster_id.pl
+
 distclean: clean
 clean:
diff --git a/src/test/test_cluster_id.pl b/src/test/test_cluster_id.pl
new file mode 100644
index 0000000..33102e0
--- /dev/null
+++ b/src/test/test_cluster_id.pl
@@ -0,0 +1,46 @@
+use v5.36;
+
+use Test::MockModule;
+use Test::More;
+
+use lib ('.', '..');
+
+use PVE::Cluster;
+
+my $raw;
+my $cluster_module = Test::MockModule->new('PVE::Cluster');
+$cluster_module->mock(
+    get_config => sub {
+        my ($path) = @_;
+        die "unexpected path '$path'\n" if $path ne 'cluster-id';
+        return $raw;
+    },
+);
+
+my $cases = [
+    ["abcdefghijklmnopqrst\n", 'abcdefghijklmnopqrst', 'valid ID'],
+    ["uvwxyz234567abcdefgh\n", 'uvwxyz234567abcdefgh', 'valid ID with digits'],
+    ['abcdefghijklmnopqrst', 'abcdefghijklmnopqrst', 'valid ID without newline'],
+    [undef, undef, 'missing file'],
+    ['', undef, 'empty file'],
+    ["\n", undef, 'only a newline'],
+    ["abcdefghijklmnopqrst\n\n", undef, 'trailing empty line'],
+    ["abcdefghijklmnopqrst \n", undef, 'trailing space'],
+    [" abcdefghijklmnopqrst\n", undef, 'leading space'],
+    ["abcdefghijklmnopqrs\n", undef, 'too short'],
+    ["abcdefghijklmnop\n", undef, '16 characters'],
+    ["abcdefghijklmnopqrstu\n", undef, 'too long'],
+    ['abcdefghijklmnopqrstu', undef, 'too long without newline'],
+    ["ABCDEFGHIJKLMNOPQRST\n", undef, 'uppercase'],
+    ["abcdefghijklmnopqr01\n", undef, 'digits outside the base32 alphabet'],
+    ["abcdefghijklmnopqr89\n", undef, 'more digits outside the base32 alphabet'],
+    ["abcdefgh\njklmnopqrst\n", undef, 'embedded newline'],
+];
+
+for my $case ($cases->@*) {
+    my ($content, $expected, $name) = $case->@*;
+    $raw = $content;
+    is(PVE::Cluster::get_cluster_id(), $expected, $name);
+}
+
+done_testing();
-- 
2.47.3





  parent reply	other threads:[~2026-11-17 22:40 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 ` Thomas Lamprecht [this message]
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 ` [PATCH manager v2 28/36] api: cluster status: add cluster ID Thomas Lamprecht
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-7-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal