Skip to content
SYLVE

Data Center

The datacenter command group manages replicated notes and provides cluster inspection, shared guest-ID recovery, and address-recovery tools. Most commands contact the running Sylve daemon through its local console socket. The exception is cluster recover-ip, which operates on a stopped node.

Manage Data Center notes

Section titled “Manage Data Center notes”

List or read replicated notes with direct commands:

Terminal window
doas sylve datacenter notes list
doas sylve datacenter notes get --id 4

Create, update, or delete a note with explicit flags:

Terminal window
doas sylve datacenter notes add --title "Maintenance" --content "Rack work on Friday"
doas sylve datacenter notes update --id 4 --title "Maintenance" --content "Rack work at 20:00"
doas sylve datacenter notes delete --id 4

The interactive console uses positional values instead:

datacenter notes list
datacenter notes get 4
datacenter notes add "Maintenance" "Rack work on Friday"
datacenter notes update 4 "Maintenance" "Rack work at 20:00"
datacenter notes delete 4

These are the same notes shown under Data Center → Notes. Mutations are committed through the cluster leader and therefore require working quorum.

Inspect cluster state

Section titled “Inspect cluster state”

Show the local member’s cluster, consensus, and lifecycle state:

Terminal window
doas sylve datacenter cluster status

List the authoritative Raft membership, including addresses, suffrage, versions, and the current leader:

Terminal window
doas sylve datacenter cluster members

Use --json with either direct command when a script needs structured output. The same read-only commands work inside the console:

datacenter cluster status
datacenter cluster members

status exposes active join, leave, and readdress phases. Check it before repeating a recovery command after a timeout. A timeout does not prove that the earlier operation failed.

Inspect and reclaim shared guest IDs

Section titled “Inspect and reclaim shared guest IDs”

VM RIDs and Jail CTIDs share one cluster-wide range from 1 through 9999. Sylve records each claimed ID in replicated cluster state so two nodes cannot create different guests with the same numeric identity.

List the current claims before investigating an ID conflict:

Terminal window
doas sylve datacenter cluster guest-ids list

Add --json for structured output. The interactive console form is:

datacenter cluster guest-ids list

Use reclaim only when a claim is orphaned and the VM or jail no longer exists anywhere in the cluster:

Terminal window
doas sylve datacenter cluster guest-ids reclaim --id 505

The normal reclaim requires a clean inventory from the cluster and is rejected if the ID is registered on any reporting node or involved in an active operation. It also requires working cluster consensus.

If a voter is permanently unavailable, externally fence that node first. Then acknowledge the risk by repeating the exact guest ID:

Terminal window
doas sylve datacenter cluster guest-ids reclaim \
  --id 505 \
  --force \
  --confirm 505

The same flags work in the interactive console:

datacenter cluster guest-ids reclaim --id 505
datacenter cluster guest-ids reclaim --id 505 --force --confirm 505

Change a healthy member’s cluster IP

Section titled “Change a healthy member’s cluster IP”

Use readdress while the old cluster address still works and the cluster has quorum:

Terminal window
doas sylve datacenter cluster readdress \
  --new-ip 192.0.2.24 \
  --allow-disruption

The new address must be an IPv4 address assigned locally, must not already belong to another member, and must be able to bind Sylve’s cluster ports. The local member must be a voter, every participating member must run the same Sylve version, and no join, leave, state-repair, or conflicting mutation may be active. If the member is the leader, Sylve first transfers leadership to another voter.

The command commits the new Raft address and requests a Sylve restart. Expect the web interface, console socket, and cluster connectivity to be interrupted. Update the host’s network configuration before running the command so the new IP remains assigned after reboot.

Inside the interactive console, use the same flags:

datacenter cluster readdress --new-ip 192.0.2.24 --allow-disruption

Recover a member whose old IP is unavailable

Section titled “Recover a member whose old IP is unavailable”

Use this two-stage procedure only when a clustered node can no longer start on or reach its recorded IP.

  1. Stop Sylve on the affected node and ensure its new IPv4 address is configured locally.

  2. Run the offline recovery command on that node:

    Terminal window
    doas service sylve stop
    doas sylve datacenter cluster recover-ip \
      --new-ip 192.0.2.24 \
      --allow-disruption

  3. Start Sylve on the recovered node. Keep it isolated from workloads until membership is repaired.

  4. Copy the printed Node ID and repair command. Run the repair from a healthy cluster member with working quorum:

    Terminal window
    doas sylve datacenter cluster repair-address \
      --node-id 550e8400-e29b-41d4-a716-446655440000 \
      --new-ip 192.0.2.24 \
      --allow-disruption

  5. Run cluster status and cluster members to confirm the new address, leader, and membership.

recover-ip is a direct CLI command only because it requires the daemon and its console socket to be stopped. It updates the affected node’s local recovery state but does not rewrite Raft membership. repair-address verifies the recovered node’s identity at its new address before committing the membership change. It cannot bypass missing quorum.