Skip to main content
Ankra supports provisioning fully managed Kubernetes clusters on Proxmox VE. You bring your own Proxmox nodes, storage, and network bridge - Ankra creates the VMs, installs Kubernetes, and manages the full cluster lifecycle: node groups, scaling, upgrades, and deprovisioning.
Closed beta. Proxmox VE cluster provisioning is in closed beta. The workflow is stable but the surface may still change, and it is enabled per organisation on request. Contact support to have it turned on for your organisation.

Prerequisites

Before creating a Proxmox VE cluster, you need two credentials:

Proxmox VE API Credential

The Proxmox API URL and an API token with VM management privileges. See Proxmox VE Credentials.

SSH Key Credential

An SSH public key for VM access. You can provide your own or let Ankra generate one. See SSH Key Credentials.
Your Proxmox environment must also provide:
  • A cloud-init VM template (e.g., Ubuntu 24.04) with the QEMU guest agent installed, registered on the node you deploy to. Ankra clones this template for every cluster VM and reads each VM’s IP address through the guest agent. You can pin a specific template with the template option; otherwise the first template on the node is used.
  • An existing network bridge with DHCP. Ankra does not create or modify bridges - you select one at creation, and all cluster VMs get their addresses from DHCP on that bridge.
  • Storage with free space on the Proxmox node you deploy to, for the VM disks.
  • API reachability. The Proxmox API must be reachable from Ankra either directly or through an SSH jumphost.

Hybrid Connectivity (SSH Jumphost)

Many Proxmox environments are not directly reachable from the internet. If the Proxmox API and the VM network cannot be reached from Ankra, attach an SSH jumphost (host, port, username, and private key) to your Proxmox VE credential. Ankra then tunnels both the Proxmox API calls and the SSH connections to your cluster nodes through the jumphost. If your Proxmox API uses a self-signed certificate, enable the TLS insecure toggle (tls_insecure) on the credential. Both options are configured on the credential - see Proxmox VE Credentials.

Creating a Proxmox VE Cluster

Via the Platform UI

1

Navigate to Clusters

Go to Clusters in the Ankra dashboard and click Create Cluster.
2

Select Proxmox VE

Choose Proxmox VE as the provider.
3

Select Credentials

Pick your Proxmox VE API credential and SSH key credential from the dropdowns. You can also create new credentials directly from the wizard.
4

Choose Placement

Select the Proxmox node to host the cluster VMs, the storage for VM disks, and the network bridge the VMs attach to. The bridge must provide DHCP.
5

Configure Nodes

Set your cluster topology:
  • Bastion - Instance size for the SSH bastion VM (e.g., px-small)
  • Control Plane - Count (1, 3, or 5) and size (e.g., px-medium)
  • Workers - Count and size (e.g., 2× px-medium)
The wizard shows vCPUs, memory, and disk for each size. Proxmox has no list pricing, so no cost estimate is shown.
6

Choose Distribution

Pick the Kubernetes distribution: k3s Lightweight Kubernetes with a user-selectable CNI (Flannel default, Calico, or Cilium). kubeadm Vanilla upstream Kubernetes bootstrapped with kubeadm and containerd. kubeadm clusters always use Cilium CNI and optionally support an external etcd topology with dedicated etcd VMs.See Kubernetes Distribution for details.
7

Create & Track Progress

Click Create to start provisioning. A live progress view tracks credential setup, SSH key deployment, bastion provisioning, VM creation, Kubernetes installation (k3s or kubeadm), and Ankra Agent setup. The cluster appears with an offline state until provisioning completes, then transitions to online.

Via the API

Proxmox VE clusters are managed from the portal or API during the closed beta - the ankra CLI does not yet include Proxmox commands. Create the Proxmox VE credential and SSH key credential from the portal first.
curl -X POST https://platform.ankra.app/api/v1/clusters/proxmox \
  -H "Authorization: Bearer $ANKRA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-cluster",
    "credential_id": "<proxmox-credential-id>",
    "ssh_key_credential_id": "<ssh-key-credential-id>",
    "node": "pve01",
    "storage": "local-lvm",
    "bridge": "vmbr0",
    "control_plane_count": 1,
    "control_plane_instance_type": "px-medium",
    "node_groups": [
      {"name": "default", "instance_type": "px-medium", "count": 2}
    ],
    "distribution": "k3s"
  }'

Cluster Configuration Options

