Contact UsGet started

Configuring access to Object Storage from an OpenSearch cluster

Written by
Updated at April 27, 2024

Managed Service for OpenSearch supports using Yandex Object Storage as an OpenSearch snapshot repository. This allows you to use Object Storage to store backups. To learn more about snapshot repository, see the OpenSearch documentation.

To access Object Storage bucket data from a cluster:

  1. Connect a service account to a cluster.
  2. Configure access rights.
  3. Connect a snapshot repository.

Connecting a service account to a cluster

  1. When creating or updating a cluster, either select an existing service account or create a new one.

  2. Make sure that this account has the role storage.editor.

Setting up access rights

  1. In the management console, select the folder containing the bucket you need. If there is no such bucket, create one.

  2. Select Object Storage.

  3. Select the Buckets tab.

  4. Set up the bucket ACL:

    1. In the Select a user drop-down list, specify the service account connected to the cluster.
    2. Select the READ and WRITE permissions for the selected service account.
    3. Click Add.
    4. Click Save.

Connecting a snapshot repository

Alert

If a bucket is registered in an OpenSearch cluster as a snapshot repository, do not edit the bucket contents manually as this will disrupt the OpenSearch snapshot mechanism.

  1. Install the repository-s3 plugin.

  2. Connect to the cluster.

  3. Register the bucket as a snapshot repository using the public OpenSearch API:

    PUT --cacert ~/.opensearch/root.crt https://admin:<password>@<OpenSearch_DATA_host_ID>.mdb.yandexcloud.net:9200/_snapshot/<repository_name>

    In the request parameters, specify the bucket associated with the cluster service account:

    curl --request PUT \
     "https://admin:<password>@<OpenSearch_DATA_host_ID>.mdb.yandexcloud.net:9200/_snapshot/<repository_name>" \
     --cacert ~/.opensearch/root.crt \
     --header "Content-Type: application/json" \
     --data '{
       "type": "s3",
       "settings": {
         "endpoint": "storage.yandexcloud.net",
         "bucket": "<bucket_name>"
       }
     }'
Previous
Managing backups
Next
Deleting a cluster