Docker InfluxDB to S3

This container periodically runs a backup of an InfluxDB database to an S3 bucket. It also has the ability to restore.

Usage

Default cron (1am daily)

docker run \
    -e DATABASE=mydatabase \
    -e DATABASE_HOST=1.2.3.4 \
    -e S3_BUCKET=mybackupbucket \
    -e AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE \
    -e AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY \
    -e AWS_DEFAULT_REGION=us-west-2 \
    jacobtomlinson/influxdb-to-s3:latest

Custom cron timing

docker run \
    -e DATABASE=mydatabase \
    -e DATABASE_HOST=1.2.3.4 \
    -e S3_BUCKET=mybackupbucket \
    -e AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE \
    -e AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY \
    -e AWS_DEFAULT_REGION=us-west-2 \
    jacobtomlinson/influxdb-to-s3:latest \
    cron "* * * * *"

Run backup

docker run \
    -e DATABASE=mydatabase \
    -e DATABASE_HOST=1.2.3.4 \
    -e S3_BUCKET=mybackupbucket \
    -e AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE \
    -e AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY \
    -e AWS_DEFAULT_REGION=us-west-2 \
    jacobtomlinson/influxdb-to-s3:latest \
    backup

Restore

Warning - Restores cannot be run on a running InfluxDB instance, which precludes doing a remote restore. This means there is a requirement for the restore container to have local access to the influxdb meta and data directories, which are probably located in /var/lib/influxdb unless you've done something non-standard. You must therefore pass in the influxdb directory as a volume instead of specifying the host.

docker run \
    -v /path/to/influxdb:/var/lib/influxdb \
    -e DATABASE=mydatabase \
    -e S3_BUCKET=mybackupbucket \
    -e AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE \
    -e AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY \
    -e AWS_DEFAULT_REGION=us-west-2 \
    jacobtomlinson/influxdb-to-s3:latest \
    restore

Environment Variables

Variable	Description	Example Usage	Default	Optional?
DATABASE	Database to backup	telegraf	None	No
S3_BUCKET	Name of bucket	mybucketname	None	No
S3_KEY_PREFIX	S3 directory to place files in	backups or backups/sqlite	None	Yes
AWS_ACCESS_KEY_ID	AWS Access key	AKIAIO...	None	Yes (if using instance role)
AWS_SECRET_ACCESS_KEY	AWS Secret Key	wJalrXUtnFE...	None	Yes (if using instance role)
AWS_DEFAULT_REGION	AWS Default Region	us-west-2	us-west-1	Yes
DATABASE_HOST	Hostname or IP of influxdb instance	1.2.3.4	localhost	Yes
DATABASE_PORT	Port of influxdb instance	8098	8088	Yes
DATABASE_META_DIR	Path to local influxdb meta dir	/path/to/influxdb/meta	/var/lib/influxdb/meta	Yes
DATABASE_DATA_DIR	Path to local influxdb data dir	/path/to/influxdb/data	/var/lib/influxdb/data	Yes
BACKUP_PATH	Directory to write the backup (within the container)	/myvolume/mybackup	/data/influxdb/backup	Yes
BACKUP_ARCHIVE_PATH	Path to compress the backup (within the container)	/myvolume/mybackup.tgz	${BACKUP_PATH}.tgz	Yes