Release 3.0.13 - See CHANGELOG.md

CHANGELOG.md

@@ -1,3 +1,57 @@
+## 3.0.13 2022-03-21 <dave at tiredofit dot ca>
+
+   ### Added
+      - Add compression levels to debug mode
+
+
+## 3.0.12 2022-03-21 <dave at tiredofit dot ca>
+
+   ### Added
+      - Throw Errors for MANUAL mode when certain other CONTAINER_* services are enabled
+
+
+## 3.0.11 2022-03-21 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Fix for Parallel Compression
+
+
+## 3.0.10 2022-03-21 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Fix for restore script not taking "custom" usernames or passwords
+
+
+## 3.0.9 2022-03-21 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Switch to using parallel versions of compression tools all the time, yet explicitly state the threads in use (1 or ++)
+
+
+## 3.0.8 2022-03-21 <dave at tiredofit dot ca>
+
+   ### Added
+      - Add PARALLEL_COMPRESSION_THREADS environment variable to limit amount of threads when compressing - Currently autodetects however many processors are avaialable to the container
+
+
+## 3.0.7 2022-03-21 <dave at tiredofit dot ca>
+
+   ### Reverted
+      - Strip unused LOG directives
+
+
+## 3.0.6 2022-03-21 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Fix for parallel compression
+
+
+## 3.0.5 2022-03-21 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Add more detail regarding manual modes
+
+
 ## 3.0.4 2022-03-21 <dave at tiredofit dot ca>
 
    ### Changed

README.md

@@ -121,16 +121,16 @@ Be sure to view the following repositories to understand all the customizable op
 
 #### Container Options
 
-| Parameter         | Description                                                                                                                      | Default         |
+| Parameter            | Description                                                                                                                      | Default         |
-| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- | --------------- |
+| -------------------- | -------------------------------------------------------------------------------------------------------------------------------- | --------------- |
-| `BACKUP_LOCATION` | Backup to `FILESYSTEM` or `S3` compatible services like S3, Minio, Wasabi                                                        | `FILESYSTEM`    |
+| `BACKUP_LOCATION`    | Backup to `FILESYSTEM` or `S3` compatible services like S3, Minio, Wasabi                                                        | `FILESYSTEM`    |
-| `MODE`            | `AUTO` mode to use internal scheduling routines or `MANUAL` to simply use this as manual backups only executed by your own means | `AUTO`          |
+| `MODE`               | `AUTO` mode to use internal scheduling routines or `MANUAL` to simply use this as manual backups only executed by your own means | `AUTO`          |
-| `MANUAL_RUN_FOREVER` | `TRUE` or `FALSE` if you wish to try to make the container exit after the backup | `TRUE` |
+| `MANUAL_RUN_FOREVER` | `TRUE` or `FALSE` if you wish to try to make the container exit after the backup                                                 | `TRUE`          |
-| `TEMP_LOCATION`   | Perform Backups and Compression in this temporary directory                                                                      | `/tmp/backups/` |
+| `TEMP_LOCATION`      | Perform Backups and Compression in this temporary directory                                                                      | `/tmp/backups/` |
-| `DB_AUTH`         | (Mongo Only - Optional) Authentication Database                                                                                  |                 |
+| `DB_AUTH`            | (Mongo Only - Optional) Authentication Database                                                                                  |                 |
-| `DEBUG_MODE`      | If set to `true`, print copious shell script messages to the container log. Otherwise only basic messages are printed.           | `FALSE`         |
+| `DEBUG_MODE`         | If set to `true`, print copious shell script messages to the container log. Otherwise only basic messages are printed.           | `FALSE`         |
-| `POST_SCRIPT`     | Fill this variable in with a command to execute post the script backing up                                                       |                 |
+| `POST_SCRIPT`        | Fill this variable in with a command to execute post the script backing up                                                       |                 |
-| `SPLIT_DB`        | If using root as username and multiple DBs on system, set to TRUE to create Seperate DB Backups instead of all in one.           | `FALSE`         |
+| `SPLIT_DB`           | If using root as username and multiple DBs on system, set to TRUE to create Seperate DB Backups instead of all in one.           | `FALSE`         |
 
 ### Database Specific Options
 | Parameter | Description                                                                                   | Default |
