--- title: Charmhub | Deploy S3 Integrator using Charmhub - The Open Operator Collection description: Deploy the latest version of S3 Integrator on any cloud. A provider charm for s3 credentials. url: https://charmhub.io/s3-integrator --- # S3 Integrator [Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical") * [Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical") * [Databases](https://charmhub.io/?filter=databases) Platform: 24.04 22.04 1/stable 562 ``` juju deploy s3-integrator --channel 1/stable ``` [Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications) --- #### Relevant links * [Homepage](https://ubuntu.com/data) * [Contact](mailto:Data Platform Team ) --- #### Contacts ##### Maintainers + [Data Platform Team](mailto:data-platform@lists.launchpad.net) * [Submit a bug](https://github.com/canonical/s3-integrator/issues) --- Share your thoughts on this charm with the community on discourse. [Join the discussion](https://discourse.charmhub.io/) # S3 Integrator documentation **IMPORTANT**: This documentation is for s3-integrator charm from track `1`. For the charm in track `2`, please refer to [s3-integrator track 2 documentation](https://github.com/canonical/object-storage-integrator/blob/main/s3/README.md). S3 Integrator is a charm to store S3 credentials and provide them for consumer charms which seek to access shared S3 data. **IMPORTANT**: The charm supports several tracks (mainly tracks `1` and `2`). The [s3-integrator](https://charmhub.io/s3-integrator?channel=1/stable) charm under the track `1/*` is an evolution of the track `latest/*`. No Juju Secrets here and no S3 bucket auto-creation on request. For the Juju secret-based user-experience, please refer to the [object-storage-integrator](https://github.com/canonical/object-storage-integrator/tree/main/s3) repository, that is published to the [s3-integrator](https://charmhub.io/s3-integrator?channel=2/edge) charm under the track `2/*.` **WARNING**: The `latest/stable` channel is deprecated and it should not be used moving forward. After 26.10, the `latest/stable` channel will be removed, [check entire deprecation details](https://discourse.charmhub.io/t/s3-support-strategy/19078). ## [Deployment](https://charmhub.io/s3-integrator#p-26171-deployment) Deploy the `s3-integrator` charm: ``` juju deploy s3-integrator ``` ## [Configuration](https://charmhub.io/s3-integrator#p-26171-configuration) Configure the relevant connection parameters for your storage by using the [juju config](https://juju.is/docs/juju/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](https://charmhub.io/s3-integrator/configurations). Add your S3 credentials by using the `sync-s3-credentials` action with the [juju run](https://juju.is/docs/juju/juju-run) command: ``` juju run s3-integrator/leader sync-s3-credentials access-key= secret-key= ``` For all available Juju actions, see the [Actions tab](https://charmhub.io/s3-integrator/actions). The mandatory settings for the S3 integrator are the credentials (access-key and secret-key) and bucket. ## [Integration](https://charmhub.io/s3-integrator#p-26171-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](https://juju.is/docs/juju/relation). For information on what other charms support this integration, see the [Integrations tab](https://charmhub.io/s3-integrator/integrations). ## [Retrieve data via Juju actions](https://charmhub.io/s3-integrator#p-26171-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 ``` ## [Limitations](https://charmhub.io/s3-integrator#p-26171-limitations) The tracks `latest` and `1` support one bucket per s3-integrator. Several s3-integrator application should be deployed if requester charm needs several buckets. The track `2` provides a new concept of “creating a bucket as per request”. The requester app can have many requirers integrated to it, while they request several buckets (e.g. B1, B2, B3, etc). The provider will create and provide those buckets to them appropriately. However, to simplify future management (e.g. credentials rotation), we recommend one bucket per s3-integrator (all applications can be deployed to the same Juju Machine). ## [Learn more](https://charmhub.io/s3-integrator#p-26171-learn-more) Refer to the relevant charmed database documentation for more details about how to use them with S3 Integrator: | | | | | --- | --- | --- | | Charmed PostgreSQL | [VM](https://documentation.ubuntu.com/charmed-postgresql/16/how-to/back-up-and-restore/configure-s3-aws/) | [K8s](https://documentation.ubuntu.com/charmed-postgresql-k8s/16/how-to/back-up-and-restore/configure-s3-aws/index.html) | | Charmed MySQL | [VM](https://documentation.ubuntu.com/charmed-mysql/8.4/how-to/back-up-and-restore/configure-s3-aws/) | [K8s](https://documentation.ubuntu.com/charmed-mysql/8.4/how-to/back-up-and-restore/configure-s3-aws/) | | Charmed MongoDB | [VM](https://documentation.ubuntu.com/charmed-mongodb/8/how-to/back-up-and-restore/configure-s3-aws/) | [K8s](https://documentation.ubuntu.com/charmed-mongodb/8/how-to/back-up-and-restore/configure-s3-aws/) | | Charmed Kafka | [VM](https://documentation.ubuntu.com/charmed-kafka/3/how-to/back-up-and-restore/) | [K8s](https://documentation.ubuntu.com/charmed-kafka-k8s/3/how-to/back-up-and-restore/) | ## [Project and community](https://charmhub.io/s3-integrator#p-26171-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](https://ubuntu.com/community/code-of-conduct) * [Join the Discourse forum](https://discourse.charmhub.io/tag/s3) * [Contribute and report bugs](https://github.com/canonical/s3-integrator/issues) --- [Help improve this document in the forum](https://discourse.charmhub.io/t/s3-integrator-track-1-documentation/10947) ([guidelines](https://discourse.charmhub.io/t/how-to-write-docs-our-documentation-guidelines-for-contributors/1245)). Last updated 5 months ago.