API Reference

Specification of the desired behavior of the backup. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Most recently observed status of the backup. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Specification of the desired behavior of the cluster. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Most recently observed status of the cluster. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Specification of the desired behavior of the ClusterImageCatalog. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Specification of the desired Database. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Most recently observed status of the Database. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Specification of the desired behavior of the ImageCatalog. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Specification of the desired behavior of the Pooler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Most recently observed status of the Pooler. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Specification of the desired behavior of the ScheduledBackup. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Most recently observed status of the ScheduledBackup. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Activates anti-affinity for the pods. The operator will define pods anti-affinity unless this field is explicitly set to false

TopologyKey to use for anti-affinity configuration. See k8s documentation for more info on that

NodeSelector is map of key-value pairs used to define the nodes on which the pods can run. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

NodeAffinity describes node affinity scheduling rules for the pod. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity

Tolerations is a list of Tolerations that should be set for all the pods, in order to allow them to run on tainted nodes. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/

PodAntiAffinityType allows the user to decide whether pod anti-affinity between cluster instance has to be considered a strong requirement during scheduling or not. Allowed values are: "preferred" (default if empty) or "required". Setting it to "required", could lead to instances remaining pending until new kubernetes nodes are added if all the existing nodes don't match the required pod anti-affinity rule. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity

AdditionalPodAntiAffinity allows to specify pod anti-affinity terms to be added to the ones generated by the operator if EnablePodAntiAffinity is set to true (default) or to be used exclusively if set to false.

AdditionalPodAffinity allows to specify pod affinity terms to be passed to all the cluster's pods.

GoArch is the name of the executable architecture

Hash is the hash of the executable

VolumeSnapshot provides the configuration for the execution of volume snapshot backups.

The configuration for the barman-cloud tool suite

RetentionPolicy is the retention policy to be used for backups and WALs (i.e. '60d'). The retention policy is expressed in the form of XXu where XX is a positive integer and u is in [dwm] - days, weeks, months. It's currently only applicable when using the BarmanObjectStore method.

The policy to decide which instance should perform backups. Available options are empty string, which will default to prefer-standby policy, primary to have backups run always on primary instances, prefer-standby to have backups run preferably on the most updated standby, if available.

Name is the name of the plugin managing this backup

Parameters are the configuration parameters passed to the backup plugin for this backup

Name is the snapshot resource name

Type is tho role of the snapshot in the cluster, such as PG_DATA, PG_WAL and PG_TABLESPACE

TablespaceName is the name of the snapshotted tablespace. Only set when type is PG_TABLESPACE

The elements list, populated with the gathered volume snapshots

EndpointCA store the CA bundle of the barman endpoint. Useful when using self-signed certificates to avoid errors with certificate issuer and barman-cloud-wal-archive.

The cluster to backup

The policy to decide which instance should perform this backup. If empty, it defaults to cluster.spec.backup.target. Available options are empty string, primary and prefer-standby. primary to have backups run always on primary instances, prefer-standby to have backups run preferably on the most updated standby, if available.

The backup method to be used, possible options are barmanObjectStore, volumeSnapshot or plugin. Defaults to: barmanObjectStore.

Configuration parameters passed to the plugin managing this backup

Whether the default type of backup with volume snapshots is online/hot (true, default) or offline/cold (false) Overrides the default setting specified in the cluster field '.spec.backup.volumeSnapshot.online'

Configuration parameters to control the online/hot backup with volume snapshots Overrides the default settings specified in the cluster '.backup.volumeSnapshot.onlineConfiguration' stanza

The potential credentials for each cloud provider

EndpointCA store the CA bundle of the barman endpoint. Useful when using self-signed certificates to avoid errors with certificate issuer and barman-cloud-wal-archive.

Endpoint to be used to upload data to the cloud, overriding the automatic endpoint discovery