@@ -152,17 +152,18 @@ Be sure to view the following repositories to understand all the customizable op
 
 - You may need to wrap your `DB_DUMP_BEGIN` value in quotes for it to properly parse. There have been reports of backups that start with a `0` get converted into a different format which will not allow the timer to start at the correct time.
 ### Backup Options
-| Parameter                     | Description                                                                                                                  | Default |
+| Parameter                      | Description                                                                                                                  | Default        |
-| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------- |
+| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | -------------- |
-| `COMPRESSION`                 | Use either Gzip `GZ`, Bzip2 `BZ`, XZip `XZ`, ZSTD `ZSTD` or none `NONE`                                                      | `GZ`    |
+| `COMPRESSION`                  | Use either Gzip `GZ`, Bzip2 `BZ`, XZip `XZ`, ZSTD `ZSTD` or none `NONE`                                                      | `GZ`           |
-| `COMPRESSION_LEVEL`           | Numberical value of what level of compression to use, most allow `1` to `9` except for `ZSTD` which allows for `1` to `19` - | `3`     |
+| `COMPRESSION_LEVEL`            | Numberical value of what level of compression to use, most allow `1` to `9` except for `ZSTD` which allows for `1` to `19` - | `3`            |
-| `ENABLE_PARALLEL_COMPRESSION` | Use multiple cores when compressing backups `TRUE` or `FALSE`                                                                | `TRUE`  |
+| `ENABLE_PARALLEL_COMPRESSION`  | Use multiple cores when compressing backups `TRUE` or `FALSE`                                                                | `TRUE`         |
-| `ENABLE_CHECKSUM`             | Generate either a MD5 or SHA1 in Directory, `TRUE` or `FALSE`                                                                | `TRUE`  |
+| `PARALLEL_COMPRESSION_THREADS` | Maximum amount of threads to use when compressing - Integer value e.g. `8`                                                   | `autodetected` |
-| `CHECKSUM`                    | Either `MD5` or `SHA1`                                                                                                       | `MD5`   |
+| `ENABLE_CHECKSUM`              | Generate either a MD5 or SHA1 in Directory, `TRUE` or `FALSE`                                                                | `TRUE`         |
-| `EXTRA_OPTS`                  | If you need to pass extra arguments to the backup command, add them here e.g. `--extra-command`                              |         |
+| `CHECKSUM`                     | Either `MD5` or `SHA1`                                                                                                       | `MD5`          |
-| `MYSQL_MAX_ALLOWED_PACKET`    | Max allowed packet if backing up MySQL / MariaDB                                                                             | `512M`  |
+| `EXTRA_OPTS`                   | If you need to pass extra arguments to the backup command, add them here e.g. `--extra-command`                              |                |
-| `MYSQL_SINGLE_TRANSACTION`    | Backup in a single transaction with MySQL / MariaDB                                                                          | `TRUE`  |
+| `MYSQL_MAX_ALLOWED_PACKET`     | Max allowed packet if backing up MySQL / MariaDB                                                                             | `512M`         |
-| `MYSQL_STORED_PROCEDURES`     | Backup stored procedures with MySQL / MariaDB                                                                                | `TRUE`  |
+| `MYSQL_SINGLE_TRANSACTION`     | Backup in a single transaction with MySQL / MariaDB                                                                          | `TRUE`         |
+| `MYSQL_STORED_PROCEDURES`      | Backup stored procedures with MySQL / MariaDB                                                                                | `TRUE`         |
 
 - When using compression with MongoDB, only `GZ` compression is possible.
 
@@ -197,7 +198,7 @@ docker exec -it (whatever your container name is) bash
 ### Manual Backups
 Manual Backups can be performed by entering the container and typing `backup-now`
 
-- Recently there was a request to have the container work with Kukbernetes cron scheduling. This can theoretically be accomplished by setting the container `MODE=MANUAL` and then setting `MANUAL_RUN_FOREVER=FALSE` - You would also want to disable a few features from the upstream base images specifically `CONTAINER_ENABLE_SCHEDULING` and `CONTAINER_ENABLE_MONITORING`. This should allow the container to start, execute a backup and then exit cleanly.
+- Recently there was a request to have the container work with Kukbernetes cron scheduling. This can theoretically be accomplished by setting the container `MODE=MANUAL` and then setting `MANUAL_RUN_FOREVER=FALSE` - You would also want to disable a few features from the upstream base images specifically `CONTAINER_ENABLE_SCHEDULING` and `CONTAINER_ENABLE_MONITORING`. This should allow the container to start, execute a backup by executing and then exit cleanly. An alternative way to running the script is to execute `/etc/services.available/10-db-backup/run`.
 
 ### Restoring Databases
 Entering in the container and executing `restore` will execute a menu based script to restore your backups.

