S3 Integrator Documentation

,

S3 Integrator documentation

S3 Integrator is an integrator charm for providing S3 credentials to consumer charms which seek to access shared S3 data. Store the credentials centrally in the integrator charm and relate consumer charms as needed.

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

Charmed PostgreSQL VM K8s
Charmed MySQL VM K8s
Charmed MongoDB VM K8s
Charmed Kafka VM K8s

Get started

Deploy the latest s3-integrator release from Charmhub

juju deploy s3-integrator

Deploy your S3 credentials

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

Retrieve the S3 credentials at any point with the following command:

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

Configure s3-integrator with the relevant config parameters for your storage. 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"

Once configured, integrate s3-integrator with the database application. For example:

juju integrate s3-integrator postgresql

Learn more

Project and community

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

Navigation

Level Path Navlink
1 tutorial Tutorial
1 how-to How To
1 reference Reference
2 r-releases Release notes
2 r-actions Actions
2 r-configurations Configurations
2 r-integrations Integrations
1 explanation Explanation

Redirects

Mapping table
Path Location

Should we mention on this landing page that we need one integrator charm per bucket? It’s obvious after reading the deployment commands, but perhaps could be useful upfronting it?