From 88199fff51335ad895b0d0f94a48aedde1792b07 Mon Sep 17 00:00:00 2001 From: Sergey Dudoladov Date: Thu, 16 May 2019 13:35:36 +0200 Subject: [PATCH] Address docs' review --- docs/developer.md | 3 +++ docs/reference/operator_parameters.md | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/developer.md b/docs/developer.md index 410aa202a..e181357ab 100644 --- a/docs/developer.md +++ b/docs/developer.md @@ -323,6 +323,9 @@ be updated. As explained [here](reference/operator_parameters.md), it's possible to configure the operator either with a ConfigMap or CRD, but currently we aim to synchronize parameters everywhere. +When choosing a parameter name for a new option in a PG manifest, keep in mind +the naming conventions there. The `snake_case` variables come from the Patroni/Postgres world, while the `camelCase` from the k8s world. + Note: If one option is defined in the operator configuration and in the cluster [manifest](../manifests/complete-postgres-manifest.yaml), the latter takes precedence. diff --git a/docs/reference/operator_parameters.md b/docs/reference/operator_parameters.md index 64bb2daf0..3e06cf31d 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. Default: "registry.opensource.zalan.do/acid/logical-backup:master-42" (`pgdumpall` on the replica + upload to S3). + 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" * **logical_backup_s3_bucket** S3 bucket to store backup results. The bucket has to be present and accessible by Postgres pods. Default: empty.