install/assets/defaults/10-db-backup

@@ -8,14 +8,13 @@ DB_DUMP_BEGIN=${DB_DUMP_BEGIN:-+0}
 DB_DUMP_FREQ=${DB_DUMP_FREQ:-1440}
 DB_DUMP_TARGET=${DB_DUMP_TARGET:-"/backup"}
 ENABLE_CHECKSUM=${ENABLE_CHECKSUM:-"TRUE"}
-ENABLE_PARALLEL_COMPRESSION={ENABLE_PARALLEL_COMPRESSION:-"TRUE"}
+ENABLE_PARALLEL_COMPRESSION=${ENABLE_PARALLEL_COMPRESSION:-"TRUE"}
-LOG_PATH=${LOG_PATH:-"/logs/"}
-LOG_TYPE=${LOG_TYPE:-"BOTH"}
 MANUAL_RUN_FOREVER=${MANUAL_RUN_FOREVER:-"TRUE"}
 MODE=${MODE:-"AUTO"}
 MYSQL_MAX_ALLOWED_PACKET=${MYSQL_MAX_ALLOWED_PACKET:-"512M"}
 MYSQL_SINGLE_TRANSACTION=${MYSQL_SINGLE_TRANSACTION:-"TRUE"}
 MYSQL_STORED_PROCEDURES=${MYSQL_STORED_PROCEDURES:-"TRUE"}
+PARALLEL_COMPRESSION_THREADS=${PARALLEL_COMPRESSION_THREADS:-"$(nproc)"}
 S3_CERT_SKIP_VERIFY=${S3_CERT_SKIP_VERIFY:-"TRUE"}
 S3_PROTOCOL=${S3_PROTOCOL:-"https"}
 SIZE_VALUE=${SIZE_VALUE:-"bytes"}

install/assets/functions/10-db-backup

@@ -3,15 +3,17 @@
 bootstrap_compression() {
     ### Set Compression Options
     if var_true "${ENABLE_PARALLEL_COMPRESSION}" ; then
-        bzip="pbzip2 -${COMPRESSION_LEVEL}"
+        print_debug "Utilizing '${PARALLEL_COMPRESSION_THREADS}' compression threads"
-        gzip="pigz -${COMPRESSION_LEVEL}"
+        bzip="pbzip2 -${COMPRESSION_LEVEL} -p ${PARALLEL_COMPRESSION_THREADS}"
-        xzip="pixz -${COMPRESSION_LEVEL}"
+        gzip="pigz -${COMPRESSION_LEVEL} -p ${PARALLEL_COMPRESSION_THREADS}"
-        zstd="zstd --rm -${COMPRESSION_LEVEL}"
+        xzip="pixz -${COMPRESSION_LEVEL} -p ${PARALLEL_COMPRESSION_THREADS}"
+        zstd="zstd --rm -${COMPRESSION_LEVEL} -T${PARALLEL_COMPRESSION_THREADS}"
     else
-        bzip="bzip2 -${COMPRESSION_LEVEL}"
+        print_debug "Utilizing single compression thread"
-        gzip="gzip -${COMPRESSION_LEVEL}"
+        bzip="pbzip2 -${COMPRESSION_LEVEL} -p 1"
-        xzip="xz -${COMPRESSION_LEVEL} "
+        gzip="pigz -${COMPRESSION_LEVEL} -p 1"
-        zstd="zstd --rm -${COMPRESSION_LEVEL}"
+        xzip="pixz -${COMPRESSION_LEVEL} -p 1"
+        zstd="zstd --rm -${COMPRESSION_LEVEL} -T1"
     fi
 }
 
@@ -341,21 +343,25 @@ compression() {
    case "${COMPRESSION,,}" in
         gz* )
             print_notice "Compressing backup with gzip"
+            print_debug "Compression Level: '${COMPRESSION_LEVEL}'"
             target=${target}.gz
             dumpoutput="$gzip "
         ;;
         bz* )
             print_notice "Compressing backup with bzip2"
