Skip to content

Commit 50cdd79

Browse files
committed
document how to perform and validate external -> embedded etcd migration
Signed-off-by: Paweł Bojanowski <[email protected]>
1 parent d273c18 commit 50cdd79

File tree

2 files changed

+28
-6
lines changed
  • vcluster_versioned_docs/version-0.25.0/configure/vcluster-yaml/control-plane/components/backing-store/etcd
  • vcluster/configure/vcluster-yaml/control-plane/components/backing-store/etcd

2 files changed

+28
-6
lines changed

vcluster/configure/vcluster-yaml/control-plane/components/backing-store/etcd/deploy.mdx

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,24 @@ controlPlane:
8181
8282
There is an option to migrate from a deployed etcd to the [embedded](/vcluster/next/configure/vcluster-yaml/control-plane/components/backing-store/etcd/embedded) etcd option. Replace your current backing store with this option and upgrade your virtual cluster.
8383
84-
```yaml
84+
```yaml title="vcluster.yaml"
85+
controlPlane:
86+
backingStore:
87+
etcd:
88+
embedded:
89+
enabled: true
90+
migrateFromDeployedEtcd: true
91+
```
92+
93+
Deploying with `migrateFromDeployedEtcd: true` keeps an external ETCD StatefulSet to perform a migration. After successful migration you should see `Successfully migrated etcd database to embedded etcd` log message in vCluster.
94+
To get rid of external ETCD after migration, remove `migrateFromDeployedEtcd: true` from `vcluster.yaml`:
95+
96+
```yaml title="vcluster.yaml after ETCD migration"
8597
controlPlane:
8698
backingStore:
8799
etcd:
88100
embedded:
89-
enabled: true
90-
migrateFromDeployedEtcd: true
101+
enabled: true
91102
```
92103

93104
## Config reference

vcluster_versioned_docs/version-0.25.0/configure/vcluster-yaml/control-plane/components/backing-store/etcd/deploy.mdx

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,24 @@ controlPlane:
8181
8282
There is an option to migrate from a deployed etcd to the [embedded](/vcluster/next/configure/vcluster-yaml/control-plane/components/backing-store/etcd/embedded) etcd option. Replace your current backing store with this option and upgrade your virtual cluster.
8383
84-
```yaml
84+
```yaml title="vcluster.yaml"
85+
controlPlane:
86+
backingStore:
87+
etcd:
88+
embedded:
89+
enabled: true
90+
migrateFromDeployedEtcd: true
91+
```
92+
93+
Deploying with `migrateFromDeployedEtcd: true` keeps an external ETCD StatefulSet to perform a migration. After successful migration you should see `Successfully migrated etcd database to embedded etcd` log message in vCluster.
94+
To get rid of external ETCD after migration, remove `migrateFromDeployedEtcd: true` from `vcluster.yaml`:
95+
96+
```yaml title="vcluster.yaml after ETCD migration"
8597
controlPlane:
8698
backingStore:
8799
etcd:
88100
embedded:
89-
enabled: true
90-
migrateFromDeployedEtcd: true
101+
enabled: true
91102
```
92103

93104
## Config reference

0 commit comments

Comments
 (0)