Choose a backing store
The backing store holds the cluster's state, the same role etcd plays in any Kubernetes cluster. vCluster sets it when you create the cluster, and changing the type in place isn't supported. Choose it before you deploy to production.
Compare the options​
| Backing store | High availability | Snapshots with vcluster snapshot | License |
|---|---|---|---|
| Embedded SQLite (default) | No | Yes | Open source |
| Embedded etcd | Yes | Yes | Free tier or higher |
| Deployed etcd | Yes | No, use etcd's own tooling | Open source |
| External database (MySQL or PostgreSQL) | Yes | Yes, exported through kine rather than a native database backup | Prod or Scale tier. The database connector needs Scale |
- Embedded SQLite is the default, and it suits sandbox and development clusters. It can't run more than one control plane replica, so don't use it for production.
- Embedded etcd runs etcd inside the control plane pods. vCluster grows and shrinks the etcd cluster as you change the replica count, so it's the simplest path to high availability.
- Deployed etcd runs etcd as its own StatefulSet next to the control plane. Back it up with etcd's own tooling, such as
etcdctl snapshot save. - External database keeps state in a MySQL or PostgreSQL server you operate. On the Scale tier, a vCluster Platform database connector can create the database for each cluster.
vCluster Standalone supports fewer options. A single control plane node can use embedded SQLite or embedded etcd, and multiple control plane nodes need embedded etcd.
What you can change later​
Changing the backing store type by editing vcluster.yaml isn't supported. Two migrations are:
- Deployed etcd to embedded etcd. A flag copies the data during an upgrade. See Migrate etcd backing store.
- Embedded etcd to any other backing store. Restore an embedded etcd snapshot onto a new cluster configured with the target backing store. vCluster converts the snapshot during the restore. See Migrate from embedded etcd to a different backing store.
Other directions, such as from a database to etcd, aren't documented or tested. If you're unsure, start with embedded etcd. Its snapshots restore onto any other backing store, so it keeps the most options open.
Next steps​
- Size for high availability and scale to set the replica count your backing store needs.
- Backing store configuration for every option in
vcluster.yaml.