Prerequisites
Before creating an OVH cluster, you need two credentials:OVH API Credential
OVH Cloud API credentials (application key, application secret, consumer key, and project ID). See OVH API Credentials.
SSH Key Credential
An SSH public key for server access. You can provide your own or let Ankra generate one. See SSH Key Credentials.
Creating an OVH Cluster
Via the Platform UI
A guided wizard walks you through creating an OVH cluster — select credentials, pick a region, choose instance flavors (general purpose, CPU-optimized, or RAM-optimized), set control plane and worker counts, and launch.Select Credentials
Pick your OVH API credential and SSH key credential from the dropdowns. You can also create new credentials directly from the wizard.
Choose Region
Select an OVH Cloud region (e.g., Gravelines, Strasbourg, Beauharnois, Warsaw, London, Frankfurt). Each region shows the location and country.
Configure Nodes
Set your cluster topology:
- Gateway — instance flavor for the SSH gateway (e.g.,
b2-7) - Control Plane — count and flavor (e.g., 1x
b2-15) - Workers — count and flavor (e.g., 2x
b2-15)
Create & Track Progress
Click Create to start provisioning. A live progress view tracks every step — network creation, gateway setup, control plane provisioning, worker provisioning, k3s installation, and Ankra Agent setup. The cluster appears with an offline state until provisioning completes, then transitions to online.
Managing from the Dashboard
Once your OVH cluster is online, you can manage it directly from the Ankra dashboard:- Scale workers — go to Cluster Settings → General to scale worker nodes up or down
- Upgrade Kubernetes — upgrade the k3s version from cluster settings
- Deprovision — delete the cluster and all OVH resources from the Danger Zone in cluster settings
Via the CLI
Via the API
Node Groups
Node groups let you organize worker nodes into logical groups with independent instance flavors, counts, labels, and taints. Manage node groups from Settings > Nodes in the dashboard, or via the API.Node Group API Reference
All node-group operations are also available via the REST API — see the OVH Node Group API. From the CLI, a node group can be created with its Kubernetes labels and taints in one step, and existing groups can be scaled, re-flavored, relabeled, retainted, or deleted:NoSchedule.
For detailed usage examples, see Hetzner Node Groups — the API is identical across all providers.
Legacy Worker Scaling
The legacyscale-workers and worker-count endpoints still work for backward compatibility.
For new clusters, prefer using Node Groups for more granular control.
Upgrading Kubernetes Version
You can upgrade the Kubernetes (k3s) version on all nodes in an OVH cluster. Upgrades are applied to control plane nodes first, then workers.Via the Dashboard
Go to your cluster → Settings → General to see the current k3s version and trigger an upgrade.Check Current Version
Upgrade Version
Stopping and Starting a Cluster
You can stop an OVH cluster to release its compute (instances, gateway, and managed gateway) while keeping its configuration, networking definition, and SSH keys. Starting the cluster re-provisions the compute and reconciles it back to a running state. This is useful for pausing non-production clusters to save cost. When starting, use--scope control_plane to bring up only the control plane first (for example to inspect or repair it), or --scope all (the default) to provision the whole cluster.
Stop and start are background operations. A start returns
409 if a stop or terminate operation is still running. The private network is preserved while stopped and reused on the next start.SSH Access and Keys
ankra cluster ovh access-info prints the gateway (bastion) and control plane IPs along with ready-to-paste ssh -J jump and Kubernetes API port-forward commands, so you can reach nodes behind the gateway without looking up IPs by hand.
Managing the Control Plane
Inspect the control plane configuration, then change the node count or instance flavor. OVH control planes support a count of1 or 3.
Inspecting Nodes
List every node in the cluster or fetch the details of a single node by ID.Deprovisioning
Deprovisioning deletes all OVH resources (instances, networks, SSH keys) and removes the cluster from Ankra.Via the Dashboard
Go to your cluster → Settings → General → Danger Zone and click Deprovision Cluster. You will be asked to confirm before the operation begins.Via CLI or API
Architecture
An OVH cluster provisions the following infrastructure:| Component | Description |
|---|---|
| Gateway | Jump server for secure SSH access to cluster nodes |
| Private Network | Isolated VLAN for inter-node communication |
| Control Plane(s) | Kubernetes control plane instances |
| Worker(s) | Kubernetes worker instances for running workloads |
| SSH Keys | Deployed to all instances for access |
Troubleshooting
Common Issues
| Issue | Solution |
|---|---|
| Cluster stuck in provisioning | Check OVH API credentials and project quota |
| Cannot scale workers | Ensure cluster is online and no operations are running |
| Invalid API credentials | Re-validate at OVH API Console |
| Flavor unavailable | Try a different region or flavor |
OVH Cloud Quotas
OVH Cloud has default resource limits per project. If provisioning fails, check your quotas in the OVH Control Panel:- Instances
- Networks / VLANs
- SSH Keys