Merge pull request #47 from jkaninda/develop

docs: refactoring of code, update doc

.github/workflows/build.yml

@@ -35,5 +35,5 @@ jobs:
           file: "./docker/Dockerfile"
           platforms: linux/amd64,linux/arm64
           tags: |
-           "${{env.BUILDKIT_IMAGE}}:v0.5"
+           "${{env.BUILDKIT_IMAGE}}:v0.6"
            "${{env.BUILDKIT_IMAGE}}:latest"

README.md

@@ -41,21 +41,37 @@ MySQL Backup and Restoration tool. Backup database to AWS S3 storage or any S3 A
 | Options               | Shorts | Usage                                                              |
 |-----------------------|--------|--------------------------------------------------------------------|
 | mysql-bkup            | bkup   | CLI utility                                                        |
-| backup                |    | Backup database operation                                          |
-| restore               |    | Restore database operation                                         |
-| history               |    | Show the history of backup                                      |
+| backup                |        | Backup database operation                                          |
+| restore               |        | Restore database operation                                         |
+| history               |        | Show the history of backup                                         |
 | --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                    |
+| --path                |        | Set s3 path without file name. eg: /custom_path                    |
 | --dbname              | -d     | Set database name                                                  |
 | --port                | -p     | Set database port (default: 3306)                                  |
 | --mode                | -m     | Set execution mode. default or scheduled (default: default)        |
-| --disable-compression |      | Disable database backup compression                                |
-| --period              |      | Set crontab period for scheduled mode only. (default: "0 1 * * *") |
+| --disable-compression |        | Disable database backup compression                                |
+| --period              |        | Set crontab period for scheduled mode only. (default: "0 1 * * *") |
 | --timeout             | -t     | Set timeout (default: 60s)                                         |
 | --help                | -h     | Print this help message and exit                                   |
 | --version             | -V     | Print version information and exit                                 |
 
+
+## Environment variables
+
+| Name        | Requirement                                      | Description          |
+|-------------|--------------------------------------------------|----------------------|
+| DB_PORT     | Optional, default 3306                           | Database port number |
+| DB_HOST     | Required                                         | Database host        |
+| DB_NAME     | Optional if it was provided from the -d flag     | Database name        |
+| DB_USERNAME | Required                                         | Database user name   |
+| DB_PASSWORD | Required                                         | Database password    |
+| ACCESS_KEY  | Optional, required for S3 storage                | AWS S3 Access Key    |
+| SECRET_KEY  | Optional, required for S3 storage                | AWS S3 Secret Key    |
+| BUCKET_NAME | Optional, required for S3 storage                | AWS S3 Bucket Name   |
+| S3_ENDPOINT | Optional, required for S3 storage                | AWS S3 Endpoint      |
+| FILE_NAME   | Optional if it was provided from the --file flag | File to restore      |
+
 ## Note:
 
 Creating a user for backup tasks who has read-only access is recommended!
@@ -83,20 +99,20 @@ FLUSH PRIVILEGES;
 Simple backup usage
 
 ```sh
-bkup backup --dbname database_name
+mysql-bkup backup --dbname database_name
 ```
 ```sh
-bkup backup -d database_name
+mysql-bkup backup -d database_name
 ```
 ### S3
 
 ```sh
-bkup backup --storage s3 --dbname database_name
+mysql-bkup 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 backup -d 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  mysql-bkup backup -d database_name
 ```
 
 ## Docker compose file:
@@ -117,7 +133,7 @@ services:
     command:
       - /bin/sh
       - -c
-      - bkup backup -d database_name
+      - mysql-bkup backup -d database_name
     volumes:
       - ./backup:/backup
     environment:
