Skip to main content
Version: main 🚧

Embedded etcd

Enterprise-Only Feature

This feature is an Enterprise feature. See our pricing plans or contact our sales team for more information.

etcd is deployed with vCluster to reduce the overall footprint while still providing the advantages of etcd.

You can migrate from an external etcd instance to the embedded one by configuring migrateFromDeployedEtcd: true as shown below. However, by default, enabled is set to false, and migrateFromDeployedEtcd is also set to false.

controlPlane:
  backingStore:
    etcd:
      embedded:
        enabled: true 
        migrateFromDeployedEtcd: true
warning

After deploying your vCluster, changing the backing store of vCluster is not supported.

Config reference​

embedded required object pro​

Embedded defines to use embedded etcd as a storage backend for the virtual cluster

enabled required boolean false pro​

Enabled defines if the embedded etcd should be used.

migrateFromDeployedEtcd required boolean false pro​

MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.