jkaninda/mysql-bkup
1
1
Fork 0
mirror of https://github.com/jkaninda/mysql-bkup.git synced 2025-12-06 21:49:40 +01:00
Code Issues Actions Projects Releases Wiki Activity

Add s3 custom path

Browse Source
This commit is contained in:
Jonas Kaninda
2023-12-19 06:37:25 +01:00
parent cffa7b7e8b
commit c1e2d21a0d
3 changed files with 44 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -21,9 +21,9 @@ MySQL Backup tool, backup database to S3 or Object Storage
|---------------|--------|------------------------------------| |---------------|--------|------------------------------------|
| mysql_bkup | bkup | CLI utility | | mysql_bkup | bkup | CLI utility |
| --operation | -o | Set operation. backup or restore (default: backup) | | --operation | -o | Set operation. backup or restore (default: backup) |
| --destination | -d | Set destination. local or s3 (default: local) | | --storage | -s | Set storage. local or s3 (default: local) |
| --source | -s | Set source. local or s3 (default: local) |
| --file | -f | Set file name for restoration | | --file | -f | Set file name for restoration |
| --path | | Set s3 path. eg: /custom_path |
| --database | -db | Set database name | | --database | -db | Set database name |
| --port | -p | Set database port (default: 3306) | | --port | -p | Set database port (default: 3306) |
| --timeout | -t | Set timeout (default: 60s) | | --timeout | -t | Set timeout (default: 60s) |
@@ -43,7 +43,7 @@ bkup -o backup
### S3 ### S3
```sh ```sh
bkup --operation backup --destination s3 bkup --operation backup --storage s3
``` ```
## Docker run: ## Docker run:
@@ -93,7 +93,7 @@ bkup -o restore -f database_20231217_115621.sql
### S3 ### S3
```sh ```sh
bkup --operation restore --source s3 --file database_20231217_115621.sql bkup --operation restore --storage s3 --file database_20231217_115621.sql
``` ```
## Docker run: ## Docker run:
@@ -139,10 +139,14 @@ docker-compose up -d
``` ```
## Backup to S3 ## Backup to S3
```sh
docker run --rm --privileged --device /dev/fuse --name mysql-bkup -e "DB_HOST=db_hostname" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" -e "ACCESS_KEY=your_access_key" -e "SECRET_KEY=your_secret_key" -e "BUCKETNAME=your_bucket_name" -e "S3_ENDPOINT=https://eu2.contabostorage.com" jkaninda/mysql-bkup:latest bkup -o backup -s s3 -db invoice
```
> To change s3 backup path add this flag : --path myPath . default path is /mysql_bkup
Simple S3 backup usage Simple S3 backup usage
```sh ```sh
bkup --operation backup --destination s3 -database mydatabase bkup --operation backup --storage s3 -database mydatabase
``` ```
```yaml ```yaml
mysql-bkup: mysql-bkup:

1
src/docker/Dockerfile
View File

@@ -5,6 +5,7 @@ ENV DB_USERNAME=""
ENV DB_PASSWORD="" ENV DB_PASSWORD=""
ENV DB_PORT="3306" ENV DB_PORT="3306"
ENV DESTINATION=local ENV DESTINATION=local
ENV STORAGE=local
ENV SOURCE=local ENV SOURCE=local
ENV BUCKETNAME="" ENV BUCKETNAME=""
ENV ACCESS_KEY="" ENV ACCESS_KEY=""

54
src/mysql_bkup.sh
View File