@@ -131,22 +147,22 @@ services:
 Simple database restore operation usage
 
 ```sh
-bkup restore --dbname database_name --file database_20231217_115621.sql
+mysql-bkup restore --dbname database_name --file database_20231217_115621.sql
 ```
 
 ```sh
-bkup restore -f database_20231217_115621.sql 
+mysql-bkup restore -f database_20231217_115621.sql 
 ```
 ### S3
 
 ```sh
-bkup restore --storage s3 --file database_20231217_115621.sql 
+mysql-bkup 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  bkup backup -d database_name -f db_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  mysql-bkup backup -d database_name -f db_20231219_022941.sql.gz
 ```
 
 ## Docker compose file:
@@ -168,7 +184,7 @@ services:
     command:
       - /bin/sh
       - -c
-      - bkup restore --file database_20231217_115621.sql --dbname database_name
+      - mysql-bkup restore --file database_20231217_115621.sql --dbname database_name
     volumes:
       - ./backup:/backup
     environment:
@@ -187,7 +203,7 @@ 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://s3.us-west-2.amazonaws.com" jkaninda/mysql-bkup  bkup backup -s s3 -d database_name
+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://s3.us-west-2.amazonaws.com" jkaninda/mysql-bkup  mysql-bkup backup -s s3 -d database_name
 ```
 > To change s3 backup path add this flag : --path /myPath . default path is /mysql_bkup
 
@@ -217,7 +233,7 @@ services:
       - DB_PASSWORD=password
       - ACCESS_KEY=${ACCESS_KEY}
       - SECRET_KEY=${SECRET_KEY}
-      - BUCKETNAME=${BUCKETNAME}
+      - BUCKET_NAME=${BUCKET_NAME}
       - S3_ENDPOINT=${S3_ENDPOINT}
 
 ```
@@ -275,7 +291,7 @@ Easy to remember format:
 > Docker run :
 
 ```sh
-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  bkup backup --dbname $DB_NAME --mode scheduled --period "0 1 * * *"
+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  mysql-bkup backup --dbname $DB_NAME --mode scheduled --period "0 1 * * *"
 ```
 
 > With Docker compose
@@ -292,7 +308,7 @@ services:
     command:
       - /bin/sh
       - -c
-      - bkup backup --storage s3 --path /mys3_custome_path --dbname database_name --mode scheduled --period "*/30 * * * *"
+      - mysql-bkup backup --storage s3 --path /mys3_custome_path --dbname database_name --mode scheduled --period "*/30 * * * *"
     environment:
       - DB_PORT=3306
       - DB_HOST=mysqlhost
@@ -300,7 +316,7 @@ services:
       - DB_PASSWORD=${DB_PASSWORD}
       - ACCESS_KEY=${ACCESS_KEY}
       - SECRET_KEY=${SECRET_KEY}
