API Reference#

Package v1 contains API Schema definitions for the postgresql v1 API group

Resource Types#

Backup#

Backup is the Schema for the backups API

Field

Description

apiVersion [Required] <br>string

postgresql.cnpg.io/v1

kind [Required] <br>string

Backup

metadata ** Required]<br>[*meta/v1.ObjectMeta* **

No description provided.Refer to the Kubernetes API documentation for the fields of the metadata field.

spec ** archive_timeout **

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

status<br> archive_timeout

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

Cluster#

Cluster is the Schema for the PostgreSQL API

Field

Description

apiVersion [Required] <br>string

postgresql.cnpg.io/v1

kind [Required] <br>string

Cluster

metadata ** Required]<br>[*meta/v1.ObjectMeta* **

No description provided.Refer to the Kubernetes API documentation for the fields of the metadata field.

spec ** Required] **

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

status<br> *ClusterStatus*

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

Pooler#

Pooler is the Schema for the poolers API

Field

Description

apiVersion [Required] <br>string

postgresql.cnpg.io/v1

kind [Required] <br>string

Pooler

metadata ** Required]<br>[*meta/v1.ObjectMeta* **

No description provided.Refer to the Kubernetes API documentation for the fields of the metadata field.

spec ** Required] **

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

status<br> *PoolerStatus*

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

ScheduledBackup#

ScheduledBackup is the Schema for the scheduledbackups API

Field

Description

apiVersion [Required] <br>string

postgresql.cnpg.io/v1

kind [Required] <br>string

ScheduledBackup

