From 4a1b8106b940d28a6b7c1c1344bbbf9dc1b57da9 Mon Sep 17 00:00:00 2001 From: Jonas Kaninda Date: Sat, 28 Sep 2024 21:28:27 +0200 Subject: [PATCH] docs: update deployment example --- docs/how-tos/deploy-on-kubernetes.md | 1 - docs/reference/index.md | 2 +- examples/docker-compose.scheduled.local.yaml | 5 +++-- examples/docker-compose.scheduled.s3.yaml | 3 ++- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/how-tos/deploy-on-kubernetes.md b/docs/how-tos/deploy-on-kubernetes.md index 3bf5be0..2e6a1e4 100644 --- a/docs/how-tos/deploy-on-kubernetes.md +++ b/docs/how-tos/deploy-on-kubernetes.md @@ -193,7 +193,6 @@ spec: command: - /bin/sh - -c - - bkup - backup --storage ssh --disable-compression resources: limits: diff --git a/docs/reference/index.md b/docs/reference/index.md index 0f996f4..98a07f2 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -123,7 +123,7 @@ You may use one of several pre-defined schedules in place of a cron expression. | @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: +You may also schedule backup task 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 where "duration" is a string accepted by time. diff --git a/examples/docker-compose.scheduled.local.yaml b/examples/docker-compose.scheduled.local.yaml index 8e2ccf4..b41071e 100644 --- a/examples/docker-compose.scheduled.local.yaml +++ b/examples/docker-compose.scheduled.local.yaml @@ -3,11 +3,12 @@ services: pg-bkup: image: jkaninda/pg-bkup container_name: pg-bkup - command: backup --dbname database_name --mode scheduled --period "0 1 * * *" + command: backup --dbname database_name volumes: - ./backup:/backup environment: - DB_PORT=5432 - DB_HOST=postgress - DB_USERNAME=userName - - DB_PASSWORD=${DB_PASSWORD} \ No newline at end of file + - DB_PASSWORD=${DB_PASSWORD} + - BACKUP_CRON_EXPRESSION=0 1 * * * \ No newline at end of file diff --git a/examples/docker-compose.scheduled.s3.yaml b/examples/docker-compose.scheduled.s3.yaml index 6e4e049..3727e57 100644 --- a/examples/docker-compose.scheduled.s3.yaml +++ b/examples/docker-compose.scheduled.s3.yaml @@ -6,7 +6,7 @@ services: # for a list of available releases. image: jkaninda/pg-bkup container_name: pg-bkup - command: backup --storage s3 -d my-database --mode scheduled --period "0 1 * * *" + command: backup --storage s3 -d my-database environment: - DB_PORT=5432 - DB_HOST=postgres @@ -21,6 +21,7 @@ services: - AWS_SECRET_KEY=xxxxx ## 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" + - BACKUP_CRON_EXPRESSION=0 1 * * * # pg-bkup container must be connected to the same network with your database networks: - web