# Custom Resource options

The Cluster is configured via the
[deploy/cr.yaml :octicons-link-external-16:](https://github.com/percona/percona-postgresql-operator/blob/main/deploy/cr.yaml) file.

The metadata part of this file contains the following keys:

* <a name="metadata-name"></a> `name` (`cluster1` by default) sets the name of your Percona Distribution
for PostgreSQL Cluster; it should include only [URL-compatible characters :octicons-link-external-16:](https://datatracker.ietf.org/doc/html/rfc3986#section-2.3), not exceed 22 characters, start with an alphabetic character, and end with an alphanumeric character;

* <a name="finalizers-delete-ssl"></a> `finalizers.percona.com/delete-ssl` if present, activates the [Finalizer :octicons-link-external-16:](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#finalizers) which deletes [objects, created for SSL](TLS.md) (Secret, certificate, and issuer) after the cluster deletion event (off by default).

* `finalizers.percona.com/delete-pvc` if present, activates the [Finalizer :octicons-link-external-16:](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#finalizers) which deletes [Persistent Volume Claims :octicons-link-external-16:](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) for the database cluster Pods after the deletion event (off by default).

The spec part of the [deploy/cr.yaml :octicons-link-external-16:](https://github.com/percona/percona-postgresql-operator/blob/main/deploy/cr.yaml) file contains the following:

|                 | |
|-----------------|-|
| **Key**         | {{ optionlink('crVersion') }} |
| **Value**       | string |
| **Example**     | `{{ release }}` |
| **Description** | Version of the Operator the Custom Resource belongs to |
|                 | |
| **Key**         | {{ optionlink('standby.enabled') }} |
| **Value**       | boolean |
| **Example**     | `false` |
| **Description** | Enables or disables running the cluster in a standby mode (read-only copy of an existing cluster, useful for disaster recovery, etc) |
|                 | |
| **Key**         | {{ optionlink('standby.host') }} |
| **Value**       | string |
| **Example**     | `"<primary-ip>"` |
| **Description** | Host address of the primary cluster this standby cluster connects to |
|                 | |
| **Key**         | {{ optionlink('standby.port') }} |
| **Value**       | string |
| **Example**     | `"<primary-port>"` |
| **Description** | Port number used by a standby copy to connect to the primary cluster |
| **Key**         | {{ optionlink('openshift') }} |
| **Value**       | boolean |
| **Example**     | `true` |
| **Description** | Set to `true` if the cluster is being deployed on OpenShift, set to `false` otherwise, or  unset it for autodetection |
|                 | |
| **Key**         | {{ optionlink('standby.repoName') }} |
| **Value**       | string |
| **Example**     | `repo1` |
| **Description** | Name of the pgBackRest repository in the primary cluster this standby cluster connects to |
|                 | |
| **Key**         | {{ optionlink('secrets.customTLSSecret.name') }} |
| **Value**       | string |
| **Example**     | `cluster1-cert` |
| **Description** | A secret with TLS certificate generated for *external* communications, see [Transport Layer Security (TLS)](TLS.md) for details |
|                 | |
| **Key**         | {{ optionlink('secrets.customReplicationTLSSecret.name') }} |
| **Value**       | string |
| **Example**     | `replication1-cert` |
| **Description** | A secret with TLS certificate generated for *internal* communications, see [Transport Layer Security (TLS)](TLS.md) for details |
|                 | |
| **Key**         | {{ optionlink('users.name') }} |
| **Value**       | string |
| **Example**     | `rhino` |
| **Description** | The name of the PostgreSQL user |
|                 | |
| **Key**         | {{ optionlink('users.databases') }} |
| **Value**       | string |
| **Example**     | `zoo` |
| **Description** | Databases accessible by a specific PostgreSQL user with rights to create objects in them (the option is ignored for `postgres` user; also, modifying it can't be used to revoke the already given access) |
|                 | |
| **Key**         | {{ optionlink('users.password.type') }} |
| **Value**       | string |
| **Example**     | `ASCII` |
| **Description** | The set of characters used for password generation: can be either `ASCII` (default) or `AlphaNumeric` |
|                 | |
| **Key**         | {{ optionlink('users.options') }} |
| **Value**       | string |
| **Example**     | `"SUPERUSER"` |
| **Description** | The `ALTER ROLE` options other than password (the option is ignored for `postgres` user) |
|                 | |
| **Key**         | {{ optionlink('users.secretName') }} |
| **Value**       | string |
| **Example**     | `"rhino-credentials"` |
| **Description** | The custom name of the user's Secret; if not specified, the default `<clusterName>-pguser-<userName>` variant will be used |
|                 | |
| **Key**         | {{ optionlink('databaseInitSQL.key') }} |
| **Value**       | string |
| **Example**     | `init.sql` |
| **Description** | Data key for the [Custom configuration options ConfigMap :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/configmap/) with the init SQL file, which will be executed at cluster creation time |
|                 | |
| **Key**         | {{ optionlink('databaseInitSQL.name') }} |
| **Value**       | string |
| **Example**     | `cluster1-init-sql` |
| **Description** | Name of the [ConfigMap :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/configmap/) with the init SQL file, which will be executed at cluster creation time |
|                 | |
| **Key**         | {{ optionlink('pause') }} |
| **Value**       | string |
| **Example**     | `false` |
| **Description** | Setting it to `true` gracefully stops the cluster, scaling workloads to zero and suspending CronJobs; setting it to `false` after shut down starts the cluster back |
|                 | |
| **Key**         | {{ optionlink('unmanaged') }} |
| **Value**       | string |
| **Example**     | `false` |
| **Description** | Setting it to `true` stops the Operator's activity including the rollout and reconciliation of changes made in the Custom Resource; setting it to `false` starts the Operator's activity back |
|                 | |
| **Key**         | {{ optionlink('dataSource.postgresCluster.clusterName') }} |
| **Value**       | string |
| **Example**     | `cluster1` |
| **Description** | Name of an existing cluster to use as the data source when restoring backup to a new cluster |
|                 | |
| **Key**         | {{ optionlink('dataSource.postgresCluster.repoName') }} |
| **Value**       | string |
| **Example**     | `repo1` |
| **Description** | Name of the pgBackRest repository in the source cluster that contains the backup to be restored to a new cluster |
|                 | |
| **Key**         | {{ optionlink('dataSource.postgresCluster.options') }} |
| **Value**       | string |
| **Example**     | |
| **Description** | The pgBackRest command-line options for the pgBackRest restore command |
|                 | |
| **Key**         | {{ optionlink('dataSource.pgbackrest.stanza') }} |
| **Value**       | string |
| **Example**     | `db` |
| **Description** | Name of the [pgBackRest stanza :octicons-link-external-16:](https://pgbackrest.org/command.html) to use as the data source when restoring backup to a new cluster |
|                 | |
| **Key**         | {{ optionlink('dataSource.pgbackrest.configuration.secret.name') }} |
| **Value**       | string |
| **Example**     | `pgo-s3-creds` |
| **Description** | Name of the [Kubernetes Secret object :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/secret/#using-imagepullsecrets) with custom pgBackRest configuration, which will be added to the pgBackRest configuration generated by the Operator |
|                 | |
| **Key**         | {{ optionlink('dataSource.pgbackrest.global') }} |
| **Value**       | subdoc |
| **Example**     | `/pgbackrest/postgres-operator/hippo/repo1` |
| **Description** | Settings, which are to be included in the `global` section of the pgBackRest configuration generated by the Operator |
|                 | |
| **Key**         | {{ optionlink('dataSource.pgbackrest.repo.name') }} |
| **Value**       | string |
| **Example**     | `repo1` |
| **Description** | Name of the pgBackRest repository |
|                 | |
| **Key**         | {{ optionlink('dataSource.pgbackrest.repo.s3.bucket') }} |
| **Value**       | string |
| **Example**     | `"my-bucket"` |
| **Description** | The [Amazon S3 bucket :octicons-link-external-16:](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html) or [Google Cloud Storage bucket :octicons-link-external-16:](https://cloud.google.com/storage/docs/key-terms#buckets)
name used for backups |
|                 | |
| **Key**         | {{ optionlink('dataSource.pgbackrest.repo.s3.endpoint') }} |
| **Value**       | string |
| **Example**     | `"s3.ca-central-1.amazonaws.com"` |
| **Description** | The endpoint URL of the S3-compatible storage to be used for backups (not needed for the original Amazon S3 cloud) |
|                 | |
| **Key**         | {{ optionlink('dataSource.pgbackrest.repo.s3.region') }} |
| **Value**       | boolean |
| **Example**     | `"ca-central-1"` |
| **Description** | The [AWS region :octicons-link-external-16:](https://docs.aws.amazon.com/general/latest/gr/rande.html) to use for Amazon and all S3-compatible storages |
|                 | |
| **Key**         | {{ optionlink('image') }} |
| **Value**       | string |
| **Example**     | `perconalab/percona-postgresql-operator:{{release}}-ppg{{postgresrecommended}}-postgres` |
| **Description** | The PostgreSQL Docker image to use |
|                 | |
| **Key**         | {{ optionlink('imagePullPolicy') }} |
| **Value**       | string |
| **Example**     | `Always` |
| **Description** | This option is used to set the [policy :octicons-link-external-16:](https://kubernetes.io/docs/concepts/containers/images/#updating-images) for updating PostgreSQL images |
|                 | |
| **Key**         | {{ optionlink('postgresVersion') }} |
| **Value**       | int |
| **Example**     | 14 |
| **Description** | The major version of PostgreSQL to use |
|                 | |
| **Key**         | {{ optionlink('port') }} |
| **Value**       | int |
| **Example**     | 5432 |
| **Description** | The port number for PostgreSQL |
|                 | |
| **Key**         | {{ optionlink('expose.annotations') }} |
| **Value**       | label |
| **Example**     | `my-annotation: value1` |
| **Description** | The [Kubernetes annotations :octicons-link-external-16:](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) metadata for PostgreSQL |
|                 | |
| **Key**         | {{ optionlink('expose.labels') }} |
| **Value**       | label |
| **Example**     | `my-label: value2` |
| **Description** | Set [labels :octicons-link-external-16:](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) for the PostgreSQL Service |
|                 | |
| **Key**         | {{ optionlink('expose.type') }} |
| **Value**       | string |
| **Example**     | `LoadBalancer` |
| **Description** | Specifies the type of [Kubernetes Service :octicons-link-external-16:](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) for PostgreSQL |
|                 | |
| **Key**         | {{ optionlink('expose.loadBalancerSourceRanges') }} |
| **Value**       | string |
| **Example**     | `"10.0.0.0/8"` |
| **Description** | The range of client IP addresses from which the load balancer should be reachable (if not set, there is no limitations) |

## <a name="operator-instances-section"></a>Instances section

The `instances` section in the [deploy/cr.yaml :octicons-link-external-16:](https://github.com/percona/percona-postgresql-operator/blob/main/deploy/cr.yaml)
file contains configuration options for PostgreSQL instances.

|                 | |
|-----------------|-|
| **Key**         | {{ optionlink('instances.metadata.labels') }} |
| **Value**       | label |
| **Example**     | `pg-cluster-label: cluster1` |
| **Description** | Set [labels :octicons-link-external-16:](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) for PostgreSQL Pods |
|                 | |
| **Key**         | {{ optionlink('instances.name') }} |
| **Value**       | string |
| **Example**     | `rs 0` |
| **Description** | The name of the PostgreSQL instance |
|                 | |
| **Key**         | {{ optionlink('instances.replicas') }} |
| **Value**       | int |
| **Example**     | 3 |
| **Description** | The number of Replicas to create for the PostgreSQL instance |
|                 | |
| **Key**         | {{ optionlink('instances.resources.limits.cpu') }} |
| **Value**       | string |
| **Example**     | `2.0` |
| **Description** | [Kubernetes CPU limits :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for a PostgreSQL instance |
|                 | |
| **Key**         | {{ optionlink('instances.resources.limits.memory') }} |
| **Value**       | string |
| **Example**     | `4Gi` |
| **Description** | The [Kubernetes memory limits :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for a PostgreSQL instance |
|                 | |
| **Key**         | {{ optionlink('instances.topologySpreadConstraints.maxSkew') }} |
| **Value**       | int |
| **Example**     | 1 |
| **Description** | The degree to which Pods may be unevenly distributed under the [Kubernetes Pod Topology Spread Constraints :octicons-link-external-16:](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/) |
|                 | |
| **Key**         | {{ optionlink('instances.topologySpreadConstraints.topologyKey') }} |
| **Value**       | string |
| **Example**     | `my-node-label` |
| **Description** | The key of node labels for the [Kubernetes Pod Topology Spread Constraints :octicons-link-external-16:](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/) |
|                 | |
| **Key**         | {{ optionlink('instances.topologySpreadConstraints.whenUnsatisfiable') }} |
| **Value**       | string |
| **Example**     | `DoNotSchedule` |
| **Description** | What to do with a Pod if it doesn't satisfy the [Kubernetes Pod Topology Spread Constraints :octicons-link-external-16:](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/) |
|                 | |
| **Key**         | {{ optionlink('instances.topologySpreadConstraints.labelSelector.matchLabels') }} |
| **Value**       | label |
| **Example**     | `postgres-operator.crunchydata.com/instance-set: instance1` |
| **Description** | The Label selector for the [Kubernetes Pod Topology Spread Constraints :octicons-link-external-16:](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/) |
|                 | |
| **Key**         | {{ optionlink('instances.tolerations.effect') }} |
| **Value**       | string |
| **Example**     | `NoSchedule` |
| **Description** | The [Kubernetes Pod tolerations :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/#concepts) effect for the PostgreSQL instance |
|                 | |
| **Key**         | {{ optionlink('instances.tolerations.key') }} |
| **Value**       | string |
| **Example**     | `role` |
| **Description** | The [Kubernetes Pod tolerations :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/#concepts) key for the PostgreSQL instance |
|                 | |
| **Key**         | {{ optionlink('instances.tolerations.operator') }} |
| **Value**       | string |
| **Example**     | `Equal` |
| **Description** | The [Kubernetes Pod tolerations :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/#concepts) operator for the PostgreSQL instance |
|                 | |
| **Key**         | {{ optionlink('instances.tolerations.value') }} |
| **Value**       | string |
| **Example**     | `connection-poolers` |
| **Description** | The [Kubernetes Pod tolerations :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/#concepts) value for the PostgreSQL instance |
|                 | |
| **Key**         | {{ optionlink('instances.priorityClassName') }} |
| **Value**       | string |
| **Example**     | `high-priority` |
| **Description** | The [Kuberentes Pod priority class :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass) for PostgreSQL instance Pods |
|                 | |
| **Key**         | {{ optionlink('instances.walVolumeClaimSpec.accessModes') }} |
| **Value**       | string |
| **Example**     | `ReadWriteOnce` |
| **Description** | The [Kubernetes PersistentVolumeClaim :octicons-link-external-16:](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) access modes for the PostgreSQL Write-ahead Log storage |
|                 | |
| **Key**         | {{ optionlink('instances.walVolumeClaimSpec.resources.requests.storage') }} |
| **Value**       | string |
| **Example**     | `1Gi` |
| **Description** | The [Kubernetes storage requests :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for the storage the PostgreSQL instance will use |
|                 | |
| **Key**         | {{ optionlink('instances.dataVolumeClaimSpec.accessModes') }} |
| **Value**       | string |
| **Example**     | `ReadWriteOnce` |
| **Description** | The [Kubernetes PersistentVolumeClaim :octicons-link-external-16:](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) access modes for the PostgreSQL Write-ahead Log storage |
|                 | |
| **Key**         | {{ optionlink('instances.dataVolumeClaimSpec.resources.requests.storage') }} |
| **Value**       | string |
| **Example**     | `1Gi` |
| **Description** | The [Kubernetes storage requests :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for the storage the PostgreSQL instance will use |

### instances.sidecars subsection

The `instances.sidecars` subsection in the [deploy/cr.yaml :octicons-link-external-16:](https://github.com/percona/percona-postgresql-operator/blob/main/deploy/cr.yaml)
file contains configuration options for [custom sidecar containers](sidecar.md) which can be added to PostgreSQL Pods.

|                 | |
|-----------------|-|
| **Key**         | {{ optionlink('instances.sidecars.image') }} |
| **Value**       | string |
| **Example**     | `mycontainer1:latest` |
| **Description** | Image for the [custom sidecar container](sidecar.md) for PostgreSQL Pods |
|                 | |
| **Key**         | {{ optionlink('instances.sidecars.name') }} |
| **Value**       | string |
| **Example**     | `testcontainer` |
| **Description** | Name of the [custom sidecar container](sidecar.md) for PostgreSQL Pods |
|                 | |
| **Key**         | {{ optionlink('instances.sidecars.imagePullPolicy') }} |
| **Value**       | string |
| **Example**     | `Always` |
| **Description** | This option is used to set the [policy :octicons-link-external-16:](https://kubernetes.io/docs/concepts/containers/images/#updating-images) for the PostgreSQL Pod sidecar container |
|                 | |
| **Key**         | {{ optionlink('instances.sidecars.env') }} |
| **Value**       | subdoc |
| **Example**     |  |
| **Description** | The [environment variables set as key-value pairs :octicons-link-external-16:](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/) for the [custom sidecar container](sidecar.md) for PostgreSQL Pods |
|                 | |
| **Key**         | {{ optionlink('instances.sidecars.envFrom') }} |
| **Value**       | subdoc |
| **Example**     | |
| **Description** | The [environment variables set as key-value pairs in ConfigMaps :octicons-link-external-16:](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/) for the [custom sidecar container](sidecar.md) for PostgreSQL Pods |
|                 | |
| **Key**         | {{ optionlink('instances.sidecars.command') }} |
| **Value**       | array |
| **Example**     | `["/bin/sh"]` |
| **Description** | Command for the [custom sidecar container](sidecar.md) for PostgreSQL Pods |
|                 | |
| **Key**         | {{ optionlink('instances.sidecars.args') }} |
| **Value**       | array |
| **Example**     | `["-c", "while true; do trap 'exit 0' SIGINT SIGTERM SIGQUIT SIGKILL; done;"]` |
| **Description** | Command arguments for the [custom sidecar container](sidecar.md) for PostgreSQL Pods |

## Backup section

The `backup` section in the
[deploy/cr.yaml :octicons-link-external-16:](https://github.com/percona/percona-postgresql-operator/blob/main/deploy/cr.yaml)
file contains the following configuration options for the regular
Percona Distribution for PostgreSQL backups.

|                 | |
|-----------------|-|
| **Key**         | {{ optionlink('backups.pgbackrest.metadata.labels') }} |
| **Value**       | label |
| **Example**     | `pg-cluster-label: cluster1` |
| **Description** | Set [labels :octicons-link-external-16:](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) for pgBackRest Pods |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.image') }} |
| **Value**       | string |
| **Example**     | `perconalab/percona-postgresql-operator:{{release}}-ppg{{postgresrecommended}}-pgbackrest` |
| **Description** | The Docker image for [pgBackRest](backups.md#backups-pgbackrest) |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.configuration.secret.name') }} |
| **Value**       | string |
| **Example**     | `cluster1-pgbackrest-secrets` |
| **Description** | Name of the [Kubernetes Secret object :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/secret/#using-imagepullsecrets) with custom pgBackRest configuration, which will be added to the pgBackRest configuration generated by the Operator |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.jobs.priorityClassName') }} |
| **Value**       | string |
| **Example**     | `high-priority` |
| **Description** | The [Kuberentes Pod priority class :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass) for pgBackRest jobs |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.jobs.resources.limits.cpu') }} |
| **Value**       | int |
| **Example**     | `200` |
| **Description** | [Kubernetes CPU limits :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for a pgBackRest job |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.jobs.resources.limits.memory') }} |
| **Value**       | int |
| **Example**     | `128Mi` |
| **Description** | The [Kubernetes memory limits :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for a pgBackRest job |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.jobs.tolerations.effect') }} |
| **Value**       | string |
| **Example**     | `NoSchedule` |
| **Description** | The [Kubernetes Pod tolerations :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/#concepts) effect for a pgBackRest job |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.jobs.tolerations.key') }} |
| **Value**       | string |
| **Example**     | `role` |
| **Description** | The [Kubernetes Pod tolerations :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/#concepts) key for a pgBackRest job |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.jobs.tolerations.operator') }} |
| **Value**       | string |
| **Example**     | `Equal` |
| **Description** | The [Kubernetes Pod tolerations :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/#concepts) operator for a pgBackRest job |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.jobs.tolerations.value') }} |
| **Value**       | string |
| **Example**     | `connection-poolers` |
| **Description** | The [Kubernetes Pod tolerations :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/#concepts) value for a pgBackRest job |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.global') }} |
| **Value**       | subdoc |
| **Example**     | `/pgbackrest/postgres-operator/hippo/repo1` |
| **Description** | Settings, which are to be included in the `global` section of the pgBackRest configuration generated by the Operator |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repoHost.priorityClassName') }} |
| **Value**       | string |
| **Example**     | `high-priority` |
| **Description** | The [Kuberentes Pod priority class :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass) for pgBackRest repo |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repoHost.topologySpreadConstraints.maxSkew') }} |
| **Value**       | int |
| **Example**     | 1 |
| **Description** | The degree to which Pods may be unevenly distributed under the [Kubernetes Pod Topology Spread Constraints :octicons-link-external-16:](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/) |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repoHost.topologySpreadConstraints.topologyKey') }} |
| **Value**       | string |
| **Example**     | `my-node-label` |
| **Description** | The key of node labels for the [Kubernetes Pod Topology Spread Constraints :octicons-link-external-16:](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/) |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repoHost.topologySpreadConstraints.whenUnsatisfiable') }} |
| **Value**       | string |
| **Example**     | `ScheduleAnyway` |
| **Description** | What to do with a Pod if it doesn't satisfy the [Kubernetes Pod Topology Spread Constraints :octicons-link-external-16:](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/) |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repoHost.topologySpreadConstraints.labelSelector.matchLabels') }} |
| **Value**       | label |
| **Example**     | `postgres-operator.crunchydata.com/pgbackrest: ""` |
| **Description** | The Label selector for the [Kubernetes Pod Topology Spread Constraints :octicons-link-external-16:](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/) |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repoHost.affinity.podAntiAffinity') }} |
| **Value**       | subdoc |
| **Example**     | |
| **Description** | [Pod anti-affinity](constraints.md#affinity-and-anti-affinity), allows setting the standard Kubernetes affinity constraints of any complexity |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.manual.repoName') }} |
| **Value**       | string |
| **Example**     | `repo1` |
| **Description** | Name of the pgBackRest repository for on-demand backups |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.manual.options') }} |
| **Value**       | string |
| **Example**     | `--type=full` |
| **Description** | The on-demand backup command-line options which will be passed to pgBackRest for on-demand backups |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repos.name') }} |
| **Value**       | string |
| **Example**     | `repo1` |
| **Description** | Name of the pgBackRest repository for backups |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repos.schedules.full') }} |
| **Value**       | string |
| **Example**     | `0 0 \* \* 6` |
| **Description** | Scheduled time to make a full backup specified in the [crontab format :octicons-link-external-16:](https://en.wikipedia.org/wiki/Cron) |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repos.schedules.differential') }} |
| **Value**       | string |
| **Example**     | `0 0 \* \* 6` |
| **Description** | Scheduled time to make a differential backup specified in the [crontab format :octicons-link-external-16:](https://en.wikipedia.org/wiki/Cron) |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repos.volume.volumeClaimSpec.accessModes') }} |
| **Value**       | string |
| **Example**     | `ReadWriteOnce` |
| **Description** | The [Kubernetes PersistentVolumeClaim :octicons-link-external-16:](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) access modes for the pgBackRest Storage |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repos.volume.volumeClaimSpec.resources.requests.storage') }} |
| **Value**       | string |
| **Example**     | `1Gi` |
| **Description** | The [Kubernetes storage requests :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for the pgBackRest storage |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repos.s3.bucket') }} |
| **Value**       | string |
| **Example**     | `"my-bucket"` |
| **Description** | The [Amazon S3 bucket :octicons-link-external-16:](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html) 
name used for backups |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repos.s3.endpoint') }} |
| **Value**       | string |
| **Example**     | `"s3.ca-central-1.amazonaws.com"` |
| **Description** | The endpoint URL of the S3-compatible storage to be used for backups (not needed for the original Amazon S3 cloud) |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repos.s3.region') }} |
| **Value**       | boolean |
| **Example**     | `"ca-central-1"` |
| **Description** | The [AWS region :octicons-link-external-16:](https://docs.aws.amazon.com/general/latest/gr/rande.html) to use for Amazon and all S3-compatible storages |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repos.gcs.bucket') }} |
| **Value**       | string |
| **Example**     | `"my-bucket"` |
| **Description** | The [Google Cloud Storage bucket :octicons-link-external-16:](https://cloud.google.com/storage/docs/key-terms#buckets)
name used for backups |
|                 | |
| **Key**         | {{ optionlink('backups.pgbackrest.repos.azure.container') }} |
| **Value**       | string |
| **Example**     | `my-container` |
| **Description** | Name of the [Azure Blob Storage container :octicons-link-external-16:](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction#containers) for backups |

## PMM section

The `pmm` section in the [deploy/cr.yaml :octicons-link-external-16:](https://github.com/percona/percona-postgresql-operator/blob/main/deploy/cr.yaml)
file contains configuration options for Percona Monitoring and Management.

|                 | |
|-----------------|-|
| **Key**         | {{ optionlink('pmm.enabled') }} |
| **Value**       | boolean |
| **Example**     | `false` |
| **Description** | Enables or disables [monitoring Percona Distribution for PostgreSQL cluster with PMM :octicons-link-external-16:](https://www.percona.com/doc/percona-monitoring-and-management/2.x/setting-up/client/postgresql.html) |
|                 | |
| **Key**         | {{ optionlink('pmm.image') }} |
| **Value**       | string |
| **Example**     | `percona/pmm-client:{{ pmm2recommended }}` |
| **Description** | [Percona Monitoring and Management (PMM) Client :octicons-link-external-16:](https://www.percona.com/doc/percona-monitoring-and-management/2.x/details/architecture.html#pmm-client) Docker image |
|                 | |
| **Key**         | {{ optionlink('pmm.imagePullPolicy') }} |
| **Value**       | string |
| **Example**     | `IfNotPresent` |
| **Description** | This option is used to set the [policy :octicons-link-external-16:](https://kubernetes.io/docs/concepts/containers/images/#updating-images) for updating PMM Client images |
|                 | |
| **Key**         | {{ optionlink('pmm.pmmSecret') }} |
| **Value**       | string |
| **Example**     | `cluster1-pmm-secret` |
| **Description** | Name of the [Kubernetes Secret object :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/secret/#using-imagepullsecrets) for the PMM Server password |
|                 | |
| **Key**         | {{ optionlink('pmm.serverHost') }} |
| **Value**       | string |
| **Example**     | `monitoring-service` |
| **Description** | Address of the PMM Server to collect data from the cluster |

## Proxy section

The `proxy` section in the [deploy/cr.yaml :octicons-link-external-16:](https://github.com/percona/percona-postgresql-operator/blob/main/deploy/cr.yaml)
file contains configuration options for the [pgBouncer :octicons-link-external-16:](http://pgbouncer.github.io/) connection pooler for PostgreSQL.

|                 | |
|-----------------|-|
| **Key**         | {{ optionlink('proxy.pgBouncer.metadata.labels') }} |
| **Value**       | label |
| **Example**     | `pg-cluster-label: cluster1` |
| **Description** | Set [labels :octicons-link-external-16:](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) for pgBouncer Pods |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.replicas') }} |
| **Value**       | int |
| **Example**     | `3` |
| **Description** | The number of the pgBouncer Pods to provide connection pooling |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.image') }} |
| **Value**       | string |
| **Example**     | `perconalab/percona-postgresql-operator:{{release}}-ppg{{postgresrecommended}}-pgbouncer` |
| **Description** | Docker image for the [pgBouncer :octicons-link-external-16:](http://pgbouncer.github.io/) connection pooler |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.exposeSuperusers') }} |
| **Value**       | boolean |
| **Example**     | `false` |
| **Description** | Enables or disables [exposing superuser user through pgBouncer](users.md#superuser-and-pgbouncer) |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.resources.limits.cpu') }} |
| **Value**       | int |
| **Example**     | `200m` |
| **Description** | [Kubernetes CPU limits :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for a pgBouncer container |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.resources.limits.memory') }} |
| **Value**       | int |
| **Example**     | `128Mi` |
| **Description** | The [Kubernetes memory limits :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for a pgBouncer container |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.expose.type') }} |
| **Value**       | string |
| **Example**     | `ClusterIP` |
| **Description** | Specifies the type of [Kubernetes Service :octicons-link-external-16:](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) for pgBouncer |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.expose.annotations') }} |
| **Value**       | label |
| **Example**     | `pg-cluster-annot: cluster1` |
| **Description** | The [Kubernetes annotations :octicons-link-external-16:](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) metadata for pgBouncer |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.expose.labels') }} |
| **Value**       | label |
| **Example**     | `pg-cluster-label: cluster1` |
| **Description** | Set [labels :octicons-link-external-16:](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) for the pgBouncer Service |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.expose.loadBalancerSourceRanges') }} |
| **Value**       | string |
| **Example**     | `"10.0.0.0/8"` |
| **Description** | The range of client IP addresses from which the load balancer should be reachable (if not set, there is no limitations) |
|                 | |
| **Value**       | string |
| **Example**     | `preferred` |
| **Description** | [Pod anti-affinity type](constraints.md#affinity-and-anti-affinity), can be either `preferred` or `required` |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.config') }} |
| **Value**       | subdoc |
| **Example**     | <pre>global:<br>pool_mode: transaction</pre> |
| **Description** | Custom configuration options for pgBouncer. Please note that configuration changes are automatically applied to the running instances without validation, so having an invalid config can make the cluster unavailable |

### proxy.pgBouncer.sidecars subsection

The `proxy.pgBouncer.sidecars` subsection in the [deploy/cr.yaml :octicons-link-external-16:](https://github.com/percona/percona-postgresql-operator/blob/main/deploy/cr.yaml)
file contains configuration options for [custom sidecar containers](sidecar.md) which can be added to pgBouncer Pods.

|                 | |
|-----------------|-|
| **Key**         | {{ optionlink('proxy.pgBouncer.sidecars.image') }} |
| **Value**       | string |
| **Example**     | `mycontainer1:latest` |
| **Description** | Image for the [custom sidecar container](sidecar.md) for pgBouncer Pods |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.sidecars.name') }} |
| **Value**       | string |
| **Example**     | `testcontainer` |
| **Description** | Name of the [custom sidecar container](sidecar.md) for pgBouncer Pods |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.sidecars.imagePullPolicy') }} |
| **Value**       | string |
| **Example**     | `Always` |
| **Description** | This option is used to set the [policy :octicons-link-external-16:](https://kubernetes.io/docs/concepts/containers/images/#updating-images) for the pgBouncer Pod sidecar container |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.sidecars.env') }} |
| **Value**       | subdoc |
| **Example**     |  |
| **Description** | The [environment variables set as key-value pairs :octicons-link-external-16:](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/) for the [custom sidecar container](sidecar.md) for pgBouncer Pods |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.sidecars.envFrom') }} |
| **Value**       | subdoc |
| **Example**     | |
| **Description** | The [environment variables set as key-value pairs in ConfigMaps :octicons-link-external-16:](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/) for the [custom sidecar container](sidecar.md) for pgBouncer Pods |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.sidecars.command') }} |
| **Value**       | array |
| **Example**     | `["/bin/sh"]` |
| **Description** | Command for the [custom sidecar container](sidecar.md) for pgBouncer Pods |
|                 | |
| **Key**         | {{ optionlink('proxy.pgBouncer.sidecars.args') }} |
| **Value**       | array |
| **Example**     | `["-c", "while true; do trap 'exit 0' SIGINT SIGTERM SIGQUIT SIGKILL; done;"]` |
| **Description** | Command arguments for the [custom sidecar container](sidecar.md) for pgBouncer Pods |

## Patroni Section

The `patroni` section in the [deploy/cr.yaml :octicons-link-external-16:](https://github.com/percona/percona-postgresql-operator/blob/main/deploy/cr.yaml)
file contains configuration options to customize the PostgreSQL high-availability implementation based on [Patroni :octicons-link-external-16:](https://patroni.readthedocs.io/).

|                 | |
|-----------------|-|
| **Key**         | {{ optionlink('patroni.dynamicConfiguration') }} |
| **Value**       | subdoc |
| **Example**     | <pre>postgresql:<br>  parameters:<br>    max_parallel_workers: 2<br>    max_worker_processes: 2<br>    shared_buffers: 1GB<br>    work_mem: 2MB</pre> |
| **Description** | Custom PostgreSQL configuration options. Please note that configuration changes are automatically applied to the running instances without validation, so having an invalid config can make the cluster unavailable |

## Custom extensions Section

The `extensions` section in the [deploy/cr.yaml :octicons-link-external-16:](https://github.com/percona/percona-postgresql-operator/blob/main/deploy/cr.yaml)
file contains configuration options to [manage PostgreSQL extensions](custom-extensions.md).

|                 | |
|-----------------|-|
| **Key**         | {{ optionlink('extensions.image') }} |
| **Value**       | string |
| **Example**     | `percona/percona-postgresql-operator:{{ release }}` |
| **Description** | Image for the custom PostgreSQL extension loader sidecar container |
|                 | |
| **Key**         | {{ optionlink('extensions.imagePullPolicy') }} |
| **Value**       | string |
| **Example**     | `Always` |
| **Description** | [Policy :octicons-link-external-16:](https://kubernetes.io/docs/concepts/containers/images/#updating-images) for the custom extension sidecar container |
|                 | |
| **Key**         | {{ optionlink('extensions.storage.type') }} |
| **Value**       | string |
| **Example**     | `s3` |
| **Description** | The cloud storage type used for backups. Only `s3` type is currently supported |
|                 | |
| **Key**         | {{ optionlink('extensions.storage.bucket') }} |
| **Value**       | string |
| **Example**     | `pg-extensions` |
| **Description** | The [Amazon S3 bucket :octicons-link-external-16:](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html) name for prepackaged PostgreSQL custom extensions |
|                 | |
| **Key**         | {{ optionlink('extensions.storage.region') }} |
| **Value**       | string |
| **Example**     | `eu-central-1` |
| **Description** | The [AWS region :octicons-link-external-16:](https://docs.aws.amazon.com/general/latest/gr/rande.html) to use |
|                 | |
| **Key**         | {{ optionlink('extensions.storage.secret.name') }} |
| **Value**       | string |
| **Example**     | `cluster1-extensions-secret` |
| **Description** | The [Kubernetes secret :octicons-link-external-16:](https://kubernetes.io/docs/concepts/configuration/secret/) for the custom extensions storage. It should contain `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` keys. |
|                 | |
| **Key**         | {{ optionlink('extensions.builtin') }} |
| **Value**       | label |
| **Example**     | `pg_stat_monitor: true` |
| **Description** | The key-value pairs which enable or disable [Percona Distribution for PostgreSQL builtin extensions :octicons-link-external-16:](https://docs.percona.com/postgresql/16/) |
|                 | |
| **Key**         | {{ optionlink('extensions.custom.name') }} |
| **Value**       | string |
| **Example**     | `pg_cron` |
| **Description** | Name of the PostgreSQL custom extension |
|                 | |
| **Key**         | {{ optionlink('extensions.custom.version') }} |
| **Value**       | string |
| **Example**     | `1.6.1` |
| **Description** | Version of the PostgreSQL custom extension |
|                 | |