metadata ** Required]<br>[*meta/v1.ObjectMeta* **

No description provided.Refer to the Kubernetes API documentation for the fields of the metadata field.

spec ** archive_timeout **

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

status<br> archive_timeout

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

AffinityConfiguration#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

AffinityConfiguration contains the info we need to create the affinity rules for Pods

Field

Description

enablePodAntiAffinity<br>*bool*

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

topologyKey<br>*string*

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

nodeSelector<br>*map[string]string*

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<br> *core/v1.NodeAffinity*

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

tolerations<br> *core/v1.Toleration*

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<br>*string*

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<br> *core/v1.PodAntiAffinity*

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<br> *core/v1.PodAffinity*

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

AzureCredentials#

Appears in:

  • BarmanCredentials {postgresql-cnpg-io-v1-BarmanCredentials}

AzureCredentials is the type for the credentials to be used to upload files to Azure Blob Storage. The connection string contains every needed information. If the connection string is not specified, we’ll need the storage account name and also one (and only one) of:

  • storageKey

  • storageSasToken

  • inheriting the credentials from the pod environment by setting inheritFromAzureAD to true

Field

Description

connectionString<br> *SecretKeySelector*

The connection string to be used

storageAccount<br> *SecretKeySelector*

The storage account where to upload data

storageKey<br> *SecretKeySelector*

The storage account key to be used in conjunction with the storage account name

storageSasToken<br> *SecretKeySelector*

A shared-access-signature to be used in conjunction with the storage account name

inheritFromAzureAD<br>*bool*

Use the Azure AD based authentication without providing explicitly the keys.

BackupConfiguration#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

BackupConfiguration defines how the backup of the cluster are taken. The supported backup methods are BarmanObjectStore and VolumeSnapshot. For details and examples refer to the Backup and Recovery section of the documentation

Field

Description

volumeSnapshot<br> *VolumeSnapshotConfiguration*

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

barmanObjectStore<br> *BarmanObjectStoreConfiguration*

The configuration for the barman-cloud tool suite

retentionPolicy<br>*string*

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.

target<br> archive_timeout

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.

BackupMethod {#postgresql-cnpg-io-v1-BackupMethod} (Alias of string )#

Appears in:

  • BackupSpec {postgresql-cnpg-io-v1-BackupSpec}

  • BackupStatus {postgresql-cnpg-io-v1-BackupStatus}

  • ScheduledBackupSpec {postgresql-cnpg-io-v1-ScheduledBackupSpec}

BackupMethod defines the way of executing the physical base backups of the selected PostgreSQL instance

BackupPhase {#postgresql-cnpg-io-v1-BackupPhase} (Alias of string )#

Appears in:

  • BackupStatus {postgresql-cnpg-io-v1-BackupStatus}

BackupPhase is the phase of the backup

BackupSnapshotElementStatus#

Appears in:

  • BackupSnapshotStatus {postgresql-cnpg-io-v1-BackupSnapshotStatus}

BackupSnapshotElementStatus is a volume snapshot that is part of a volume snapshot method backup

Field

Description

name [Required] <br>*string*

Name is the snapshot resource name

type [Required] <br>*string*

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

BackupSnapshotStatus#

Appears in:

  • BackupStatus {postgresql-cnpg-io-v1-BackupStatus}

BackupSnapshotStatus the fields exclusive to the volumeSnapshot method backup

Field

Description

elements<br> archive_timeout

The elements list, populated with the gathered volume snapshots

BackupSource#

Appears in:

  • BootstrapRecovery {postgresql-cnpg-io-v1-BootstrapRecovery}

BackupSource contains the backup we need to restore from, plus some information that could be needed to correctly restore it.

Field

Description

LocalObjectReference<br> *LocalObjectReference*

(Members of LocalObjectReference are embedded into this type.) No description provided.

endpointCA<br> *SecretKeySelector*

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.

BackupSpec#

Appears in:

BackupSpec defines the desired state of Backup

Field

Description

cluster ** Required] **

The cluster to backup

target<br> archive_timeout

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.

method<br> archive_timeout

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

BackupStatus#

Appears in:

BackupStatus defines the observed state of Backup

Field

Description

BarmanCredentials<br> *BarmanCredentials*

<p>(Members of BarmanCredentials are embedded into this type.) </p><p>The potential credentials for each cloud provider</p>

endpointCA<br> *SecretKeySelector*

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.

endpointURL<br>*string*

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

destinationPath<br>*string*

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.

serverName<br>*string*

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

encryption<br>*string*

Encryption method required to S3 API

backupId<br>*string*

The ID of the Barman backup

backupName<br>*string*

The Name of the Barman backup

phase<br> archive_timeout

The last backup status

startedAt<br> *meta/v1.Time*

When the backup was started

stoppedAt<br> *meta/v1.Time*

When the backup was terminated

beginWal<br>*string*

The starting WAL

endWal<br>*string*

The ending WAL

beginLSN<br>*string*

The starting xlog

endLSN<br>*string*

The ending xlog

error<br>*string*

The detected error

commandOutput<br>*string*

Unused. Retained for compatibility with old versions.

commandError<br>*string*

The backup command output in case of error

instanceID<br> *InstanceID*

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

snapshotBackupStatus<br> archive_timeout

Status of the volumeSnapshot backup

method<br> archive_timeout

The backup method being used

BackupTarget {#postgresql-cnpg-io-v1-BackupTarget} (Alias of string )#

Appears in:

  • BackupConfiguration {postgresql-cnpg-io-v1-BackupConfiguration}

  • BackupSpec {postgresql-cnpg-io-v1-BackupSpec}

  • ScheduledBackupSpec {postgresql-cnpg-io-v1-ScheduledBackupSpec}

BackupTarget describes the preferred targets for a backup

BarmanCredentials#

Appears in:

  • BackupStatus {postgresql-cnpg-io-v1-BackupStatus}

  • BarmanObjectStoreConfiguration {postgresql-cnpg-io-v1-BarmanObjectStoreConfiguration}

BarmanCredentials an object containing the potential credentials for each cloud provider

Field

Description

googleCredentials<br> *GoogleCredentials*

The credentials to use to upload data to Google Cloud Storage

s3Credentials<br> *S3Credentials*

The credentials to use to upload data to S3

azureCredentials<br> *AzureCredentials*

The credentials to use to upload data to Azure Blob Storage

BarmanObjectStoreConfiguration#

Appears in:

  • BackupConfiguration {postgresql-cnpg-io-v1-BackupConfiguration}

  • The `externalClusters section <The externalClusters section>`

BarmanObjectStoreConfiguration contains the backup configuration using Barman against an S3-compatible object storage

Field

Description

BarmanCredentials<br> *BarmanCredentials*

<p>(Members of BarmanCredentials are embedded into this type.) </p><p>The potential credentials for each cloud provider</p>

endpointURL<br>*string*

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

endpointCA<br> *SecretKeySelector*

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

destinationPath [Required] <br>*string*

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

serverName<br>*string*

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

wal<br> archive_timeout

The configuration for the backup of the WAL stream. When not defined, WAL files will be stored uncompressed and may be unencrypted in the object store, according to the bucket default policy.

data<br> archive_timeout

The configuration to be used to backup the data files When not defined, base backups files will be stored uncompressed and may be unencrypted in the object store, according to the bucket default policy.

tags<br>*map[string]string*

Tags is a list of key value pairs that will be passed to the Barman –tags option.

historyTags<br>*map[string]string*

HistoryTags is a list of key value pairs that will be passed to the Barman –history-tags option.

BootstrapConfiguration#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

BootstrapConfiguration contains information about how to create the PostgreSQL cluster. Only a single bootstrap method can be defined among the supported ones. initdb will be used as the bootstrap method if left unspecified. Refer to the Bootstrap page of the documentation for more information.

Field

Description

initdb<br> archive_timeout

Bootstrap the cluster via initdb

recovery<br> archive_timeout

Bootstrap the cluster from a backup

pg_basebackup<br> archive_timeout

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

BootstrapInitDB#

Appears in:

  • BootstrapConfiguration {postgresql-cnpg-io-v1-BootstrapConfiguration}

BootstrapInitDB is the configuration of the bootstrap process when initdb is used Refer to the Bootstrap page of the documentation for more information.

Field

Description

database<br>*string*

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

owner<br>*string*

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

secret<br> *LocalObjectReference*

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

options<br>*[]string*

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.

dataChecksums<br>*bool*

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

encoding<br>*string*

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

localeCollate<br>*string*

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

localeCType<br>*string*

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

walSegmentSize<br>*int*

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

postInitSQL<br>*[]string*

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

postInitApplicationSQL<br>*[]string*

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

postInitTemplateSQL<br>*[]string*

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

import<br> *Import*

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

postInitApplicationSQLRefs<br> archive_timeout

PostInitApplicationSQLRefs points references to ConfigMaps or Secrets which contain SQL files, the general implementation order to these references is from all Secrets to all ConfigMaps, and inside Secrets or ConfigMaps, the implementation order is same as the order of each array (by default empty)

BootstrapPgBaseBackup#

Appears in:

  • BootstrapConfiguration {postgresql-cnpg-io-v1-BootstrapConfiguration}

BootstrapPgBaseBackup contains the configuration required to take a physical backup of an existing PostgreSQL cluster

Field

Description

source [Required] <br>*string*

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

database<br>*string*

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

owner<br>*string*

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

secret<br> *LocalObjectReference*

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

BootstrapRecovery#

Appears in:

  • BootstrapConfiguration {postgresql-cnpg-io-v1-BootstrapConfiguration}

BootstrapRecovery contains the configuration required to restore from an existing cluster using 3 methodologies: external cluster, volume snapshots or backup objects. Full recovery and Point-In-Time Recovery are supported. The method can be also be used to create clusters in continuous recovery (replica clusters), also supporting cascading replication when instances >

  1. Once the cluster exits recovery, the password for the superuser will be changed through the provided secret. Refer to the Bootstrap page of the documentation for more information.

Field

Description

backup<br> archive_timeout

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

source<br>*string*

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.

volumeSnapshots<br> *DataSource*

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.

recoveryTarget<br> archive_timeout

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

database<br>*string*

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

owner<br>*string*

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

secret<br> *LocalObjectReference*

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

CertificatesConfiguration#

Appears in:

  • CertificatesStatus {postgresql-cnpg-io-v1-CertificatesStatus}

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

CertificatesConfiguration contains the needed configurations to handle server certificates.

Field

Description

serverCASecret<br>*string*

<p>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: </p><p>- ca.crt: CA that should be used to validate the server certificate, used as sslrootcert in client connection strings.</p><p>- ca.key: key used to generate Server SSL certs, if ServerTLSSecret is provided, this can be omitted.</p>

serverTLSSecret<br>*string*

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.

replicationTLSSecret<br>*string*

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.

clientCASecret<br>*string*

<p>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: </p><p>- ca.crt: CA that should be used to validate the client certificates, used as ssl_ca_file of all the instances.</p><p>- ca.key: key used to generate client certificates, if ReplicationTLSSecret is provided, this can be omitted.</p>

serverAltDNSNames<br>*[]string*

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

CertificatesStatus#

Appears in:

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

CertificatesStatus contains configuration certificates and related expiration dates.

Field

Description

CertificatesConfiguration<br> archive_timeout

<p>(Members of CertificatesConfiguration are embedded into this type.) </p><p>Needed configurations to handle server certificates, initialized with default values, if needed.</p>

expirations<br>*map[string]string*

Expiration dates for all certificates.

ClusterSpec#

Appears in:

ClusterSpec defines the desired state of Cluster

Field

Description

description<br>*string*

Description of this PostgreSQL cluster

inheritedMetadata<br> *EmbeddedObjectMetadata*

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

imageName<br>*string*

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

imagePullPolicy<br> *core/v1.PullPolicy*

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

schedulerName<br>*string*

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/

postgresUID<br>*int64*

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

postgresGID<br>*int64*

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

instances [Required] <br>*int*

Number of instances required in the cluster

minSyncReplicas<br>*int*

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

maxSyncReplicas<br>*int*

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.

postgresql<br> *PostgresConfiguration*

Configuration of the PostgreSQL server

replicationSlots<br> archive_timeout

Replication slots management configuration

bootstrap<br> archive_timeout

Instructions to bootstrap this cluster

replica<br> *ReplicaClusterConfiguration*

Replica cluster configuration

superuserSecret<br> *LocalObjectReference*

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

enableSuperuserAccess<br>*bool*

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.

certificates<br> archive_timeout

The configuration for the CA and related certificates

imagePullSecrets<br> *LocalObjectReference*

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

storage<br> archive_timeout

Configuration of the storage of the instances

serviceAccountTemplate<br> *ServiceAccountTemplate*

Configure the generation of the service account

walStorage<br> archive_timeout

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

startDelay<br>*int32*

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).

stopDelay<br>*int32*

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

smartShutdownTimeout<br>*int32*

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).

switchoverDelay<br>*int32*

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).

