Skip to main content

Embedded SQLite

Supported Configurations
Running the control plane as a container with:
Running the control plane as a binary with vCluster Standalone. When scaling with additional worker nodes, they are joined as private nodes.

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.

Config reference​

embedded required object ​

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

enabled required boolean false ​

Enabled defines if the database should be used.

dataSource required string ​

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

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

identityProvider required string ​

IdentityProvider is the kine identity provider to use when generating temporary authentication tokens for enhanced security. This is optional for the external database. Examples:

  • aws: RDS IAM Authentication

keyFile required string ​

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

certFile required string ​

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

caFile required string ​

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

extraArgs required string[] [] ​

ExtraArgs are additional arguments to pass to Kine.