trustchain-oc1-orchestral/authentik
Archived
10
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

website/docs: improve docs for restore in k8s

Browse source 
Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
Jens Langhammer 2021-06-30 19:07:11 +02:00
parent d102c59654
commit 775e0ef2fa
1 changed files with 16 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
website/docs/maintenance/backups/index.md
View file

@ -16,6 +16,8 @@ Local backups can be created by running the following command in your authentik
``` ```
docker-compose run --rm worker backup docker-compose run --rm worker backup
# Or for kubernetes
kubectl exec -it authentik-worker-.... -- ./lifecycle/bootstrap.sh backup
``` ```
This will dump the current database into the `./backups` folder. By defaults, the last 10 Backups are kept. This will dump the current database into the `./backups` folder. By defaults, the last 10 Backups are kept.
@ -26,15 +28,19 @@ Run this command in your authentik installation directory
``` ```
docker-compose run --rm worker restore docker-compose run --rm worker restore
# Or for kubernetes
kubectl exec -it authentik-worker-.... -- ./lifecycle/bootstrap.sh restore
``` ```
This will prompt you to restore from your last backup. If you want to restore from a specific file, use the `-i` flag with the filename: This will prompt you to restore from your last backup. If you want to restore from a specific file, use the `-i` flag with the filename:
``` ```
docker-compose run --rm worker restore -i default-2020-10-03-115557.psql docker-compose run --rm worker restore -i default-2020-10-03-115557.psql
# Or for kubernetes
kubectl exec -it authentik-worker-.... -- ./lifecycle/bootstrap.sh restore -i default-2020-10-03-115557.psql
``` ```
After you've restored the backup, it is recommended to restart all services with `docker-compose restart`. After you've restored the backup, it is recommended to restart all services with `docker-compose restart` or `kubectl restart deployment --all`.
### S3 Configuration ### S3 Configuration
@ -92,12 +98,15 @@ Simply enable these options in your values.yaml file
```yaml ```yaml
# Enable Database Backups to S3 # Enable Database Backups to S3
backup: authentik:
accessKey: access-key postgresql:
secretKey: secret-key s3_backup:
bucket: s3-bucket bucket: "authentik-backup"
region: eu-central-1 access_key: foo
host: s3-host secret_key: bar
region: eu-central-1
# Optional S3 host
# host: "https://backup-s3.beryju.org"
``` ```
Afterwards, run a `helm upgrade` to update the ConfigMap. Backups are done automatically as above, at 00:00 every day. Afterwards, run a `helm upgrade` to update the ConfigMap. Backups are done automatically as above, at 00:00 every day.