public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Thomas Lamprecht <t.lamprecht@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH docs v4 38/41] pvecm: document the cluster ID and how to get a new one
Date: Thu, 19 Nov 2026 11:34:24 +0100	[thread overview]
Message-ID: <20261119103551.1666964-39-t.lamprecht@proxmox.com> (raw)
In-Reply-To: <20261119103551.1666964-1-t.lamprecht@proxmox.com>

Since Proxmox VE 9.3, clusters and standalone nodes have a random ID in
/etc/pve/cluster-id. Tools need it alongside the guest uid because
guests in different clusters can share a uid, for example after a
remote migration that keeps the source guest.

Explain where to read the ID, why generation can be delayed, and how
creating or joining a cluster affects it. pmxcfs protects the file
against ordinary changes from user space.

Cloned installations and nodes separated without reinstalling keep
their old ID. Document removal in forced local mode to get a new
one, and include it in the existing node-separation procedure. Warn
against doing this on a cluster member: the removal can propagate and
cause the entire cluster to generate a new ID.

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

changes v3 -> v4:
* the web interface shows the ID in the datacenter summary, not in the
  'Guest Identity' window
* a node without a cluster that cannot store its ID starts without one
* what happens if the generating node gets cut off, and when its ID can
  replace the one of the others
* the reasons for a missing ID as a list, with what to do if a directory
  takes up the path of the file
* the API also omits the field if reading the file fails
* the anchor is pvecm_cluster_id

changes v2 -> v3:
* the file can exist without a valid ID, and forced local mode also
  allows moving it away

 pmxcfs.adoc |   1 +
 pvecm.adoc  | 106 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 vzdump.adoc |   3 ++
 3 files changed, 110 insertions(+)

diff --git a/pmxcfs.adoc b/pmxcfs.adoc
index 1128425..be22131 100644
--- a/pmxcfs.adoc
+++ b/pmxcfs.adoc
@@ -95,6 +95,7 @@ Files
 |=======
 |`authkey.pub`                          | Public key used by the ticket system
 |`ceph.conf`                            | Ceph configuration file (note: /etc/ceph/ceph.conf is a symbolic link to this)
+|`cluster-id`                           | Random ID of the cluster, generated by pmxcfs and read-only (see xref:pvecm_cluster_id[Cluster ID])
 |`corosync.conf`                        | Corosync cluster configuration file (prior to {pve} 4.x, this file was called cluster.conf)
 |`datacenter.cfg`                       | {pve} datacenter-wide configuration (keyboard layout, proxy, ...)
 |`domains.cfg`                          | {pve} authentication domains
