Sign inSign up

keltuo/mysql-restore-s3

By keltuo

•Updated over 4 years ago

https://github.com/keltuo/docker-tools/tree/main/mysql-restore-s3

Image
0

873

keltuo/mysql-restore-s3 repository overview

⁠mysql-restore-s3

Restore MySQL From S3 (supports periodic restore)

GITHUB https://github.com/keltuo/docker-tools/tree/main/mysql-restore-s3⁠

⁠Basic usage

⁠Docker
$ docker run \ 
  -e S3_ACCESS_KEY_ID=key \ 
  -e S3_SECRET_ACCESS_KEY=secret \
  -e S3_BUCKET=my-bucket \
  -e S3_PREFIX=backup \
  -e MYSQL_USER=user \
  -e MYSQL_PASSWORD=password \
  -e MYSQL_HOST=localhost \
  -e SCHEDULE="@weekly"
  keltuo/mysql-restore-s3
⁠Environment variables
  • MYSQL_HOST the mysql host required
  • MYSQL_PORT the mysql port (default: 3306)
  • MYSQL_USER the mysql user required
  • MYSQL_PASSWORD the mysql password required
  • S3_ACCESS_KEY_ID your AWS access key required
  • S3_SECRET_ACCESS_KEY your AWS secret key required
  • S3_BUCKET your AWS S3 bucket path required
  • S3_PREFIX path prefix in your bucket (default: 'backup')
  • S3_FILENAME a consistent filename to overwrite with your backup. If not set will use a timestamp.
  • S3_REGION the AWS S3 bucket region (default: us-west-1)
  • S3_ENDPOINT the AWS Endpoint URL, for S3 Compliant APIs such as minio⁠ (default: none)
  • S3_S3V4 set to yes to enable AWS Signature Version 4, required for minio⁠ servers (default: no)
  • SCHEDULE backup schedule time, see explainatons below
⁠Docker compose
$ docker-compose --env-file ./.env_docker-compose up -d --remove-orphans

.env_docker-compose

PROJECT_NAME=my-project

# S3, minio, digital ocean
S3_ENDPOINT=https://fra1.digitaloceanspaces.com
S3_ACCESS_KEY=****access-key****
S3_SECRET_KEY=****secret-key****
S3_BUCKET_BACKUPS=my-prefix
S3_PREFIX=my-prefix

RESTORE_SCHEDULE="0 0 0,10,12,14,18 * *"
MYSQL_HOST=mariadb
MYSQL_USER=root
MYSQL_PASSWORD=root

docker-compose.override.yml

version: "3.7"

services:
  database-restore:
    image: keltuo/mysql-restore-s3
    container_name: ${PROJECT_NAME}_database_restore
    restart: always
    environment:
      - S3_ACCESS_KEY_ID=${S3_ACCESS_KEY_ID}
      - S3_SECRET_ACCESS_KEY=${S3_SECRET_ACCESS_KEY}
      - S3_BUCKET=${S3_BUCKET_BACKUPS}
      - S3_PREFIX=${S3_PREFIX}
      - S3_ENDPOINT=${S3_ENDPOINT}
      - MYSQL_USER=${MYSQL_USER}
      - MYSQL_PASSWORD=${MYSQL_PASSWORD}
      - MYSQL_HOST=${MYSQL_HOST}
      - SCHEDULE=${RESTORE_SCHEDULE}
⁠Automatic Periodic Restore

Using for demo or dev projects.

You can additionally set the SCHEDULE environment variable like -e SCHEDULE="@weekly" to run the backup automatically.

More information about the scheduling can be found here⁠.

⁠Credits

https://github.com/csabasulyok/dockerfiles/tree/cs-mysql-restore-s3⁠

Tag summary

Content type

Image

Digest

Size

59.2 MB

Last updated

over 4 years ago

docker pull keltuo/mysql-restore-s3