ParameterDefaultDescription
namerequiredUnique cluster name
credential_idrequiredProxmox VE API credential ID
ssh_key_credential_idrequiredSSH key credential ID
noderequiredProxmox node that hosts the cluster VMs
bridgerequiredExisting network bridge the VMs attach to (must provide DHCP)
storagelocal-lvmProxmox storage for VM disks
templateauto-pickedCloud-init template to clone, by VMID or name. Defaults to the first template on the node
bastion_instance_typepx-smallInstance size for the bastion VM
control_plane_count1Number of control plane nodes (1, 3, or 5)
control_plane_instance_typepx-mediumInstance size for control planes
worker_count1Number of worker nodes (legacy, use node_groups instead)
worker_instance_typepx-mediumInstance size for workers (legacy, use node_groups instead)
node_groupsArray of node group definitions (see Node Groups)
distributionk3sKubernetes distribution (k3s or kubeadm)
kubernetes_versionlatest stableKubernetes version (optional)
cniflannel (k3s)CNI plugin (flannel, calico, or cilium). kubeadm clusters always use cilium
etcd_topologystackedkubeadm only. stacked (etcd on control planes) or external (dedicated etcd VMs)
etcd_node_count3kubeadm external topology only. Number of dedicated etcd VMs (3 or 5)
etcd_instance_typepx-mediumkubeadm external topology only. Instance size for dedicated etcd nodes

Instance Sizes

Proxmox VE clusters use fixed instance size presets:
SizevCPUsRAMDiskTypical use
px-small24 GB40 GBBastion
px-medium48 GB80 GBControl plane, general workers
px-large816 GB160 GBLarger workloads
px-xlarge1632 GB320 GBHeavy workloads
Proxmox VE has no list pricing, so Ankra does not show cost estimates for Proxmox clusters - neither in the creation wizard nor in Cloud Cost.

Networking

Ankra does not create networks or bridges on Proxmox. You select an existing bridge at creation, and all cluster VMs receive their IP addresses via DHCP on that bridge. Make sure the bridge has a DHCP server available before creating the cluster.

Kubernetes Distribution

Proxmox VE clusters can be provisioned with either k3s (default) or kubeadm.
k3skubeadm
KubernetesLightweight, single-binary distributionVanilla upstream Kubernetes
CNIUser-selectable (Flannel default, Calico, or Cilium)Cilium (fixed, cannot be changed after creation)
etcdEmbeddedstacked (on control planes) or external (dedicated VMs)
Version formatv1.35.1+k3s1v1.31.0 (plain upstream tag)
kubeadm clusters always use Cilium CNI (eBPF-based networking, L7 policies, Hubble observability). The CNI cannot be changed after creation.

External etcd topology (kubeadm)

By default kubeadm runs etcd stacked on the control plane nodes. For larger clusters you can run etcd on dedicated VMs by setting etcd_topology to external:
curl -X POST https://platform.ankra.app/api/v1/clusters/proxmox \
  -H "Authorization: Bearer $ANKRA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-cluster",
    "credential_id": "<proxmox-credential-id>",
    "ssh_key_credential_id": "<ssh-key-credential-id>",
    "node": "pve01",
    "storage": "local-lvm",
    "bridge": "vmbr0",
    "control_plane_count": 3,
    "control_plane_instance_type": "px-medium",
    "node_groups": [
      {"name": "default", "instance_type": "px-medium", "count": 2}
    ],
    "distribution": "kubeadm",
    "etcd_topology": "external",
    "etcd_node_count": 3,
    "etcd_instance_type": "px-medium"
  }'

Node Groups

Node groups let you organize worker nodes into logical groups with independent instance sizes, counts, labels, and taints. Manage node groups from Settings > Nodes in the dashboard, or via the API.

Node Group API Reference

EndpointMethodDescription
/api/v1/clusters/proxmox/{id}/node-groupsGETList all node groups
/api/v1/clusters/proxmox/{id}/node-groupsPOSTAdd a node group
/api/v1/clusters/proxmox/{id}/node-groups/{name}/scalePUTScale a node group (0-100)
/api/v1/clusters/proxmox/{id}/node-groups/{name}/instance-typePUTChange instance size
/api/v1/clusters/proxmox/{id}/node-groups/{name}/labelsPUTUpdate labels
/api/v1/clusters/proxmox/{id}/node-groups/{name}/taintsPUTUpdate taints
/api/v1/clusters/proxmox/{id}/node-groups/{name}DELETEDelete a node group
For detailed usage examples, see Hetzner Node Groups - the API is identical across all providers.

Legacy Worker Scaling

