How to configure S3 storage

This guide shows how to configure the S3 Integrator charm for OpenSearch backups, using either AWS S3 or Ceph RadosGW.

Configure S3 for AWS

Deploy the s3-integrator charm and provide credentials:

juju deploy s3-integrator
juju run s3-integrator/leader sync-s3-credentials \
    access-key=<access-key> secret-key=<secret-key>

Configure the bucket and endpoint:

juju config s3-integrator \
    bucket=<bucket-name> \
    region=<region> \
    endpoint=s3.<region>.amazonaws.com

Note

The endpoint must be specified as s3.<region>.amazonaws.com within the first 24 hours of creating the bucket. For older buckets, s3.amazonaws.com can be used. See this AWS knowledge centre article.

See the s3-integrator configuration reference for all available options.

Configure S3 for Ceph RadosGW

Deploy the s3-integrator charm and provide credentials:

juju deploy s3-integrator
juju run s3-integrator/leader sync-s3-credentials \
    access-key=<access-key> secret-key=<secret-key>

Configure the endpoint and bucket:

juju config s3-integrator \
    endpoint="https://<radosgw-url>" \
    bucket=<bucket-name> \
    path=<path> \
    region=<region> \
    tls-ca-chain="$(base64 -w0 <path-to-rgw-ca.pem>)"

tls-ca-chain is the base64-encoded CA certificate that signed the RadosGW TLS certificate.

Note

Set region to default if no custom region was configured in Ceph. See the RadosGW documentation for details.

Integrate with Charmed OpenSearch

Connect the s3-integrator to OpenSearch:

juju integrate s3-integrator opensearch

Once the integration is established, juju status --relations shows the s3-integrator application active with an s3-credentials relation to opensearch. The OpenSearch application remains active.

Next steps