From 06ca77d06a221948223fd8a53f65e35726f65e95 Mon Sep 17 00:00:00 2001 From: Sergey Dudoladov Date: Mon, 27 May 2019 16:57:59 +0200 Subject: [PATCH] update docs --- docs/administrator.md | 2 +- docs/reference/operator_parameters.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/administrator.md b/docs/administrator.md index f6f37aafb..d2ec6e5df 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` image implements the backup via `pg_dumpall` and upload of (compressed) results to an S3 bucket; `pg_dumpall` requires a `superuser` access to a DB and runs on the replica when possible. +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. 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 3e06cf31d..298eaf30f 100644 --- a/docs/reference/operator_parameters.md +++ b/docs/reference/operator_parameters.md @@ -487,7 +487,7 @@ scalyr sidecar. In the CRD-based configuration they are grouped under the 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` Default: "registry.opensource.zalan.do/acid/logical-backup" + 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" * **logical_backup_s3_bucket** S3 bucket to store backup results. The bucket has to be present and accessible by Postgres pods. Default: empty.