From a16143a3f41b79fc79da301d3a57fb70b3068989 Mon Sep 17 00:00:00 2001 From: Sebastian Kippe Date: Sat, 5 Jan 2019 10:22:48 +0800 Subject: [PATCH] Add docs for Ark dependency --- doc/backup-and-restore.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/doc/backup-and-restore.md b/doc/backup-and-restore.md index 189294e..49da412 100644 --- a/doc/backup-and-restore.md +++ b/doc/backup-and-restore.md @@ -1,6 +1,19 @@ # Backups -We're using [Ark][1] for backing up Kubernetes config and GKE resources. +We're using [Ark][1] for backing up Kubernetes config and GKE resources. It is +available as a Git submodule in the `vendor/` folder (incl. the `ark` +executable). + +In order to initialize submodules in your local repo, run once: + + git submodule init + +Then, to fetch/update the modules, run: + + git submodule update + +The Ark service is running on the Sidamo cluster and was set up using the +[official docs' GCP instructions and config files][4]. ## Backup location @@ -15,3 +28,4 @@ creates volume snapshots as native [GCE disk snapshots][2]. [1]: https://heptio.github.io/ark/v0.10.0 [2]: https://console.cloud.google.com/compute/snapshots?organizationId=772167872692&project=fluted-magpie-218106&tab=snapshots&snapshotssize=50 [3]: https://console.cloud.google.com/storage/browser/sidamo-backups?project=fluted-magpie-218106&organizationId=772167872692 +[4]: https://heptio.github.io/ark/v0.10.0/gcp-config