-      - BUCKETNAME=${BUCKETNAME}
+      - BUCKET_NAME=${BUCKET_NAME}
       - S3_ENDPOINT=${S3_ENDPOINT}
 ```
 
@@ -329,7 +345,7 @@ spec:
             command:
             - /bin/sh
             - -c
-            - bkup backup -s s3 --path /custom_path
+            - mysql-bkup backup -s s3 --path /custom_path
             env:
               - name: DB_PORT
                 value: "3306" 
@@ -346,7 +362,7 @@ spec:
                 value: ""
               - name: SECRET_KEY
                 value: ""
-              - name: BUCKETNAME
+              - name: BUCKET_NAME
                 value: ""
               - name: S3_ENDPOINT
                 value: "https://s3.us-west-2.amazonaws.com"

docker/Dockerfile

@@ -21,7 +21,7 @@ ENV ACCESS_KEY=""
 ENV SECRET_KEY=""
 ENV S3_ENDPOINT=https://s3.amazonaws.com
 ARG DEBIAN_FRONTEND=noninteractive
-ENV VERSION="v0.5"
+ENV VERSION="v0.6"
 LABEL authors="Jonas Kaninda"
 
 RUN apt-get update -qq

examples/docker-compose.s3.yaml

@@ -9,7 +9,7 @@ services:
     command:
       - /bin/sh
       - -c
-      - bkup backup --storage s3 --path /mys3_custom_path --dbname database_name
+      - mysql-bkup backup --storage s3 --path /mys3_custom_path --dbname database_name
     environment:
       - DB_PORT=3306
       - DB_HOST=mysqlhost
@@ -17,5 +17,5 @@ services:
       - DB_PASSWORD=${DB_PASSWORD}
       - ACCESS_KEY=${ACCESS_KEY}
       - SECRET_KEY=${SECRET_KEY}
-      - BUCKETNAME=${BUCKETNAME}
+      - BUCKET_NAME=${BUCKET_NAME}
       - S3_ENDPOINT=https://s3.us-west-2.amazonaws.com

examples/docker-compose.scheduled.local.yaml

@@ -6,7 +6,7 @@ services:
     command:
       - /bin/sh
       - -c
-      - bkup backup --dbname database_name --mode scheduled --period "0 1 * * *"
+      - mysql-bkup backup --dbname database_name --mode scheduled --period "0 1 * * *"
     volumes:
       - ./backup:/backup
     environment:

examples/docker-compose.scheduled.s3.yaml

@@ -9,7 +9,7 @@ services:
     command:
       - /bin/sh
       - -c
-      - bkup backup --storage s3 --path /mys3_custom_path --dbname database_name --mode scheduled --period "0 1 * * *"
+      - mysql-bkup backup --storage s3 --path /mys3_custom_path --dbname database_name --mode scheduled --period "0 1 * * *"
     environment:
       - DB_PORT=3306
       - DB_HOST=mysqlhost
@@ -17,5 +17,5 @@ services:
       - DB_PASSWORD=${DB_PASSWORD}
       - ACCESS_KEY=${ACCESS_KEY}
       - SECRET_KEY=${SECRET_KEY}
-      - BUCKETNAME=${BUCKETNAME}
+      - BUCKET_NAME=${BUCKET_NAME}
       - S3_ENDPOINT=https://s3.us-west-2.amazonaws.com

examples/docker-compose.yaml

@@ -6,7 +6,7 @@ services:
     command:
       - /bin/sh
       - -c
-      - bkup backup --dbname database_name
+      - mysql-bkup backup --dbname database_name
     volumes:
       - ./backup:/backup
     environment:

examples/k8s-job.yaml

@@ -16,7 +16,7 @@ spec:
             command:
             - /bin/sh
             - -c
-            - bkup backup --storage s3 --path /custom_path
+            - mysql-bkup backup --storage s3 --path /custom_path
             env:
               - name: DB_PORT
                 value: "3306" 

pkg/restore.go

@@ -39,7 +39,7 @@ func RestoreDatabase(file string) {
 	dbPort = os.Getenv("DB_PORT")
 	storagePath = os.Getenv("STORAGE_PATH")
 	if file == "" {
-		utils.Fatal("Error required --file")
+		utils.Fatal("Error, file required")
 	}
 
 	if os.Getenv("DB_HOST") == "" || os.Getenv("DB_NAME") == "" || os.Getenv("DB_USERNAME") == "" || os.Getenv("DB_PASSWORD") == "" || file == "" {

pkg/s3fs.go

@@ -26,11 +26,14 @@ func S3Mount() {
 func MountS3Storage(s3Path string) {
 	accessKey = os.Getenv("ACCESS_KEY")
 	secretKey = os.Getenv("SECRET_KEY")
-	bucketName = os.Getenv("BUCKETNAME")
+	bucketName = os.Getenv("BUCKET_NAME")
+	if bucketName == "" {
+		bucketName = os.Getenv("BUCKETNAME")
+	}
 	s3Endpoint = os.Getenv("S3_ENDPOINT")
 
 	if accessKey == "" || secretKey == "" || bucketName == "" {
-		utils.Fatal("Please make sure all environment variables are set")
+		utils.Fatal("Please make sure all environment variables are set for S3")
 	} else {
 		storagePath := fmt.Sprintf("%s%s", s3MountPath, s3Path)
 		err := os.Setenv("STORAGE_PATH", storagePath)