Recipes

DatabaseBackup

Continuous + scheduled backup configuration for a dedicated CNPG cluster. Renders `spec.backup.barmanObjectStore` on the Cluster plus a ScheduledBackup resource. Backup is explicit opt-in — nothing renders unless this prop is set.

Component:DatabaseBackup

Props

destinationPathstringRequired

S3 destination path, e.g. 's3://backups/myapp-cnpg'

endpointURLstringRequired

S3 endpoint URL, e.g. 'https://s3.example.com' (RustFS/Scaleway/…)

credentialsSecretstringOptional

Name of an existing Secret holding the S3 credentials with CNPG keys access-key-id and secret-access-key. When omitted, the Platform secrets backend (openbao/vault) provisions <name>-backup-credentials from <path>/<name>-s3-credentials — the backend entry must contain the same kebab-case keys. Without backend or secret this throws.

retentionstringOptional

Retention policy for barman backups (default: '30d')

schedulestringOptional

Cron schedule for the ScheduledBackup (default: '0 3 * * *')

compression'gzip' | 'bzip2' | 'snappy'Optional

Data/WAL compression — values valid for both streams (default: 'gzip')

encryption'AES256' | 'aws:kms'Optional

WAL encryption (default: 'AES256')