+            print_debug "Compression Level: '${COMPRESSION_LEVEL}'"
             target=${target}.bz2
             dumpoutput="$bzip "
         ;;
         xz* )
             print_notice "Compressing backup with xzip"
+            print_debug "Compression Level: '${COMPRESSION_LEVEL}'"
             target=${target}.xz
             dumpoutput="$xzip "
         ;;
         zst* )
             print_notice "Compressing backup with zstd"
+            print_debug "Compression Level: '${COMPRESSION_LEVEL}'"
             target=${target}.zst
             dumpoutput="$zstd "
         ;;
@@ -458,7 +464,7 @@ setup_mode() {
     if [ "${MODE,,}" = "auto" ] || [ ${MODE,,} = "default" ] ; then
         print_debug "Running in Auto / Default Mode - Letting Image control scheduling"
     else
-        print_info "Running in Manual mode - Execute 'backup_now' to run a manual backup"
+        print_info "Running in Manual mode - Execute 'backup_now' or '/etc/services.available/10-db-backup/run' to perform a manual backup"
         service_stop 10-db-backup
         if var_true "${MANUAL_RUN_FOREVER}" ; then
             mkdir -p /etc/services.d/99-run_forever
@@ -470,6 +476,19 @@ do
 done
 EOF
             chmod +x /etc/services.d/99-run_forever/run
+        else
+            if var_true "${CONTAINER_ENABLE_SCHEDULING}" ; then
+                print_error "Manual / Exit after execution mode doesn't work with 'CONTAINER_ENABLE_SCHEDULING=TRUE'"
+                exit 1
+            fi
+            if var_true "${CONTAINER_ENABLE_MONITORING}" ; then
+                print_error "Manual / Exit after execution mode doesn't work with 'CONTAINER_ENABLE_MONITORING=TRUE'"
+                exit 1
+            fi
+            if var_true "${CONTAINER_ENABLE_LOGSHIPPING}" ; then
+                print_error "Manual / Exit after execution mode doesn't work with 'CONTAINER_ENABLE_LOGSHIPPING=TRUE'"
+                exit 1
+            fi
         fi
     fi
 }

install/etc/services.available/10-db-backup/run

@@ -11,6 +11,7 @@ bootstrap_variables
 if [ "${MODE,,}" = "manual" ] ; then
     DB_DUMP_BEGIN=+0
     manual=TRUE
+    print_debug "Detected Manual Mode"
 fi
 
 case "${1,,}" in
@@ -32,7 +33,7 @@ case "${1,,}" in
         :
     ;;
     * )
-        if [ "${manual,,}" = "true" ]; then
+        if [ "${manual,,}" != "true" ]; then
             current_time=$(date +"%s")
             today=$(date +"%Y%m%d")
 

install/usr/local/bin/restore

@@ -697,9 +697,9 @@ EOF
                     c* )
                         counter=1
                         q_dbuser=" "
-                        while [[ $q_dbname = *" "* ]];  do
+                        while [[ $q_dbuser = *" "* ]];  do
                             if [ $counter -gt 1 ] ; then print_error "DB Usernames can't have spaces in them, please re-enter." ; fi ;
-                            read -e -p "$(echo -e ${clg}** ${cdgy}What DB User do you wish to use:\ ${coff})" q_dbname
+                            read -e -p "$(echo -e ${clg}** ${cdgy}What DB User do you wish to use:\ ${coff})" q_dbuser
                             (( counter+=1 ))
                         done
                         r_dbuser=${q_dbuser}
@@ -766,9 +766,9 @@ EOF
                     c* )
                         counter=1
                         q_dbpass=" "
-                        while [[ $q_dbname = *" "* ]];  do
+                        while [[ $q_dbpass = *" "* ]];  do
                             if [ $counter -gt 1 ] ; then print_error "DB Passwords can't have spaces in them, please re-enter." ; fi ;
-                            read -e -p "$(echo -e ${clg}** ${cdgy}What DB Password do you wish to use:\ ${coff})" q_dbname
+                            read -e -p "$(echo -e ${clg}** ${cdgy}What DB Password do you wish to use:\ ${coff})" q_dbpass
                             (( counter+=1 ))
                         done
                         r_dbpass=${q_dbpass}