phosphore/s3ql repository overview

⁠S3QL

This container allow you to mount the backend s3ql.
It has only been tested to backup on swift for now.

⁠Usage

For the container to mount the s3ql filesystem you need to configure at least :

• The credential to login to the swift backend :

  • backend_login=TENANT_NAME:USERNAME
  • backend_password=PASSWORD

  On OVH you can find those informations by downloading your openrc file in horizon.

• The following environment variables :

  • storage_url : URL of the backend storage and region Example : swiftks://auth.cloud.ovh.net/REGION_NAME:CT_NAME
  • fs_passphrase : the passphrase you want to use for the filesystem encryption

The filesystem will be created if necessary but it won't be formatted if corrupted or in an unknown state.

A docker-compose.yml file can be found in the repo if you need more examples.

⁠Example

docker run command :

docker run -d --privileged --name s3qltest --stop-timeout 900 --restart=unless-stopped -e CACHESIZE=20971520 -e TIMEOUT=36000 \
           -e "backend_login=TENANT_NAME:USERNAME" -e "backend_password=HIDDEN" \
           -e "storage_url=swiftks://auth.cloud.ovh.net/GRA3:blueminds3ql" -e "fs_passphrase=SECRET" \
           -v /srv/caches3ql:/root/.s3ql -v /mnt/s3ql:/mnt/s3ql docker-gitlab.sudokeys.com/phosphore/s3ql

⁠Optional Environment variables

⁠TroubleShooting

ERROR: Found existing file system! Use --force to overwrite is nothing to worry about, this just mean your filesystem already existed and no creation was needed
ERROR: File system damaged or not unmounted cleanly, run fsck! most likely mean your filesystem wasn't unmounted properly, you can solve it with the following steps :

!!! caution Make sure the filesystem is not in use anywhere or you might lose data

1. run the container in debug mode : change the entrypoint to watch echo debug
2. inside the container run the script /scripts/10_create_s3ql_filesystem to create the authentification file to s3ql
3. run the following command to launch a check of the filesystem : fsck.s3ql --authfile /root/s3ql.ini $storage_url