-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
105 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,111 @@ | ||
| # influxdb-s3-backup | ||
| .... | ||
|
|
||
| A docker container for backing up your InfluxDB to AWS S3. It works on a Raspberry Pi as well. | ||
|
|
||
| # Example | ||
|
|
||
| ... | ||
|
|
||
| # Usage | ||
|
|
||
| ## Default cron (1am daily) | ||
|
|
||
| ```shell | ||
| 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 | ||
| ``` | ||
|
|
||
| or if you just start your docker compose deployment | ||
|
|
||
| ## Custom cron timing | ||
|
|
||
| ```shell | ||
| 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 \ | ||
| -e CRON="* * * * *" \ | ||
| jacobtomlinson/influxdb-to-s3:latest | ||
| ``` | ||
|
|
||
| ```yaml | ||
| version: '3.3' | ||
|
|
||
| services: | ||
| influxdb: | ||
| image: influxdb:latest | ||
| environment: | ||
| INFLUXDB_DB: mydb | ||
| INFLUXDB_BIND_ADDRESS: 0.0.0.0:8088 | ||
| influxdbs3backup: | ||
| build: | ||
| context: . | ||
| environment: | ||
| DATABASE: mydb | ||
| DATABASE_HOST: influxdb | ||
| S3_BUCKET: mybackupbucket | ||
| AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAMPLE | ||
| AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY | ||
| AWS_DEFAULT_REGION: us-west-2 | ||
| CRON: '* * * * *' | ||
| ``` | ||
| ### Run backup | ||
| ```shell | ||
| 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](https://docs.influxdata.com/influxdb/v1.1/administration/backup_and_restore/#restore), 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. | ||
|
|
||
| ```shell | ||
| 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 | | ||
|
|
||
| # Thanks To: | ||
| * Jacob Tomlinson https://github.com/jacobtomlinson/docker-influxdb-to-s3 | ||
|
|
||
| - Jacob Tomlinson https://github.com/jacobtomlinson/docker-influxdb-to-s3 |