S3 Integrator documentation

S3 Integrator is a charm to store S3 credentials and provide them for consumer charms which seek to access shared S3 data.

Deployment

Deploy the s3-integrator charm:

juju deploy s3-integrator

Configuration

Configure the relevant connection parameters for your storage by using the juju config command. For example:

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

For all available configuration parameters, see the Configurations tab.

Add your S3 credentials by using the sync-s3-credentials action with the juju run command:

juju run s3-integrator/leader sync-s3-credentials access-key=<your_key> secret-key=<your_secret_key>

For all available Juju actions, see the Actions tab.

The mandatory settings for the S3 integrator are the credentials (access-key and secret-key) and bucket.

Integration

Once configured, integrate the S3 integrator charm with a consumer charm. For example:

juju integrate s3-integrator postgresql

Now you can use S3 credentials via juju integration. For information on what other charms support this integration, see the Integrations tab.

Retrieve data via Juju actions

To retrieve S3 credentials:

juju run s3-integrator/leader get-s3-credentials

To retrieve connection parameters:

juju run s3-integrator/leader get-s3-connection-info

Learn more

Refer to the relevant charmed database documentation for more details about how to use them with S3 Integrator:

Project and community

S3 Integrator is an open-source project that welcomes community contributions, suggestions, fixes and constructive feedback. For more information:

• Read our Code of Conduct
• Join the Discourse forum
• Contribute and report bugs