Reference material for Proxmox VE clusters.
Cluster Configuration Options
| Parameter | Default | Description |
|---|
name | required | Unique cluster name |
credential_id | required | Proxmox VE API credential ID |
ssh_key_credential_id | required | SSH key credential ID |
node | required | Proxmox node that hosts the cluster VMs |
bridge | required | Existing network bridge the VMs attach to (must provide DHCP) |
storage | local-lvm | Proxmox storage for VM disks |
template | auto-picked | Cloud-init template to clone, by VMID or name |
bastion_instance_type | px-small | Instance size for the bastion VM |
control_plane_count | 1 | Number of control plane nodes (1, 3, or 5) |
control_plane_instance_type | px-medium | Instance size for control planes |
node_groups | | Array of node group definitions |
distribution | k3s | Kubernetes distribution (k3s or kubeadm) |
kubernetes_version | latest stable | Kubernetes version (optional) |
cni | flannel (k3s) | CNI plugin. kubeadm clusters always use cilium |
etcd_topology | stacked | kubeadm only. stacked or external (dedicated etcd VMs) |
etcd_node_count | 3 | kubeadm external topology only (3 or 5) |
etcd_instance_type | px-medium | kubeadm external topology only. Instance size for etcd nodes |
Instance Sizes
| Size | vCPUs | RAM | Disk | Typical use |
|---|
px-small | 2 | 4 GB | 40 GB | Bastion |
px-medium | 4 | 8 GB | 80 GB | Control plane, general workers |
px-large | 8 | 16 GB | 160 GB | Larger workloads |
px-xlarge | 16 | 32 GB | 320 GB | Heavy workloads |
Proxmox VE has no list pricing, so Ankra does not show cost estimates for Proxmox clusters.
Node Group API Reference
| Endpoint | Method | Description |
|---|
/api/v1/clusters/proxmox/{id}/node-groups | GET | List all node groups |
/api/v1/clusters/proxmox/{id}/node-groups | POST | Add a node group |
/api/v1/clusters/proxmox/{id}/node-groups/{name}/scale | PUT | Scale a node group (0-100) |
/api/v1/clusters/proxmox/{id}/node-groups/{name}/instance-type | PUT | Change instance size |
/api/v1/clusters/proxmox/{id}/node-groups/{name}/labels | PUT | Update labels |
/api/v1/clusters/proxmox/{id}/node-groups/{name}/taints | PUT | Update taints |
/api/v1/clusters/proxmox/{id}/node-groups/{name} | DELETE | Delete a node group |