@@ -6,8 +6,10 @@ arg0=$(basename "$0" .sh)
blnk=$(echo "$arg0" | sed 's/./ /g') blnk=$(echo "$arg0" | sed 's/./ /g')
export OPERATION=backup export OPERATION=backup
export DESTINATION=local export DESTINATION=local
export DESTINATION_DIR=/backup export STORAGE=local
export STORAGE_PATH=/backup
export SOURCE=local export SOURCE=local
export S3_PATH=/mysql-bkup
export TIMEOUT=60 export TIMEOUT=60
export FILE_COMPRESION=true export FILE_COMPRESION=true
usage_info() usage_info()
@@ -15,7 +17,7 @@ usage_info()
echo "Usage: \\" echo "Usage: \\"
echo " $blnk Backup: mysql_bkup -o backup -d s3 \\" echo " $blnk Backup: mysql_bkup -o backup -d s3 \\"
echo " $blnk Restore: mysql_bkup -o restore -s s3 -f my_db.sql \\" echo " $blnk Restore: mysql_bkup -o restore -s s3 -f my_db.sql \\"
echo " $blnk [-o|--operation] [{-d|--destination} ] [{-f|--file} ] [{-s|--source} ] [{-h|--help} ] \\" echo " $blnk [-o|--operation] [{-f|--file} ] [{-s|--storage} ] [{-h|--help} ] \\"
} }
version_info() version_info()
@@ -40,14 +42,14 @@ help()
{ {
echo echo
echo " -o |--operation -- Set operation (default: backup)" echo " -o |--operation -- Set operation (default: backup)"
echo " -d |--destination -- Set destination (default: local)" echo " -s |--storage -- Set storage (default: local)"
echo " -s |--source -- Set source (default: local)" echo " -f |--file -- Set file name "
echo " -s |--file -- Set file name " echo " |--path -- Set s3 path, whiout file name"
echo " -db|--database -- Set database name " echo " -db|--database -- Set database name "
echo " -p |--port -- Set database port (default: 3306)" echo " -p |--port -- Set database port (default: 3306)"
echo " -t |--timeout -- Set timeout (default: 120s)" echo " -t |--timeout -- Set timeout (default: 120s)"
echo " -h |--help -- Print this help message and exit" echo " -h |--help -- Print this help message and exit"
echo " -v |--version -- Print version information and exit" echo " -V |--version -- Print version information and exit"
exit 0 exit 0
} }
@@ -66,18 +68,25 @@ flags()
[ $# = 0 ] && error "No destination specified - local or s3 | default local" [ $# = 0 ] && error "No destination specified - local or s3 | default local"
export DESTINATION="$1" export DESTINATION="$1"
export SOURCE="$1" export SOURCE="$1"
export STORAGE="$1"
shift;; shift;;
(-s|--source) (-s|--storage)
shift shift
[ $# = 0 ] && error "No source specified - local or s3 | default local" [ $# = 0 ] && error "No storage specified - local or s3 | default local"
export SOURCE="$1" export SOURCE="$1"
export DESTINATION="$1" export DESTINATION="$1"
export STORAGE="$1"
shift;; shift;;
(-f|--file) (-f|--file)
shift shift
[ $# = 0 ] && error "No file specified - file to restore" [ $# = 0 ] && error "No file specified - file to restore"
export FILE_NAME="$1" export FILE_NAME="$1"
shift;; shift;;
(--path)
shift
[ $# = 0 ] && error "No s3 path specified - s3 path without file name"
export S3_PATH="$1"
shift;;
(-db|--database) (-db|--database)
shift shift
[ $# = 0 ] && error "No database name specified" [ $# = 0 ] && error "No database name specified"
@@ -109,11 +118,14 @@ backup()
if [ -z "${DB_HOST}"] || [ -z "${DB_DATABASE}"] || [ -z "${DB_USERNAME}"] || [ -z "${DB_PASSWORD}"]; then if [ -z "${DB_HOST}"] || [ -z "${DB_DATABASE}"] || [ -z "${DB_USERNAME}"] || [ -z "${DB_PASSWORD}"]; then
echo "Please make sure all required options are set " echo "Please make sure all required options are set "
else else
## Test database connection
mysql -h ${DB_HOST} -P ${DB_PORT} -u ${DB_USERNAME} --password=${DB_PASSWORD} ${DB_DATABASE} -e"quit"
## Backup database ## Backup database
mysqldump -h ${DB_HOST} -P ${DB_PORT} -u ${DB_USERNAME} --password=${DB_PASSWORD} ${DB_DATABASE} | gzip > ${DESTINATION_DIR}/${DB_DATABASE}_${TIME}.sql.gz mysqldump -h ${DB_HOST} -P ${DB_PORT} -u ${DB_USERNAME} --password=${DB_PASSWORD} ${DB_DATABASE} | gzip > ${STORAGE_PATH}/${DB_DATABASE}_${TIME}.sql.gz
echo "Database has been saved" echo "Database has been saved"
fi fi
exit exit 0
} }
restore() restore()
@@ -122,15 +134,15 @@ if [ -z "${DB_HOST}" ] || [ -z "${DB_DATABASE}" ] || [ -z "${DB_USERNAME}" ] |
echo "Please make sure all required options are set " echo "Please make sure all required options are set "
else else
## Restore database ## Restore database
if [ -f "${DESTINATION_DIR}/$FILE_NAME" ]; then if [ -f "${STORAGE_PATH}/$FILE_NAME" ]; then
if gzip -t ${DESTINATION_DIR}/$FILE_NAME; then if gzip -t ${STORAGE_PATH}/$FILE_NAME; then
zcat ${DESTINATION_DIR}/${FILE_NAME} | mysql -h ${DB_HOST} -P ${DB_PORT} -u ${DB_USERNAME} --password=${DB_PASSWORD} ${DB_DATABASE} zcat ${STORAGE_PATH}/${FILE_NAME} | mysql -h ${DB_HOST} -P ${DB_PORT} -u ${DB_USERNAME} --password=${DB_PASSWORD} ${DB_DATABASE}
else else
cat ${DESTINATION_DIR}/${FILE_NAME} | mysql -h ${DB_HOST} -P ${DB_PORT} -u ${DB_USERNAME} --password=${DB_PASSWORD} ${DB_DATABASE} cat ${STORAGE_PATH}/${FILE_NAME} | mysql -h ${DB_HOST} -P ${DB_PORT} -u ${DB_USERNAME} --password=${DB_PASSWORD} ${DB_DATABASE}
fi fi
echo "Database has been restored" echo "Database has been restored"
else else
echo "Error, file not found in /backup folder" echo "Error, file not found in ${STORAGE_PATH}/${FILE_NAME}"
fi fi
fi fi
exit exit
@@ -162,18 +174,20 @@ else
echo "Mounting Object storage in /s3mnt .... " echo "Mounting Object storage in /s3mnt .... "
if [ -z "$(ls -A /s3mnt)" ]; then if [ -z "$(ls -A /s3mnt)" ]; then
s3fs $BUCKETNAME /s3mnt -o passwd_file=/etc/passwd-s3fs -o use_cache=/tmp/s3cache -o allow_other -o url=$S3_ENDPOINT -o use_path_request_style s3fs $BUCKETNAME /s3mnt -o passwd_file=/etc/passwd-s3fs -o use_cache=/tmp/s3cache -o allow_other -o url=$S3_ENDPOINT -o use_path_request_style
ls /s3mnt | wc -l if [ ! -d "/s3mnt$S3_PATH" ]; then
mkdir -p /s3mnt$S3_PATH
fi
else else
echo "Object storage already mounted in /s3mnt" echo "Object storage already mounted in /s3mnt"
fi fi
export DESTINATION_DIR=/s3mnt export STORAGE_PATH=/s3mnt$S3_PATH
fi fi
} }
flags "$@" flags "$@"
# ? # ?
if [ $OPERATION != 'backup' ] if [ $OPERATION != 'backup' ]
then then
if [ $DESTINATION != 's3' ] if [ $STORAGE != 's3' ]
then then
echo "Restore from local" echo "Restore from local"
restore restore
@@ -182,12 +196,12 @@ flags "$@"
s3_restore s3_restore
fi fi
else else
if [ $DESTINATION != 's3' ] if [ $STORAGE != 's3' ]
then then
echo "Backup to local destination" echo "Backup to local destination"
backup backup
else else
echo "Restore from s3" echo "Backup to s3 storage"
s3_backup s3_backup
fi fi
fi fi