Getting Started

Add Your First Node

Register a Proxmox host with flex.plane.

With the platform running, it is time to connect your first Proxmox node. This process involves generating a join token, installing the agent on your Proxmox host, and verifying the node appears in the platform.

Generate a join token

The join token allows a new node to authenticate with the mesh network and register itself with the orchestrator.

  1. Log in to the portal as an admin.
  2. Navigate to Infrastructure > Hosts.
  3. Click Add Host.

The portal generates a join token and provides the install command ready to copy.

  1. Copy the install command shown in the modal. It contains the join token and everything the agent needs to connect.

Install the agent

SSH into your Proxmox node and paste the install command you copied from the portal:

ssh root@your-proxmox-node

The command looks like this:

curl -fsSL https://<tenant>.flexplane.io/agent/install.sh | \
  JOIN_TOKEN=your-join-token-here \
  bash

The installer:

  1. Downloads the flexplane-agent binary for your architecture
  2. Creates the configuration file at /etc/default/flexplane-agent
  3. Registers the node with the mesh network using the join token
  4. Starts the agent as a systemd service

You can verify the agent is running:

systemctl status flexplane-agent
The agent listens on the mesh network interface only. It does not expose any ports on your public network. All communication between the orchestrator and the agent travels over the encrypted WireGuard mesh.

Understand cluster behavior

When you install the agent on one node of a Proxmox cluster, all nodes in that cluster become visible in the portal's zone view. The orchestrator discovers the cluster membership through Proxmox and shows every node.

However, the agent must be installed on each individual node for flex.plane to manage it. Nodes without the agent appear in the zone but cannot be used for VM creation, image downloads, or other management operations.

Install the agent on every Proxmox node you want to manage. The cluster-level discovery shows you what is there, but the agent is what makes a node operational within flex.plane.

Verify node registration

Once the agent is running and connected to the mesh, the node should appear in flex.plane within a few seconds.

Check hosts

Navigate to Infrastructure > Hosts. Your new node should appear with a Connected status, showing its hostname, zone, CPU count, and memory.

All connected hosts with their status, zone assignment, and resource information.

Check zones

The node is automatically assigned to a zone based on its Proxmox cluster membership. Navigate to Infrastructure > Zones to see the zone view.

Zones represent your Proxmox clusters. Each zone shows its hosts and aggregated resources.

Click on a zone to see detailed resource usage and the hosts within it.

The zone detail page shows individual host resources and overall zone capacity.

If the node does not appear, check the agent logs on the Proxmox host: journalctl -u flexplane-agent -f. Common issues include mesh connectivity problems or an expired join token.

Your infrastructure is now connected. The next step is to set up compute profiles, storage profiles, and images so you can create your first VM.