update restic docs for v0.9.0 GA release
Signed-off-by: Steve Kriss <steve@heptio.com>pull/643/head
parent
562a719382
commit
a2c1fece33
|
@ -9,6 +9,8 @@ The Ark repository includes a set of example YAML files that specify the setting
|
||||||
* [Run Ark on Azure][2]
|
* [Run Ark on Azure][2]
|
||||||
* [Use IBM Cloud Object Store as Ark's storage destination][4]
|
* [Use IBM Cloud Object Store as Ark's storage destination][4]
|
||||||
|
|
||||||
|
In version 0.9.0 and later, you can use Ark's integration with restic, which requires additional setup. See [Restic instructions][20].
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
After you set up the Ark server, try these examples:
|
After you set up the Ark server, try these examples:
|
||||||
|
@ -77,3 +79,4 @@ After you set up the Ark server, try these examples:
|
||||||
[3]: namespace.md
|
[3]: namespace.md
|
||||||
[4]: ibm-config.md
|
[4]: ibm-config.md
|
||||||
[19]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaiming
|
[19]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaiming
|
||||||
|
[20]: https://github.com/heptio/ark/blob/master/docs/restic.md
|
||||||
|
|
|
@ -23,7 +23,7 @@ cross-volume-type data migrations. Stay tuned as this evolves!
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- A working install of Ark version 0.8.1 or later. See [Set up Ark][2]
|
- A working install of Ark version 0.9.0 or later. See [Set up Ark][2]
|
||||||
- A local clone of [the latest release tag of the Ark repository][3]
|
- A local clone of [the latest release tag of the Ark repository][3]
|
||||||
|
|
||||||
#### Additional steps if upgrading from version 0.9 alpha
|
#### Additional steps if upgrading from version 0.9 alpha
|
||||||
|
@ -49,13 +49,6 @@ cross-volume-type data migrations. Stay tuned as this evolves!
|
||||||
- GCP: `kubectl apply -f examples/gcp/20-restic-daemonset.yaml`
|
- GCP: `kubectl apply -f examples/gcp/20-restic-daemonset.yaml`
|
||||||
- Minio: `kubectl apply -f examples/minio/30-restic-daemonset.yaml`
|
- Minio: `kubectl apply -f examples/minio/30-restic-daemonset.yaml`
|
||||||
|
|
||||||
1. Update the image tag on the Ark daemonset and deployment to match the release version you're working with -- for example, `v0.9.0`:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
kubectl -n heptio-ark set image deployment/ark ark=gcr.io/heptio-images/ark:<RELEASE_VERSION>
|
|
||||||
kubectl -n heptio-ark set image daemonset/restic ark=gcr.io/heptio-images/ark:<RELEASE_VERSION>
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Create a new bucket for restic to store its data in, and give the `heptio-ark` IAM user access to it, similarly to
|
1. Create a new bucket for restic to store its data in, and give the `heptio-ark` IAM user access to it, similarly to
|
||||||
the main Ark bucket you've already set up. Note that this must be a different bucket than the main Ark bucket.
|
the main Ark bucket you've already set up. Note that this must be a different bucket than the main Ark bucket.
|
||||||
We plan to remove this limitation in a future release.
|
We plan to remove this limitation in a future release.
|
||||||
|
@ -123,17 +116,27 @@ You're now ready to use Ark with restic.
|
||||||
1. When the backup completes, view information about the backups:
|
1. When the backup completes, view information about the backups:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
ark backup describe YOUR_BACKUP_NAME
|
||||||
|
|
||||||
kubectl -n heptio-ark get podvolumebackups -l ark.heptio.com/backup-name=YOUR_BACKUP_NAME -o yaml
|
kubectl -n heptio-ark get podvolumebackups -l ark.heptio.com/backup-name=YOUR_BACKUP_NAME -o yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
## Restore
|
## Restore
|
||||||
|
|
||||||
Restore from your Ark backup as usual:
|
1. Restore from your Ark backup:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
ark restore create --from-backup BACKUP_NAME OPTIONS...
|
ark restore create --from-backup BACKUP_NAME OPTIONS...
|
||||||
```
|
```
|
||||||
|
|
||||||
|
1. When the restore completes, view information about your pod volume restores:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ark restore describe YOUR_RESTORE_NAME
|
||||||
|
|
||||||
|
kubectl -n heptio-ark get podvolumerestores -l ark.heptio.com/restore-name=YOUR_RESTORE_NAME -o yaml
|
||||||
|
```
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
||||||
- You cannot use the main Ark bucket for storing restic backups. We plan to address this issue
|
- You cannot use the main Ark bucket for storing restic backups. We plan to address this issue
|
||||||
|
|
Loading…
Reference in New Issue