API Reference ============= Package v1 contains API Schema definitions for the postgresql v1 API group Resource Types -------------- - :ref:`Appendix B - Backup on object stores ` .. _postgresql-cnpg-io-v1-Backup: Backup ------ A Backup resource is a request for a PostgreSQL backup by the user. .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `apiVersion` **[Required]** string,`postgresql.cnpg.io/v1` `kind` **[Required]** string,`Backup` `metadata` **[Required]** `_meta/v1.ObjectMeta_ `__ ,No description provided.Refer to the Kubernetes API documentation for the fields of the `metadata` field. `spec` **[Required]** :ref:`_BackupSpec_ ` ,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` :ref:`_BackupStatus_ ` ,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 .. _postgresql-cnpg-io-v1-Cluster: Cluster ------- Cluster is the Schema for the PostgreSQL API .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `apiVersion` **[Required]** string,`postgresql.cnpg.io/v1` `kind` **[Required]** string,`Cluster` `metadata` **[Required]** `_meta/v1.ObjectMeta_ `__ ,No description provided.Refer to the Kubernetes API documentation for the fields of the `metadata` field. `spec` **[Required]** :ref:`_ClusterSpec_ ` ,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` :ref:`_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 .. _postgresql-cnpg-io-v1-ClusterImageCatalog: ClusterImageCatalog ------------------- ClusterImageCatalog is the Schema for the clusterimagecatalogs API .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `apiVersion` **[Required]** string,`postgresql.cnpg.io/v1` `kind` **[Required]** string,`ClusterImageCatalog` `metadata` **[Required]** `_meta/v1.ObjectMeta_ `__ ,No description provided.Refer to the Kubernetes API documentation for the fields of the `metadata` field. `spec` **[Required]** :ref:`_ImageCatalogSpec_ ` ,Specification of the desired behavior of the ClusterImageCatalog. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status .. _postgresql-cnpg-io-v1-Database: Database -------- Database is the Schema for the databases API .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `apiVersion` **[Required]** string,`postgresql.cnpg.io/v1` `kind` **[Required]** string,`Database` `metadata` **[Required]** `_meta/v1.ObjectMeta_ `__ ,No description provided.Refer to the Kubernetes API documentation for the fields of the `metadata` field. `spec` **[Required]** :ref:`_DatabaseSpec_ ` ,Specification of the desired Database. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status `status` :ref:`_DatabaseStatus_ ` ,Most recently observed status of the Database. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status .. _postgresql-cnpg-io-v1-FailoverQuorum: FailoverQuorum -------------- **Appears in:** FailoverQuorum contains the information about the current failover quorum status of a PG cluster. It is updated by the instance manager of the primary node and reset to zero by the operator to trigger an update. .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `apiVersion` **[Required]** string,`postgresql.cnpg.io/v1` `kind` **[Required]** string,`FailoverQuorum` `metadata` **[Required]** `_meta/v1.ObjectMeta_ `__ ,No description provided.Refer to the Kubernetes API documentation for the fields of the `metadata` field. `status` :ref:`_FailoverQuorumStatus_ ` ,Most recently observed status of the failover quorum. .. _postgresql-cnpg-io-v1-ImageCatalog: ImageCatalog ------------ ImageCatalog is the Schema for the imagecatalogs API .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `apiVersion` **[Required]** string,`postgresql.cnpg.io/v1` `kind` **[Required]** string,`ImageCatalog` `metadata` **[Required]** `_meta/v1.ObjectMeta_ `__ ,No description provided.Refer to the Kubernetes API documentation for the fields of the `metadata` field. `spec` **[Required]** :ref:`_ImageCatalogSpec_ ` ,Specification of the desired behavior of the ImageCatalog. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status .. _postgresql-cnpg-io-v1-Pooler: Pooler ------ Pooler is the Schema for the poolers API .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `apiVersion` **[Required]** string,`postgresql.cnpg.io/v1` `kind` **[Required]** string,`Pooler` `metadata` **[Required]** `_meta/v1.ObjectMeta_ `__ ,No description provided.Refer to the Kubernetes API documentation for the fields of the `metadata` field. `spec` **[Required]** :ref:`_PoolerSpec_ ` ,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` :ref:`_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 .. _postgresql-cnpg-io-v1-Publication: Publication ----------- Publication is the Schema for the publications API .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `apiVersion` **[Required]** string,`postgresql.cnpg.io/v1` `kind` **[Required]** string,`Publication` `metadata` **[Required]** `_meta/v1.ObjectMeta_ `__ ,No description provided.Refer to the Kubernetes API documentation for the fields of the `metadata` field. `spec` **[Required]** :ref:`_PublicationSpec_ ` ,No description provided. `status` **[Required]** :ref:`_PublicationStatus_ ` ,No description provided. .. _postgresql-cnpg-io-v1-ScheduledBackup: ScheduledBackup --------------- ScheduledBackup is the Schema for the scheduledbackups API .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `apiVersion` **[Required]** string,`postgresql.cnpg.io/v1` `kind` **[Required]** string,`ScheduledBackup` `metadata` **[Required]** `_meta/v1.ObjectMeta_ `__ ,No description provided.Refer to the Kubernetes API documentation for the fields of the `metadata` field. `spec` **[Required]** :ref:`_ScheduledBackupSpec_ ` ,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` :ref:`_ScheduledBackupStatus_ ` ,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 .. _postgresql-cnpg-io-v1-Subscription: Subscription ------------ Subscription is the Schema for the subscriptions API .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `apiVersion` **[Required]** string,`postgresql.cnpg.io/v1` `kind` **[Required]** string,`Subscription` `metadata` **[Required]** `_meta/v1.ObjectMeta_ `__ ,No description provided.Refer to the Kubernetes API documentation for the fields of the `metadata` field. `spec` **[Required]** :ref:`_SubscriptionSpec_ ` ,No description provided. `status` **[Required]** :ref:`_SubscriptionStatus_ ` ,No description provided. .. _postgresql-cnpg-io-v1-AffinityConfiguration: AffinityConfiguration --------------------- **Appears in:** - :ref:`ClusterSpec {postgresql-cnpg-io-v1-ClusterSpec} ` AffinityConfiguration contains the info we need to create the affinity rules for Pods .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `enablePodAntiAffinity` _bool_,Activates anti-affinity for the pods. The operator will define pods anti-affinity unless this field is explicitly set to false `topologyKey` _string_,TopologyKey to use for anti-affinity configuration. See k8s documentation for more info on that `nodeSelector` _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` `_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` [_[]core/v1.Toleration_](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#toleration-v1-core) ,"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` _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` `_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` `_core/v1.PodAffinity_ `__ ,AdditionalPodAffinity allows to specify pod affinity terms to be passed to all the cluster's pods. .. _postgresql-cnpg-io-v1-AvailableArchitecture: AvailableArchitecture --------------------- **Appears in:** - :ref:`ClusterStatus {postgresql-cnpg-io-v1-ClusterStatus} ` AvailableArchitecture represents the state of a cluster’s architecture .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `goArch` **[Required]** _string_,GoArch is the name of the executable architecture `hash` **[Required]** _string_,Hash is the hash of the executable .. _postgresql-cnpg-io-v1-BackupConfiguration: BackupConfiguration ------------------- **Appears in:** - :ref:`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 .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `volumeSnapshot` :ref:`_VolumeSnapshotConfiguration_ ` ,VolumeSnapshot provides the configuration for the execution of volume snapshot backups. `barmanObjectStore` `_github.com/cloudnative-pg/barman-cloud/pkg/api.BarmanObjectStoreConfiguration_ `__ ,The configuration for the barman-cloud tool suite `retentionPolicy` _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` :ref:`_BackupTarget_ ` ,"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." .. _postgresql-cnpg-io-v1-BackupMethod: BackupMethod ------------ (Alias of ``string`` ) **Appears in:** - :ref:`BackupSpec {postgresql-cnpg-io-v1-BackupSpec} ` BackupMethod defines the way of executing the physical base backups of the selected PostgreSQL instance .. _postgresql-cnpg-io-v1-BackupPhase: BackupPhase ----------- (Alias of ``string`` ) **Appears in:** - :ref:`BackupStatus {postgresql-cnpg-io-v1-BackupStatus} ` BackupPhase is the phase of the backup .. _postgresql-cnpg-io-v1-BackupPluginConfiguration: BackupPluginConfiguration ------------------------- **Appears in:** - :ref:`BackupSpec {postgresql-cnpg-io-v1-BackupSpec} ` BackupPluginConfiguration contains the backup configuration used by the backup plugin .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `name` **[Required]** _string_,Name is the name of the plugin managing this backup `parameters` _map[string]string_,Parameters are the configuration parameters passed to the backup plugin for this backup .. _postgresql-cnpg-io-v1-BackupSnapshotElementStatus: BackupSnapshotElementStatus --------------------------- **Appears in:** - :ref:`BackupSnapshotStatus {postgresql-cnpg-io-v1-BackupSnapshotStatus} ` BackupSnapshotElementStatus is a volume snapshot that is part of a volume snapshot method backup .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `name` **[Required]** _string_,Name is the snapshot resource name `type` **[Required]** _string_,"Type is tho role of the snapshot in the cluster, such as PG\_DATA, PG\_WAL and PG\_TABLESPACE" `tablespaceName` _string_,TablespaceName is the name of the snapshotted tablespace. Only set when type is PG\_TABLESPACE .. _postgresql-cnpg-io-v1-BackupSnapshotStatus: BackupSnapshotStatus -------------------- **Appears in:** - :ref:`BackupStatus {postgresql-cnpg-io-v1-BackupStatus} ` BackupSnapshotStatus the fields exclusive to the volumeSnapshot method backup .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `elements` [_[]BackupSnapshotElementStatus_](BackupSnapshotElementStatus) ,"The elements list, populated with the gathered volume snapshots" .. _postgresql-cnpg-io-v1-BackupSource: BackupSource ------------ **Appears in:** - :ref:`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. .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `LocalObjectReference` `_github.com/cloudnative-pg/machinery/pkg/api.LocalObjectReference_ `__ ,(Members of `LocalObjectReference` are embedded into this type.) No description provided. `endpointCA` `_github.com/cloudnative-pg/machinery/pkg/api.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. .. _postgresql-cnpg-io-v1-BackupSpec: BackupSpec ---------- **Appears in:** - :ref:`Appendix B - Backup on object stores ` BackupSpec defines the desired state of Backup .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `cluster` **[Required]** `_github.com/cloudnative-pg/machinery/pkg/api.LocalObjectReference_ `__ ,The cluster to backup `target` :ref:`_BackupTarget_ ` ,"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:`_BackupMethod_ ` ,"The backup method to be used, possible options are `barmanObjectStore`, `volumeSnapshot` or `plugin`. Defaults to: `barmanObjectStore`." `pluginConfiguration` :ref:`_BackupPluginConfiguration_ ` ,Configuration parameters passed to the plugin managing this backup `online` _bool_,"Whether the default type of backup with volume snapshots is online/hot (`true`, default) or offline/cold (`false`) Overrides the default setting specified in the cluster field '.spec.backup.volumeSnapshot.online'" `onlineConfiguration` :ref:`_OnlineConfiguration_ ` ,Configuration parameters to control the online/hot backup with volume snapshots Overrides the default settings specified in the cluster '.backup.volumeSnapshot.onlineConfiguration' stanza .. _postgresql-cnpg-io-v1-BackupStatus: BackupStatus ------------ **Appears in:** - :ref:`Appendix B - Backup on object stores ` BackupStatus defines the observed state of Backup .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `BarmanCredentials` `_github.com/cloudnative-pg/barman-cloud/pkg/api.BarmanCredentials_ `__ ,(Members of `BarmanCredentials` are embedded into this type.) The potential credentials for each cloud provider `endpointCA` `_github.com/cloudnative-pg/machinery/pkg/api.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` _string_,"Endpoint to be used to upload data to the cloud, overriding the automatic endpoint discovery" `destinationPath` _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` _string_,"The server name on S3, the cluster name is used if this parameter is omitted" `encryption` _string_,Encryption method required to S3 API `backupId` _string_,The ID of the Barman backup `backupName` _string_,The Name of the Barman backup `phase` :ref:`_BackupPhase_ ` ,The last backup status `startedAt` `_meta/v1.Time_ `__ ,When the backup was started `stoppedAt` `_meta/v1.Time_ `__ ,When the backup was terminated `beginWal` _string_,The starting WAL `endWal` _string_,The ending WAL `beginLSN` _string_,The starting xlog `endLSN` _string_,The ending xlog `error` _string_,The detected error `commandOutput` _string_,Unused. Retained for compatibility with old versions. `commandError` _string_,The backup command output in case of error `backupLabelFile` _[]byte_,Backup label file content as returned by Postgres in case of online (hot) backups `tablespaceMapFile` _[]byte_,Tablespace map file content as returned by Postgres in case of online (hot) backups `instanceID` :ref:`_InstanceID_ ` ,Information to identify the instance where the backup has been taken from `snapshotBackupStatus` :ref:`_BackupSnapshotStatus_ ` ,Status of the volumeSnapshot backup `method` :ref:`_BackupMethod_ ` ,The backup method being used `online` _bool_,Whether the backup was online/hot (`true`) or offline/cold (`false`) `pluginMetadata` _map[string]string_,A map containing the plugin metadata .. _postgresql-cnpg-io-v1-BackupTarget: BackupTarget ------------ (Alias of ``string`` ) **Appears in:** - :ref:`BackupConfiguration {postgresql-cnpg-io-v1-BackupConfiguration} ` BackupTarget describes the preferred targets for a backup .. _postgresql-cnpg-io-v1-BootstrapConfiguration: BootstrapConfiguration ---------------------- **Appears in:** - :ref:`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. .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `initdb` :ref:`_BootstrapInitDB_ ` ,Bootstrap the cluster via initdb `recovery` :ref:`_BootstrapRecovery_ ` ,Bootstrap the cluster from a backup `pg_basebackup` :ref:`_BootstrapPgBaseBackup_ ` ,Bootstrap the cluster taking a physical backup of another compatible PostgreSQL instance .. _postgresql-cnpg-io-v1-BootstrapInitDB: BootstrapInitDB --------------- **Appears in:** - :ref:`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. .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `database` _string_,Name of the database used by the application. Default: `app`. `owner` _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` `_github.com/cloudnative-pg/machinery/pkg/api.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` _[]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` _bool_,"Whether the `-k` option should be passed to initdb, enabling checksums on data pages (default: `false`)" `encoding` _string_,The value to be passed as option `--encoding` for initdb (default:`UTF8`) `localeCollate` _string_,The value to be passed as option `--lc-collate` for initdb (default:`C`) `localeCType` _string_,The value to be passed as option `--lc-ctype` for initdb (default:`C`) `locale` _string_,Sets the default collation order and character classification in the new database. `localeProvider` _string_,This option sets the locale provider for databases created in the new cluster. Available from PostgreSQL 16. `icuLocale` _string_,Specifies the ICU locale when the ICU provider is used. This option requires `localeProvider` to be set to `icu`. Available from PostgreSQL 15. `icuRules` _string_,Specifies additional collation rules to customize the behavior of the default collation. This option requires `localeProvider` to be set to `icu`. Available from PostgreSQL 16. `builtinLocale` _string_,Specifies the locale name when the builtin provider is used. This option requires `localeProvider` to be set to `builtin`. Available from PostgreSQL 17. `walSegmentSize` _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` _[]string_,List of SQL queries to be executed as a superuser in the `postgres` database right after the cluster has been created- to be used with extreme care (by default empty) `postInitApplicationSQL` _[]string_,List of SQL queries to be executed as a superuser in the application database right after the cluster has been created- to be used with extreme care (by default empty) `postInitTemplateSQL` _[]string_,List of SQL queries to be executed as a superuser in the `template1` database right after the cluster has been created- to be used with extreme care (by default empty) `import` :ref:`_Import_ ` ,Bootstraps the new cluster by importing data from an existing PostgreSQL instance using logical backup (`pg_dump` and `pg_restore`) `postInitApplicationSQLRefs` :ref:`_SQLRefs_ ` ,"List of references to ConfigMaps or Secrets containing SQL files to be executed as a superuser in the application database right after the cluster has been created. The references are processed in a specific order: first, all Secrets are processed, followed by all ConfigMaps. Within each group, the processing order follows the sequence specified in their respective arrays. (by default empty)" `postInitTemplateSQLRefs` :ref:`_SQLRefs_ ` ,"List of references to ConfigMaps or Secrets containing SQL files to be executed as a superuser in the `template1` database right after the cluster has been created. The references are processed in a specific order: first, all Secrets are processed, followed by all ConfigMaps. Within each group, the processing order follows the sequence specified in their respective arrays. (by default empty)" `postInitSQLRefs` :ref:`_SQLRefs_ ` ,"List of references to ConfigMaps or Secrets containing SQL files to be executed as a superuser in the `postgres` database right after the cluster has been created. The references are processed in a specific order: first, all Secrets are processed, followed by all ConfigMaps. Within each group, the processing order follows the sequence specified in their respective arrays. (by default empty)" .. _postgresql-cnpg-io-v1-BootstrapPgBaseBackup: BootstrapPgBaseBackup --------------------- **Appears in:** - :ref:`BootstrapConfiguration {postgresql-cnpg-io-v1-BootstrapConfiguration} ` BootstrapPgBaseBackup contains the configuration required to take a physical backup of an existing PostgreSQL cluster .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `source` **[Required]** _string_,The name of the server of which we need to take a physical backup `database` _string_,Name of the database used by the application. Default: `app`. `owner` _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` `_github.com/cloudnative-pg/machinery/pkg/api.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 .. _postgresql-cnpg-io-v1-BootstrapRecovery: BootstrapRecovery ----------------- **Appears in:** - :ref:`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. .. csv-table:: :header: Field,Description :widths: 15,25 :align: left :class: longtable `backup` :ref:`_BackupSource_ ` ,The backup object containing the physical base backup from which to initiate the recovery procedure. Mutually exclusive with `source` and `volumeSnapshots`. `source` _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` :ref:`_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` :ref:`_RecoveryTarget_