awsbck
This utility lets you compress a folder and upload it to a AWS S3 bucket, once or periodically.
Disclaimer
This software is in a beta stage and, although it has not caused any problems in testing, I wouldn't recommend it for production use.
Use at your own risks!
The CLI will certainly change, but any breaking change should mean an increase in the minor version number as per semver , until it reaches 1.0.0. New features that are backwards-compatible and bug fixes will lead to patch number bumps until then.
Usage
Usage: awsbck [OPTIONS] --bucket <BUCKET> --id <KEY_ID> --key <KEY> <FOLDER>
Arguments:
<FOLDER> Path to the folder to backup [env: AWSBCK_FOLDER=]
Options:
-i, --interval <SECONDS> Specify an interval in seconds to run the backup periodically [env: AWSBCK_INTERVAL=]
-f, --filename <NAME> The name of the archive that will be uploaded to S3, without extension (optional) [env: AWSBCK_FILENAME=]
-r, --region <REGION> The AWS S3 region [env: AWS_REGION=] [default: us-east-1]
-b, --bucket <BUCKET> The AWS S3 bucket name [env: AWS_BUCKET=]
--id <KEY_ID> The AWS S3 access key ID [env: AWS_ACCESS_KEY_ID=]
-k, --key <KEY> The AWS S3 secret access key [env: AWS_SECRET_ACCESS_KEY=]
-h, --help Print help (see more with '--help')
-V, --version Print version
CLI arguments take precedence over environment variables.
The --filename option accepts ASCII alphanumeric characters and !-_.*'()/. Other characters will be discarded.
Example
# The .env file in the current directory is read by awsbck
$ cat .env
AWS_REGION="eu-central-1"
AWS_ACCESS_KEY_ID="YOUR_KEY_ID"
AWS_SECRET_ACCESS_KEY="yoursecret"
$ awsbck -i 3600 -b my_bucket /my_folder
Docker example
$ export AWS_REGION="eu-central-1"
$ export AWS_ACCESS_KEY_ID="YOUR_KEY_ID"
$ export AWS_SECRET_ACCESS_KEY="yoursecret"
$ docker run \
--rm \
--mount type=bind,src="$(pwd)"/target,dst=/target,readonly \
-e AWS_REGION -e AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY \
vbersier/awsbck:latest \
-i 3600 -b my_bucket /target
Installation
Prebuilt binaries
Check out the releases for prebuilt binaries.
Cargo
$ cargo install awsbck
Docker
This utility is available as a docker image vbersier/awsbck.
There are two tag variants, one running as a non-root user (latest) and one as a root user (root-latest).
This image is particularly useful to backup named volumes in docker. If you encounter problems where the awsbck logs report a permissions problem, then you can try to switch to the root-latest tag.
Below an example of using it with docker compose. In order to make sure the backup happens properly, we can't just copy the db data, as it might be in the middle of a write or other operation. Thus we send the pg_dumpall command and store the resulting dump to a separate volume that we can backup to S3.
---
version: '3.2'
volumes:
# the first volume is to persist the database raw data
database:
# this volume will be used to share the dump file with awsbck
database-backup:
services:
postgresql:
image: postgres:14
restart: unless-stopped
volumes:
- type: volume
source: database
target: /var/lib/postgresql/data/
- type: volume
source: database-backup
target: /backup
# this service will send a dump command to the postgres container periodically (here 6h)
# and store the resulting file in the `database-backup` volume mounted at `/backup`
postgres-backup:
image: docker:cli
container_name: postgres_backup
volumes:
- type: bind
source: /var/run/docker.sock
target: /var/run/docker.sock
command:
[
'/bin/sh',
'-c',
'while true; do sleep 21600; docker exec -t postgres pg_dumpall -c -U postgres > /backup/dump_database.sql; done'
]
# we mount the backup volume as read-only and back up the SQL dump every 24h
awsbck:
image: vbersier/awsbck:latest
restart: unless-stopped
volumes:
- type: volume
source: database-backup
target: /database
read_only: true
environment:
AWSBCK_FOLDER: /database
AWSBCK_INTERVAL: 86400
AWS_REGION: eu-central-1
AWS_BUCKET: my_bucket
AWS_ACCESS_KEY_ID: $AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY: $AWS_SECRET_ACCESS_KEY
10 Nov 7, 2022
321 Jan 2, 2023
68 Dec 7, 2021
3 Jan 12, 2022
184 Jan 5, 2023
184 Jan 5, 2023
2.4k Dec 29, 2022
3 Sep 25, 2022
11 Oct 30, 2022
3 Aug 27, 2022
7 Aug 21, 2022
128 Jan 1, 2023
6 Jan 14, 2023
18 Sep 28, 2021
15 Feb 12, 2022
2.6k Jan 3, 2023
14 Dec 25, 2022
4 Aug 30, 2022