failoverDelay<br>*int32*

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

affinity<br> *AffinityConfiguration*

Affinity/Anti-affinity rules for Pods

topologySpreadConstraints<br> *core/v1.TopologySpreadConstraint*

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

resources<br> *core/v1.ResourceRequirements*

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

ephemeralVolumesSizeLimit ** Required] **

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

priorityClassName<br>*string*

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

primaryUpdateStrategy<br> *PrimaryUpdateStrategy*

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)

primaryUpdateMethod<br> *PrimaryUpdateMethod*

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)

backup<br> archive_timeout

The configuration to be used for backups

nodeMaintenanceWindow<br> *NodeMaintenanceWindow*

Define a maintenance window for the Kubernetes nodes

monitoring<br> archive_timeout

The configuration of the monitoring infrastructure of this cluster

externalClusters<br> *ExternalCluster*

The list of external clusters which are used in the configuration

logLevel<br>*string*

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

projectedVolumeTemplate<br> *core/v1.ProjectedVolumeSource*

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

env<br> *core/v1.EnvVar*

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

envFrom<br> *core/v1.EnvFromSource*

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

managed<br> *ManagedConfiguration*

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

seccompProfile<br> *core/v1.SeccompProfile*

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

ClusterStatus#

Appears in:

ClusterStatus defines the observed state of Cluster

Field

Description

instances<br>*int*

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

readyInstances<br>*int*

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

instancesStatus<br>*map[github.com/cloudnative-pg/cloudnative-pg/pkg/utils.PodStatus][]string*

InstancesStatus indicates in which status the instances are

instancesReportedState<br> *map[github.com/cloudnative-pg/cloudnative-pg/api/v1.PodName]github.com/cloudnative-pg/cloudnative-pg/api/v1.InstanceReportedState*

The reported state of the instances during the last reconciliation loop

managedRolesStatus<br> *ManagedRoles*

ManagedRolesStatus reports the state of the managed roles in the cluster

timelineID<br>*int*

The timeline of the Postgres cluster

topology<br> *Topology*

Instances topology.

latestGeneratedNode<br>*int*

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

currentPrimary<br>*string*

Current primary instance

targetPrimary<br>*string*

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

pvcCount<br>*int32*

How many PVCs have been created by this cluster

jobCount<br>*int32*

How many Jobs have been created by this cluster

danglingPVC<br>*[]string*

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

resizingPVC<br>*[]string*

List of all the PVCs that have ResizingPVC condition.

initializingPVC<br>*[]string*

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

healthyPVC<br>*[]string*

List of all the PVCs not dangling nor initializing

unusablePVC<br>*[]string*

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

writeService<br>*string*

Current write pod

readService<br>*string*

Current list of read pods

phase<br>*string*

Current phase of the cluster

phaseReason<br>*string*

Reason for the current phase

secretsResourceVersion<br> *SecretsResourceVersion*

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

configMapResourceVersion<br> *ConfigMapResourceVersion*

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

certificates<br> archive_timeout

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

firstRecoverabilityPoint<br>*string*

