Merge pull request #7 from jkaninda/develop

Develop
Update README
2025-12-06 13:39:41 +01:00 · 2023-12-22 10:46:48 +01:00 · 2023-12-22 10:46:13 +01:00 · 2023-12-22 10:45:45 +01:00 · 2023-12-22 10:44:38 +01:00 · 2023-12-22 10:29:41 +01:00
7 changed files with 83 additions and 88 deletions
--- a/.DS_Store
+++ b/.DS_Store
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -36,4 +36,4 @@ jobs:
          platforms: linux/amd64,linux/arm64
          tags: |
           "${{env.BUILDKIT_IMAGE}}:latest"
-           "${{env.BUILDKIT_IMAGE}}:v0.1"
+           "${{env.BUILDKIT_IMAGE}}:v0.2"
--- a/README.md
+++ b/README.md
@@ -1,16 +1,23 @@
 # MySQL Backup
 MySQL Backup tool, backup database to S3 or Object Storage

- Docker
- Kubernetes
-
 [![Build](https://github.com/jkaninda/mysql-bkup/actions/workflows/build.yml/badge.svg)](https://github.com/jkaninda/mysql-bkup/actions/workflows/build.yml)
 ![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/jkaninda/mysql-bkup?style=flat-square)
 ![Docker Pulls](https://img.shields.io/docker/pulls/jkaninda/mysql-bkup?style=flat-square)

+> Run on:
+- Docker
+- Kubernetes
+
+> Links:
 - [Docker Hub](https://hub.docker.com/r/jkaninda/mysql-bkup)
 - [Github](https://github.com/jkaninda/mysql-bkup)

+> Postgres solution :
+- [Postgress](https://github.com/jkaninda/pg-bkup)
+
+
+
 ## Storage:
 - local
 - s3
@@ -24,7 +31,7 @@ MySQL Backup tool, backup database to S3 or Object Storage
 | --storage      | -s     | Set storage. local or s3 (default: local)        |
 | --file        | -f     | Set file name for restoration      |
 | --path        |      | Set s3 path without file name. eg: /custom_path      |
-| --database        | -db     | Set database name      |
+| --dbname        | -d     | Set database name      |
 | --port        | -p     | Set database port (default: 3306)      |
 | --timeout     | -t     | Set timeout (default: 60s)        |
 | --help        | -h     | Print this help message and exit   |
@@ -35,20 +42,20 @@ MySQL Backup tool, backup database to S3 or Object Storage
 Simple backup usage

 ```sh
-bkup --operation backup
+bkup --operation backup --dbname database_name
 ```
 ```sh
-bkup -o backup
+bkup -o backup -d database_name
 ```
 ### S3

 ```sh
-bkup --operation backup --storage s3
+bkup --operation backup --storage s3 --dbname database_name
 ```
 ## Docker run:

 ```sh
-docker run --rm --network your_network_name --name mysql-bkup -v $PWD/backup:/backup/ -e "DB_HOST=database_host_name" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" jkaninda/mysql-bkup:latest  bkup -o backup -db database_name
+docker run --rm --network your_network_name --name mysql-bkup -v $PWD/backup:/backup/ -e "DB_HOST=database_host_name" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" jkaninda/mysql-bkup:latest  bkup -o backup -d database_name
 ```

 ## Docker compose file:
@@ -57,25 +64,24 @@ version: '3'
 services:
  mariadb:
    container_name: mariadb
-    image: mariadb:latest
+    image: mariadb
    environment:
      MYSQL_DATABASE: mariadb
      MYSQL_USER: mariadb
      MYSQL_PASSWORD: password
      MYSQL_ROOT_PASSWORD: password
  mysql-bkup:
-    image: jkaninda/mysql-bkup:latest
+    image: jkaninda/mysql-bkup
    container_name: mysql-bkup
    command:
      - /bin/sh
      - -c
-      - bkup --operation backup -db mariadb
+      - bkup --operation backup -d database_name
    volumes:
      - ./backup:/backup
    environment:
      - DB_PORT=3306
      - DB_HOST=mariadb
-      - DB_DATABASE=mariadb
      - DB_USERNAME=mariadb
      - DB_PASSWORD=password
 ```
@@ -84,7 +90,7 @@ services:
 Simple database restore operation usage

 ```sh
-bkup --operation restore --file database_20231217_115621.sql 
+bkup --operation restore --dbname database_name --file database_20231217_115621.sql
 ```

 ```sh
@@ -99,7 +105,7 @@ bkup --operation restore --storage s3 --file database_20231217_115621.sql
 ## Docker run:

 ```sh
-docker run --rm --network your_network_name --name mysql-bkup -v $PWD/backup:/backup/ -e "DB_HOST=database_host_name" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" jkaninda/mysql-bkup:latest  bkup -o backup -db database_name -f napata_20231219_022941.sql.gz
+docker run --rm --network your_network_name --name mysql-bkup -v $PWD/backup:/backup/ -e "DB_HOST=database_host_name" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" jkaninda/mysql-bkup  bkup -o backup -d database_name -f mydb_20231219_022941.sql.gz
 ```

 ## Docker compose file:
@@ -116,19 +122,19 @@ services:
      MYSQL_PASSWORD: password
      MYSQL_ROOT_PASSWORD: password
  mysql-bkup:
-    image: jkaninda/mysql-bkup:latest
+    image: jkaninda/mysql-bkup
    container_name: mysql-bkup
    command:
      - /bin/sh
      - -c
-      - bkup --operation restore --file database_20231217_115621.sql
+      - bkup --operation restore --file database_20231217_115621.sql --dbname database_name
    volumes:
      - ./backup:/backup
    environment:
      #- FILE_NAME=mariadb_20231217_040238.sql # Optional if file name is set from command
      - DB_PORT=3306
      - DB_HOST=mariadb
-      - DB_DATABASE=mariadb
+      - DB_NAME=mariadb
      - DB_USERNAME=mariadb
      - DB_PASSWORD=password
 ```
@@ -140,17 +146,18 @@ docker-compose up -d
 ## 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
+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  bkup -o backup -s s3 -d database_name
 ```
 > To change s3 backup path add this flag : --path myPath . default path is /mysql_bkup
+
 Simple S3 backup usage

 ```sh
-bkup --operation backup --storage s3 --database mydatabase 
+bkup --operation backup --storage s3 --dbname mydatabase 
 ```
 ```yaml
  mysql-bkup:
-    image: jkaninda/mysql-bkup:latest
+    image: jkaninda/mysql-bkup
    container_name: mysql-bkup
    tty: true
    privileged: true
@@ -159,11 +166,11 @@ bkup --operation backup --storage s3 --database mydatabase
    command:
      - /bin/sh
      - -c
-      - mysql_bkup --operation restore --source s3 -f database_20231217_115621.sql.gz
+      - mysql_bkup --operation restore --storage s3 -f database_20231217_115621.sql.gz
    environment:
      - DB_PORT=3306
      - DB_HOST=mysql
-      - DB_DATABASE=mariadb
+      - DB_NAME=mariadb
      - DB_USERNAME=mariadb
      - DB_PASSWORD=password
      - ACCESS_KEY=${ACCESS_KEY}
@@ -186,7 +193,7 @@ DB_HOST='db_hostname'
 DB_NAME='db_name'
 BACKUP_DIR='/some/path/backup/'

-docker run --rm --name mysql-bkup -v $BACKUP_DIR:/backup/ -e "DB_HOST=$DB_HOST" -e "DB_USERNAME=$DB_USERNAME" -e "DB_PASSWORD=$DB_PASSWORD" jkaninda/mysql-bkup:latest  bkup -o backup -db $DB_NAME
+docker run --rm --name mysql-bkup -v $BACKUP_DIR:/backup/ -e "DB_HOST=$DB_HOST" -e "DB_USERNAME=$DB_USERNAME" -e "DB_PASSWORD=$DB_PASSWORD" jkaninda/mysql-bkup:latest  bkup -o backup -d $DB_NAME
 ```

 ```sh
@@ -209,30 +216,40 @@ kind: CronJob
 metadata:
  name: mysql-bkup-job
 spec:
-  schedule: "0 0 * * *"
+  schedule: "0 1 * * *"
  jobTemplate:
    spec:
      template:
        spec:
-          backoffLimit: 4
+          backoffLimit: 2
          containers:
          - name: mysql-bkup
-            image: jkaninda/mysql-bkup:latest
+            image: jkaninda/mysql-bkup
+            securityContext:
+              privileged: true
            command:
            - /bin/sh
            - -c
-            - bkup --operation backup 
+            - bkup -o backup -s s3 --path /custom_path
            env:
              - name: DB_PORT
-                value: "3306"
+                value: "3306" 
              - name: DB_HOST
-                value: "mysql-svc"
-              - name: DB_DATABASE
-                value: "mariadb"
+                value: ""
+              - name: DB_NAME
+                value: ""
              - name: DB_USERNAME
-                value: "mariadb"
-              # Please use secret instead!
+                value: ""
+              # Please use secret!
              - name: DB_PASSWORD
                value: "password"
+              - name: ACCESS_KEY
+                value: ""
+              - name: SECRET_KEY
+                value: ""
+              - name: BUCKETNAME
+                value: ""
+              - name: S3_ENDPOINT
+                value: "https://s3.amazonaws.com"
          restartPolicy: Never
 ```
--- a/compose-compose.yaml
+++ b/compose-compose.yaml
@@ -1,26 +0,0 @@
-version: '3'
-services:
-  mariadb:
-    container_name: mariadb
-    image: mariadb:latest
-    environment:
-      MYSQL_DATABASE: mariadb
-      MYSQL_USER: mariadb
-      MYSQL_PASSWORD: password
-      MYSQL_ROOT_PASSWORD: password
-  mysql-bkup:
-    image: jkaninda/mysql-bkup:latest
-    container_name: mysql-bkup
-    command:
-      - /bin/sh
-      - -c
-      - bkup --operation backup
-    volumes:
-      - ./backup:/backup
-    environment:
-      #- FILE_NAME=mariadb_20231217_040238.sql # Optional if file name is set from command
-      - DB_PORT=3306
-      - DB_HOST=mariadb
-      - DB_DATABASE=mariadb
-      - DB_USERNAME=mariadb
-      - DB_PASSWORD=password
--- a/k8s-job.yaml
+++ b/k8s-job.yaml
@@ -1,31 +1,41 @@
 apiVersion: batch/v1
 kind: CronJob
 metadata:
-  name: mysql-bkup-job
+  name: db-bkup-job
 spec:
-  schedule: "0 0 * * *"
+  schedule: "0 1 * * *"
  jobTemplate:
    spec:
      template:
        spec:
-          backoffLimit: 4
+          backoffLimit: 2
          containers:
          - name: mysql-bkup
-            image: jkaninda/mysql-bkup:latest
+            image: jkaninda/mysql-bkup
+            securityContext:
+              privileged: true
            command:
            - /bin/sh
            - -c
-            - bkup --operation backup 
+            - bkup -o backup -s s3 --path /custom_path
            env:
              - name: DB_PORT
-                value: "3306"
+                value: "3306" 
              - name: DB_HOST
-                value: "mysql-svc"
-              - name: DB_DATABASE
-                value: "mariadb"
+                value: ""
+              - name: DB_NAME
+                value: ""
              - name: DB_USERNAME
-                value: "mariadb"
+                value: ""
              # Please use secret!
              - name: DB_PASSWORD
                value: "password"
+              - name: ACCESS_KEY
+                value: ""
+              - name: SECRET_KEY
+                value: ""
+              - name: BUCKETNAME
+                value: ""
+              - name: S3_ENDPOINT
+                value: "https://s3.amazonaws.com"
          restartPolicy: Never
--- a/src/docker/Dockerfile
+++ b/src/docker/Dockerfile
@@ -1,6 +1,6 @@
 FROM ubuntu:24.04
 ENV DB_HOST=""
-ENV DB_DATABASE=""
+ENV DB_NAME=""
 ENV DB_USERNAME=""
 ENV DB_PASSWORD=""
 ENV DB_PORT="3306"
--- a/src/mysql_bkup.sh
+++ b/src/mysql_bkup.sh
@@ -5,10 +5,8 @@ MY_SQL_DUMP=/usr/bin/mysqldump
 arg0=$(basename "$0" .sh)
 blnk=$(echo "$arg0" | sed 's/./ /g')
 export OPERATION=backup
-export DESTINATION=local
 export STORAGE=local
 export STORAGE_PATH=/backup
-export SOURCE=local
 export S3_PATH=/mysql-bkup
 export TIMEOUT=60
 export FILE_COMPRESION=true
@@ -45,7 +43,7 @@ help()
    echo "  -s |--storage           -- Set storage (default: local)"
    echo "  -f |--file              -- Set file name "
    echo "     |--path              -- Set s3 path, without file name"
-    echo "  -db|--database          -- Set database name "
+    echo "  -d |--dbname            -- Set database name "
    echo "  -p |--port              -- Set database port (default: 3306)"
    echo "  -t |--timeout           -- Set timeout (default: 120s)"
    echo "  -h |--help              -- Print this help message and exit"
@@ -63,18 +61,14 @@ flags()
            [ $# = 0 ] && error "No operation specified - restore or backup"
            export OPERATION="$1"
            shift;;
-        (-d|--destination)
+        (-d|--dbname)
            shift
-            [ $# = 0 ] && error "No destination specified - local or s3 | default local"
-            export DESTINATION="$1"
-            export SOURCE="$1"
-            export STORAGE="$1"
+            [ $# = 0 ] && error "No database name specified"
+            export DB_NAME="$1"
            shift;;
        (-s|--storage)
            shift
            [ $# = 0 ] && error "No storage specified - local or s3 | default local"
-            export SOURCE="$1"
-            export DESTINATION="$1"
            export STORAGE="$1"
            shift;;
        (-f|--file)
@@ -90,7 +84,7 @@ flags()
        (-db|--database)
            shift
            [ $# = 0 ] && error "No database name specified"
-            export DB_DATABASE="$1"
+            export DB_NAME="$1"
            shift;;
        (-p|--port)
            shift
@@ -115,14 +109,14 @@ flags()

 backup()
 {
- if [ -z "${DB_HOST}"] ||  [ -z "${DB_DATABASE}"] ||  [ -z "${DB_USERNAME}"] ||  [ -z "${DB_PASSWORD}"]; then
+ if [ -z "${DB_HOST}"] ||  [ -z "${DB_NAME}"] ||  [ -z "${DB_USERNAME}"] ||  [ -z "${DB_PASSWORD}"]; then
   echo "Please make sure all required options are set "
 else
      ## Test database connection
-      mysql -h ${DB_HOST} -P ${DB_PORT} -u ${DB_USERNAME} --password=${DB_PASSWORD} ${DB_DATABASE} -e"quit"
+      mysql -h ${DB_HOST} -P ${DB_PORT} -u ${DB_USERNAME} --password=${DB_PASSWORD} ${DB_NAME} -e"quit"
      
      ## Backup database
-      mysqldump -h ${DB_HOST} -P ${DB_PORT} -u ${DB_USERNAME} --password=${DB_PASSWORD} ${DB_DATABASE} | gzip > ${STORAGE_PATH}/${DB_DATABASE}_${TIME}.sql.gz
+      mysqldump -h ${DB_HOST} -P ${DB_PORT} -u ${DB_USERNAME} --password=${DB_PASSWORD} ${DB_NAME} | gzip > ${STORAGE_PATH}/${DB_NAME}_${TIME}.sql.gz
      echo "Database has been saved"
 fi
 exit 0
@@ -130,15 +124,15 @@ exit 0

 restore()
 {
-if [ -z "${DB_HOST}" ] ||  [ -z "${DB_DATABASE}" ] ||  [ -z "${DB_USERNAME}" ] || [ -z "${DB_PASSWORD}" ]; then
+if [ -z "${DB_HOST}" ] ||  [ -z "${DB_NAME}" ] ||  [ -z "${DB_USERNAME}" ] || [ -z "${DB_PASSWORD}" ]; then
   echo "Please make sure all required options are set "
 else
    ## Restore database
     if [ -f "${STORAGE_PATH}/$FILE_NAME" ]; then
         if gzip -t ${STORAGE_PATH}/$FILE_NAME; then
-            zcat ${STORAGE_PATH}/${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_NAME}
         else 
-             cat ${STORAGE_PATH}/${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_NAME}
           fi
        echo "Database has been restored"
      else
Author	SHA1	Message	Date
Jonas Kaninda	5fdc402497	Merge pull request #7 from jkaninda/develop Develop	2023-12-22 10:46:48 +01:00
Jonas Kaninda	871d5b5b57	Update README	2023-12-22 10:46:13 +01:00
Jonas Kaninda	c4c6b58fa7	Update README	2023-12-22 10:45:45 +01:00
Jonas Kaninda	a0144f817f	Update README	2023-12-22 10:44:38 +01:00
Jonas Kaninda	6372da013a	Merge pull request #6 from jkaninda/develop Update README	2023-12-22 10:29:41 +01:00
Jonas Kaninda	3572b24f18	Update README	2023-12-22 10:28:49 +01:00
Jonas Kaninda	8922ad1aaf	Merge pull request #5 from jkaninda/develop Update README	2023-12-22 10:27:04 +01:00
Jonas Kaninda	87c9104640	Update README	2023-12-22 10:26:40 +01:00
Jonas Kaninda	30755c4293	Merge pull request #4 from jkaninda/develop Update README	2023-12-22 06:16:47 +01:00
Jonas Kaninda	cff384c6e9	Update README.md	2023-12-22 06:16:15 +01:00
Jonas Kaninda	d7aa63929b	Refactoring	2023-12-22 06:07:47 +01:00
Jonas Kaninda	7dc86c6cde	Update action	2023-12-22 06:06:10 +01:00
Jonas Kaninda	c8ffec2dc9	Refactoring	2023-12-22 06:04:35 +01:00