Skip to main content
Version: 1.2

PostgreSQL Backup

Prerequisites

  • PostgreSQL database asset
  • PostgreSQL credentials
  • Storage bucket asset
  • Storage bucket asset credentials

Procedure from web console

  • Navigate to the policy's page: Operations > Policies (or go directly to /home/operations/policies)
  • Click on Create Policy button
  • Select PostgreSQL backup
  • Fill out the PostgreSQL backup policy form with the following information:
    • Policy name: Enter a descriptive name for your backup policy
    • The PostgreSQL asset to backup: Select the PostgreSQL instance from the dropdown
    • The credential name to access PostgreSQL: Select the credential bound to the PostgreSQL asset from the dropdown
    • The database name to backup: Specify the name of the database you want to backup
    • The Bucket asset where backups will be saved: Choose the storage bucket from the dropdown
    • The opts for PostgreSQL backup: Configure additional backup options (optional)
    • The version for PostgreSQL client version: Specify the PostgreSQL client version to use (optional)
    • The credential name to access Bucket: Select the credential bound to the Bucket from the dropdown
    • The path inside the bucket where backup is saved: Define the storage path within the bucket
    • Storage class for backup volume : Select the storage class to use for the temporary volume (optional)
    • Storage size for backup volume: Specify the disk size (e.g., 1Gi, 5Gi) (optional). Default value: 10Gi
    • The backup schedule in Cron format: Set the backup frequency using cron syntax (e.g., 0 2 * * * for daily at 2 AM)
    • Enable GZIP compression: Check this option to compress backups
    • Click Next to continue with the policy configuration
  • Select the target cluster where you want to deploy the policy (optional - if not specified, the policy will be deployed to the default cluster)
  • Review the policy configuration summary
  • Click Create Policy to deploy the PostgreSQL backup policy

Procedure from CLI

Create a YAML file with the policy configuration:

apiVersion: operations.resiliency.io/v1alpha1
kind: Policy
metadata:
name: <policy-name>
namespace: resiliency-system
spec:
templateName: postgresql-backup
params:
- name: postgresql-asset
value: <postgresql-asset-id>
- name: postgresql-database
value: <database-name>
- name: bucket-asset
value: <bucket-asset-id>
- name: postgresql-opts
value: "<backup-options>"
- name: postgresql-version
value: "<client-version>"
- name: bucket-path
value: "<path-in-bucket>"
- name: pvc-storage-class
value: <storage-class-name>
- name: pvc-size
value: "<disk-size-in-Gi>"
- name: schedule
value: "<cron-schedule>"
- name: use-gzip
value: <true|false>
- name: bucket-credential
value: <bucket-credential-name>
- name: postgresql-credential
value: <postgresql-credential-name>
placement:
clusterName: <target-cluster-id>
createNamespace: true
credentialName: <cluster-credential-name>
suspended: false

Apply the policy to the cluster:

kubectl apply -f postgresql-backup-policy.yaml