Skip to main content

OpenSearch

Selecting the Configuration Type​

To specify the configuration type, select one of the tiles displayed on the page. In this case, choose the OpenSearch tile.

Important!

Once saved, the configuration type cannot be changed.

Filling in Connection Information​

The subsequent configuration details should be entered in the "Enter Configuration Information" section. Fields marked with a red asterisk are mandatory. If any field contains invalid data, the configuration will not be saved, and an error message will appear next to the field with the issue. Follow these steps to provide the connection information:

  1. Enter the configuration name in the field labeled "Configuration Name". Only Latin letters or numbers in CamelCase format are allowed.
  2. Enter the OpenSearch server URL in the "Server URL" field. Valid formats include http://my_opensearch_server.
  3. Enter the connection port in the "Port" field. Only numeric values are allowed.
  4. If the cluster where OpenSearch is deployed has Search Anywhere installed, activate the "SA is installed on the cluster" field.
  5. If your connection requires SSL validation, enable the "SSL Validation" option. This will display a warning about saving data to the keystore:

Keystore Warning for OpenSearch

After that, you can enable host name verification and specify the path to the trust store in the "Trust Store Path" field. Valid formats include /my_path/to/trust-store/.

  1. Select the authentication type. If Basic authentication is chosen, you must also provide a username in the "Username" field. Enabling this mode will display a warning about saving the following data to the keystore:

Keystore Warning for OpenSearch (Basic Authentication)

If Api Key authentication is chosen, a similar warning will appear about saving the following data to the keystore:

Keystore Warning for OpenSearch (API Key)

  1. To test the connection, click the "Test Connection" button. If the connection to OpenSearch is successful, the following message will appear:

Successful Connection

If the connection fails, an error message will be displayed:

Connection Error

Note

The example shows a sample error message. The actual error may vary.

Configurations can be saved even if connection errors occur. However, configurations with invalid data formats or empty mandatory fields will not be saved.

Editing Configuration Features​

Configurations can be edited using the same rules as when they are created. You can edit fields in any order necessary to adjust the configuration settings.