mirror of
https://github.com/zalando/postgres-operator.git
synced 2026-10-06 14:31:40 +02:00
Address review comments
This commit is contained in:
@@ -229,10 +229,10 @@ The operator logs reasons for a rolling update with the `info` level and a diff
|
||||
|
||||
## Logical backups
|
||||
|
||||
The operator can launch k8s cron jobs to do periodic logical backups of all PG clusters under its control. The cron job spawns a separate pod with a single container that connects to one of the Postgres replicas for a backup. The operator updates cron jobs during Sync if a schedule or a docker image of a job changes. Notes:
|
||||
The operator can manage k8s cron jobs to do periodic logical backups of all PG clusters under its control. The cron job spawns a separate pod with a single container that connects to one of the Postgres replicas for a backup. The operator updates cron jobs during Sync if a schedule or a docker image of a job changes. 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.
|
||||
|
||||
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.
|
||||
|
||||
3. The operator does not remove old backups: it is the responsibility of a k8s cluster administrator to define and implement a retention policy for backups.
|
||||
3. The operator does not remove old backups.
|
||||
|
||||
@@ -39,7 +39,7 @@ Those parameters are grouped under the `metadata` top-level key.
|
||||
|
||||
## Top-level parameters
|
||||
|
||||
These are parameters are grouped directly under the `spec` key in the manifest.
|
||||
These parameters are grouped directly under the `spec` key in the manifest.
|
||||
|
||||
* **teamId**
|
||||
name of the team the cluster belongs to. Changing it after the cluster
|
||||
@@ -111,6 +111,12 @@ These are parameters are grouped directly under the `spec` key in the manifest.
|
||||
is `false`, then no volume will be mounted no matter how operator was
|
||||
configured (so you can override the operator configuration).
|
||||
|
||||
* **enableLogicalBackup**
|
||||
Determines if the logical backup of this cluster should be taken and uploaded to S3. Default: false.
|
||||
|
||||
* **logicalBackupSchedule**
|
||||
Backup schedule in the Cron format. Default: "30 00 \* \* \*"
|
||||
|
||||
## Postgres parameters
|
||||
|
||||
Those parameters are grouped under the `postgresql` top-level key.
|
||||
@@ -256,11 +262,3 @@ defined in the sidecar dictionary:
|
||||
a dictionary of environment variables. Use usual Kubernetes definition
|
||||
(https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/)
|
||||
for environment variables. Optional.
|
||||
|
||||
### Logical backup
|
||||
|
||||
Those parameters are defined under the `logical_backup` key:
|
||||
* **enable_logical_backup**
|
||||
determines if the logical backup of this cluster should be taken and uploaded to S3. Default: false.
|
||||
* **logical_backup_schedule**
|
||||
backup schedule in Cron format. Default: "30 00 * * *"
|
||||
|
||||
+1
-1
@@ -316,4 +316,4 @@ If you add
|
||||
logical_backup:
|
||||
enable_logical_backup: true
|
||||
```
|
||||
to the cluster manifest, the operator will start a k8s cron job that will periodically execute `pg_dumpall` on the target PG cluster and upload results to an S3 bucket. Note that 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. See [configuration reference](reference/cluster_manifest.md) for details.
|
||||
to the cluster manifest, the operator will create and sync the configuration of a k8s cron job that periodically executes `pg_dumpall` on the target PG cluster and uploads results to an S3 bucket. Note that 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. See [configuration reference](reference/cluster_manifest.md) for details.
|
||||
|
||||
Reference in New Issue
Block a user