From 4f05ab21623aad9451ef632bc5c19910742e9afa Mon Sep 17 00:00:00 2001
From: Arie Peterson <arie@greenhost.nl>
Date: Tue, 8 Feb 2022 11:42:10 +0100
Subject: [PATCH] Document installing velero CLI program
---
docs/maintenance.rst | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/docs/maintenance.rst b/docs/maintenance.rst
index 8ecbc2087..6d62e39fa 100644
--- a/docs/maintenance.rst
+++ b/docs/maintenance.rst
@@ -22,7 +22,13 @@ On your cluster
Stackspin supports using the program Velero to make backups of your
Stackspin instance to external storage via the S3 API. See
:ref:`backups-with-velero` in the installation instructions for setup details.
-By default this will make nightly backups of the entire cluster (minus
+
+For the maintenance operations described below -- in particular, restoring
+backups -- you need the ``velero`` client program installed, typically on your
+provisioning machine although you can also run it on the VPS if preferred. You
+may find it at `Velero's github release page`_.
+
+By default Velero will make nightly backups of the entire cluster (minus
Prometheus data). To make a manual backup, run
.. code:: bash
@@ -159,6 +165,7 @@ following command that will apply the changes to all installed kustomizations:
flux get -A kustomizations --no-header | awk -F' ' '{system("flux reconcile -n " $1 " kustomization " $2)}'
+.. _Velero's github release page: https://github.com/vmware-tanzu/velero/releases/latest
.. _Velero’s documentation: https://velero.io/docs/v1.4/
.. _reach out to us: https://stackspin.net/contact.html
.. _taints: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/
--
GitLab