You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: vcluster/manage/backup-restore.mdx
+44-19
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ sidebar_label: Snapshot & Restore
4
4
sidebar_position: 3
5
5
---
6
6
7
-
There is multiple ways how to backup and restore a virtual cluster. vCluster provides a way to create a vCluster snapshot and restore the snapshot via its own CLI.
7
+
There are multiple ways how to backup and restore a virtual cluster. vCluster provides a way to create a vCluster snapshot and restore the snapshot via its own CLI.
8
8
9
9
:::warning
10
10
If you are using an external database like MySQL or Postgresql that is **not** running inside the same namespace as vCluster, you need to create a separate backup for the datastore as well. Please refer to the appropriate docs for doing that.
@@ -13,27 +13,27 @@ If you are using an external database like MySQL or Postgresql that is **not** r
13
13
## Using vCluster CLI
14
14
15
15
:::info
16
-
This method requires vCluster version v0.24.0 or higher
16
+
Only supported in vCluster v0.24.0+
17
17
:::
18
18
19
-
The easiest and recommended way to backup the etcd datastore of a vCluster is through the CLI. When using the CLI, vCluster creates a new pod to save the snapshot to the specified location. vCluster automatically determines the configured backing store. The following information is snapshotted:
19
+
The recommended way to back up the etcd datastore of a vCluster is through the CLI. When using the CLI, vCluster creates a new pod to save the snapshot to the specified location. vCluster automatically determines the configured backing store. The following information is snapshotted:
20
20
* Backing store data (e.g. etcd, sqlite)
21
21
* vCluster helm release information
22
22
* vCluster configuration (e.g. vcluster.yaml)
23
23
24
24
:::info
25
-
Currently the vCluster CLI backup method does not support backing up persistent volumes. If you require that please take a look at the velero backup method below.
25
+
Currently the vCluster CLI backup method does not support backing up persistent volumes. If you are using persistent volumes in your virtual cluster, use the velero backup method below.
26
26
:::
27
27
28
28
### Snapshot URL
29
29
30
30
vCluster uses a snapshot URL to save the snapshot to a specific location. The snapshot URL is a string that contains the following information:
31
31
32
-
*The protocol to use (e.g. `oci`, `s3`, `container`)
33
-
*The location to save the snapshot (e.g. `oci://ghcr.io/my-user/my-repo:my-tag`, `s3://my-s3-bucket/my-snapshot-key`, `container:///data/my-snapshot.tar.gz`)
34
-
* Optional flags to pass to the snapshot location (e.g. `skip-client-credentials=true`)
32
+
*Protocol to use to take the snapshot (e.g. `oci`, `s3`, `container`)
33
+
*Location to save the snapshot (e.g. `oci://ghcr.io/my-user/my-repo:my-tag`, `s3://my-s3-bucket/my-snapshot-key`, `container:///data/my-snapshot.tar.gz`)
34
+
* Optional parameters to pass to the snapshot location (e.g. `skip-client-credentials=true`)
35
35
36
-
The following protocols are supported:
36
+
### Supported Protocols
37
37
38
38
*`oci` - OCI image registry (e.g. docker hub or ghcr.io)
39
39
*`s3` - s3 compatible bucket (e.g. AWS S3 or minio)
0 commit comments