Embedded SQLite

By default, vCluster uses embedded SQLite with a PersistentVolume resource to store data.

You can turn off PersistentVolume sync for testing, where losing data on restarts is acceptable.

Disable SQLite

controlPlane:
  backingStore:
    database:
      embedded:
        enabled: false

Disable SQLite if you want to use a different database. See External database for configuration details.

warning

After deploying your vCluster, there are limited migration paths to change your backing store. Review the backing store migration options before deploying.

Config reference

embedded required object pro

Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster

enabled required boolean false pro

Enabled defines if the database should be used.

dataSource required string pro

DataSource is the kine dataSource to use for the database. This depends on the database format. This is optional for the embedded database. Examples:

• mysql: mysql://username:password@tcp(hostname:3306)/k3s
• postgres: postgres://username:password@hostname:5432/k3s

keyFile required string pro

KeyFile is the key file to use for the database. This is optional.

certFile required string pro

CertFile is the cert file to use for the database. This is optional.

caFile required string pro

CaFile is the ca file to use for the database. This is optional.