This topic contains property reference tables for the resources that you create for performing backup and restore.

PostgresBackupLocation Resource
PostgresBackupSchedule Resource
PostgresBackup Resource
PostgresRestore Resource

For information about backup and restore, see Backing Up and Restoring.

PostgresBackupLocation Resource

The table below explains the properties that can be set for the PostgresBackupLocation resource.

Property Type Default Description
metadata.name
(Required)
String n/a The name of the PostgresBackupLocation. Must be unique within a namespace.
Example:backuplocation-sample
spec.storage.s3.bucket
(Required)
String n/a The name of an existing S3-compatible bucket for this backup location.
Example:s3-bucket-sample
spec.storage.s3.bucketPath
(Optional)
String n/a The name of the path where backup artifacts will be uploaded. If a folder in the path does not already exist, it is created automatically. The trailing slash in the path is required.
Example:s3-sample-path/sample-subpath/
spec.storage.s3.region
(Optional)
String us-east-1 The geographic region of the bucket. Some non-AWS S3 implementations do not require this value.
Example:us-west-1
spec.storage.s3.endpoint
(Optional)
String https://
BUCKET-NAME
.s3.REGION
.amazonaws.com/
The endpoint URL for the configured S3-compatible provider. Leave blank for AWS S3.
Example:http://minio.default:9000
spec.storage.s3.forcePathStyle
(Optional)
boolean false true forces the use of path-style S3 URLs for compatibility. May be required for some non-AWS S3 providers.
false uses virtual hosted-style S3 URLs.
Path-style URLs look like the following: https://bucket-endpoint.example.com/bucket Virtual hosted-style URLs look like the following: https://bucket.bucket-endpoint.example.com For information about AWS S3 Path Deprecation, see the AWS blog site.
Example:false
spec.storage.s3.enableSSL
(Optional)
boolean true true enables SSL for S3 server validation
false disables SSL

Example:false
spec.storage.s3.secret.name
(Required)
String n/a The name of the Kubernetes secret that contains the credentials for connecting to S3.
Example:backuplocation-sample-creds

Backup Secret

The table below explains the properties that can be set in the secret for the PostgresBackupLocation resource.

Property Type Default Description
metadata.name
(Required)
String n/a The name of the Secret. Must match spec.storage.s3.secret.name in a BackupLocation. Must be unique within a namespace.
Example:backuplocation-sample-creds
stringData.accessKeyId
(Required)
String n/a The Access Key ID for an AWS IAM user that has permissions to read/write from the S3 bucket.
Example:AKIAIOSFODNN7EXAMPLE
stringData.secretAccessKey
(Required)
String n/a The Secret Access Key for an AWS IAM user that has permissions to read/write from the S3 bucket
Example:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

PostgresBackupSchedule Resource

The table below explains the properties that can be set for the PostgresBackupSchedule resource.

Property Type Default Description
metadata.name
(Required)
String n/a The name of the PostgresBackupSchedule. Must be unique within a namespace.
Example:backupschedule-sample
spec.backupTemplate.spec.sourceInstance.name
(Required)
String n/a The name of the Postgres instance on which you want scheduled backups for. Must be in the same namespace as the PostgresBackupSchedule.
Example:postgres-sample
spec.backupTemplate.spec.sourceInstance.type
(Optional)
String full The type of the Postgres Backup you want to take at a scheduled interval.
Example:full,incremental, or differential
spec.schedule
(Required)
String (cron schedule) n/a The cron schedule for backups. Must be a valid cron schedule.
Example:"0 23 * * 6" (every Saturday at 11PM)
status.message
(Optional)
String n/a Success/failure status message for PostgresBackupSchedule
Example:Instance my-2-postgres does not exist in the namespace default

PostgresBackup Resource

The table below explains the properties that can be set for the PostgresBackup resource.

Property Type Default Description
metadata.name
(Required)
String n/a The name of the PostgresBackup. Must be unique within a namespace.
Example:backup-sample
spec.location.name
(Required)
String n/a The name of the PostgresBackupLocation that represents the blobstore where the backup will be uploaded. Must be in the same namespace as the Postgres instance.
Example:backuplocation-sample
spec.sourceInstance.name
(Required)
String n/a The name of the Postgres instance on which you want to perform the on-demand backup.
Example:my-instance
spec.sourceInstance.type
(Optional)
String full The type of the Postgres Backup you want to take.
Example:full,incremental, or differential

PostgresRestore Resource

The table below explains the properties that can be set for the PostgresRestore resource.

Property Type Default Description
metadata.name
(Required)
String n/a The name of the PostgresRestore. Must be unique within a namespace.
Example:restore-sample
spec.sourceBackup.name
(Required)
String n/a The name of the PostgresBackup that represents the backup artifact to restore. Must be in the same namespace as the PostgresRestore.
Example:backup-sample
spec.targetInstance.name
(Required)
String n/a The name of the target instance where the sourceBackup should be restored. In case of in-place restore, this should be the source instance where the sourceBackup was taken
Example:my-target-instance
check-circle-line exclamation-circle-line close-line
Scroll to top icon