Getting started with Managed Service for OpenSearch

To get started with the service:

1. Create a cluster.
2. Configure security groups.
3. Connect to the cluster.
4. Connect to OpenSearch Dashboards.

Getting startedGetting started

1. Log in to the management console or sign up if you do not have an account yet.

2. If you do not have a folder yet, create one:

   1. In the management console, select the appropriate cloud from the list on the left.

   2. At the top right, click Create folder.

   3. Give your folder a name. The naming requirements are as follows:

      • It must be from 2 to 63 characters long.
      • It may contain lowercase Latin letters, numbers, and hyphens.
      • It must start with a letter and cannot end with a hyphen.

   4. Optionally, specify the description for your folder.

   5. Select Create a default network. This will create a network with subnets in each availability zone. Within this network, you will also have a default security group, inside which all network traffic will be allowed.

   6. Click Create.

3. Assign the vpc.user role and the managed-opensearch.editor role or higher to your Yandex Cloud account. These roles allow you to create a cluster.

   To link the service account to a cluster, e.g., to use Yandex Object Storage, your account also needs the iam.serviceAccounts.user role or higher.

   Note

   If you are unable to manage roles, contact your cloud or organization administrator.

4. You can connect to an OpenSearch cluster both from inside Yandex Cloud and from the internet:

   • To connect from inside Yandex Cloud, create a Linux VM in the same network as the cluster.

   • To connect to a cluster from the internet, request public access to hosts with the DATA role when creating the cluster.

Create a clusterCreate a cluster

1. In the management console, select the folder where you want to create a cluster.

2. Select Managed Service for OpenSearch.

3. Click Create cluster. For more information, see Creating clusters.

4. Set the cluster parameters.

   To gain access to the OpenSearch Dashboards web interface, request public access. To do this, navigate to Virtual node group with the Dashboards group type and select Public access.

   Tip

   You can use OpenSearch Dashboards even if you can't request public access to the hosts (for example, for security reasons). To do this, proxy the connections via the virtual machine in Yandex Compute Cloud that is hosted in the same network as the cluster. For more information, see Connecting to OpenSearch Dashboards.

5. Click Create cluster.

6. Wait until the cluster is ready: its status on the Managed Service for OpenSearch dashboard changes to Creating and then to Alive. This may take some time.

Configure security groupsConfigure security groups

To connect to a cluster, security groups must include rules allowing traffic from certain ports, IP addresses, or from other security groups.

Settings of access policies depend on the connection method you select:

For more information about security groups, see Security groups.

Connect to the clusterConnect to the cluster

It is assumed that all the steps below are performed on Linux.

To connect to a cluster:

1. Install an SSL certificate:

   Linux (Bash)/macOS (Zsh)

   Windows (PowerShell)

   mkdir -p ~/.opensearch && \
   wget "https://storage.yandexcloud.net/cloud-certs/CA.pem" \
        --output-document ~/.opensearch/root.crt && \
   chmod 0600 ~/.opensearch/root.crt
   

   The certificate will be saved to the ~/.opensearch/root.crt file.

   mkdir $HOME\.opensearch; curl.exe -o $HOME\.opensearch\root.crt https://storage.yandexcloud.net/cloud-certs/CA.pem
   

   The certificate will be saved to the $HOME\.opensearch\root.crt file.

   Corporate policies and antivirus software can block the download of certificates. For more information, see FAQ.

2. Connect to the cluster using cURL:

   curl \
       --user admin:<password> \
       --cacert ~/.opensearch/root.crt \
       --request GET 'https://<FQDN_of_the_OpenSearch_host_with_the_DATA_role>:9200/'
   

   To connect, enter admin for username and the password you set when creating the cluster.

   A message like this is displayed if the connection is successful:

   {
     "name" : "....mdb.yandexcloud.net",
     "cluster_name" : "...",
     "cluster_uuid" : "...",
     "version" : {
     "distribution" : "opensearch",
     ...
     },
     "tagline" : "The OpenSearch Project: https://opensearch.org/"
   }
   

Connect to OpenSearch DashboardsConnect to OpenSearch Dashboards

1. In your browser, connect to the OpenSearch Dashboards web interface:

   1. Make sure hosts with the DASHBOARDS role are publicly accessible.

   2. Install the SSL certificate in your browser's trusted root certificate store (instructions for Mozilla Firefox).

   3. On the cluster page in the management console, click OpenSearch Dashboards or go to https://c-<OpenSearch_cluster_ID>.rw.mdb.yandexcloud.net> in your browser.

   4. Enter admin for username and the password you set when creating the cluster.

2. Explore a set of sample data:

   1. On the OpenSearch Dashboards welcome screen, click Add sample data.
   2. Next, click View data for the desired dataset.

Learn more about working with OpenSearch Dashboards in the OpenSearch documentation.

What's nextWhat's next

• Read about service concepts.
• Learn more about creating a cluster and connecting to a cluster.