`
CertificatesConfiguration contains the needed configurations to handle
server certificates.
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
serverCASecret
*string*,"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.
"
serverTLSSecret
*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
*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
*string*,"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.
"
serverAltDNSNames
*[]string*,"The list of the server alternative DNS names to be added to the generated server TLS certificates, when required."
"",""
.. _postgresql-cnpg-io-v1-CertificatesStatus:
CertificatesStatus
------------------
**Appears in:**
- :ref:`ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus} `
CertificatesStatus contains configuration certificates and related
expiration dates.
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
CertificatesConfiguration
:ref:`archive_timeout ` ,"(Members of CertificatesConfiguration are embedded into this type.)
Needed configurations to handle server certificates, initialized with default values, if needed.
"
expirations
*map[string]string*,Expiration dates for all certificates.
"",""
.. _postgresql-cnpg-io-v1-ClusterSpec:
ClusterSpec
-----------
**Appears in:**
- :ref:`Multi-availability zone Kubernetes clusters `
ClusterSpec defines the desired state of Cluster
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
description
*string*,Description of this PostgreSQL cluster
inheritedMetadata
:ref:`*EmbeddedObjectMetadata* <#postgresql-cnpg-io-v1-embeddedobjectmetadata>` ,Metadata that will be inherited by all objects related to the Cluster
imageName
*string*,"Name of the container image, supporting both tags (:) and digests for deterministic and repeatable deployments (:@sha256:)"
imagePullPolicy
`*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
*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
*int64*,"The UID of the postgres user inside the image, defaults to 26"
postgresGID
*int64*,"The GID of the postgres user inside the image, defaults to 26"
instances **[Required]**
*int*,Number of instances required in the cluster
minSyncReplicas
*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
*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
:ref:`*PostgresConfiguration* <#postgresql-cnpg-io-v1-postgresconfiguration>` ,Configuration of the PostgreSQL server
replicationSlots
:ref:`archive_timeout ` ,Replication slots management configuration
bootstrap
:ref:`archive_timeout ` ,Instructions to bootstrap this cluster
replica
:ref:`*ReplicaClusterConfiguration* <#postgresql-cnpg-io-v1-replicaclusterconfiguration>` ,Replica cluster configuration
superuserSecret
:ref:`*LocalObjectReference* <#postgresql-cnpg-io-v1-localobjectreference>` ,The secret containing the superuser password. If not defined a new secret will be created with a randomly generated password
enableSuperuserAccess
*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
:ref:`archive_timeout ` ,The configuration for the CA and related certificates
imagePullSecrets
:ref:`*LocalObjectReference* <#postgresql-cnpg-io-v1-localobjectreference>` ,The list of pull secrets to be used to pull the images
storage
:ref:`archive_timeout ` ,Configuration of the storage of the instances
serviceAccountTemplate
:ref:`*ServiceAccountTemplate* <#postgresql-cnpg-io-v1-serviceaccounttemplate>` ,Configure the generation of the service account
walStorage
:ref:`archive_timeout ` ,Configuration of the storage for PostgreSQL WAL (Write-Ahead Log)
startDelay
*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
*int32*,The time in seconds that is allowed for a PostgreSQL instance to gracefully shutdown (default 1800)
smartShutdownTimeout
*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
*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
*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
:ref:`*AffinityConfiguration* <#postgresql-cnpg-io-v1-affinityconfiguration>` ,Affinity/Anti-affinity rules for Pods
topologySpreadConstraints
`*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
`*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 ** :ref:`Required]
[*EphemeralVolumesSizeLimitConfiguration* <#postgresql-cnpg-io-v1-ephemeralvolumessizelimitconfiguration>` ** ,EphemeralVolumesSizeLimit allows the user to set the limits for the ephemeral volumes
priorityClassName
*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
:ref:`*PrimaryUpdateStrategy* <#postgresql-cnpg-io-v1-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
:ref:`*PrimaryUpdateMethod* <#postgresql-cnpg-io-v1-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
:ref:`archive_timeout ` ,The configuration to be used for backups
nodeMaintenanceWindow
:ref:`*NodeMaintenanceWindow* <#postgresql-cnpg-io-v1-nodemaintenancewindow>` ,Define a maintenance window for the Kubernetes nodes
monitoring
:ref:`archive_timeout ` ,The configuration of the monitoring infrastructure of this cluster
externalClusters
:ref:`*ExternalCluster* <#postgresql-cnpg-io-v1-externalcluster>` ,The list of external clusters which are used in the configuration
logLevel
*string*,"The instances' log level, one of the following values: error, warning, info (default), debug, trace"
projectedVolumeTemplate
`*core/v1.ProjectedVolumeSource* `__ ,"Template to be used to define projected volumes, projected volumes will be mounted under /projected base folder"
env
`*core/v1.EnvVar* `__ ,Env follows the Env format to pass environment variables to the pods created in the cluster
envFrom
`*core/v1.EnvFromSource* `__ ,EnvFrom follows the EnvFrom format to pass environment variables sources to the pods to be used by Env
managed
:ref:`*ManagedConfiguration* <#postgresql-cnpg-io-v1-managedconfiguration>` ,The configuration that is used by the portions of PostgreSQL that are managed by the instance manager
seccompProfile
`*core/v1.SeccompProfile* `__ ,The SeccompProfile applied to every Pod and Container. Defaults to: RuntimeDefault
"",""
.. _postgresql-cnpg-io-v1-ClusterStatus:
ClusterStatus
-------------
**Appears in:**
- :ref:`Multi-availability zone Kubernetes clusters `
ClusterStatus defines the observed state of Cluster
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
instances
*int*,The total number of PVC Groups detected in the cluster. It may differ from the number of existing instance pods.
readyInstances
*int*,The total number of ready instances in the cluster. It is equal to the number of ready instance pods.
instancesStatus
*map[github.com/cloudnative-pg/cloudnative-pg/pkg/utils.PodStatus][]string*,InstancesStatus indicates in which status the instances are
instancesReportedState
:ref:`*map\[github.com/cloudnative-pg/cloudnative-pg/api/v1.PodName\]github.com/cloudnative-pg/cloudnative-pg/api/v1.InstanceReportedState* <#postgresql-cnpg-io-v1-instancereportedstate>` ,The reported state of the instances during the last reconciliation loop
managedRolesStatus
:ref:`*ManagedRoles* <#postgresql-cnpg-io-v1-managedroles>` ,ManagedRolesStatus reports the state of the managed roles in the cluster
timelineID
*int*,The timeline of the Postgres cluster
topology
:ref:`*Topology* <#postgresql-cnpg-io-v1-topology>` ,Instances topology.
latestGeneratedNode
*int*,ID of the latest generated node (used to avoid node name clashing)
currentPrimary
*string*,Current primary instance
targetPrimary
*string*,"Target primary instance, this is different from the previous one during a switchover or a failover"
pvcCount
*int32*,How many PVCs have been created by this cluster
jobCount
*int32*,How many Jobs have been created by this cluster
danglingPVC
*[]string*,List of all the PVCs created by this cluster and still available which are not attached to a Pod
resizingPVC
*[]string*,List of all the PVCs that have ResizingPVC condition.
initializingPVC
*[]string*,List of all the PVCs that are being initialized by this cluster
healthyPVC
*[]string*,List of all the PVCs not dangling nor initializing
unusablePVC
*[]string*,List of all the PVCs that are unusable because another PVC is missing
writeService
*string*,Current write pod
readService
*string*,Current list of read pods
phase
*string*,Current phase of the cluster
phaseReason
*string*,Reason for the current phase
secretsResourceVersion
:ref:`*SecretsResourceVersion* <#postgresql-cnpg-io-v1-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
:ref:`*ConfigMapResourceVersion* <#postgresql-cnpg-io-v1-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
:ref:`archive_timeout ` ,"The configuration for the CA and related certificates, initialized with defaults."
firstRecoverabilityPoint
*string*,"The first recoverability point, stored as a date in RFC3339 format"
lastSuccessfulBackup
*string*,Stored as a date in RFC3339 format
lastFailedBackup
*string*,Stored as a date in RFC3339 format
cloudNativePGCommitHash
*string*,The commit hash number of which this operator running
currentPrimaryTimestamp
*string*,The timestamp when the last actual promotion to primary has occurred
currentPrimaryFailingSinceTimestamp
*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
*string*,The timestamp when the last request for a new primary has occurred
poolerIntegrations
:ref:`*PoolerIntegrations* <#postgresql-cnpg-io-v1-poolerintegrations>` ,The integration needed by poolers referencing the cluster
cloudNativePGOperatorHash
*string*,The hash of the binary of the operator
conditions
`*meta/v1.Condition* `__ ,Conditions for cluster object
instanceNames
*[]string*,List of instance names in the cluster
onlineUpdateEnabled
*bool*,OnlineUpdateEnabled shows if the online upgrade is enabled inside the cluster
azurePVCUpdateEnabled
*bool*,AzurePVCUpdateEnabled shows if the PVC online upgrade is enabled for this cluster
"",""
CompressionType {#postgresql-cnpg-io-v1-CompressionType} (Alias of ``string`` )
-------------------------------------------------------------------------------
**Appears in:**
- :ref:`DataBackupConfiguration {postgresql-cnpg-io-v1-DataBackupConfiguration} `
- :ref:`WalBackupConfiguration {postgresql-cnpg-io-v1-WalBackupConfiguration} `
CompressionType encapsulates the available types of compression
.. _postgresql-cnpg-io-v1-ConfigMapKeySelector:
ConfigMapKeySelector
--------------------
**Appears in:**
- :ref:`MonitoringConfiguration {postgresql-cnpg-io-v1-MonitoringConfiguration} `
- :ref:`PostInitApplicationSQLRefs {postgresql-cnpg-io-v1-PostInitApplicationSQLRefs} `
ConfigMapKeySelector contains enough information to let you locate the
key of a ConfigMap
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
LocalObjectReference
:ref:`*LocalObjectReference* <#postgresql-cnpg-io-v1-localobjectreference>` ,(Members of LocalObjectReference are embedded into this type.)
The name of the secret in the pod's namespace to select from.
key **[Required]**
*string*,The key to select
"",""
.. _postgresql-cnpg-io-v1-ConfigMapResourceVersion:
ConfigMapResourceVersion
------------------------
**Appears in:**
- :ref:`ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus} `
ConfigMapResourceVersion is the resource versions of the secrets managed
by the operator
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
metrics
*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"
"",""
.. _postgresql-cnpg-io-v1-DataBackupConfiguration:
DataBackupConfiguration
-----------------------
**Appears in:**
- :ref:`BarmanObjectStoreConfiguration {postgresql-cnpg-io-v1-BarmanObjectStoreConfiguration} `
DataBackupConfiguration is the configuration of the backup of the data
directory
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
compression
:ref:`*CompressionType* <#postgresql-cnpg-io-v1-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
:ref:`*EncryptionType* <#postgresql-cnpg-io-v1-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
*int32*,"The number of parallel jobs to be used to upload the backup, defaults to 2"
immediateCheckpoint
*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."
"",""
.. _postgresql-cnpg-io-v1-DataSource:
DataSource
----------
**Appears in:**
- :ref:`BootstrapRecovery {postgresql-cnpg-io-v1-BootstrapRecovery} `
DataSource contains the configuration required to bootstrap a PostgreSQL
cluster from an existing storage
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
storage ** `Required]
[*core/v1.TypedLocalObjectReference* `__ ** ,Configuration of the storage of the instances
walStorage
`*core/v1.TypedLocalObjectReference* `__ ,Configuration of the storage for PostgreSQL WAL (Write-Ahead Log)
"",""
.. _postgresql-cnpg-io-v1-EmbeddedObjectMetadata:
EmbeddedObjectMetadata
----------------------
**Appears in:**
- :ref:`ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec} `
EmbeddedObjectMetadata contains metadata to be inherited by all
resources related to a Cluster
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
labels
*map[string]string*,No description provided.
annotations
*map[string]string*,No description provided.
"",""
EncryptionType {#postgresql-cnpg-io-v1-EncryptionType} (Alias of ``string`` )
-----------------------------------------------------------------------------
**Appears in:**
- :ref:`DataBackupConfiguration {postgresql-cnpg-io-v1-DataBackupConfiguration} `
- :ref:`WalBackupConfiguration {postgresql-cnpg-io-v1-WalBackupConfiguration} `
EncryptionType encapsulated the available types of encryption
EnsureOption {#postgresql-cnpg-io-v1-EnsureOption} (Alias of ``string`` )
-------------------------------------------------------------------------
**Appears in:**
- :ref:`RoleConfiguration {postgresql-cnpg-io-v1-RoleConfiguration} `
EnsureOption represents whether we should enforce the presence or
absence of a Role in a PostgreSQL instance
.. _postgresql-cnpg-io-v1-EphemeralVolumesSizeLimitConfiguration:
EphemeralVolumesSizeLimitConfiguration
--------------------------------------
**Appears in:**
- :ref:`ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec} `
EphemeralVolumesSizeLimitConfiguration contains the configuration of the
ephemeral storage
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
shm **[Required]**
*k8s.io/apimachinery/pkg/api/resource.Quantity*,Shm is the size limit of the shared memory volume
temporaryData **[Required]**
*k8s.io/apimachinery/pkg/api/resource.Quantity*,TemporaryData is the size limit of the temporary data volume
"",""
.. _postgresql-cnpg-io-v1-ExternalCluster:
ExternalCluster
---------------
**Appears in:**
- :ref:`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
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
name **[Required]**
*string*,"The server name, required"
connectionParameters
*map[string]string*,"The list of connection parameters, such as dbname, host, username, etc"
sslCert
`*core/v1.SecretKeySelector* `__ ,The reference to an SSL certificate to be used to connect to this instance
sslKey
`*core/v1.SecretKeySelector* `__ ,The reference to an SSL private key to be used to connect to this instance
sslRootCert
`*core/v1.SecretKeySelector* `__ ,The reference to an SSL CA public key to be used to connect to this instance
password
`*core/v1.SecretKeySelector* `__ ,The reference to the password to be used to connect to the server
barmanObjectStore
:ref:`*BarmanObjectStoreConfiguration* <#postgresql-cnpg-io-v1-barmanobjectstoreconfiguration>` ,The configuration for the barman-cloud tool suite
"",""
.. _postgresql-cnpg-io-v1-GoogleCredentials:
GoogleCredentials
-----------------
**Appears in:**
- :ref:`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.
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
applicationCredentials
:ref:`*SecretKeySelector* <#postgresql-cnpg-io-v1-secretkeyselector>` ,The secret containing the Google Cloud Storage JSON file with the credentials
gkeEnvironment
*bool*,"If set to true, will presume that it's running inside a GKE environment, default to false."
"",""
.. _postgresql-cnpg-io-v1-Import:
Import
------
**Appears in:**
- :ref:`BootstrapInitDB {postgresql-cnpg-io-v1-BootstrapInitDB} `
Import contains the configuration to init a database from a logic
snapshot of an externalCluster
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
source ** :ref:`Required]
[*ImportSource* <#postgresql-cnpg-io-v1-importsource>` ** ,The source of the import
type ** :ref:`Required]
[*SnapshotType* <#postgresql-cnpg-io-v1-snapshottype>` ** ,The import type. Can be microservice or monolith.
databases **[Required]**
*[]string*,The databases to import
roles
*[]string*,The roles to import
postImportApplicationSQL
*[]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
*bool*,"When set to true, only the pre-data and post-data sections of pg\_restore are invoked, avoiding data import. Default: false."
"",""
.. _postgresql-cnpg-io-v1-ImportSource:
ImportSource
------------
**Appears in:**
- :ref:`Import {postgresql-cnpg-io-v1-Import} `
ImportSource describes the source for the logical snapshot
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
externalCluster **[Required]**
*string*,The name of the externalCluster used for import
"",""
.. _postgresql-cnpg-io-v1-InstanceID:
InstanceID
----------
**Appears in:**
- :ref:`BackupStatus {postgresql-cnpg-io-v1-BackupStatus} `
InstanceID contains the information to identify an instance
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
podName
*string*,The pod name
ContainerID
*string*,The container ID
"",""
.. _postgresql-cnpg-io-v1-InstanceReportedState:
InstanceReportedState
---------------------
**Appears in:**
- :ref:`ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus} `
InstanceReportedState describes the last reported state of an instance
during a reconciliation loop
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
isPrimary **[Required]**
*bool*,indicates if an instance is the primary one
timeLineID
*int*,indicates on which TimelineId the instance is
"",""
.. _postgresql-cnpg-io-v1-LDAPBindAsAuth:
LDAPBindAsAuth
--------------
**Appears in:**
- :ref:`LDAPConfig {postgresql-cnpg-io-v1-LDAPConfig} `
LDAPBindAsAuth provides the required fields to use the bind
authentication for LDAP
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
prefix
*string*,Prefix for the bind authentication option
suffix
*string*,Suffix for the bind authentication option
"",""
.. _postgresql-cnpg-io-v1-LDAPBindSearchAuth:
LDAPBindSearchAuth
------------------
**Appears in:**
- :ref:`LDAPConfig {postgresql-cnpg-io-v1-LDAPConfig} `
LDAPBindSearchAuth provides the required fields to use the bind+search
LDAP authentication process
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
baseDN
*string*,Root DN to begin the user search
bindDN
*string*,DN of the user to bind to the directory
bindPassword
`*core/v1.SecretKeySelector* `__ ,Secret with the password for the user to bind to the directory
searchAttribute
*string*,Attribute to match against the username
searchFilter
*string*,Search filter to use when doing the search+bind authentication
"",""
.. _postgresql-cnpg-io-v1-LDAPConfig:
LDAPConfig
----------
**Appears in:**
- :ref:`PostgresConfiguration {postgresql-cnpg-io-v1-PostgresConfiguration} `
LDAPConfig contains the parameters needed for LDAP authentication
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
server
*string*,LDAP hostname or IP address
port
*int*,LDAP server port
scheme
:ref:`*LDAPScheme* <#postgresql-cnpg-io-v1-ldapscheme>` ,"LDAP schema to be used, possible options are ldap and ldaps"
bindAsAuth
:ref:`*LDAPBindAsAuth* <#postgresql-cnpg-io-v1-ldapbindasauth>` ,Bind as authentication configuration
bindSearchAuth
:ref:`*LDAPBindSearchAuth* <#postgresql-cnpg-io-v1-ldapbindsearchauth>` ,Bind+Search authentication configuration
tls
*bool*,Set to 'true' to enable LDAP over TLS. 'false' is default
"",""
LDAPScheme {#postgresql-cnpg-io-v1-LDAPScheme} (Alias of ``string`` )
---------------------------------------------------------------------
**Appears in:**
- :ref:`LDAPConfig {postgresql-cnpg-io-v1-LDAPConfig} `
LDAPScheme defines the possible schemes for LDAP
.. _postgresql-cnpg-io-v1-LocalObjectReference:
LocalObjectReference
--------------------
**Appears in:**
- :ref:`BackupSource {postgresql-cnpg-io-v1-BackupSource} `
- :ref:`BackupSpec {postgresql-cnpg-io-v1-BackupSpec} `
- :ref:`BootstrapInitDB {postgresql-cnpg-io-v1-BootstrapInitDB} `
- :ref:`BootstrapPgBaseBackup {postgresql-cnpg-io-v1-BootstrapPgBaseBackup} `
- :ref:`BootstrapRecovery {postgresql-cnpg-io-v1-BootstrapRecovery} `
- :ref:`ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec} `
- :ref:`ConfigMapKeySelector {postgresql-cnpg-io-v1-ConfigMapKeySelector} `
- :ref:`PgBouncerSpec {postgresql-cnpg-io-v1-PgBouncerSpec} `
- :ref:`PoolerSpec {postgresql-cnpg-io-v1-PoolerSpec} `
- :ref:`RoleConfiguration {postgresql-cnpg-io-v1-RoleConfiguration} `
- :ref:`ScheduledBackupSpec {postgresql-cnpg-io-v1-ScheduledBackupSpec} `
- :ref:`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
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
name **[Required]**
*string*,Name of the referent.
"",""
.. _postgresql-cnpg-io-v1-ManagedConfiguration:
ManagedConfiguration
--------------------
**Appears in:**
- :ref:`ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec} `
ManagedConfiguration represents the portions of PostgreSQL that are
managed by the instance manager
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
roles
:ref:`*RoleConfiguration* <#postgresql-cnpg-io-v1-roleconfiguration>` ,Database roles managed by the Cluster
"",""
.. _postgresql-cnpg-io-v1-ManagedRoles:
ManagedRoles
------------
**Appears in:**
- :ref:`ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus} `
ManagedRoles tracks the status of a cluster’s managed roles
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
byStatus
*map[github.com/cloudnative-pg/cloudnative-pg/api/v1.RoleStatus][]string*,ByStatus gives the list of roles in each state
cannotReconcile
*map[string][]string*,"CannotReconcile lists roles that cannot be reconciled in PostgreSQL, with an explanation of the cause"
passwordStatus
:ref:`*map\[string\]github.com/cloudnative-pg/cloudnative-pg/api/v1.PasswordState* <#postgresql-cnpg-io-v1-passwordstate>` ,PasswordStatus gives the last transaction id and password secret version for each managed role
"",""
.. _postgresql-cnpg-io-v1-Metadata:
Metadata
--------
**Appears in:**
- :ref:`PodTemplateSpec {postgresql-cnpg-io-v1-PodTemplateSpec} `
- :ref:`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.
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
labels
*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
*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
"",""
.. _postgresql-cnpg-io-v1-MonitoringConfiguration:
MonitoringConfiguration
-----------------------
**Appears in:**
- :ref:`ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec} `
MonitoringConfiguration is the type containing all the monitoring
configuration for a certain cluster
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
disableDefaultQueries
*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
:ref:`*ConfigMapKeySelector* <#postgresql-cnpg-io-v1-configmapkeyselector>` ,The list of config maps containing the custom queries
customQueriesSecret
:ref:`*SecretKeySelector* <#postgresql-cnpg-io-v1-secretkeyselector>` ,The list of secrets containing the custom queries
enablePodMonitor
*bool*,Enable or disable the PodMonitor
"",""
.. _postgresql-cnpg-io-v1-NodeMaintenanceWindow:
NodeMaintenanceWindow
---------------------
**Appears in:**
- :ref:`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.
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
reusePVC
*bool*,Reuse the existing PVC (wait for the node to come up again) or not (recreate it elsewhere - when instances >1)
inProgress
*bool*,Is there a node maintenance activity in progress?
"",""
.. _postgresql-cnpg-io-v1-PasswordState:
PasswordState
-------------
**Appears in:**
- :ref:`ManagedRoles {postgresql-cnpg-io-v1-ManagedRoles} `
PasswordState represents the state of the password of a managed
RoleConfiguration
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
transactionID
*int64*,the last transaction ID to affect the role definition in PostgreSQL
resourceVersion
*string*,the resource version of the password secret
"",""
.. _postgresql-cnpg-io-v1-PgBouncerIntegrationStatus:
PgBouncerIntegrationStatus
--------------------------
**Appears in:**
- :ref:`PoolerIntegrations {postgresql-cnpg-io-v1-PoolerIntegrations} `
PgBouncerIntegrationStatus encapsulates the needed integration for the
pgbouncer poolers referencing the cluster
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
secrets
*[]string*,No description provided.
"",""
PgBouncerPoolMode {#postgresql-cnpg-io-v1-PgBouncerPoolMode} (Alias of ``string`` )
-----------------------------------------------------------------------------------
**Appears in:**
- :ref:`PgBouncerSpec {postgresql-cnpg-io-v1-PgBouncerSpec} `
PgBouncerPoolMode is the mode of PgBouncer
.. _postgresql-cnpg-io-v1-PgBouncerSecrets:
PgBouncerSecrets
----------------
**Appears in:**
- :ref:`PoolerSecrets {postgresql-cnpg-io-v1-PoolerSecrets} `
PgBouncerSecrets contains the versions of the secrets used by pgbouncer
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
authQuery
:ref:`*SecretVersion* <#postgresql-cnpg-io-v1-secretversion>` ,The auth query secret version
"",""
.. _postgresql-cnpg-io-v1-PgBouncerSpec:
PgBouncerSpec
-------------
**Appears in:**
- :ref:`PoolerSpec {postgresql-cnpg-io-v1-PoolerSpec} `
PgBouncerSpec defines how to configure PgBouncer
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
poolMode
:ref:`*PgBouncerPoolMode* <#postgresql-cnpg-io-v1-pgbouncerpoolmode>` ,The pool mode. Default: session.
authQuerySecret
:ref:`*LocalObjectReference* <#postgresql-cnpg-io-v1-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
*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
*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
*[]string*,PostgreSQL Host Based Authentication rules (lines to be appended to the pg\_hba.conf file)
paused
*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."
"",""
.. _postgresql-cnpg-io-v1-PodTemplateSpec:
PodTemplateSpec
---------------
**Appears in:**
- :ref:`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:
https://github.com/kubernetes-sigs/controller-tools/issues/385
https://github.com/kubernetes-sigs/controller-tools/issues/448
https://github.com/prometheus-operator/prometheus-operator/issues/3041
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
metadata
:ref:`*Metadata* <#postgresql-cnpg-io-v1-metadata>` ,Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec
`*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:**
- :ref:`PodTopologyLabels {postgresql-cnpg-io-v1-PodTopologyLabels} (Alias of `map[string]string` ) `
PodTopologyLabels represent the topology of a Pod.
map[labelName]labelValue
.. _postgresql-cnpg-io-v1-PoolerIntegrations:
PoolerIntegrations
------------------
**Appears in:**
- :ref:`ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus} `
PoolerIntegrations encapsulates the needed integration for the poolers
referencing the cluster
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
pgBouncerIntegration
:ref:`*PgBouncerIntegrationStatus* <#postgresql-cnpg-io-v1-pgbouncerintegrationstatus>` ,No description provided.
"",""
.. _postgresql-cnpg-io-v1-PoolerMonitoringConfiguration:
PoolerMonitoringConfiguration
-----------------------------
**Appears in:**
- :ref:`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.
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
enablePodMonitor
*bool*,Enable or disable the PodMonitor
"",""
.. _postgresql-cnpg-io-v1-PoolerSecrets:
PoolerSecrets
-------------
**Appears in:**
- :ref:`PoolerStatus {postgresql-cnpg-io-v1-PoolerStatus} `
PoolerSecrets contains the versions of all the secrets used
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
serverTLS
:ref:`*SecretVersion* <#postgresql-cnpg-io-v1-secretversion>` ,The server TLS secret version
serverCA
:ref:`*SecretVersion* <#postgresql-cnpg-io-v1-secretversion>` ,The server CA secret version
clientCA
:ref:`*SecretVersion* <#postgresql-cnpg-io-v1-secretversion>` ,The client CA secret version
pgBouncerSecrets
:ref:`*PgBouncerSecrets* <#postgresql-cnpg-io-v1-pgbouncersecrets>` ,The version of the secrets used by PgBouncer
"",""
.. _postgresql-cnpg-io-v1-PoolerSpec:
PoolerSpec
----------
**Appears in:**
- :ref:`Pooler {postgresql-cnpg-io-v1-Pooler} `
PoolerSpec defines the desired state of Pooler
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
cluster ** :ref:`Required]
[*LocalObjectReference* <#postgresql-cnpg-io-v1-localobjectreference>` ** ,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
:ref:`*PoolerType* <#postgresql-cnpg-io-v1-poolertype>` ,Type of service to forward traffic to. Default: rw.
instances
*int32*,The number of replicas we want. Default: 1.
template
:ref:`*PodTemplateSpec* <#postgresql-cnpg-io-v1-podtemplatespec>` ,The template of the Pod to be created
pgbouncer ** :ref:`Required]
[*PgBouncerSpec* <#postgresql-cnpg-io-v1-pgbouncerspec>` ** ,The PgBouncer configuration
deploymentStrategy
`*apps/v1.DeploymentStrategy* `__ ,The deployment strategy to use for pgbouncer to replace existing pods with new ones
monitoring
:ref:`archive_timeout ` ,The configuration of the monitoring infrastructure of this pooler.
"",""
.. _postgresql-cnpg-io-v1-PoolerStatus:
PoolerStatus
------------
**Appears in:**
- :ref:`Pooler {postgresql-cnpg-io-v1-Pooler} `
PoolerStatus defines the observed state of Pooler
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
secrets
:ref:`*PoolerSecrets* <#postgresql-cnpg-io-v1-poolersecrets>` ,The resource version of the config object
instances
*int32*,The number of pods trying to be scheduled
"",""
PoolerType {#postgresql-cnpg-io-v1-PoolerType} (Alias of ``string`` )
---------------------------------------------------------------------
**Appears in:**
- :ref:`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.
.. _postgresql-cnpg-io-v1-PostInitApplicationSQLRefs:
PostInitApplicationSQLRefs
--------------------------
**Appears in:**
- :ref:`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
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
secretRefs
:ref:`*SecretKeySelector* <#postgresql-cnpg-io-v1-secretkeyselector>` ,SecretRefs holds a list of references to Secrets
configMapRefs
:ref:`*ConfigMapKeySelector* <#postgresql-cnpg-io-v1-configmapkeyselector>` ,ConfigMapRefs holds a list of references to ConfigMaps
"",""
.. _postgresql-cnpg-io-v1-PostgresConfiguration:
PostgresConfiguration
---------------------
**Appears in:**
- :ref:`ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec} `
PostgresConfiguration defines the PostgreSQL configuration
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
parameters
*map[string]string*,PostgreSQL configuration options (postgresql.conf)
pg\_hba
*[]string*,PostgreSQL Host Based Authentication rules (lines to be appended to the pg\_hba.conf file)
syncReplicaElectionConstraint
:ref:`*SyncReplicaElectionConstraints* <#postgresql-cnpg-io-v1-syncreplicaelectionconstraints>` ,"Requirements to be met by sync replicas. This will affect how the ""synchronous\_standby\_names"" parameter will be set up."
shared\_preload\_libraries
*[]string*,Lists of shared preload libraries to add to the default ones
ldap
:ref:`*LDAPConfig* <#postgresql-cnpg-io-v1-ldapconfig>` ,Options to specify LDAP configuration
promotionTimeout
*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:**
- :ref:`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:**
- :ref:`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
.. _postgresql-cnpg-io-v1-RecoveryTarget:
RecoveryTarget
--------------
**Appears in:**
- :ref:`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.
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
backupID
*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
*string*,"The target timeline (""latest"" or a positive integer)"
targetXID
*string*,The target transaction ID
targetName
*string*,The target name (to be previously created with pg\_create\_restore\_point)
targetLSN
*string*,The target LSN (Log Sequence Number)
targetTime
*string*,The target time as a timestamp in the RFC3339 standard
targetImmediate
*bool*,End recovery as soon as a consistent state is reached
exclusive
*bool*,"Set the target to be exclusive. If omitted, defaults to false, so that in Postgres, recovery\_target\_inclusive will be true"
"",""
.. _postgresql-cnpg-io-v1-ReplicaClusterConfiguration:
ReplicaClusterConfiguration
---------------------------
**Appears in:**
- :ref:`ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec} `
ReplicaClusterConfiguration encapsulates the configuration of a replica
cluster
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
source **[Required]**
*string*,The name of the external cluster which is the replication origin
enabled **[Required]**
*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."
"",""
.. _postgresql-cnpg-io-v1-ReplicationSlotsConfiguration:
ReplicationSlotsConfiguration
-----------------------------
**Appears in:**
- :ref:`ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec} `
ReplicationSlotsConfiguration encapsulates the configuration of
replication slots
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
highAvailability
:ref:`archive_timeout ` ,Replication slots for high availability configuration
updateInterval
*int*,Standby will update the status of the local replication slots every updateInterval seconds (default 30).
"",""
.. _postgresql-cnpg-io-v1-ReplicationSlotsHAConfiguration:
ReplicationSlotsHAConfiguration
-------------------------------
**Appears in:**
- :ref:`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.
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
enabled
*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
*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\_."
"",""
.. _postgresql-cnpg-io-v1-RoleConfiguration:
RoleConfiguration
-----------------
\*\*.\ *\**\ :raw-latex:`\s`- :ref:`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
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
name **[Required]**
*string*,Name of the role
comment
*string*,Description of the role
ensure
:ref:`*EnsureOption* <#postgresql-cnpg-io-v1-ensureoption>` ,"Ensure the role is present or absent - defaults to ""present"""
passwordSecret
:ref:`*LocalObjectReference* <#postgresql-cnpg-io-v1-localobjectreference>` ,"Secret containing the password of the role (if present) If null, the password will be ignored unless DisablePassword is set"
connectionLimit
*int64*,"If the role can log in, this specifies how many concurrent connections the role can make. -1 (the default) means no limit."
validUntil
`*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
*[]string*,List of one or more existing roles to which this role will be immediately added as a new member. Default empty.
inherit
*bool*,"Whether a role ""inherits"" the privileges of roles it is a member of. Defaults is true."
disablePassword
*bool*,DisablePassword indicates that a role's password should be set to NULL in Postgres
superuser
*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
*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
*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
*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
*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
*bool*,Whether a role bypasses every row-level security (RLS) policy. Default is false.
"",""
.. _postgresql-cnpg-io-v1-S3Credentials:
S3Credentials
-------------
**Appears in:**
- :ref:`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
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
accessKeyId
:ref:`*SecretKeySelector* <#postgresql-cnpg-io-v1-secretkeyselector>` ,The reference to the access key id
secretAccessKey
:ref:`*SecretKeySelector* <#postgresql-cnpg-io-v1-secretkeyselector>` ,The reference to the secret access key
region
:ref:`*SecretKeySelector* <#postgresql-cnpg-io-v1-secretkeyselector>` ,The reference to the secret containing the region name
sessionToken
:ref:`*SecretKeySelector* <#postgresql-cnpg-io-v1-secretkeyselector>` ,The references to the session key
inheritFromIAMRole
*bool*,Use the role based authentication without providing explicitly the keys.
"",""
.. _postgresql-cnpg-io-v1-ScheduledBackupSpec:
ScheduledBackupSpec
-------------------
**Appears in:**
- :ref:`ScheduledBackup {postgresql-cnpg-io-v1-ScheduledBackup} `
ScheduledBackupSpec defines the desired state of ScheduledBackup
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
suspend
*bool*,If this backup is suspended or not
immediate
*bool*,If the first backup has to be immediately start after creation or not
schedule **[Required]**
*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 ** :ref:`Required]
[*LocalObjectReference* <#postgresql-cnpg-io-v1-localobjectreference>` ** ,The cluster to backup
backupOwnerReference
*string*,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
target
:ref:`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
:ref:`archive_timeout ` ,"The backup method to be used, possible options are barmanObjectStore and volumeSnapshot. Defaults to: barmanObjectStore."
"",""
.. _postgresql-cnpg-io-v1-ScheduledBackupStatus:
ScheduledBackupStatus
---------------------
**Appears in:**
- :ref:`ScheduledBackup {postgresql-cnpg-io-v1-ScheduledBackup} `
ScheduledBackupStatus defines the observed state of ScheduledBackup
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
lastCheckTime
`*meta/v1.Time* `__ ,The latest time the schedule
lastScheduleTime
`*meta/v1.Time* `__ ,Information when was the last time that backup was successfully scheduled.
nextScheduleTime
`*meta/v1.Time* `__ ,Next time we will run a backup
"",""
.. _postgresql-cnpg-io-v1-SecretKeySelector:
SecretKeySelector
-----------------
**Appears in:**
- :ref:`AzureCredentials {postgresql-cnpg-io-v1-AzureCredentials} `
- :ref:`BackupSource {postgresql-cnpg-io-v1-BackupSource} `
- :ref:`BackupStatus {postgresql-cnpg-io-v1-BackupStatus} `
- :ref:`BarmanObjectStoreConfiguration {postgresql-cnpg-io-v1-BarmanObjectStoreConfiguration} `
- :ref:`GoogleCredentials {postgresql-cnpg-io-v1-GoogleCredentials} `
- :ref:`MonitoringConfiguration {postgresql-cnpg-io-v1-MonitoringConfiguration} `
- :ref:`PostInitApplicationSQLRefs {postgresql-cnpg-io-v1-PostInitApplicationSQLRefs} `
- :ref:`S3Credentials {postgresql-cnpg-io-v1-S3Credentials} `
SecretKeySelector contains enough information to let you locate the key
of a Secret
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
LocalObjectReference
:ref:`*LocalObjectReference* <#postgresql-cnpg-io-v1-localobjectreference>` ,(Members of LocalObjectReference are embedded into this type.)
The name of the secret in the pod's namespace to select from.
key **[Required]**
*string*,The key to select
"",""
.. _postgresql-cnpg-io-v1-SecretVersion:
SecretVersion
-------------
**Appears in:**
- :ref:`PgBouncerSecrets {postgresql-cnpg-io-v1-PgBouncerSecrets} `
- :ref:`PoolerSecrets {postgresql-cnpg-io-v1-PoolerSecrets} `
SecretVersion contains a secret name and its ResourceVersion
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
name
*string*,The name of the secret
version
*string*,The ResourceVersion of the secret
"",""
.. _postgresql-cnpg-io-v1-SecretsResourceVersion:
SecretsResourceVersion
----------------------
**Appears in:**
- :ref:`ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus} `
SecretsResourceVersion is the resource versions of the secrets managed
by the operator
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
superuserSecretVersion
*string*,"The resource version of the ""postgres"" user secret"
replicationSecretVersion
*string*,"The resource version of the ""streaming\_replica"" user secret"
applicationSecretVersion
*string*,"The resource version of the ""app"" user secret"
managedRoleSecretVersion
*map[string]string*,The resource versions of the managed roles secrets
caSecretVersion
*string*,Unused. Retained for compatibility with old versions.
clientCaSecretVersion
*string*,The resource version of the PostgreSQL client-side CA secret version
serverCaSecretVersion
*string*,The resource version of the PostgreSQL server-side CA secret version
serverSecretVersion
*string*,The resource version of the PostgreSQL server-side secret version
barmanEndpointCA
*string*,The resource version of the Barman Endpoint CA if provided
metrics
*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"
"",""
.. _postgresql-cnpg-io-v1-ServiceAccountTemplate:
ServiceAccountTemplate
----------------------
**Appears in:**
- :ref:`ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec} `
ServiceAccountTemplate contains the template needed to generate the
service accounts
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
metadata ** :ref:`Required]
[*Metadata* <#postgresql-cnpg-io-v1-metadata>` ** ,Metadata are the metadata to be used for the generated service account
"",""
SnapshotOwnerReference {#postgresql-cnpg-io-v1-SnapshotOwnerReference} (Alias of ``string`` )
---------------------------------------------------------------------------------------------
**Appears in:**
- :ref:`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:**
- :ref:`Import {postgresql-cnpg-io-v1-Import} `
SnapshotType is a type of allowed import
.. _postgresql-cnpg-io-v1-StorageConfiguration:
StorageConfiguration
--------------------
**Appears in:**
- :ref:`ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec} `
StorageConfiguration is the configuration of the storage of the
PostgreSQL instances
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
storageClass
*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
*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
*bool*,"Resize existent PVCs, defaults to true"
pvcTemplate
`*core/v1.PersistentVolumeClaimSpec* `__ ,Template to be used to generate the Persistent Volume Claim
"",""
.. _postgresql-cnpg-io-v1-SyncReplicaElectionConstraints:
SyncReplicaElectionConstraints
------------------------------
**Appears in:**
- :ref:`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.
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
nodeLabelsAntiAffinity
*[]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]**
*bool*,This flag enables the constraints for sync replicas
"",""
.. _postgresql-cnpg-io-v1-Topology:
Topology
--------
**Appears in:**
- :ref:`ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus} `
Topology contains the cluster topology
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
instances
:ref:`*map\[github.com/cloudnative-pg/cloudnative-pg/api/v1.PodName\]github.com/cloudnative-pg/cloudnative-pg/api/v1.PodTopologyLabels* <#postgresql-cnpg-io-v1-podtopologylabels>` ,Instances contains the pod topology of the instances
nodesUsed
*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
*bool*,SuccessfullyExtracted indicates if the topology data was extract. It is useful to enact fallback behaviors in synchronous replica election in case of failures
"",""
.. _postgresql-cnpg-io-v1-VolumeSnapshotConfiguration:
VolumeSnapshotConfiguration
---------------------------
**Appears in:**
- :ref:`BackupConfiguration {postgresql-cnpg-io-v1-BackupConfiguration} `
VolumeSnapshotConfiguration represents the configuration for the
execution of snapshot backups.
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
labels
*map[string]string*,Labels are key-value pairs that will be added to .metadata.labels snapshot resources.
annotations
*map[string]string*,Annotations key-value pairs that will be added to .metadata.annotations snapshot resources.
className
*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
*string*,WalClassName specifies the Snapshot Class to be used for the PG\_WAL PersistentVolumeClaim.
snapshotOwnerReference
:ref:`*SnapshotOwnerReference* <#postgresql-cnpg-io-v1-snapshotownerreference>` ,SnapshotOwnerReference indicates the type of owner reference the snapshot should have
"",""
.. _postgresql-cnpg-io-v1-WalBackupConfiguration:
WalBackupConfiguration
----------------------
**Appears in:**
- :ref:`BarmanObjectStoreConfiguration {postgresql-cnpg-io-v1-BarmanObjectStoreConfiguration} `
WalBackupConfiguration is the configuration of the backup of the WAL
stream
.. csv-table::
:header: **Field**,**Description**
:widths: 10,30
:align: left
:class: longtable
compression
:ref:`*CompressionType* <#postgresql-cnpg-io-v1-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
:ref:`*EncryptionType* <#postgresql-cnpg-io-v1-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
*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."
"",""