Mindgrub / docker-mysqldump-to-s3

This Alpine-based Docker image produces a file with mysqldump and uploads it to Amazon S3.

docker-mysqldump-to-s3

An Alpine-based Docker image for producing a file with mysqldump and uploading it to Amazon S3.

Environment Variables

• DB_HOST – Required. The hostname to which mysqldump will connect.
• DB_NAME – Required. The name of the database to dump.
• DB_USER – Required. The username to use to connect.
• DB_PASS – Required. The password to use to connect.
• S3_BUCKET – Required. The S3 bucket to store the exported file.
• FILENAME_PREFIX – Optional. A string to prepend to the exported file (Default: "snapshot").
• S3_STORAGE_TIER – Optional. The storage tier to use with S3 (Default: "STANDARD_IA").
• S3_PREFIX – Optional. A string to prepend to the S3 object key (Default: "").
• MYSQL_NET_BUFFER_LENGTH – Optional. The net_buffer_length setting for mysqldump (Default: "16384").
• REQUESTOR – Optional. The email address of the user who requested this dump to be stored in the S3 metadata.

AWS Permissions

If this Docker image is used within Amazon ECS, specify permissions to S3 within your Task Definition role. Otherwise, you can provide AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY as environment variables.

Technical Details

Since this image is based on Alpine, the version of mysqldump in this image is actually MariaDB.

The following CLI arguments are included in the call to mysqldump: -R -E --triggers --single-transaction --comments.

The database host, database name, and requestor are all added to the S3 object metadata.

The pattern for the final S3 object URL is: s3://${S3_BUCKET}/${S3_PREFIX}${FILENAME_PREFIX}-${timestamp}.sql.gz, where $timestamp is an ISO 8601 date and time with symbols removed (e.g. 20220202T160142).