The legacy scale-workers and worker-count endpoints operate on all workers as a single pool.
curl https://platform.ankra.app/api/v1/clusters/proxmox/<cluster_id>/worker-count \
  -H "Authorization: Bearer $ANKRA_API_TOKEN"

curl -X POST https://platform.ankra.app/api/v1/clusters/proxmox/<cluster_id>/scale-workers \
  -H "Authorization: Bearer $ANKRA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"worker_count": 4}'
Prefer using Node Groups for more granular control.

Upgrading Kubernetes Version

You can upgrade the Kubernetes version on all nodes in a Proxmox VE cluster. Upgrades are applied to control plane nodes first, then workers. Both k3s and kubeadm clusters are supported.
  • Both k3s and kubeadm clusters are supported for version upgrades, including kubeadm clusters with an external etcd topology: the dedicated etcd members are upgraded first, one at a time, each saving a pre-upgrade snapshot before its static pod rolls to the etcd image matching the target Kubernetes version.
  • Use the matching version format for the target: v1.35.1+k3s1 for k3s, or a plain v1.31.0 upstream tag for kubeadm.
  • Downgrades are not supported - downgrades require an etcd snapshot restore.
  • You can only upgrade one minor version at a time (e.g., v1.33.x to v1.34.x, not v1.33.x to v1.35.x).
  • The cluster must be online with no active operations.

Check Current Version

curl https://platform.ankra.app/api/v1/clusters/proxmox/<cluster_id>/k8s-version \
  -H "Authorization: Bearer $ANKRA_API_TOKEN"

Upgrade Version

curl -X POST https://platform.ankra.app/api/v1/clusters/proxmox/<cluster_id>/upgrade-k8s-version \
  -H "Authorization: Bearer $ANKRA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target_version": "v1.35.1+k3s1"}'
For a kubeadm cluster, use a plain upstream tag instead (for example "target_version": "v1.31.0").

Deprovisioning

Deprovisioning deletes all VMs Ankra created on your Proxmox nodes (bastion, control planes, workers, and dedicated etcd VMs if any) and removes the cluster from Ankra. Your Proxmox nodes, storage, and bridges are left untouched.
This action is irreversible. All data on the cluster will be permanently deleted.
curl -X DELETE https://platform.ankra.app/api/v1/clusters/proxmox/<cluster_id> \
  -H "Authorization: Bearer $ANKRA_API_TOKEN"

Architecture

A Proxmox VE cluster provisions the following infrastructure:
ComponentDescription
Bastion VMJump server for secure SSH access to cluster nodes
Control Plane(s)Kubernetes control plane VMs (1, 3, or 5)
Worker(s)Kubernetes worker VMs organized in node groups
etcd Node(s)Dedicated etcd VMs, only for kubeadm clusters with an external etcd topology
SSH KeysDeployed to all VMs for access
All VMs are QEMU virtual machines on the Proxmox node you selected, attached to your existing bridge with DHCP addressing. The bastion VM provides the only SSH access point Ankra uses to reach the cluster nodes. When an SSH jumphost is configured, Ankra reaches both the Proxmox API and the bastion through the jumphost.
Proxmox VE clusters do not include a cloud controller manager or load balancer integration - external_cloud_provider is not supported. Kubernetes LoadBalancer services are not provisioned automatically; expose workloads with NodePort services, an ingress controller, or a load balancer solution you deploy yourself.

Troubleshooting

Common Issues

IssueSolution
Proxmox API unreachable from AnkraAttach an SSH jumphost to the credential - Ankra tunnels API calls and node SSH through it
TLS certificate errors (self-signed)Enable the TLS insecure toggle (tls_insecure) on the Proxmox VE credential
Nodes never get an IP addressThe selected bridge must provide DHCP - Ankra does not manage IP allocation. Verify a DHCP server answers on that bridge
Provisioning fails waiting for a VM’s IP addressThe cloned template must have the QEMU guest agent installed and enabled - Ankra reads VM addresses through the agent. Rebuild the template with qemu-guest-agent and retry
No VM templates found on the nodeCreate a cloud-init template on the selected Proxmox node first - Ankra clones it for every cluster VM
Cluster stuck in provisioningCheck the API token privileges (see Proxmox VE Credentials) and free capacity on the selected node and storage
VM creation fails with a permission errorThe API token is missing privileges (e.g., VM.Allocate, Datastore.AllocateSpace) on the selected node, storage, or bridge
LoadBalancer service stuck in PendingProxmox clusters have no cloud controller manager - use NodePort, ingress, or your own load balancer
No cost estimates shownExpected - Proxmox has no list pricing, so cost estimation is not supported