diff --git a/docs/maintenance.rst b/docs/maintenance.rst index 8ecbc208733a20bb421ca093c203422dc0ae67bd..6d62e39fa7198f299d586a8377a04228785a249b 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/