diff --git a/docs/index.rst b/docs/index.rst index 68d3da6c0769bde964f2a663c48f493c954f2631..7a59ea267199a6f0cd4baf11c39e38d7a0829234 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,6 +29,7 @@ For more information, go to `the OpenAppStack website`_. installation_instructions upgrading testing_instructions + troubleshooting + maintenance design reference - troubleshooting diff --git a/docs/maintenance.md b/docs/maintenance.md new file mode 100644 index 0000000000000000000000000000000000000000..180dfa4b04369187e6eef8bd360a13a41fab6356 --- /dev/null +++ b/docs/maintenance.md @@ -0,0 +1,36 @@ +# Maintaining an Openappstack cluster + +## Backup + +Please take care to backup the following locations: + +### On your provisioning machine + +* Your cluster config directory, located in the top-level sub-directory + `clusters` in your clone of the openappstack git repository. + Here you can find all the files generated during the `create` and `install` + commands of the CLI, together with the generated secrets that are stored during + installation. + +### On your cluster + +* The local storage directories under `/var/lib/OpenAppStack/local-storage`. + This is the place all persistant volumes are stored. + Some are more important than others, if you want to hand-pick what volumes + to backup, use `kubectl get pvc --all-namespaces` to see which volumes are + used by what application. The prometheus and alertmanager volume contain + metrics, so you could choose to not back those up to save space. +* The [rke](https://rancher.com/docs/rke/latest/en/) directory `/var/lib/OpenAppStack/rke` + where the `rke` config and state file of your cluster is stored. +* At this moment, [recurring, automated etcd snapshots are not configured](https://open.greenhost.net/openappstack/openappstack/issues/453). + Please refer to the [rke etc snapshot + documentation](https://rancher.com/docs/rke/latest/en/etcd-snapshots/) if you + like to backup [etcd](https://etcd.io/). + +If you don't care about your backup disk usage too much, the easiest way is to +backup the whole `/var/lib/OpenAppStack/` directory. + +## Restore + +Restore instructions will follow, please [reach out to us](https://openappstack.net/contact.html) +if you need assistance.