The first recoverability point, stored as a date in RFC3339 format

lastSuccessfulBackup<br>*string*

Stored as a date in RFC3339 format

lastFailedBackup<br>*string*

Stored as a date in RFC3339 format

cloudNativePGCommitHash<br>*string*

The commit hash number of which this operator running

currentPrimaryTimestamp<br>*string*

The timestamp when the last actual promotion to primary has occurred

currentPrimaryFailingSinceTimestamp<br>*string*

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

targetPrimaryTimestamp<br>*string*

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

poolerIntegrations<br> *PoolerIntegrations*

The integration needed by poolers referencing the cluster

cloudNativePGOperatorHash<br>*string*

The hash of the binary of the operator

conditions<br> *meta/v1.Condition*

Conditions for cluster object

instanceNames<br>*[]string*

List of instance names in the cluster

onlineUpdateEnabled<br>*bool*

OnlineUpdateEnabled shows if the online upgrade is enabled inside the cluster

azurePVCUpdateEnabled<br>*bool*

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

CompressionType {#postgresql-cnpg-io-v1-CompressionType} (Alias of string )#

Appears in:

  • DataBackupConfiguration {postgresql-cnpg-io-v1-DataBackupConfiguration}

  • WalBackupConfiguration {postgresql-cnpg-io-v1-WalBackupConfiguration}

CompressionType encapsulates the available types of compression

ConfigMapKeySelector#

Appears in:

  • MonitoringConfiguration {postgresql-cnpg-io-v1-MonitoringConfiguration}

  • PostInitApplicationSQLRefs {postgresql-cnpg-io-v1-PostInitApplicationSQLRefs}

ConfigMapKeySelector contains enough information to let you locate the key of a ConfigMap

Field

Description

LocalObjectReference<br> *LocalObjectReference*

<p>(Members of LocalObjectReference are embedded into this type.) </p><p>The name of the secret in the pod’s namespace to select from.</p>

key [Required] <br>*string*

The key to select

ConfigMapResourceVersion#

Appears in:

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

ConfigMapResourceVersion is the resource versions of the secrets managed by the operator

Field

Description

metrics<br>*map[string]string*

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

DataBackupConfiguration#

Appears in:

  • BarmanObjectStoreConfiguration {postgresql-cnpg-io-v1-BarmanObjectStoreConfiguration}

DataBackupConfiguration is the configuration of the backup of the data directory

Field

Description

compression<br> *CompressionType*

Compress a backup file (a tar file per tablespace) while streaming it to the object store. Available options are empty string (no compression, default), gzip, bzip2 or snappy.

encryption<br> *EncryptionType*

Whenever to force the encryption of files (if the bucket is not already configured for that). Allowed options are empty string (use the bucket policy, default), AES256 and aws:kms

jobs<br>*int32*

The number of parallel jobs to be used to upload the backup, defaults to 2

immediateCheckpoint<br>*bool*

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.

DataSource#

Appears in:

  • BootstrapRecovery {postgresql-cnpg-io-v1-BootstrapRecovery}

DataSource contains the configuration required to bootstrap a PostgreSQL cluster from an existing storage

Field

Description

storage ** Required]<br>[*core/v1.TypedLocalObjectReference* **

Configuration of the storage of the instances

walStorage<br> *core/v1.TypedLocalObjectReference*

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

EmbeddedObjectMetadata#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

EmbeddedObjectMetadata contains metadata to be inherited by all resources related to a Cluster

Field

Description

labels<br>*map[string]string*

No description provided.

annotations<br>*map[string]string*

No description provided.

EncryptionType {#postgresql-cnpg-io-v1-EncryptionType} (Alias of string )#

Appears in:

  • DataBackupConfiguration {postgresql-cnpg-io-v1-DataBackupConfiguration}

  • WalBackupConfiguration {postgresql-cnpg-io-v1-WalBackupConfiguration}

EncryptionType encapsulated the available types of encryption

EnsureOption {#postgresql-cnpg-io-v1-EnsureOption} (Alias of string )#

Appears in:

  • RoleConfiguration {postgresql-cnpg-io-v1-RoleConfiguration}

EnsureOption represents whether we should enforce the presence or absence of a Role in a PostgreSQL instance

EphemeralVolumesSizeLimitConfiguration#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

EphemeralVolumesSizeLimitConfiguration contains the configuration of the ephemeral storage

Field

Description

shm [Required] <br>*k8s.io/apimachinery/pkg/api/resource.Quantity*

Shm is the size limit of the shared memory volume

temporaryData [Required] <br>*k8s.io/apimachinery/pkg/api/resource.Quantity*

TemporaryData is the size limit of the temporary data volume

ExternalCluster#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

ExternalCluster represents the connection parameters to an external cluster which is used in the other sections of the configuration

Field

Description

name [Required] <br>*string*

The server name, required

connectionParameters<br>*map[string]string*

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

sslCert<br> *core/v1.SecretKeySelector*

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

sslKey<br> *core/v1.SecretKeySelector*

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

sslRootCert<br> *core/v1.SecretKeySelector*

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

password<br> *core/v1.SecretKeySelector*

The reference to the password to be used to connect to the server

barmanObjectStore<br> *BarmanObjectStoreConfiguration*

The configuration for the barman-cloud tool suite

GoogleCredentials#

Appears in:

  • BarmanCredentials {postgresql-cnpg-io-v1-BarmanCredentials}

GoogleCredentials is the type for the Google Cloud Storage credentials. This needs to be specified even if we run inside a GKE environment.

Field

Description

applicationCredentials<br> *SecretKeySelector*

The secret containing the Google Cloud Storage JSON file with the credentials

gkeEnvironment<br>*bool*

If set to true, will presume that it’s running inside a GKE environment, default to false.

Import#

Appears in:

  • BootstrapInitDB {postgresql-cnpg-io-v1-BootstrapInitDB}

Import contains the configuration to init a database from a logic snapshot of an externalCluster

Field

Description

source ** Required] **

The source of the import

type ** Required] **

The import type. Can be microservice or monolith.

databases [Required] <br>*[]string*

The databases to import

roles<br>*[]string*

The roles to import

postImportApplicationSQL<br>*[]string*

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.

schemaOnly<br>*bool*

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

ImportSource#

Appears in:

  • Import {postgresql-cnpg-io-v1-Import}

ImportSource describes the source for the logical snapshot

Field

Description

externalCluster [Required] <br>*string*

The name of the externalCluster used for import

InstanceID#

Appears in:

  • BackupStatus {postgresql-cnpg-io-v1-BackupStatus}

InstanceID contains the information to identify an instance

Field

Description

podName<br>*string*

The pod name

ContainerID<br>*string*

The container ID

InstanceReportedState#

Appears in:

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

InstanceReportedState describes the last reported state of an instance during a reconciliation loop

Field

Description

isPrimary [Required] <br>*bool*

indicates if an instance is the primary one

timeLineID<br>*int*

indicates on which TimelineId the instance is

LDAPBindAsAuth#

Appears in:

  • LDAPConfig {postgresql-cnpg-io-v1-LDAPConfig}

LDAPBindAsAuth provides the required fields to use the bind authentication for LDAP

Field

Description

prefix<br>*string*

Prefix for the bind authentication option

suffix<br>*string*

Suffix for the bind authentication option

LDAPBindSearchAuth#

Appears in:

  • LDAPConfig {postgresql-cnpg-io-v1-LDAPConfig}

LDAPBindSearchAuth provides the required fields to use the bind+search LDAP authentication process

Field

Description

baseDN<br>*string*

Root DN to begin the user search

bindDN<br>*string*

DN of the user to bind to the directory

bindPassword<br> *core/v1.SecretKeySelector*

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

searchAttribute<br>*string*

Attribute to match against the username

searchFilter<br>*string*

Search filter to use when doing the search+bind authentication

LDAPConfig#

Appears in:

  • PostgresConfiguration {postgresql-cnpg-io-v1-PostgresConfiguration}

LDAPConfig contains the parameters needed for LDAP authentication

Field

Description

server<br>*string*

LDAP hostname or IP address

port<br>*int*

LDAP server port

scheme<br> *LDAPScheme*

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

bindAsAuth<br> *LDAPBindAsAuth*

Bind as authentication configuration

bindSearchAuth<br> *LDAPBindSearchAuth*

Bind+Search authentication configuration

tls<br>*bool*

Set to ‘true’ to enable LDAP over TLS. ‘false’ is default

LDAPScheme {#postgresql-cnpg-io-v1-LDAPScheme} (Alias of string )#

Appears in:

  • LDAPConfig {postgresql-cnpg-io-v1-LDAPConfig}

LDAPScheme defines the possible schemes for LDAP

LocalObjectReference#

Appears in:

  • BackupSource {postgresql-cnpg-io-v1-BackupSource}

  • BackupSpec {postgresql-cnpg-io-v1-BackupSpec}

  • BootstrapInitDB {postgresql-cnpg-io-v1-BootstrapInitDB}

  • BootstrapPgBaseBackup {postgresql-cnpg-io-v1-BootstrapPgBaseBackup}

  • BootstrapRecovery {postgresql-cnpg-io-v1-BootstrapRecovery}

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

  • ConfigMapKeySelector {postgresql-cnpg-io-v1-ConfigMapKeySelector}

  • PgBouncerSpec {postgresql-cnpg-io-v1-PgBouncerSpec}

  • PoolerSpec {postgresql-cnpg-io-v1-PoolerSpec}

  • RoleConfiguration {postgresql-cnpg-io-v1-RoleConfiguration}

  • ScheduledBackupSpec {postgresql-cnpg-io-v1-ScheduledBackupSpec}

  • SecretKeySelector {postgresql-cnpg-io-v1-SecretKeySelector}

LocalObjectReference contains enough information to let you locate a local object with a known type inside the same namespace

Field

Description

name [Required] <br>*string*

Name of the referent.

ManagedConfiguration#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

ManagedConfiguration represents the portions of PostgreSQL that are managed by the instance manager

Field

Description

roles<br> *RoleConfiguration*

Database roles managed by the Cluster

ManagedRoles#

Appears in:

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

ManagedRoles tracks the status of a cluster’s managed roles

Field

Description

byStatus<br>*map[github.com/cloudnative-pg/cloudnative-pg/api/v1.RoleStatus][]string*

ByStatus gives the list of roles in each state

cannotReconcile<br>*map[string][]string*

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

passwordStatus<br> *map[string]github.com/cloudnative-pg/cloudnative-pg/api/v1.PasswordState*

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

Metadata#

Appears in:

  • PodTemplateSpec {postgresql-cnpg-io-v1-PodTemplateSpec}

  • ServiceAccountTemplate {postgresql-cnpg-io-v1-ServiceAccountTemplate}

Metadata is a structure similar to the metav1.ObjectMeta, but still parseable by controller-gen to create a suitable CRD for the user. The comment of PodTemplateSpec has an explanation of why we are not using the core data types.

Field

Description

labels<br>*map[string]string*

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<br>*map[string]string*

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

MonitoringConfiguration#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

MonitoringConfiguration is the type containing all the monitoring configuration for a certain cluster

Field

Description

disableDefaultQueries<br>*bool*

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.

customQueriesConfigMap<br> *ConfigMapKeySelector*

The list of config maps containing the custom queries

customQueriesSecret<br> *SecretKeySelector*

The list of secrets containing the custom queries

enablePodMonitor<br>*bool*

Enable or disable the PodMonitor

NodeMaintenanceWindow#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

NodeMaintenanceWindow contains information that the operator will use while upgrading the underlying node.

This option is only useful when the chosen storage prevents the Pods from being freely moved across nodes.

Field

Description

reusePVC<br>*bool*

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

inProgress<br>*bool*

Is there a node maintenance activity in progress?

PasswordState#

Appears in:

  • ManagedRoles {postgresql-cnpg-io-v1-ManagedRoles}

PasswordState represents the state of the password of a managed RoleConfiguration

Field

Description

transactionID<br>*int64*

the last transaction ID to affect the role definition in PostgreSQL

resourceVersion<br>*string*

the resource version of the password secret

PgBouncerIntegrationStatus#

Appears in:

  • PoolerIntegrations {postgresql-cnpg-io-v1-PoolerIntegrations}

PgBouncerIntegrationStatus encapsulates the needed integration for the pgbouncer poolers referencing the cluster

Field

Description

secrets<br>*[]string*

No description provided.

PgBouncerPoolMode {#postgresql-cnpg-io-v1-PgBouncerPoolMode} (Alias of string )#

Appears in:

  • PgBouncerSpec {postgresql-cnpg-io-v1-PgBouncerSpec}

PgBouncerPoolMode is the mode of PgBouncer

PgBouncerSecrets#

Appears in:

  • PoolerSecrets {postgresql-cnpg-io-v1-PoolerSecrets}

PgBouncerSecrets contains the versions of the secrets used by pgbouncer

Field

Description

authQuery<br> *SecretVersion*

The auth query secret version

PgBouncerSpec#

Appears in:

  • PoolerSpec {postgresql-cnpg-io-v1-PoolerSpec}

PgBouncerSpec defines how to configure PgBouncer

Field

Description

poolMode<br> *PgBouncerPoolMode*

The pool mode. Default: session.

authQuerySecret<br> *LocalObjectReference*

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_shadow WHERE usename=$1”) has to be specified and no automatic CNPG Cluster integration will be triggered.

authQuery<br>*string*

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

parameters<br>*map[string]string*

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

pg_hba<br>*[]string*

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

paused<br>*bool*

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.

PodTemplateSpec#

Appears in:

  • PoolerSpec {postgresql-cnpg-io-v1-PoolerSpec}

PodTemplateSpec is a structure allowing the user to set a template for Pod generation.

Unfortunately we can’t use the corev1.PodTemplateSpec type because the generated CRD won’t have the field for the metadata section.

References: kubernetes-sigs/controller-tools#385 kubernetes-sigs/controller-tools#448 prometheus-operator/prometheus-operator#3041

Field

Description

metadata<br> *Metadata*

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

spec<br> *core/v1.PodSpec*

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

PodTopologyLabels {#postgresql-cnpg-io-v1-PodTopologyLabels} (Alias of map[string]string )#

Appears in:

  • PodTopologyLabels {postgresql-cnpg-io-v1-PodTopologyLabels} (Alias of `map[string]string ) <PodTopologyLabels {postgresql-cnpg-io-v1-PodTopologyLabels} (Alias of map[string]string )>`

PodTopologyLabels represent the topology of a Pod. map[labelName]labelValue

PoolerIntegrations#

Appears in:

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

PoolerIntegrations encapsulates the needed integration for the poolers referencing the cluster

Field

Description

pgBouncerIntegration<br> *PgBouncerIntegrationStatus*

No description provided.

PoolerMonitoringConfiguration#

Appears in:

  • PoolerSpec {postgresql-cnpg-io-v1-PoolerSpec}

PoolerMonitoringConfiguration is the type containing all the monitoring configuration for a certain Pooler.

Mirrors the Cluster’s MonitoringConfiguration but without the custom queries part for now.

Field

Description

enablePodMonitor<br>*bool*

Enable or disable the PodMonitor

PoolerSecrets#

Appears in:

  • PoolerStatus {postgresql-cnpg-io-v1-PoolerStatus}

PoolerSecrets contains the versions of all the secrets used

Field

Description

serverTLS<br> *SecretVersion*

The server TLS secret version

serverCA<br> *SecretVersion*

The server CA secret version

clientCA<br> *SecretVersion*

The client CA secret version

pgBouncerSecrets<br> *PgBouncerSecrets*

The version of the secrets used by PgBouncer

PoolerSpec#

Appears in:

  • Pooler {postgresql-cnpg-io-v1-Pooler}

PoolerSpec defines the desired state of Pooler

Field

Description

cluster ** Required] **

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<br> *PoolerType*

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

instances<br>*int32*

The number of replicas we want. Default: 1.

template<br> *PodTemplateSpec*

The template of the Pod to be created

pgbouncer ** Required] **

The PgBouncer configuration

deploymentStrategy<br> *apps/v1.DeploymentStrategy*

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

monitoring<br> archive_timeout

The configuration of the monitoring infrastructure of this pooler.

PoolerStatus#

Appears in:

  • Pooler {postgresql-cnpg-io-v1-Pooler}

PoolerStatus defines the observed state of Pooler

Field

Description

secrets<br> *PoolerSecrets*

The resource version of the config object

instances<br>*int32*

The number of pods trying to be scheduled

PoolerType {#postgresql-cnpg-io-v1-PoolerType} (Alias of string )#

Appears in:

  • PoolerSpec {postgresql-cnpg-io-v1-PoolerSpec}

PoolerType is the type of the connection pool, meaning the service we are targeting. Allowed values are rw and ro.

PostInitApplicationSQLRefs#

Appears in:

  • BootstrapInitDB {postgresql-cnpg-io-v1-BootstrapInitDB}

PostInitApplicationSQLRefs points references to ConfigMaps or Secrets which contain SQL files, the general implementation order to these references is from all Secrets to all ConfigMaps, and inside Secrets or ConfigMaps, the implementation order is same as the order of each array

Field

Description

secretRefs<br> *SecretKeySelector*

SecretRefs holds a list of references to Secrets

configMapRefs<br> *ConfigMapKeySelector*

ConfigMapRefs holds a list of references to ConfigMaps

PostgresConfiguration#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

PostgresConfiguration defines the PostgreSQL configuration

Field

Description

parameters<br>*map[string]string*

PostgreSQL configuration options (postgresql.conf)

pg_hba<br>*[]string*

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

syncReplicaElectionConstraint<br> *SyncReplicaElectionConstraints*

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

shared_preload_libraries<br>*[]string*

Lists of shared preload libraries to add to the default ones

ldap<br> *LDAPConfig*

Options to specify LDAP configuration

promotionTimeout<br>*int32*

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

PrimaryUpdateMethod {#postgresql-cnpg-io-v1-PrimaryUpdateMethod} (Alias of string )#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

PrimaryUpdateMethod contains the method to use when upgrading the primary server of the cluster as part of rolling updates

PrimaryUpdateStrategy {#postgresql-cnpg-io-v1-PrimaryUpdateStrategy} (Alias of string )#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

PrimaryUpdateStrategy contains the strategy to follow when upgrading the primary server of the cluster as part of rolling updates

RecoveryTarget#

Appears in:

  • BootstrapRecovery {postgresql-cnpg-io-v1-BootstrapRecovery}

RecoveryTarget allows to configure the moment where the recovery process will stop. All the target options except TargetTLI are mutually exclusive.

Field

Description

backupID<br>*string*

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.

targetTLI<br>*string*

The target timeline (“latest” or a positive integer)

targetXID<br>*string*

The target transaction ID

targetName<br>*string*

The target name (to be previously created with pg_create_restore_point)

targetLSN<br>*string*

The target LSN (Log Sequence Number)

targetTime<br>*string*

The target time as a timestamp in the RFC3339 standard

targetImmediate<br>*bool*

End recovery as soon as a consistent state is reached

exclusive<br>*bool*

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

ReplicaClusterConfiguration#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

ReplicaClusterConfiguration encapsulates the configuration of a replica cluster

Field

Description

source [Required] <br>*string*

The name of the external cluster which is the replication origin

enabled [Required] <br>*bool*

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.

ReplicationSlotsConfiguration#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

ReplicationSlotsConfiguration encapsulates the configuration of replication slots

Field

Description

highAvailability<br> archive_timeout

Replication slots for high availability configuration

updateInterval<br>*int*

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

ReplicationSlotsHAConfiguration#

Appears in:

  • ReplicationSlotsConfiguration {postgresql-cnpg-io-v1-ReplicationSlotsConfiguration}

ReplicationSlotsHAConfiguration encapsulates the configuration of the replication slots that are automatically managed by the operator to control the streaming replication connections with the standby instances for high availability (HA) purposes. Replication slots are a PostgreSQL feature that makes sure that PostgreSQL automatically keeps WAL files in the primary when a streaming client (in this specific case a replica that is part of the HA cluster) gets disconnected.

Field

Description

enabled<br>*bool*

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.

slotPrefix<br>*string*

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_.

RoleConfiguration#

**.*:raw-latex:`\s`- ManagedConfiguration {postgresql-cnpg-io-v1-ManagedConfiguration}

RoleConfiguration is the representation, in Kubernetes, of a PostgreSQL role with the additional field Ensure specifying whether to ensure the presence or absence of the role in the database

The defaults of the CREATE ROLE command are applied Reference: https://www.postgresql.org/docs/current/sql-createrole.html

Field

Description

name [Required] <br>*string*

Name of the role

comment<br>*string*

Description of the role

ensure<br> *EnsureOption*

Ensure the role is present or absent - defaults to “present”

passwordSecret<br> *LocalObjectReference*

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

connectionLimit<br>*int64*

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

validUntil<br> *meta/v1.Time*

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

inRoles<br>*[]string*

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

inherit<br>*bool*

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

disablePassword<br>*bool*

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

superuser<br>*bool*

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.

createdb<br>*bool*

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.

createrole<br>*bool*

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.

login<br>*bool*

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.

replication<br>*bool*

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.

bypassrls<br>*bool*

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

S3Credentials#

Appears in:

  • BarmanCredentials {postgresql-cnpg-io-v1-BarmanCredentials}

S3Credentials is the type for the credentials to be used to upload files to S3. It can be provided in two alternative ways:

  • explicitly passing accessKeyId and secretAccessKey

  • inheriting the role from the pod environment by setting inheritFromIAMRole to true

Field

Description

accessKeyId<br> *SecretKeySelector*

The reference to the access key id

secretAccessKey<br> *SecretKeySelector*

The reference to the secret access key

region<br> *SecretKeySelector*

The reference to the secret containing the region name

sessionToken<br> *SecretKeySelector*

The references to the session key

inheritFromIAMRole<br>*bool*

Use the role based authentication without providing explicitly the keys.

ScheduledBackupSpec#

Appears in:

  • ScheduledBackup {postgresql-cnpg-io-v1-ScheduledBackup}

ScheduledBackupSpec defines the desired state of ScheduledBackup

Field

Description

suspend<br>*bool*

If this backup is suspended or not

immediate<br>*bool*

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

schedule [Required] <br>*string*

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

cluster ** Required] **

The cluster to backup

backupOwnerReference<br>*string*

<p>Indicates which ownerReference should be put inside the created backup resources.</p><p>- none: no owner reference for created backup objects (same behavior as before the field was introduced)</p><p>- self: sets the Scheduled backup object as owner of the backup</p><p>- cluster: set the cluster as owner of the backup</p>

target<br> archive_timeout

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.

method<br> archive_timeout

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

ScheduledBackupStatus#

Appears in:

  • ScheduledBackup {postgresql-cnpg-io-v1-ScheduledBackup}

ScheduledBackupStatus defines the observed state of ScheduledBackup

Field

Description

lastCheckTime<br> *meta/v1.Time*

The latest time the schedule

lastScheduleTime<br> *meta/v1.Time*

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

nextScheduleTime<br> *meta/v1.Time*

Next time we will run a backup

SecretKeySelector#

Appears in:

  • AzureCredentials {postgresql-cnpg-io-v1-AzureCredentials}

  • BackupSource {postgresql-cnpg-io-v1-BackupSource}

  • BackupStatus {postgresql-cnpg-io-v1-BackupStatus}

  • BarmanObjectStoreConfiguration {postgresql-cnpg-io-v1-BarmanObjectStoreConfiguration}

  • GoogleCredentials {postgresql-cnpg-io-v1-GoogleCredentials}

  • MonitoringConfiguration {postgresql-cnpg-io-v1-MonitoringConfiguration}

  • PostInitApplicationSQLRefs {postgresql-cnpg-io-v1-PostInitApplicationSQLRefs}

  • S3Credentials {postgresql-cnpg-io-v1-S3Credentials}

SecretKeySelector contains enough information to let you locate the key of a Secret

Field

Description

LocalObjectReference<br> *LocalObjectReference*

<p>(Members of LocalObjectReference are embedded into this type.) </p><p>The name of the secret in the pod’s namespace to select from.</p>

key [Required] <br>*string*

The key to select

SecretVersion#

Appears in:

  • PgBouncerSecrets {postgresql-cnpg-io-v1-PgBouncerSecrets}

  • PoolerSecrets {postgresql-cnpg-io-v1-PoolerSecrets}

SecretVersion contains a secret name and its ResourceVersion

Field

Description

name<br>*string*

The name of the secret

version<br>*string*

The ResourceVersion of the secret

SecretsResourceVersion#

Appears in:

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

SecretsResourceVersion is the resource versions of the secrets managed by the operator

Field

Description

superuserSecretVersion<br>*string*

The resource version of the “postgres” user secret

replicationSecretVersion<br>*string*

The resource version of the “streaming_replica” user secret

applicationSecretVersion<br>*string*

The resource version of the “app” user secret

managedRoleSecretVersion<br>*map[string]string*

The resource versions of the managed roles secrets

caSecretVersion<br>*string*

Unused. Retained for compatibility with old versions.

clientCaSecretVersion<br>*string*

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

serverCaSecretVersion<br>*string*

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

serverSecretVersion<br>*string*

The resource version of the PostgreSQL server-side secret version

barmanEndpointCA<br>*string*

The resource version of the Barman Endpoint CA if provided

metrics<br>*map[string]string*

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

ServiceAccountTemplate#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

ServiceAccountTemplate contains the template needed to generate the service accounts

Field

Description

metadata ** Required] **

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

SnapshotOwnerReference {#postgresql-cnpg-io-v1-SnapshotOwnerReference} (Alias of string )#

Appears in:

  • VolumeSnapshotConfiguration {postgresql-cnpg-io-v1-VolumeSnapshotConfiguration}

SnapshotOwnerReference defines the reference type for the owner of the snapshot. This specifies which owner the processed resources should relate to.

SnapshotType {#postgresql-cnpg-io-v1-SnapshotType} (Alias of string )#

Appears in:

  • Import {postgresql-cnpg-io-v1-Import}

SnapshotType is a type of allowed import

StorageConfiguration#

Appears in:

  • ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec}

StorageConfiguration is the configuration of the storage of the PostgreSQL instances

Field

Description

storageClass<br>*string*

StorageClass to use for database data (PGDATA). Applied after evaluating the PVC template, if available. If not specified, generated PVCs will be satisfied by the default storage class

size<br>*string*

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.

resizeInUseVolumes<br>*bool*

Resize existent PVCs, defaults to true

pvcTemplate<br> *core/v1.PersistentVolumeClaimSpec*

Template to be used to generate the Persistent Volume Claim

SyncReplicaElectionConstraints#

Appears in:

  • PostgresConfiguration {postgresql-cnpg-io-v1-PostgresConfiguration}

SyncReplicaElectionConstraints contains the constraints for sync replicas election.

For anti-affinity parameters two instances are considered in the same location if all the labels values match.

In future synchronous replica election restriction by name will be supported.

Field

Description

nodeLabelsAntiAffinity<br>*[]string*

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

enabled [Required] <br>*bool*

This flag enables the constraints for sync replicas

Topology#

Appears in:

  • ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus}

Topology contains the cluster topology

Field

Description

instances<br> *map[github.com/cloudnative-pg/cloudnative-pg/api/v1.PodName]github.com/cloudnative-pg/cloudnative-pg/api/v1.PodTopologyLabels*

Instances contains the pod topology of the instances

nodesUsed<br>*int32*

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<br>*bool*

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

VolumeSnapshotConfiguration#

Appears in:

  • BackupConfiguration {postgresql-cnpg-io-v1-BackupConfiguration}

VolumeSnapshotConfiguration represents the configuration for the execution of snapshot backups.

Field

Description

labels<br>*map[string]string*

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

annotations<br>*map[string]string*

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

className<br>*string*

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<br>*string*

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

snapshotOwnerReference<br> *SnapshotOwnerReference*

SnapshotOwnerReference indicates the type of owner reference the snapshot should have

WalBackupConfiguration#

Appears in:

  • BarmanObjectStoreConfiguration {postgresql-cnpg-io-v1-BarmanObjectStoreConfiguration}

WalBackupConfiguration is the configuration of the backup of the WAL stream

Field

Description

compression<br> *CompressionType*

Compress a WAL file before sending it to the object store. Available options are empty string (no compression, default), gzip, bzip2 or snappy.

encryption<br> *EncryptionType*

Whenever to force the encryption of files (if the bucket is not already configured for that). Allowed options are empty string (use the bucket policy, default), AES256 and aws:kms

maxParallel<br>*int*

Number of WAL files to be either archived in parallel (when the PostgreSQL instance is archiving to a backup object store) or restored in parallel (when a PostgreSQL standby is fetching WAL files from a recovery object store). If not specified, WAL files will be processed one at a time. It accepts a positive integer as a value - with 1 being the minimum accepted value.