The path where to store the backup (i.e. s3://bucket/path/to/folder) this path, with different destination folders, will be used for WALs and for data. This may not be populated in case of errors.

The server name on S3, the cluster name is used if this parameter is omitted

Encryption method required to S3 API

The ID of the Barman backup

The Name of the Barman backup

The last backup status

When the backup was started

When the backup was terminated

The starting WAL

The ending WAL

The starting xlog

The ending xlog

The detected error

Unused. Retained for compatibility with old versions.

The backup command output in case of error

Backup label file content as returned by Postgres in case of online (hot) backups

Tablespace map file content as returned by Postgres in case of online (hot) backups

Information to identify the instance where the backup has been taken from

Status of the volumeSnapshot backup

The backup method being used

Whether the backup was online/hot (true) or offline/cold (false)

A map containing the plugin metadata

Bootstrap the cluster via initdb

Bootstrap the cluster from a backup

Bootstrap the cluster taking a physical backup of another compatible PostgreSQL instance

Name of the database used by the application. Default: app.

Name of the owner of the database in the instance to be used by applications. Defaults to the value of the database key.

Name of the secret containing the initial credentials for the owner of the user database. If empty a new secret will be created from scratch

The list of options that must be passed to initdb when creating the cluster. Deprecated: This could lead to inconsistent configurations, please use the explicit provided parameters instead. If defined, explicit values will be ignored.

Whether the -k option should be passed to initdb, enabling checksums on data pages (default: false)

The value to be passed as option --encoding for initdb (default:UTF8)

The value to be passed as option --lc-collate for initdb (default:C)

The value to be passed as option --lc-ctype for initdb (default:C)

Sets the default collation order and character classification in the new database.

This option sets the locale provider for databases created in the new cluster. Available from PostgreSQL 16.

Specifies the ICU locale when the ICU provider is used. This option requires localeProvider to be set to icu. Available from PostgreSQL 15.

Specifies additional collation rules to customize the behavior of the default collation. This option requires localeProvider to be set to icu. Available from PostgreSQL 16.

Specifies the locale name when the builtin provider is used. This option requires localeProvider to be set to builtin. Available from PostgreSQL 17.

The value in megabytes (1 to 1024) to be passed to the --wal-segsize option for initdb (default: empty, resulting in PostgreSQL default: 16MB)

List of SQL queries to be executed as a superuser in the postgres database right after the cluster has been created - to be used with extreme care (by default empty)

List of SQL queries to be executed as a superuser in the application database right after the cluster has been created - to be used with extreme care (by default empty)

List of SQL queries to be executed as a superuser in the template1 database right after the cluster has been created - to be used with extreme care (by default empty)

Bootstraps the new cluster by importing data from an existing PostgreSQL instance using logical backup (pg_dump and pg_restore)

List of references to ConfigMaps or Secrets containing SQL files to be executed as a superuser in the application database right after the cluster has been created. The references are processed in a specific order: first, all Secrets are processed, followed by all ConfigMaps. Within each group, the processing order follows the sequence specified in their respective arrays. (by default empty)

List of references to ConfigMaps or Secrets containing SQL files to be executed as a superuser in the template1 database right after the cluster has been created. The references are processed in a specific order: first, all Secrets are processed, followed by all ConfigMaps. Within each group, the processing order follows the sequence specified in their respective arrays. (by default empty)

List of references to ConfigMaps or Secrets containing SQL files to be executed as a superuser in the postgres database right after the cluster has been created. The references are processed in a specific order: first, all Secrets are processed, followed by all ConfigMaps. Within each group, the processing order follows the sequence specified in their respective arrays. (by default empty)

The name of the server of which we need to take a physical backup

Name of the database used by the application. Default: app.

Name of the owner of the database in the instance to be used by applications. Defaults to the value of the database key.

Name of the secret containing the initial credentials for the owner of the user database. If empty a new secret will be created from scratch

The backup object containing the physical base backup from which to initiate the recovery procedure. Mutually exclusive with source and volumeSnapshots.

The external cluster whose backup we will restore. This is also used as the name of the folder under which the backup is stored, so it must be set to the name of the source cluster Mutually exclusive with backup.

The static PVC data source(s) from which to initiate the recovery procedure. Currently supporting VolumeSnapshot and PersistentVolumeClaim resources that map an existing PVC group, compatible with CloudNativePG, and taken with a cold backup copy on a fenced Postgres instance (limitation which will be removed in the future when online backup will be implemented). Mutually exclusive with backup.

By default, the recovery process applies all the available WAL files in the archive (full recovery). However, you can also end the recovery as soon as a consistent state is reached or recover to a point-in-time (PITR) by specifying a RecoveryTarget object, as expected by PostgreSQL (i.e., timestamp, transaction Id, LSN, ...). More info: https://www.postgresql.org/docs/current/runtime-config-wal.html#RUNTIME-CONFIG-WAL-RECOVERY-TARGET

Name of the database used by the application. Default: app.

Name of the owner of the database in the instance to be used by applications. Defaults to the value of the database key.

Name of the secret containing the initial credentials for the owner of the user database. If empty a new secret will be created from scratch

The image reference

The PostgreSQL major version of the image. Must be unique within the catalog.

The secret containing the Server CA certificate. If not defined, a new secret will be created with a self-signed CA and will be used to generate the TLS certificate ServerTLSSecret. Contains:

• ca.crt: CA that should be used to validate the server certificate, used as sslrootcert in client connection strings.
• ca.key: key used to generate Server SSL certs, if ServerTLSSecret is provided, this can be omitted.

The secret of type kubernetes.io/tls containing the server TLS certificate and key that will be set as ssl_cert_file and ssl_key_file so that clients can connect to postgres securely. If not defined, ServerCASecret must provide also ca.key and a new secret will be created using the provided CA.

The secret of type kubernetes.io/tls containing the client certificate to authenticate as the streaming_replica user. If not defined, ClientCASecret must provide also ca.key, and a new secret will be created using the provided CA.

The secret containing the Client CA certificate. If not defined, a new secret will be created with a self-signed CA and will be used to generate all the client certificates. Contains:

• ca.crt: CA that should be used to validate the client certificates, used as ssl_ca_file of all the instances.
• ca.key: key used to generate client certificates, if ReplicationTLSSecret is provided, this can be omitted.

The list of the server alternative DNS names to be added to the generated server TLS certificates, when required.

Needed configurations to handle server certificates, initialized with default values, if needed.

Expiration dates for all certificates.

Enable TLS for the monitoring endpoint. Changing this option will force a rollout of all instances.

Description of this PostgreSQL cluster

Metadata that will be inherited by all objects related to the Cluster

Name of the container image, supporting both tags (<image>:<tag>) and digests for deterministic and repeatable deployments (<image>:<tag>@sha256:<digestValue>)

Defines the major PostgreSQL version we want to use within an ImageCatalog

Image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

If specified, the pod will be dispatched by specified Kubernetes scheduler. If not specified, the pod will be dispatched by the default scheduler. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/kube-scheduler/

The UID of the postgres user inside the image, defaults to 26

The GID of the postgres user inside the image, defaults to 26

Number of instances required in the cluster

Minimum number of instances required in synchronous replication with the primary. Undefined or 0 allow writes to complete when no standby is available.

The target value for the synchronous replication quorum, that can be decreased if the number of ready standbys is lower than this. Undefined or 0 disable synchronous replication.

Configuration of the PostgreSQL server

Replication slots management configuration

Instructions to bootstrap this cluster

Replica cluster configuration

The secret containing the superuser password. If not defined a new secret will be created with a randomly generated password

When this option is enabled, the operator will use the SuperuserSecret to update the postgres user password (if the secret is not present, the operator will automatically create one). When this option is disabled, the operator will ignore the SuperuserSecret content, delete it when automatically created, and then blank the password of the postgres user by setting it to NULL. Disabled by default.

The configuration for the CA and related certificates

The list of pull secrets to be used to pull the images

Configuration of the storage of the instances

Configure the generation of the service account

Configuration of the storage for PostgreSQL WAL (Write-Ahead Log)

EphemeralVolumeSource allows the user to configure the source of ephemeral volumes.

The time in seconds that is allowed for a PostgreSQL instance to successfully start up (default 3600). The startup probe failure threshold is derived from this value using the formula: ceiling(startDelay / 10).

The time in seconds that is allowed for a PostgreSQL instance to gracefully shutdown (default 1800)

The time in seconds that controls the window of time reserved for the smart shutdown of Postgres to complete. Make sure you reserve enough time for the operator to request a fast shutdown of Postgres (that is: stopDelay - smartShutdownTimeout).

The time in seconds that is allowed for a primary PostgreSQL instance to gracefully shutdown during a switchover. Default value is 3600 seconds (1 hour).

The amount of time (in seconds) to wait before triggering a failover after the primary PostgreSQL instance in the cluster was detected to be unhealthy

LivenessProbeTimeout is the time (in seconds) that is allowed for a PostgreSQL instance to successfully respond to the liveness probe (default 30). The Liveness probe failure threshold is derived from this value using the formula: ceiling(livenessProbe / 10).

Affinity/Anti-affinity rules for Pods

TopologySpreadConstraints specifies how to spread matching pods among the given topology. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/

Resources requirements of every generated Pod. Please refer to https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ for more information.

EphemeralVolumesSizeLimit allows the user to set the limits for the ephemeral volumes

Name of the priority class which will be used in every generated Pod, if the PriorityClass specified does not exist, the pod will not be able to schedule. Please refer to https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/#priorityclass for more information

Deployment strategy to follow to upgrade the primary server during a rolling update procedure, after all replicas have been successfully updated: it can be automated (unsupervised - default) or manual (supervised)

Method to follow to upgrade the primary server during a rolling update procedure, after all replicas have been successfully updated: it can be with a switchover (switchover) or in-place (restart - default)

The configuration to be used for backups

Define a maintenance window for the Kubernetes nodes

The configuration of the monitoring infrastructure of this cluster

The list of external clusters which are used in the configuration

The instances' log level, one of the following values: error, warning, info (default), debug, trace

Template to be used to define projected volumes, projected volumes will be mounted under /projected base folder

Env follows the Env format to pass environment variables to the pods created in the cluster

EnvFrom follows the EnvFrom format to pass environment variables sources to the pods to be used by Env

The configuration that is used by the portions of PostgreSQL that are managed by the instance manager

The SeccompProfile applied to every Pod and Container. Defaults to: RuntimeDefault

The tablespaces configuration

Manage the PodDisruptionBudget resources within the cluster. When configured as true (default setting), the pod disruption budgets will safeguard the primary node from being terminated. Conversely, setting it to false will result in the absence of any PodDisruptionBudget resource, permitting the shutdown of all nodes hosting the PostgreSQL cluster. This latter configuration is advisable for any PostgreSQL cluster employed for development/staging purposes.

The plugins configuration, containing any plugin to be loaded with the corresponding configuration

The configuration of the probes to be injected in the PostgreSQL Pods.

The total number of PVC Groups detected in the cluster. It may differ from the number of existing instance pods.

The total number of ready instances in the cluster. It is equal to the number of ready instance pods.

InstancesStatus indicates in which status the instances are

The reported state of the instances during the last reconciliation loop

ManagedRolesStatus reports the state of the managed roles in the cluster

TablespacesStatus reports the state of the declarative tablespaces in the cluster

The timeline of the Postgres cluster

Instances topology.

ID of the latest generated node (used to avoid node name clashing)

Current primary instance

Target primary instance, this is different from the previous one during a switchover or a failover

LastPromotionToken is the last verified promotion token that was used to promote a replica cluster

How many PVCs have been created by this cluster

How many Jobs have been created by this cluster

List of all the PVCs created by this cluster and still available which are not attached to a Pod

List of all the PVCs that have ResizingPVC condition.

List of all the PVCs that are being initialized by this cluster

List of all the PVCs not dangling nor initializing

List of all the PVCs that are unusable because another PVC is missing

Current write pod

Current list of read pods

Current phase of the cluster

Reason for the current phase

The list of resource versions of the secrets managed by the operator. Every change here is done in the interest of the instance manager, which will refresh the secret data

The list of resource versions of the configmaps, managed by the operator. Every change here is done in the interest of the instance manager, which will refresh the configmap data

The configuration for the CA and related certificates, initialized with defaults.

The first recoverability point, stored as a date in RFC3339 format. This field is calculated from the content of FirstRecoverabilityPointByMethod

The first recoverability point, stored as a date in RFC3339 format, per backup method type

Last successful backup, stored as a date in RFC3339 format This field is calculated from the content of LastSuccessfulBackupByMethod

Last successful backup, stored as a date in RFC3339 format, per backup method type

Stored as a date in RFC3339 format

The commit hash number of which this operator running

The timestamp when the last actual promotion to primary has occurred

The timestamp when the primary was detected to be unhealthy This field is reported when .spec.failoverDelay is populated or during online upgrades

The timestamp when the last request for a new primary has occurred

The integration needed by poolers referencing the cluster

The hash of the binary of the operator

AvailableArchitectures reports the available architectures of a cluster

Conditions for cluster object

List of instance names in the cluster

OnlineUpdateEnabled shows if the online upgrade is enabled inside the cluster

AzurePVCUpdateEnabled shows if the PVC online upgrade is enabled for this cluster

Image contains the image name used by the pods

PluginStatus is the status of the loaded plugins

SwitchReplicaClusterStatus is the status of the switch to replica cluster

DemotionToken is a JSON token containing the information from pg_controldata such as Database system identifier, Latest checkpoint's TimeLineID, Latest checkpoint's REDO location, Latest checkpoint's REDO WAL file, and Time of latest checkpoint

A map with the versions of all the config maps used to pass metrics. Map keys are the config map names, map values are the versions

Configuration of the storage of the instances

Configuration of the storage for PostgreSQL WAL (Write-Ahead Log)

Configuration of the storage for PostgreSQL tablespaces

The name of the PostgreSQL cluster hosting the database.

Ensure the PostgreSQL database is present or absent - defaults to "present".

The name of the database to create inside PostgreSQL. This setting cannot be changed.

Maps to the OWNER parameter of CREATE DATABASE. Maps to the OWNER TO command of ALTER DATABASE. The role name of the user who owns the database inside PostgreSQL.

Maps to the TEMPLATE parameter of CREATE DATABASE. This setting cannot be changed. The name of the template from which to create this database.

Maps to the ENCODING parameter of CREATE DATABASE. This setting cannot be changed. Character set encoding to use in the database.

Maps to the LOCALE parameter of CREATE DATABASE. This setting cannot be changed. Sets the default collation order and character classification in the new database.

Maps to the LOCALE_PROVIDER parameter of CREATE DATABASE. This setting cannot be changed. This option sets the locale provider for databases created in the new cluster. Available from PostgreSQL 16.

Maps to the LC_COLLATE parameter of CREATE DATABASE. This setting cannot be changed.

Maps to the LC_CTYPE parameter of CREATE DATABASE. This setting cannot be changed.

Maps to the ICU_LOCALE parameter of CREATE DATABASE. This setting cannot be changed. Specifies the ICU locale when the ICU provider is used. This option requires localeProvider to be set to icu. Available from PostgreSQL 15.

Maps to the ICU_RULES parameter of CREATE DATABASE. This setting cannot be changed. Specifies additional collation rules to customize the behavior of the default collation. This option requires localeProvider to be set to icu. Available from PostgreSQL 16.

Maps to the BUILTIN_LOCALE parameter of CREATE DATABASE. This setting cannot be changed. Specifies the locale name when the builtin provider is used. This option requires localeProvider to be set to builtin. Available from PostgreSQL 17.

Maps to the COLLATION_VERSION parameter of CREATE DATABASE. This setting cannot be changed.

Maps to the IS_TEMPLATE parameter of CREATE DATABASE and ALTER DATABASE. If true, this database is considered a template and can be cloned by any user with CREATEDB privileges.

Maps to the ALLOW_CONNECTIONS parameter of CREATE DATABASE and ALTER DATABASE. If false then no one can connect to this database.

Maps to the CONNECTION LIMIT clause of CREATE DATABASE and ALTER DATABASE. How many concurrent connections can be made to this database. -1 (the default) means no limit.

Maps to the TABLESPACE parameter of CREATE DATABASE. Maps to the SET TABLESPACE command of ALTER DATABASE. The name of the tablespace (in PostgreSQL) that will be associated with the new database. This tablespace will be the default tablespace used for objects created in this database.

The policy for end-of-life maintenance of this database.

A sequence number representing the latest desired state that was synchronized

Applied is true if the database was reconciled correctly

Message is the reconciliation output message

Shm is the size limit of the shared memory volume

TemporaryData is the size limit of the temporary data volume

The server name, required

The list of connection parameters, such as dbname, host, username, etc

The reference to an SSL certificate to be used to connect to this instance

The reference to an SSL private key to be used to connect to this instance

The reference to an SSL CA public key to be used to connect to this instance

The reference to the password to be used to connect to the server. If a password is provided, CloudNativePG creates a PostgreSQL passfile at /controller/external/NAME/pass (where "NAME" is the cluster's name). This passfile is automatically referenced in the connection string when establishing a connection to the remote PostgreSQL server from the current PostgreSQL Cluster. This ensures secure and efficient password management for external clusters.

The configuration for the barman-cloud tool suite

The configuration of the plugin that is taking care of WAL archiving and backups for this external cluster

The major version of PostgreSQL we want to use from the ImageCatalog

List of CatalogImages available in the catalog

The source of the import

The import type. Can be microservice or monolith.

The databases to import

The roles to import

List of SQL queries to be executed as a superuser in the application database right after is imported - to be used with extreme care (by default empty). Only available in microservice type.

When set to true, only the pre-data and post-data sections of pg_restore are invoked, avoiding data import. Default: false.

List of custom options to pass to the pg_dump command. IMPORTANT: Use these options with caution and at your own risk, as the operator does not validate their content. Be aware that certain options may conflict with the operator's intended functionality or design.

List of custom options to pass to the pg_restore command. IMPORTANT: Use these options with caution and at your own risk, as the operator does not validate their content. Be aware that certain options may conflict with the operator's intended functionality or design.

The name of the externalCluster used for import

The pod name

The container ID

indicates if an instance is the primary one

indicates on which TimelineId the instance is

Prefix for the bind authentication option

Suffix for the bind authentication option

Root DN to begin the user search

DN of the user to bind to the directory

Secret with the password for the user to bind to the directory

Attribute to match against the username

Search filter to use when doing the search+bind authentication

LDAP hostname or IP address

LDAP server port

LDAP schema to be used, possible options are ldap and ldaps

Bind as authentication configuration

Bind+Search authentication configuration

Set to 'true' to enable LDAP over TLS. 'false' is default

Database roles managed by the Cluster

Services roles managed by the Cluster

ByStatus gives the list of roles in each state

CannotReconcile lists roles that cannot be reconciled in PostgreSQL, with an explanation of the cause

PasswordStatus gives the last transaction id and password secret version for each managed role

SelectorType specifies the type of selectors that the service will have. Valid values are "rw", "r", and "ro", representing read-write, read, and read-only services.

UpdateStrategy describes how the service differences should be reconciled

ServiceTemplate is the template specification for the service.

DisabledDefaultServices is a list of service types that are disabled by default. Valid values are "r", and "ro", representing read, and read-only services.

Additional is a list of additional managed services specified by the user.

The name of the resource. Only supported for certain types

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

Whether the default queries should be injected. Set it to true if you don't want to inject default queries into the cluster. Default: false.

The list of config maps containing the custom queries

The list of secrets containing the custom queries

Enable or disable the PodMonitor

Configure TLS communication for the metrics endpoint. Changing tls.enabled option will force a rollout of all instances.

The list of metric relabelings for the PodMonitor. Applied to samples before ingestion.

The list of relabelings for the PodMonitor. Applied to samples before scraping.

Reuse the existing PVC (wait for the node to come up again) or not (recreate it elsewhere - when instances >1)

Is there a node maintenance activity in progress?

If false, the function will return immediately after the backup is completed, without waiting for WAL to be archived. This behavior is only useful with backup software that independently monitors WAL archiving. Otherwise, WAL required to make the backup consistent might be missing and make the backup useless. By default, or when this parameter is true, pg_backup_stop will wait for WAL to be archived when archiving is enabled. On a standby, this means that it will wait only when archive_mode = always. If write activity on the primary is low, it may be useful to run pg_switch_wal on the primary in order to trigger an immediate segment switch.

Control whether the I/O workload for the backup initial checkpoint will be limited, according to the checkpoint_completion_target setting on the PostgreSQL server. If set to true, an immediate checkpoint will be used, meaning PostgreSQL will complete the checkpoint as soon as possible. false by default.

the last transaction ID to affect the role definition in PostgreSQL

the resource version of the password secret

The auth query secret version

The pool mode. Default: session.

The credentials of the user that need to be used for the authentication query. In case it is specified, also an AuthQuery (e.g. "SELECT usename, passwd FROM pg_catalog.pg_shadow WHERE usename=$1") has to be specified and no automatic CNPG Cluster integration will be triggered.

The query that will be used to download the hash of the password of a certain user. Default: "SELECT usename, passwd FROM public.user_search($1)". In case it is specified, also an AuthQuerySecret has to be specified and no automatic CNPG Cluster integration will be triggered.

Additional parameters to be passed to PgBouncer - please check the CNPG documentation for a list of options you can configure

PostgreSQL Host Based Authentication rules (lines to be appended to the pg_hba.conf file)

When set to true, PgBouncer will disconnect from the PostgreSQL server, first waiting for all queries to complete, and pause all new client connections until this value is set to false (default). Internally, the operator calls PgBouncer's PAUSE and RESUME commands.

Name is the plugin name

Enabled is true if this plugin will be used

Parameters is the configuration of the plugin

Name is the name of the plugin

Version is the version of the plugin loaded by the latest reconciliation loop

Capabilities are the list of capabilities of the plugin

OperatorCapabilities are the list of capabilities of the plugin regarding the reconciler

WALCapabilities are the list of capabilities of the plugin regarding the WAL management

BackupCapabilities are the list of capabilities of the plugin regarding the Backup management

RestoreJobHookCapabilities are the list of capabilities of the plugin regarding the RestoreJobHook management

Status contain the status reported by the plugin through the SetStatusInCluster interface

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Enable or disable the PodMonitor

The list of metric relabelings for the PodMonitor. Applied to samples before ingestion.

The list of relabelings for the PodMonitor. Applied to samples before scraping.

The server TLS secret version

The server CA secret version

The client CA secret version

The version of the secrets used by PgBouncer

This is the cluster reference on which the Pooler will work. Pooler name should never match with any cluster name within the same namespace.

Type of service to forward traffic to. Default: rw.

The number of replicas we want. Default: 1.

The template of the Pod to be created

The PgBouncer configuration

The deployment strategy to use for pgbouncer to replace existing pods with new ones

The configuration of the monitoring infrastructure of this pooler.

Template for the Service to be created

The resource version of the config object

The number of pods trying to be scheduled

PostgreSQL configuration options (postgresql.conf)

Configuration of the PostgreSQL synchronous replication feature

PostgreSQL Host Based Authentication rules (lines to be appended to the pg_hba.conf file)

PostgreSQL User Name Maps rules (lines to be appended to the pg_ident.conf file)

Requirements to be met by sync replicas. This will affect how the "synchronous_standby_names" parameter will be set up.

Lists of shared preload libraries to add to the default ones

Options to specify LDAP configuration

Specifies the maximum number of seconds to wait when promoting an instance to primary. Default value is 40000000, greater than one year in seconds, big enough to simulate an infinite timeout

If this parameter is true, the user will be able to invoke ALTER SYSTEM on this CloudNativePG Cluster. This should only be used for debugging and troubleshooting. Defaults to false.

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

The startup probe configuration

The liveness probe configuration

The readiness probe configuration

The name of the PostgreSQL cluster that identifies the "publisher"

The name of the publication inside PostgreSQL

The name of the database where the publication will be installed in the "publisher" cluster

Publication parameters part of the WITH clause as expected by PostgreSQL CREATE PUBLICATION command

Target of the publication as expected by PostgreSQL CREATE PUBLICATION command

The policy for end-of-life maintenance of this publication

A sequence number representing the latest desired state that was synchronized

Applied is true if the publication was reconciled correctly

Message is the reconciliation output message

Marks the publication as one that replicates changes for all tables in the database, including tables created in the future. Corresponding to FOR ALL TABLES in PostgreSQL.

Just the following schema objects

Marks the publication as one that replicates changes for all tables in the specified list of schemas, including tables created in the future. Corresponding to FOR TABLES IN SCHEMA in PostgreSQL.

Specifies a list of tables to add to the publication. Corresponding to FOR TABLE in PostgreSQL.

Whether to limit to the table only or include all its descendants

The table name

The schema name

The columns to publish

The ID of the backup from which to start the recovery process. If empty (default) the operator will automatically detect the backup based on targetTime or targetLSN if specified. Otherwise use the latest available backup in chronological order.

The target timeline ("latest" or a positive integer)

The target transaction ID

The target name (to be previously created with pg_create_restore_point)

The target LSN (Log Sequence Number)

The target time as a timestamp in the RFC3339 standard

End recovery as soon as a consistent state is reached

Set the target to be exclusive. If omitted, defaults to false, so that in Postgres, recovery_target_inclusive will be true

Self defines the name of this cluster. It is used to determine if this is a primary or a replica cluster, comparing it with primary

Primary defines which Cluster is defined to be the primary in the distributed PostgreSQL cluster, based on the topology specified in externalClusters

The name of the external cluster which is the replication origin

If replica mode is enabled, this cluster will be a replica of an existing cluster. Replica cluster can be created from a recovery object store or via streaming through pg_basebackup. Refer to the Replica clusters page of the documentation for more information.

A demotion token generated by an external cluster used to check if the promotion requirements are met.

When replica mode is enabled, this parameter allows you to replay transactions only when the system time is at least the configured time past the commit time. This provides an opportunity to correct data loss errors. Note that when this parameter is set, a promotion token cannot be used.

Replication slots for high availability configuration

Standby will update the status of the local replication slots every updateInterval seconds (default 30).

Configures the synchronization of the user defined physical replication slots

If enabled (default), the operator will automatically manage replication slots on the primary instance and use them in streaming replication connections with all the standby instances that are part of the HA cluster. If disabled, the operator will not take advantage of replication slots in streaming connections with the replicas. This feature also controls replication slots in replica cluster, from the designated primary to its cascading replicas.

Prefix for replication slots managed by the operator for HA. It may only contain lower case letters, numbers, and the underscore character. This can only be set at creation time. By default set to _cnpg_.

Name of the role

Description of the role

Ensure the role is present or absent - defaults to "present"

Secret containing the password of the role (if present) If null, the password will be ignored unless DisablePassword is set

If the role can log in, this specifies how many concurrent connections the role can make. -1 (the default) means no limit.

Date and time after which the role's password is no longer valid. When omitted, the password will never expire (default).

List of one or more existing roles to which this role will be immediately added as a new member. Default empty.

Whether a role "inherits" the privileges of roles it is a member of. Defaults is true.

DisablePassword indicates that a role's password should be set to NULL in Postgres

Whether the role is a superuser who can override all access restrictions within the database - superuser status is dangerous and should be used only when really needed. You must yourself be a superuser to create a new superuser. Defaults is false.

When set to true, the role being defined will be allowed to create new databases. Specifying false (default) will deny a role the ability to create databases.

Whether the role will be permitted to create, alter, drop, comment on, change the security label for, and grant or revoke membership in other roles. Default is false.

Whether the role is allowed to log in. A role having the login attribute can be thought of as a user. Roles without this attribute are useful for managing database privileges, but are not users in the usual sense of the word. Default is false.

Whether a role is a replication role. A role must have this attribute (or be a superuser) in order to be able to connect to the server in replication mode (physical or logical replication) and in order to be able to create or drop replication slots. A role having the replication attribute is a very highly privileged role, and should only be used on roles actually used for replication. Default is false.

Whether a role bypasses every row-level security (RLS) policy. Default is false.

SecretRefs holds a list of references to Secrets

ConfigMapRefs holds a list of references to ConfigMaps

If this backup is suspended or not

If the first backup has to be immediately start after creation or not

The schedule does not follow the same format used in Kubernetes CronJobs as it includes an additional seconds specifier, see https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format

The cluster to backup

Indicates which ownerReference should be put inside the created backup resources.

• none: no owner reference for created backup objects (same behavior as before the field was introduced)
• self: sets the Scheduled backup object as owner of the backup
• cluster: set the cluster as owner of the backup

The policy to decide which instance should perform this backup. If empty, it defaults to cluster.spec.backup.target. Available options are empty string, primary and prefer-standby. primary to have backups run always on primary instances, prefer-standby to have backups run preferably on the most updated standby, if available.

The backup method to be used, possible options are barmanObjectStore, volumeSnapshot or plugin. Defaults to: barmanObjectStore.

Configuration parameters passed to the plugin managing this backup

Whether the default type of backup with volume snapshots is online/hot (true, default) or offline/cold (false) Overrides the default setting specified in the cluster field '.spec.backup.volumeSnapshot.online'

Configuration parameters to control the online/hot backup with volume snapshots Overrides the default settings specified in the cluster '.backup.volumeSnapshot.onlineConfiguration' stanza

The latest time the schedule

Information when was the last time that backup was successfully scheduled.

Next time we will run a backup

The name of the secret

The ResourceVersion of the secret

The resource version of the "postgres" user secret

The resource version of the "streaming_replica" user secret

The resource version of the "app" user secret

The resource versions of the managed roles secrets

Unused. Retained for compatibility with old versions.

The resource version of the PostgreSQL client-side CA secret version

The resource version of the PostgreSQL server-side CA secret version

The resource version of the PostgreSQL server-side secret version

The resource version of the Barman Endpoint CA if provided

The resource versions of the external cluster secrets

A map with the versions of all the secrets used to pass metrics. Map keys are the secret names, map values are the versions

Metadata are the metadata to be used for the generated service account

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Specification of the desired behavior of the service. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

StorageClass to use for PVCs. Applied after evaluating the PVC template, if available. If not specified, the generated PVCs will use the default storage class

Size of the storage. Required if not already specified in the PVC template. Changes to this field are automatically reapplied to the created PVCs. Size cannot be decreased.

Resize existent PVCs, defaults to true

Template to be used to generate the Persistent Volume Claim

The name of the PostgreSQL cluster that identifies the "subscriber"

The name of the subscription inside PostgreSQL

The name of the database where the publication will be installed in the "subscriber" cluster

Subscription parameters part of the WITH clause as expected by PostgreSQL CREATE SUBSCRIPTION command

The name of the publication inside the PostgreSQL database in the "publisher"

The name of the database containing the publication on the external cluster. Defaults to the one in the external cluster definition.

The name of the external cluster with the publication ("publisher")

The policy for end-of-life maintenance of this subscription

A sequence number representing the latest desired state that was synchronized

Applied is true if the subscription was reconciled correctly

Message is the reconciliation output message

InProgress indicates if there is an ongoing procedure of switching a cluster to a replica cluster.

A list of node labels values to extract and compare to evaluate if the pods reside in the same topology or not

This flag enables the constraints for sync replicas

When set to true, every replication slot that is on the primary is synchronized on each standby

List of regular expression patterns to match the names of replication slots to be excluded (by default empty)

Method to select synchronous replication standbys from the listed servers, accepting 'any' (quorum-based synchronous replication) or 'first' (priority-based synchronous replication) as values.

Specifies the number of synchronous standby servers that transactions must wait for responses from.

Specifies the maximum number of local cluster pods that can be automatically included in the synchronous_standby_names option in PostgreSQL.

A user-defined list of application names to be added to synchronous_standby_names before local cluster pods (the order is only useful for priority-based synchronous replication).

A user-defined list of application names to be added to synchronous_standby_names after local cluster pods (the order is only useful for priority-based synchronous replication).

If set to "required", data durability is strictly enforced. Write operations with synchronous commit settings (on, remote_write, or remote_apply) will block if there are insufficient healthy replicas, ensuring data persistence. If set to "preferred", data durability is maintained when healthy replicas are available, but the required number of instances will adjust dynamically if replicas become unavailable. This setting relaxes strict durability enforcement to allow for operational continuity. This setting is only applicable if both standbyNamesPre and standbyNamesPost are unset (empty).

The name of the tablespace

The storage configuration for the tablespace

Owner is the PostgreSQL user owning the tablespace

When set to true, the tablespace will be added as a temp_tablespaces entry in PostgreSQL, and will be available to automatically house temp database objects, or other temporary files. Please refer to PostgreSQL documentation for more information on the temp_tablespaces GUC.

Name is the name of the tablespace

Owner is the PostgreSQL user owning the tablespace

State is the latest reconciliation state

Error is the reconciliation error, if any

Instances contains the pod topology of the instances

NodesUsed represents the count of distinct nodes accommodating the instances. A value of '1' suggests that all instances are hosted on a single node, implying the absence of High Availability (HA). Ideally, this value should be the same as the number of instances in the Postgres HA cluster, implying shared nothing architecture on the compute side.

SuccessfullyExtracted indicates if the topology data was extract. It is useful to enact fallback behaviors in synchronous replica election in case of failures

Labels are key-value pairs that will be added to .metadata.labels snapshot resources.

Annotations key-value pairs that will be added to .metadata.annotations snapshot resources.

ClassName specifies the Snapshot Class to be used for PG_DATA PersistentVolumeClaim. It is the default class for the other types if no specific class is present

WalClassName specifies the Snapshot Class to be used for the PG_WAL PersistentVolumeClaim.

TablespaceClassName specifies the Snapshot Class to be used for the tablespaces. defaults to the PGDATA Snapshot Class, if set

SnapshotOwnerReference indicates the type of owner reference the snapshot should have

Whether the default type of backup with volume snapshots is online/hot (true, default) or offline/cold (false)

Configuration parameters to control the online/hot backup with volume snapshots