Sending notifications via email in Yandex Managed Service for OpenSearch

You can set up email notifications using the Notifications plugin in Managed Service for OpenSearch. Do this by creating a notification channel in the OpenSearch Dashboards web interface, configuring the SMTP sender, and specifying the recipients. You need to add the sender's password to your OpenSearch keystore.

To set up email notifications, follow these steps:

1. Set up your infrastructure.
2. Create a sender.
3. Add authentication data to the OpenSearch keystore.
4. Update cluster settings.
5. Create a recipient group.
6. Create a notification channel.
7. Send a test email.

If you no longer need the resources you created, delete them.

Getting startedGetting started

Sign up for Yandex Cloud and create a billing account:

1. Navigate to the management console and log in to Yandex Cloud or create a new account.
2. On the Yandex Cloud Billing page, make sure you have a billing account linked and it has the ACTIVE or TRIAL_ACTIVE status. If you do not have a billing account, create one and link a cloud to it.

If you have an active billing account, you can create or select a folder for your infrastructure on the cloud page.

Learn more about clouds and folders here.

Required paid resourcesRequired paid resources

• Managed Service for OpenSearch cluster, which includes the use of computing resources and storage size (see Managed Service for OpenSearch pricing).
• Public IP addresses if public access is enabled for cluster hosts (see Virtual Private Cloud pricing).

Set up your infrastructureSet up your infrastructure

1. Create a Managed Service for OpenSearch cluster with public access to the Dashboards and OpenSearch host groups.

2. Configure the Managed Service for OpenSearch cluster security groups as follows:

   1. Create rules to access the Dashboards and OpenSearch host groups over the internet.
   2. Create an outbound rule that allows TCP connections to port 465 or another port that will be used to send email notifications.

Create a senderCreate a sender

1. Connect to OpenSearch Dashboards.

2. In the top-left corner of OpenSearch Dashboards, click and under Management, select Notifications.

3. In the left-hand panel, select Email senders.

4. Click Create SMTP sender.

5. In the Sender name field, specify my_sender.

6. In the Email address field, enter the email address from which notifications will be sent.

7. Fill out the Host and Port fields.

   You must allow outbound traffic for the specified port in the cluster security groups.

8. In the Encryption method field, select the encryption method supported by the sender's SMTP server.

9. Click Create.

Add authentication data to the OpenSearch keystoreAdd authentication data to the OpenSearch keystore

yc managed-opensearch cluster update <cluster_name_or_ID> \
  --set-keystore-settings opensearch.notifications.core.email.my_sender.username=<sender's_email> \
  --set-keystore-settings opensearch.notifications.core.email.my_sender.password=<password>

After adding the keys, update the secure cluster settings.

Update cluster settingsUpdate cluster settings

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.

   Warning

   Certificate upload may be restricted by corporate policies or antivirus software.

2. Update the secure cluster settings:

   Linux (Bash)/macOS (Zsh)

   Windows (PowerShell)

   curl \
     --user admin:<password>
     --cacert ~/.opensearch/root.crt \
     -X POST 'https://<host_FQDN_with_DATA_role>:9200/_nodes/reload_secure_settings'
   

   curl `
     -Certificate $HOME\.opensearch\root.crt `
     -Uri https://<host_FQDN_with_DATA_role>:9200/_nodes/reload_secure_settings `
     -Method Post `
     -Credential admin
   

   For more information on getting a host FQDN, see FQDNs of OpenSearch hosts.

Create a recipient groupCreate a recipient group

1. In the top-left corner of OpenSearch Dashboards, click and under Management, select Notifications.
2. In the left-hand panel, select Email recipient groups.
3. Click Create recipient group.
4. In the Name field, enter my_recipient_group.
5. In the Emails field, select or enter the email addresses you want to add to the notification recipient group.
6. Click Create.

Create a notification channelCreate a notification channel

1. In the top-left corner of OpenSearch Dashboards, click and under Management, select Notifications.
2. Click Create channel.
3. In the Name field, enter my_channel.
4. In the Channel type field, select Email.
5. In the Sender type field, select SMTP sender.
6. In the SMTP sender field, select my_sender.
7. In the Default recipients field, select my_recipient_group.
8. Click Create.

Send a test emailSend a test email

1. In the top-left corner of OpenSearch Dashboards, click and under Management, select Notifications.
2. In the channel list, click my_channel.
3. In the Actions menu, select Send test message.

Delete the resources you createdDelete the resources you created

Some resources are not free of charge. Delete the resources you no longer need to avoid paying for them:

Delete the Managed Service for OpenSearch cluster.