ansible-docker-backup's Introduction

Collection chatton.docker_backup

This collection contains the following roles:

chatton.docker_backup.docker_backup (backup docker volumes)
chatton.docker_backup.docker_restore (restore docker volumes)

Shared variables

Variable	Description	Default
docker_backup_aws_s3_region	The AWS region to use	us-east-1
docker_backup_aws_s3_bucket	The AWS S3 bucket to use	backups
docker_backup_host_backup_directory	The directory on the host to store the backup	""
docker_backup_aws_s3_url	The AWS S3 url to use	""
docker_backup_aws_s3_aws_access_key	The AWS access key to use	""
docker_backup_aws_s3_aws_secret_key	The AWS secret key to use	""
docker_backup_aws_s3_permissions	The AWS S3 permissions to use	[]
docker_backup_aws_s3_encrypt	Whether to encrypt the backup	true

chatton.docker_backup.docker_backup

Variable	Description	Default
container_backup	The container to backup	""

This role will stop the given container, backup all non host volumes, and restart the container. The backup will be uploaded to the given AWS S3 bucket.

chatton.docker_backup.docker_restore

Variable	Description	Default
docker_backup_restore_force	forces a revert to the volume.	false
docker_backup_restore_latest_s3_key	specify docker_backup_restore_latest_s3_key true to automatically determine the latest backup in the s3 backup.	false
docker_backup_s3_volume.name	The name of the volume to restore	""
docker_backup_s3_volume.s3_key	The s3 key to restore from	""
docker_backup_fail_on_no_s3_backups	causes the task to fail if there are no s3 backups.	true

ansible-docker-backup's People