diff --git a/pvecm.adoc b/pvecm.adoc
index cd5a0fb..6d4666c 100644
--- a/pvecm.adoc
+++ b/pvecm.adoc
@@ -529,6 +529,14 @@ rm /etc/pve/corosync.conf
 rm -r /etc/corosync/*
 ----
 
+Remove the xref:pvecm_cluster_id[cluster ID], if the cluster has one.
+Without this step, the node keeps the ID of its former cluster instead of
+generating its own when the file system starts again as a normal service:
+[source,bash]
+----
+rm /etc/pve/cluster-id
+----
+
 You can now start the file system again as a normal service:
 [source,bash]
 ----
@@ -572,6 +580,104 @@ authentication. You should fix this by removing the respective keys from the
 '/etc/pve/priv/authorized_keys' file.
 
 
+[[pvecm_cluster_id]]
+Cluster ID
+----------
+
+Since {pve} 9.3, each cluster has a random cluster ID in the same format as the
+`uid` of a xref:guest_identity[guest identity]. A node that is not part of a
+cluster has an ID of its own. Guests in different clusters can have the same
+`uid`, for example after a migration to another cluster that kept the source
+guest. The cluster ID tells tools to which cluster the `uid` of a guest belongs.
+
+The cluster ID is stored in `/etc/pve/cluster-id`:
+
+----
+# cat /etc/pve/cluster-id
+----
+
+Through the API, `/cluster/status` returns it in the `cluster-id` field of the
+entry of type `cluster`. On a node without a cluster, the field is on the node
+entry instead. Reading the cluster ID through the API requires the `Sys.Audit`
+privilege on `/`. Users with this privilege also see it in the web interface
+(__Datacenter -> Summary__).
+
+{pve} generates the cluster ID and keeps it unchanged. Creating, changing,
+moving or removing `/etc/pve/cluster-id` fails with `Permission denied`. The
+only exception is removing or moving it away in local mode (`pmxcfs -l`), as
+described below. Nodes running a {pve} version older than 9.3 do not protect the
+file.
+
+A node without a cluster generates its ID when its cluster file system starts.
+If it cannot store the ID, for example because the root file system is full, it
+starts without one and generates it at the next start of the `pve-cluster`
+service. In a cluster, the online node with the lowest node ID generates the ID
+once all of the following apply:
+
+* The cluster is quorate.
+* More than half of the configured nodes are online.
+* The cluster file systems of the online nodes are in sync.
+
+If the node that generates the ID loses the connection to the other nodes at
+that moment, it reports its ID while the other nodes generate and report another
+one. When that node joins again, it normally takes over the ID of the others.
+Its own ID replaces theirs only if nothing in `/etc/pve` changed meanwhile and
+its clock is a few seconds ahead of theirs.
+
+Until an ID exists, the API omits the field, and the file is missing or holds
+no valid ID. The API also omits the field if reading the file fails. An ID can
+be missing for the following reasons:
+
+* The online node with the lowest node ID runs a {pve} version older than 9.3.
+  The cluster gets no ID as long as that is the case.
+* The online node with the lowest node ID runs {pve} 9.3 or later, but cannot
+  generate the ID yet. Its `pve-cluster` service then logs the reason in a
+  message starting with `not generating a cluster ID yet`.
+* A directory takes up the path of the file, for example one created on a node
+  with an older version. {pve} then logs that
+  `'cluster-id' is not a regular file`. Move the contents of the directory away
+  and remove it with `rmdir /etc/pve/cluster-id`. A cluster then generates the
+  ID within a few seconds. A node without a cluster generates it the next time
+  the `pve-cluster` service starts, for example after
+  `systemctl restart pve-cluster`.
+
+Creating a cluster with `pvecm create` keeps the ID of the node, which then
+identifies the new cluster. A node that joins a cluster takes over the ID of the
+cluster, because joining replaces the configuration of the node in `/etc/pve`.
+A copy of an installation, such as a cloned disk or a copy of the cluster file
+system database, has the same ID as the original.
+
+To give a node that is not part of a cluster a new ID, for example after cloning
+an installation, follow the steps below. To separate a node from its cluster,
+follow xref:pvecm_separate_node_without_reinstall[Separate a Node Without Reinstalling]
+instead. That procedure includes the removal of the cluster ID.
+
+WARNING: Do not remove `/etc/pve/cluster-id` on a node that is still part of a
+cluster. When that node rejoins the cluster, the removal is either undone, or it
+reaches all nodes and the whole cluster gets a new ID.
+
+. Stop the cluster file system and start it again in local mode:
++
+----
+# systemctl stop pve-cluster
+# pmxcfs -l
+----
+
+. Remove the cluster ID file:
++
+----
+# rm /etc/pve/cluster-id
+----
+
+. Stop the cluster file system and start it again as a normal service, which
+  generates a new ID:
++
+----
+# killall pmxcfs
+# systemctl start pve-cluster
+----
+
+
 Quorum
 ------
 
diff --git a/vzdump.adoc b/vzdump.adoc
index 5a813c4..f1a56be 100644
--- a/vzdump.adoc
+++ b/vzdump.adoc
@@ -679,6 +679,9 @@ The following places show the guest identity. All of them require the
 The configuration in a backup contains the `meta` property as well. You can
 show it with `pvesm extractconfig <volume>`, for example.
 
+To tell apart guests with the same `uid` in different clusters, combine the
+`uid` with the xref:pvecm_cluster_id[cluster ID].
+
 [[guest_identity_lifecycle]]
 Lifecycle
 ~~~~~~~~~
-- 
2.47.3





  parent reply	other threads:[~2026-11-19 10:41 UTC|newest]

Thread overview: 46+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-19 10:33 [PATCH cluster/guest-common/qemu-server/container/manager/docs v4 00/41] fix #7846: guest identity (uid) and cluster ID Thomas Lamprecht
2026-11-19 10:33 ` [PATCH cluster v4 01/41] pmxcfs: reject changes to the cluster ID file from user space Thomas Lamprecht
2026-11-19 10:33 ` [PATCH cluster v4 02/41] pmxcfs: generate a cluster ID on standalone nodes Thomas Lamprecht
2026-11-19 10:33 ` [PATCH cluster v4 03/41] pmxcfs: dfsm: add a callback that runs once all members are in sync Thomas Lamprecht
2026-11-19 10:33 ` [PATCH cluster v4 04/41] pmxcfs: quorum: record the corosync membership Thomas Lamprecht
2026-11-19 10:33 ` [PATCH cluster v4 05/41] pmxcfs: dcdb: generate the cluster ID once the cluster is in sync Thomas Lamprecht
2026-11-19 10:33 ` [PATCH cluster v4 06/41] cluster: add helper to read the cluster ID Thomas Lamprecht
2026-11-19 10:33 ` [PATCH cluster v4 07/41] pmxcfs: allow removing the cluster ID file in forced local mode Thomas Lamprecht
2026-11-19 10:33 ` [PATCH guest-common v4 08/41] guest identity: add helpers for the guest uid and registration time Thomas Lamprecht
2026-11-19 10:33 ` [PATCH guest-common v4 09/41] abstract config: assign a guest identity and keep it on config writes Thomas Lamprecht
2026-11-19 10:33 ` [PATCH guest-common v4 10/41] abstract config: let the VMID reservation return the previous state Thomas Lamprecht
2026-11-19 10:33 ` [PATCH guest-common v4 11/41] guest identity: allow adopting a uid that is unused in the cluster Thomas Lamprecht
2026-11-19 10:33 ` [PATCH guest-common v4 12/41] migrate: add shared helpers for the identity command of the migration tunnel Thomas Lamprecht
2026-11-19 10:33 ` [PATCH guest-common v4 13/41] vzdump: notes template: list the uid variable Thomas Lamprecht
2026-11-19 10:34 ` [PATCH qemu-server v4 14/41] api: restore: release the VMID if a restore to an unused VMID fails Thomas Lamprecht
2026-11-19 10:34 ` [PATCH qemu-server v4 15/41] api: migrate, clone: refuse targets that would drop the guest identity Thomas Lamprecht
2026-11-19 10:34 ` [PATCH qemu-server v4 16/41] fix #7846: config: add a guest identity to the 'meta' property Thomas Lamprecht
2026-11-19 10:34 ` [PATCH qemu-server v4 17/41] restore: take over the guest uid from the backup where possible Thomas Lamprecht
2026-11-19 10:34 ` [PATCH qemu-server v4 18/41] api: remote migration: take over the guest uid from the source Thomas Lamprecht
2026-11-19 10:34 ` [PATCH qemu-server v4 19/41] api: status: return the guest uid Thomas Lamprecht
2026-11-19 10:34 ` [PATCH container v4 20/41] restore: decide by the reservation whether the container is new Thomas Lamprecht
2026-11-19 10:34 ` [PATCH container v4 21/41] config: add read-only meta property with the creation time Thomas Lamprecht
2026-11-19 10:34 ` [PATCH container v4 22/41] fix #7846: config: add a guest identity to the 'meta' property Thomas Lamprecht
2026-11-19 10:34 ` [PATCH container v4 23/41] api: migrate, clone: refuse targets that would drop the guest identity Thomas Lamprecht
2026-11-19 10:34 ` [PATCH container v4 24/41] restore: take over the guest uid from the backup where possible Thomas Lamprecht
2026-11-19 10:34 ` [PATCH container v4 25/41] restore: refuse overwriting a container with another guest's backup Thomas Lamprecht
2026-11-19 10:34 ` [PATCH container v4 26/41] api: remote migration: take over the guest uid from the source Thomas Lamprecht
2026-11-19 10:34 ` [PATCH container v4 27/41] api: status: return the guest uid Thomas Lamprecht
2026-11-19 10:34 ` [PATCH manager v4 28/41] api: cluster resources: add guest uid and registration time Thomas Lamprecht
2026-11-19 10:34 ` [PATCH manager v4 29/41] api: cluster status: add cluster ID Thomas Lamprecht
2026-11-19 12:32   ` Lukas Wagner
2026-11-19 12:51     ` Thomas Lamprecht
2026-11-19 10:34 ` [PATCH manager v4 30/41] ui: datacenter summary: show the " Thomas Lamprecht
2026-11-19 10:34 ` [PATCH manager v4 31/41] ui: restore: allow overwriting a guest with a backup of another guest Thomas Lamprecht
2026-11-19 10:34 ` [PATCH manager v4 32/41] ui: migrate: refuse target nodes that would drop the guest identity Thomas Lamprecht
2026-11-19 10:34 ` [PATCH manager v4 33/41] ui: guest summary: show " Thomas Lamprecht
2026-11-19 10:34 ` [PATCH manager v4 34/41] api: bulk migrate: refuse targets that would drop " Thomas Lamprecht
2026-11-19 10:34 ` [PATCH manager v4 35/41] vzdump: notes template: add the guest uid as variable Thomas Lamprecht
2026-11-19 10:34 ` [PATCH docs v4 36/41] vzdump: restore: describe what a failed restore can leave behind Thomas Lamprecht
2026-11-19 10:34 ` [PATCH docs v4 37/41] vzdump: describe the guest identity of VMs and containers Thomas Lamprecht
2026-11-19 10:34 ` Thomas Lamprecht [this message]
2026-11-19 10:34 ` [PATCH docs v4 39/41] qm: configuration: describe the read-only meta property Thomas Lamprecht
2026-11-19 10:34 ` [PATCH docs v4 40/41] pct: " Thomas Lamprecht
2026-11-19 10:34 ` [PATCH docs v4 41/41] vzdump: notes: document the uid template variable Thomas Lamprecht
2026-11-19 14:46 ` [PATCH cluster/guest-common/qemu-server/container/manager/docs v4 00/41] fix #7846: guest identity (uid) and cluster ID Dominik Csapak
2026-11-19 19:49 ` superseded: " 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=20261119103551.1666964-39-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
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal