WIP: Update backup-restore docs #529
Conversation
deniseschannon
changed the title
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
[Google.Headings] 'Using Velero' should use sentence-style capitalization.
| ::: | ||
|
|
||
| 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: | ||
| 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: | ||
| * Backing store data (e.g. etcd, sqlite) | ||
| * vCluster helm release information |
There was a problem hiding this comment.
[Loft.capitalize-helm-project] 'Helm' should be capitalized when referring to the project.
| * Backing store data (e.g. etcd, sqlite) | ||
| * vCluster helm release information | ||
| * vCluster configuration (e.g. vcluster.yaml) | ||
|
|
||
| :::info | ||
| 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. | ||
| 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. | ||
| ::: | ||
|
|
||
| ### Snapshot URL |
There was a problem hiding this comment.
[Google.Headings] 'Snapshot URL' should use sentence-style capitalization.
| @@ -46,32 +46,53 @@ vcluster snapshot my-vcluster "oci://ghcr.io/my-user/my-repo:my-tag" | |||
|
|
|||
| #### oci | |||
There was a problem hiding this comment.
[Google.Headings] 'oci' should use sentence-style capitalization.
| vcluster snapshot my-vcluster "oci://ghcr.io/my-user/my-repo:my-tag" | ||
| ``` | ||
|
|
||
| Alternative Options: Pass credentials as URL parameters. |
There was a problem hiding this comment.
[Google.Colons] ': P' should be in lowercase.
| vcluster snapshot my-vcluster "oci://ghcr.io/my-user/my-repo:my-tag" | ||
| export OCI_USERNAME=my-username | ||
| export OCI_PASSWORD=$(echo -n "my-password" | base64) | ||
| vcluster snapshot my-vcluster "oci://ghcr.io/my-user/my-repo:my-tag?username=$OCI_USERNAME&password=$OCI_PASSWORD&skip-client-credentials=true" | ||
| ``` | ||
|
|
||
| #### s3 |
There was a problem hiding this comment.
[Google.Headings] 's3' should use sentence-style capitalization.
| vcluster snapshot my-vcluster "s3://my-s3-bucket/my-bucket-key" | ||
| ``` | ||
|
|
||
| Alternative Options: Pass credentials as URL parameters. |
There was a problem hiding this comment.
[Google.Colons] ': P' should be in lowercase.
✅ Deploy Preview for vcluster-docs-site ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
This is addressed in #523 |
Content Description
Preview Link
Internal Reference
Closes DOC-