Configure S3 for AWS

A Charmed PostgreSQL backup can be stored on any S3-compatible storage. S3 access and configurations are managed with the s3-integrator charm .

This guide will teach you how to deploy and configure the s3-integrator charm for AWS S3 , send the configurations to the Charmed PostgreSQL application, and update it.

See also: Configure S3 for RadosGW.

pgBackRest limitations

The backup tool pgBackRest can only interact with S3-compatible storage if they work with SSL/TLS .

Backup via the plain HTTP is currently not supported.

Set up s3-integrator

Deploy and configure the s3-integrator charm for AWS S3:

juju deploy s3-integrator --channel=1/stable
juju run s3-integrator/leader sync-s3-credentials access-key=<access-key-here> secret-key=<secret-key-here>

juju config s3-integrator \
    endpoint="https://s3.us-west-2.amazonaws.com" \
    bucket="postgresql-test-bucket-1" \
    path="/postgresql-test" \
    region="us-west-2"

We recommend using the 1/stable channel of the S3 integrator charm.

The latest version of the S3 integrator charm is in 2/stable, and adds support for Juju secrets.

The PostgreSQL charm is not yet using the latest version of the S3 integrator library, so we recommend using 1/stable for guaranteed compatibility.

There is an experimental configuration option that sets up a retention time (in days) for backups stored in S3: experimental-delete-older-than-days .

See: Manage backup retention.

The S3 endpoint must be specified as s3.<region>.amazonaws.com within the first 24 hours of creating the bucket.

For older buckets, the endpoint s3.amazonaws.com can be used.

See this post in the AWS forum for more information.

Integrate with Charmed PostgreSQL

To pass these configurations to Charmed PostgreSQL, integrate the two applications:

VM

juju integrate s3-integrator postgresql

K8s

juju integrate s3-integrator postgresql-k8s

You can create, list, and restore backups now:

VM

juju run postgresql/leader list-backups
juju run postgresql/leader create-backup
juju run postgresql/leader list-backups
juju run postgresql/leader restore backup-id=<backup-id>

K8s

juju run postgresql-k8s/leader list-backups
juju run postgresql-k8s/leader create-backup
juju run postgresql-k8s/leader list-backups
juju run postgresql-k8s/leader restore backup-id=<backup-id>

You can also update your S3 configuration options after relating:

juju config s3-integrator <option>=<value>

See the s3-integrator charm on Charmhub for a list of all its configuration parameters.