From d28f445c5a842dcbc7b096d51c512500dcbffc1e Mon Sep 17 00:00:00 2001 From: Steve Kriss Date: Mon, 3 Dec 2018 13:49:05 -0700 Subject: [PATCH] document Ark's behavior re: API versions Signed-off-by: Steve Kriss --- docs/about.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/about.md b/docs/about.md index 6f6c045bb..35d1051da 100644 --- a/docs/about.md +++ b/docs/about.md @@ -49,6 +49,12 @@ By default, `ark backup create` makes disk snapshots of any persistent volumes. ![19] +## Backed-up API versions + +Ark backs up resources using the Kubernetes API server's *preferred version* for each group/resource. When restoring a resource, this same API group/version must exist in the target cluster in order for the restore to be successful. + +For example, if the cluster being backed up has a `gizmos` resource in the `things` API group, with group/versions `things/v1alpha1`, `things/v1beta1`, and `things/v1`, and the server's preferred group/version is `things/v1`, then all `gizmos` will be backed up from the `things/v1` API endpoint. When backups from this cluster are restored, the target cluster **must** have the `things/v1` endpoint in order for `gizmos` to be restored. Note that `things/v1` **does not** need to be the preferred version in the target cluster; it just needs to exist. + ## Set a backup to expire When you create a backup, you can specify a TTL by adding the flag `--ttl `. If Ark sees that an existing backup resource is expired, it removes: