Merge pull request #78 from jkaninda/cron

Cron
jkaninda · Sep 28, 2024 · 58aa695 · 58aa695
2 parents 7475e35 + ddc76a6
commit 58aa695
Show file tree

Hide file tree

Showing 18 changed files with 217 additions and 238 deletions.
diff --git a/cmd/backup.go b/cmd/backup.go
@@ -30,7 +30,8 @@ func init() {
 	BackupCmd.PersistentFlags().StringP("storage", "s", "local", "Storage. local or s3")
 	BackupCmd.PersistentFlags().StringP("path", "P", "", "AWS S3 path without file name. eg: /custom_path or ssh remote path `/home/foo/backup`")
 	BackupCmd.PersistentFlags().StringP("mode", "m", "default", "Execution mode. default or scheduled")
-	BackupCmd.PersistentFlags().StringP("period", "", "0 1 * * *", "Schedule period time")
+	BackupCmd.PersistentFlags().StringP("period", "", "", "Schedule period time | Deprecated")
+	BackupCmd.PersistentFlags().StringP("cron-expression", "", "", "Backup cron expression")
 	BackupCmd.PersistentFlags().BoolP("prune", "", false, "Delete old backup, default disabled")
 	BackupCmd.PersistentFlags().IntP("keep-last", "", 7, "Delete files created more than specified days ago, default 7 days")
 	BackupCmd.PersistentFlags().BoolP("disable-compression", "", false, "Disable backup compression")

diff --git a/docker/Dockerfile b/docker/Dockerfile
@@ -36,7 +36,7 @@ ENV TARGET_DB_NAME=""
 ENV TARGET_DB_USERNAME=""
 ENV TARGET_DB_PASSWORD=""
 ARG DEBIAN_FRONTEND=noninteractive
-ENV VERSION="v1.2.5"
+ENV VERSION="v1.2.8"
 ENV BACKUP_CRON_EXPRESSION=""
 ENV TG_TOKEN=""
 ENV TG_CHAT_ID=""
@@ -50,7 +50,7 @@ LABEL author="Jonas Kaninda"
 
 RUN apt-get update -qq
 
-RUN apt install postgresql-client supervisor cron gnupg -y
+RUN apt install postgresql-client cron gnupg -y
 
 # Clear cache
 RUN apt-get clean && rm -rf /var/lib/apt/lists/*
@@ -71,7 +71,6 @@ RUN chmod +x /usr/local/bin/pg-bkup
 
 RUN ln -s /usr/local/bin/pg-bkup /usr/local/bin/bkup
 
-ADD docker/supervisord.conf /etc/supervisor/supervisord.conf
 # Create the backup script and make it executable
 RUN echo '#!/bin/sh\n/usr/local/bin/pg-bkup backup "$@"' > /usr/local/bin/backup && \
     chmod +x /usr/local/bin/backup

diff --git a/docs/how-tos/backup-to-s3.md b/docs/how-tos/backup-to-s3.md
@@ -48,7 +48,7 @@ networks:
 ### Recurring backups to S3
 
 As explained above, you need just to add AWS environment variables and specify the storage type `--storage s3`.
-In case you need to use recurring backups, you can use `--mode scheduled` and specify the periodical backup time by adding `--period "0 1 * * *"` flag as described below.
+In case you need to use recurring backups, you can use `--cron-expression "0 1 * * *"` flag or  `BACKUP_CRON_EXPRESSION=0 1 * * *` as described below.
 
 ```yml
 services:
@@ -72,6 +72,7 @@ services:
       - AWS_REGION="us-west-2"
       - AWS_ACCESS_KEY=xxxx
       - AWS_SECRET_KEY=xxxxx
+     # - BACKUP_CRON_EXPRESSION=0 1 * * * # Optional
       ## In case you are using S3 alternative such as Minio and your Minio instance is not secured, you change it to true
       - AWS_DISABLE_SSL="false"
      # pg-bkup container must be connected to the same network with your database

diff --git a/docs/how-tos/backup-to-ssh.md b/docs/how-tos/backup-to-ssh.md
@@ -52,7 +52,7 @@ networks:
 ### Recurring backups to SSH remote server
 
 As explained above, you need just to add required environment variables and specify the storage type `--storage ssh`.
-You can use `--mode scheduled` and specify the periodical backup time by adding `--period "0 1 * * *"` flag as described below.
+You can use `--cron-expression "* * * * *"` or  `BACKUP_CRON_EXPRESSION=0 1 * * *` as described below.
 
 ```yml
 services:
@@ -63,10 +63,7 @@ services:
     # for a list of available releases.
     image: jkaninda/pg-bkup
     container_name: pg-bkup
-    command:
-      - /bin/sh
-      - -c
-      - pg-bkup backup -d database --storage ssh --mode scheduled --period "0 1 * * *"
+    command: backup -d database --storage ssh --cron-expression "0 1 * * *"
     volumes:
       - ./id_ed25519:/tmp/id_ed25519"
     environment:

diff --git a/docs/how-tos/backup.md b/docs/how-tos/backup.md
@@ -56,7 +56,7 @@ networks:
  jkaninda/pg-bkup backup -d database_name
 ```
 
-In case you need to use recurring backups, you can use `--mode scheduled` and specify the periodical backup time by adding `--period "0 1 * * *"` flag as described below.
+In case you need to use recurring backups, you can use `--cron-expression "0 1 * * *"` flag or  `BACKUP_CRON_EXPRESSION=0 1 * * *` as described below.
 
 ```yml
 services:
@@ -67,7 +67,7 @@ services:
     # for a list of available releases.
     image: jkaninda/pg-bkup
     container_name: pg-bkup
-    #command:  backup -d database --mode scheduled --period "0 1 * * *"
+    command:  backup -d database --cron-expression "0 1 * * *"
     volumes:
       - ./backup:/backup
     environment:
@@ -76,6 +76,7 @@ services:
       - DB_NAME=database
       - DB_USERNAME=username
       - DB_PASSWORD=password
+      - BACKUP_CRON_EXPRESSION=0 1 * * *
     # pg-bkup container must be connected to the same network with your database
     networks:
       - web

diff --git a/docs/how-tos/encrypt-backup.md b/docs/how-tos/encrypt-backup.md
@@ -11,6 +11,9 @@ The image supports encrypting backups using GPG out of the box. In case a `GPG_P
 {: .warning }
 To restore an encrypted backup, you need to provide the same GPG passphrase used during backup process.
 
+- GPG home directory `/config/gnupg`
+- Cipher algorithm `aes256`
+- 
 To decrypt manually, you need to install `gnupg`
 
 ```shell

diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -25,51 +25,50 @@ Backup, restore and migrate targets, schedule and retention are configured using
 | --path                |        | AWS S3 path without file name. eg: /custom_path  or ssh remote path `/home/foo/backup` |
 | --dbname              | -d     | Database name                                                                          |
 | --port                | -p     | Database port (default: 5432)                                                          |
-| --mode                | -m     | Execution mode. default or scheduled (default: default)                                |
 | --disable-compression |        | Disable database backup compression                                                    |
 | --prune               |        | Delete old backup, default disabled                                                    |
 | --keep-last           |        | Delete old backup created more than specified days ago, default 7 days                 |
-| --period              |        | Crontab period for scheduled mode only. (default: "0 1 * * *")                         |
+| --cron-expression     |        | Backup cron expression, eg: (* * * * *) or @daily                                      |
 | --help                | -h     | Print this help message and exit                                                       |
 | --version             | -V     | Print version information and exit                                                     |
 
 ## Environment variables
 
-| Name                   | Requirement                                        | Description                                          |
-|------------------------|----------------------------------------------------|------------------------------------------------------|
-| DB_PORT                | Optional, default 5432                             | 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                                    |
-| AWS_ACCESS_KEY         | Optional, required for S3 storage                  | AWS S3 Access Key                                    |
-| AWS_SECRET_KEY         | Optional, required for S3 storage                  | AWS S3 Secret Key                                    |
-| AWS_BUCKET_NAME        | Optional, required for S3 storage                  | AWS S3 Bucket Name                                   |
-| AWS_BUCKET_NAME        | Optional, required for S3 storage                  | AWS S3 Bucket Name                                   |
-| AWS_REGION             | Optional, required for S3 storage                  | AWS Region                                           |
-| AWS_DISABLE_SSL        | Optional, required for S3 storage                  | Disable SSL                                          |
-| FILE_NAME              | Optional if it was provided from the --file flag   | Database file to restore (extensions: .sql, .sql.gz) |
-| GPG_PASSPHRASE         | Optional, required to encrypt and restore backup   | GPG passphrase                                       |
-| BACKUP_CRON_EXPRESSION | Optional if it was provided from the --period flag | Backup cron expression for docker in scheduled mode  |
-| SSH_HOST_NAME          | Optional, required for SSH storage                 | ssh remote hostname or ip                            |
-| SSH_USER               | Optional, required for SSH storage                 | ssh remote user                                      |
-| SSH_PASSWORD           | Optional, required for SSH storage                 | ssh remote user's password                           |
-| SSH_IDENTIFY_FILE      | Optional, required for SSH storage                 | ssh remote user's private key                        |
-| SSH_PORT               | Optional, required for SSH storage                 | ssh remote server port                               |
-| SSH_REMOTE_PATH        | Optional, required for SSH storage                 | ssh remote path (/home/toto/backup)                  |
-| TARGET_DB_HOST         | Optional, required for database migration          | Target database host                                 |
-| TARGET_DB_PORT         | Optional, required for database migration          | Target database port                                 |
-| TARGET_DB_NAME         | Optional, required for database migration          | Target database name                                 |
-| TARGET_DB_USERNAME     | Optional, required for database migration          | Target database username                             |
-| TARGET_DB_PASSWORD     | Optional, required for database migration          | Target database password                             |
-| TG_TOKEN               | Optional, required for Telegram notification       | Telegram token                                       |
-| TG_CHAT_ID             | Optional, required for Telegram notification       | Telegram Chat ID                                     |
+| Name                   | Requirement                                                   | Description                                          |
+|------------------------|---------------------------------------------------------------|------------------------------------------------------|
+| DB_PORT                | Optional, default 5432                                        | 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                                    |
+| AWS_ACCESS_KEY         | Optional, required for S3 storage                             | AWS S3 Access Key                                    |
+| AWS_SECRET_KEY         | Optional, required for S3 storage                             | AWS S3 Secret Key                                    |
+| AWS_BUCKET_NAME        | Optional, required for S3 storage                             | AWS S3 Bucket Name                                   |
+| AWS_BUCKET_NAME        | Optional, required for S3 storage                             | AWS S3 Bucket Name                                   |
+| AWS_REGION             | Optional, required for S3 storage                             | AWS Region                                           |
+| AWS_DISABLE_SSL        | Optional, required for S3 storage                             | Disable SSL                                          |
+| FILE_NAME              | Optional if it was provided from the --file flag              | Database file to restore (extensions: .sql, .sql.gz) |
+| GPG_PASSPHRASE         | Optional, required to encrypt and restore backup              | GPG passphrase                                       |
+| BACKUP_CRON_EXPRESSION | Optional if it was provided from the `--cron-expression` flag | Backup cron expression for docker in scheduled mode  |
+| SSH_HOST_NAME          | Optional, required for SSH storage                            | ssh remote hostname or ip                            |
+| SSH_USER               | Optional, required for SSH storage                            | ssh remote user                                      |
+| SSH_PASSWORD           | Optional, required for SSH storage                            | ssh remote user's password                           |
+| SSH_IDENTIFY_FILE      | Optional, required for SSH storage                            | ssh remote user's private key                        |
+| SSH_PORT               | Optional, required for SSH storage                            | ssh remote server port                               |
+| SSH_REMOTE_PATH        | Optional, required for SSH storage                            | ssh remote path (/home/toto/backup)                  |
+| TARGET_DB_HOST         | Optional, required for database migration                     | Target database host                                 |
+| TARGET_DB_PORT         | Optional, required for database migration                     | Target database port                                 |
+| TARGET_DB_NAME         | Optional, required for database migration                     | Target database name                                 |
+| TARGET_DB_USERNAME     | Optional, required for database migration                     | Target database username                             |
+| TARGET_DB_PASSWORD     | Optional, required for database migration                     | Target database password                             |
+| TG_TOKEN               | Optional, required for Telegram notification                  | Telegram token (`BOT-ID:BOT-TOKEN`)                  |
+| TG_CHAT_ID             | Optional, required for Telegram notification                  | Telegram Chat ID                                     |
 
 ---
 ## Run in Scheduled mode
 
 This image can be run as CronJob in Kubernetes for a regular backup which makes deployment on Kubernetes easy as Kubernetes has CronJob resources.
-For Docker, you need to run it in scheduled mode by adding `--mode scheduled` flag and specify the periodical backup time by adding `--period "0 1 * * *"` flag.
+For Docker, you need to run it in scheduled mode by adding `--cron-expression  "* * * * *"` flag or by defining `BACKUP_CRON_EXPRESSION=0 1 * * *` environment variable.
 
 ## Syntax of crontab (field description)
 
@@ -111,4 +110,22 @@ Easy to remember format:
 
 ```conf
 0 1 * * *
-```
+```
+## Predefined schedules
+You may use one of several pre-defined schedules in place of a cron expression.
+
+| Entry                  | Description                                | Equivalent To |
+|------------------------|--------------------------------------------|---------------|
+| @yearly (or @annually) | Run once a year, midnight, Jan. 1st        | 0 0 1 1 *     |
+| @monthly               | Run once a month, midnight, first of month | 0 0 1 * *     |
+| @weekly                | Run once a week, midnight between Sat/Sun  | 0 0 * * 0     |
+| @daily (or @midnight)  | Run once a day, midnight                   | 0 0 * * *     |
+| @hourly                | Run once an hour, beginning of hour        | 0 * * * *     |
+
+### Intervals
+You may also schedule a job to execute at fixed intervals, starting at the time it's added or cron is run. This is supported by formatting the cron spec like this:
+
+@every <duration>
+where "duration" is a string accepted by time.
+
+For example, "@every 1h30m10s" would indicate a schedule that activates after 1 hour, 30 minutes, 10 seconds, and then every interval after that.
diff --git a/go.mod b/go.mod
@@ -12,9 +12,9 @@ require (
 	github.com/bramvdbogaerde/go-scp v1.5.0 // indirect
 	github.com/hpcloud/tail v1.0.0 // indirect
 	github.com/jmespath/go-jmespath v0.4.0 // indirect
+	github.com/robfig/cron/v3 v3.0.1 // indirect
 	golang.org/x/crypto v0.18.0 // indirect
 	golang.org/x/sys v0.22.0 // indirect
 	gopkg.in/fsnotify.v1 v1.4.7 // indirect
 	gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 // indirect
 )
-
diff --git a/go.sum b/go.sum
@@ -29,6 +29,8 @@ github.com/minio/md5-simd v1.1.2/go.mod h1:MzdKDxYpY2BT9XQFocsiZf/NKVtR7nkE4RoEp
 github.com/minio/minio-go/v7 v7.0.74 h1:fTo/XlPBTSpo3BAMshlwKL5RspXRv9us5UeHEGYCFe0=
 github.com/minio/minio-go/v7 v7.0.74/go.mod h1:qydcVzV8Hqtj1VtEocfxbmVFa2siu6HGa+LDEPogjD8=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/robfig/cron/v3 v3.0.1 h1:WdRxkvbJztn8LMz/QEvLN5sBU+xKpSqwwUO1Pjr4qDs=
+github.com/robfig/cron/v3 v3.0.1/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro=
 github.com/rs/xid v1.5.0 h1:mKX4bl4iPYJtEIxp6CYiUuLQ/8DYMoz0PUdtGgMFRVc=
 github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=