diff --git a/docs/index.rst b/docs/index.rst index b10a8df901e4b57f299931d09873b9c12f3a5e17..674ab78db3f30a6cd8e604e375d7ec84f7f3f29e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -28,6 +28,7 @@ For more information, go to `the OpenAppStack website`_. installation_instructions testing_instructions + troubleshooting + maintenance design reference - troubleshooting diff --git a/docs/maintenance.md b/docs/maintenance.md new file mode 100644 index 0000000000000000000000000000000000000000..43cdb94c624919f1c4e1fe16966d3812a46a05b4 --- /dev/null +++ b/docs/maintenance.md @@ -0,0 +1,34 @@ +# Maintaining an Openappstack cluster + +## Backup + +Please take care to backup the following locations: + +### On your provisioning machine + +* Your cluster config directory where you put your `inventory.yml` and + `settings.yml` files. This is also the place where the generated secrets + are stored during installation. It's located under at `openappstack/clusters` + +### 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 volumes usually take the most space + for retaining metrics. + We recommend backing up the whole directory. +* 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 if you need assistance.