Skip to main content

Create and manage custom repositories in Aiven for OpenSearch® Limited availability

Configure custom repositories in Aiven for OpenSearch to store snapshots in your cloud storage.

Prerequisites

Limitations

You can configure custom repositories for the following object storage services:

  • Amazon S3
  • Google Cloud Storage (GCS)
  • Microsoft Azure Blob Storage

Create custom repositories

Each repository requires a unique name, a storage type (such as S3, Azure, or GCS), and the appropriate settings for the selected storage provider.

  1. Log in to the Aiven Console, go to your project, and open your service's page.
  2. Click Snapshots in the sidebar.
  3. On the Snapshots page, click Add repository.
  4. In the Add custom repository window:
    1. Enter a repository name.
    2. Select a storage provider.
    3. Give provider-specific details required for accessing the storage.
    4. Click Add.

List custom repositories

  1. Log in to the Aiven Console, go to your project, and open your service's page.
  2. Click Snapshots in the sidebar.

Find your custom repositories listed on the Snapshots page.

View or edit repository details

  1. Log in to the Aiven Console, go to your project, and open your service's page.
  2. Click Snapshots in the sidebar.
  3. On the Snapshots page, find your custom repository and click Actions > Edit repository.
  4. Edit repository details and save your changes by clicking Update.

Remove a repository

  1. Log in to the Aiven Console, go to your project, and open your service's page.
  2. Click Snapshots in the sidebar.
  3. On the Snapshots page, find your custom repository and click Actions > Remove repository > Remove.

Error handling

The Aiven API returns OpenSearch errors as they are.

Exceptions:

  • 502: OpenSearch did not respond.
  • 409: The service is not powered on or does not support this feature.

Related pages

OpenSearch snapshot API reference.