From 983e19f40f2e78ebd602426fc85cf05913751c77 Mon Sep 17 00:00:00 2001 From: Sergey Dudoladov Date: Tue, 28 May 2019 15:49:39 +0200 Subject: [PATCH] Clarify the docs --- docs/administrator.md | 2 +- docs/reference/operator_parameters.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/administrator.md b/docs/administrator.md index d2ec6e5df..cbd0d75e4 100644 --- a/docs/administrator.md +++ b/docs/administrator.md @@ -346,7 +346,7 @@ The operator logs reasons for a rolling update with the `info` level and a diff The operator can manage k8s cron jobs to run logical backups of Postgres clusters. The cron job periodically spawns a batch job that runs a single pod. The backup script within this pod's container can connect to a DB for a logical backup. The operator updates cron jobs during Sync if the job schedule changes; the job name acts as the job identifier. These jobs are to be enabled for each indvidual Postgres cluster by setting `enableLogicalBackup: true` in its manifest. Notes: -1. The provided `registry.opensource.zalan.do/acid/logical-backup` example image implements the backup via `pg_dumpall` and upload of compressed and encypted results to an S3 bucket ([image source](../docker/logical-backup/Dockerfile)); `pg_dumpall` requires a `superuser` access to a DB and runs on the replica when possible. +1. The `registry.opensource.zalan.do/acid/logical-backup` example image implements the backup via `pg_dumpall` and upload of compressed and encrypted results to an S3 bucket ([image source](../docker/logical-backup/Dockerfile)); the default image is the same image built with the internal CI pipeline. `pg_dumpall` requires a `superuser` access to a DB and runs on the replica when possible. 2. Due to the [limitation of Kubernetes cron jobs](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#cron-job-limitations) it is highly advisable to set up additional monitoring for this feature; such monitoring is outside of the scope of operator responsibilities. diff --git a/docs/reference/operator_parameters.md b/docs/reference/operator_parameters.md index a0b76fd45..fa85f9d05 100644 --- a/docs/reference/operator_parameters.md +++ b/docs/reference/operator_parameters.md @@ -485,9 +485,9 @@ scalyr sidecar. In the CRD-based configuration they are grouped under the * **logical_backup_schedule** Backup schedule in the cron format. Please take [the reference schedule format](https://kubernetes.io/docs/tasks/job/automated-tasks-with-cron-jobs/#schedule) into account. Default: "30 00 \* \* \*" - + * **logical_backup_docker_image** - Docker image for the pods of the cron job. Must implement backup logic and correctly handle pod and job restarts. The default image runs `pg_dumpall` (on a replica if possible) and uploads compressed results to an S3 bucket under the key `/spilo/pg_cluster_name/cluster_k8s_uuid/logical_backups` ([image source](../../docker/logical-backup/Dockerfile)) Default: "registry.opensource.zalan.do/acid/logical-backup" + An image for pods of the logical backup job. The example image runs `pg_dumpall` (on a replica if possible) and uploads compressed results to an S3 bucket under the key `/spilo/pg_cluster_name/cluster_k8s_uuid/logical_backups` ([image source](../../docker/logical-backup/Dockerfile)). The default image is the same image built with the internal CI pipeline. Default: "registry.opensource.zalan.do/acid/logical-backup" * **logical_backup_s3_bucket** S3 bucket to store backup results. The bucket has to be present and accessible by Postgres pods. Default: empty.