A Backup resource is a request for a PostgreSQL backup by the user.
5 top-level fields, 2 required · last changed in CloudNativePG v1.27.3
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
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
The cluster to backup
Name of the referent.
The backup method to be used, possible options are `barmanObjectStore`, `volumeSnapshot` or `plugin`. Defaults to: `barmanObjectStore`.
Whether the default type of backup with volume snapshots is online/hot (`true`, default) or offline/cold (`false`) Overrides the default setting specified in the cluster field '.spec.backup.volumeSnapshot.online'
Configuration parameters to control the online/hot backup with volume snapshots Overrides the default settings specified in the cluster '.backup.volumeSnapshot.onlineConfiguration' stanza
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.
If false, the function will return immediately after the backup is completed, without waiting for WAL to be archived. This behavior is only useful with backup software that independently monitors WAL archiving. Otherwise, WAL required to make the backup consistent might be missing and make the backup useless. By default, or when this parameter is true, pg_backup_stop will wait for WAL to be archived when archiving is enabled. On a standby, this means that it will wait only when archive_mode = always. If write activity on the primary is low, it may be useful to run pg_switch_wal on the primary in order to trigger an immediate segment switch.
Configuration parameters passed to the plugin managing this backup
Name is the name of the plugin managing this backup
Parameters are the configuration parameters passed to the backup plugin for this backup
The policy to decide which instance should perform this backup. If empty, it defaults to `cluster.spec.backup.target`. Available options are empty string, `primary` and `prefer-standby`. `primary` to have backups run always on primary instances, `prefer-standby` to have backups run preferably on the most updated standby, if available.
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
The credentials to use to upload data to Azure Blob Storage
The connection string to be used
The key to select
Name of the referent.
Use the Azure AD based authentication without providing explicitly the keys.
The storage account where to upload data
The key to select
Name of the referent.
The storage account key to be used in conjunction with the storage account name
The key to select
Name of the referent.
A shared-access-signature to be used in conjunction with the storage account name
The key to select
Name of the referent.
Use the default Azure authentication flow, which includes DefaultAzureCredential. This allows authentication using environment variables and managed identities.
The ID of the Barman backup
Backup label file content as returned by Postgres in case of online (hot) backups
The Name of the Barman backup
The starting xlog
The starting WAL
The backup command output in case of error
Unused. Retained for compatibility with old versions.
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.
Encryption method required to S3 API
The ending xlog
The ending WAL
EndpointCA store the CA bundle of the barman endpoint. Useful when using self-signed certificates to avoid errors with certificate issuer and barman-cloud-wal-archive.
The key to select
Name of the referent.
Endpoint to be used to upload data to the cloud, overriding the automatic endpoint discovery
The detected error
The credentials to use to upload data to Google Cloud Storage
The secret containing the Google Cloud Storage JSON file with the credentials
The key to select
Name of the referent.
If set to true, will presume that it's running inside a GKE environment, default to false.
Information to identify the instance where the backup has been taken from
The container ID
The pod name
The instance manager session ID. This is a unique identifier generated at instance manager startup and changes on every restart (including container reboots). Used to detect if the instance manager was restarted during long-running operations like backups, which would terminate any running backup process.
The PostgreSQL major version that was running when the backup was taken.
The backup method being used
Whether the backup was online/hot (`true`) or offline/cold (`false`)
The last backup status
A map containing the plugin metadata
The credentials to use to upload data to S3
The reference to the access key id
The key to select
Name of the referent.
Use the role based authentication without providing explicitly the keys.
The reference to the secret containing the region name
The key to select
Name of the referent.
The reference to the secret access key
The key to select
Name of the referent.
The references to the session key
The key to select
Name of the referent.
The server name on S3, the cluster name is used if this parameter is omitted
Status of the volumeSnapshot backup
The elements list, populated with the gathered volume snapshots
Name is the snapshot resource name
TablespaceName is the name of the snapshotted tablespace. Only set when type is PG_TABLESPACE
Type is tho role of the snapshot in the cluster, such as PG_DATA, PG_WAL and PG_TABLESPACE
When the backup was started
When the backup was terminated
Tablespace map file content as returned by Postgres in case of online (hot) backups
Source: postgresql.cnpg.io_backups.yaml
Changes to Backup (postgresql.cnpg.io/v1) in each CloudNativePG version, compared to the version before it.
2 properties have been added
Released · View Backup in v1.27.3
1 property has been added
Released · View Backup in v1.27.1
1 property has been removed
Released · View Backup in v1.27.0
1 property has been added
Released · View Backup in v1.26.2
The description of Backup has changed
Released · View Backup in v1.25.2
The description of Backup has changed
Released · View Backup in v1.24.4
18 properties have changed the description
Released · View Backup in v1.22.2
1 property has been added
18 properties have changed the description
Released · View Backup in v1.22.0
17 properties have changed the description
Released · View Backup in v1.21.4
5 properties have been added
Released · View Backup in v1.21.1
3 properties have been added
Released · View Backup in v1.21.0
3 properties are now required
Released · View Backup in v1.20.3
3 properties are no longer required
1 property has changed the description
Released · View Backup in v1.20.0
3 properties are now required
Released · View Backup in v1.19.5
2 properties have been added
1 property is no longer required
1 property has changed the description
Released · View Backup in v1.19.1
1 property has been removed
1 property is now required
1 property has changed the description
Released · View Backup in v1.19.0
1 property has been added
1 property is no longer required
1 property has changed the description
Released · View Backup in v1.18.3
1 property is no longer required
1 property has changed the description
Released · View Backup in v1.17.5
2 properties have changed the description
Released · View Backup in v1.16.1
2 properties have been added
Released · View Backup in v1.16.0
Backup was first seen on this version of CloudNativePG
Released · View Backup in v1.15.0
No examples of Backup yet. Contribute one on GitHub.
kubespec.dev