Install and uninstall OpenSearch

This topic describes how to use OceanBase Admin Toolkit (OAT) to install and uninstall OpenSearch.

Prerequisites

Before you install OpenSearch, make sure that the following conditions are met:

• You have installed OAT and logged on as either a super administrator or an O&M engineer. For more information, see Install OAT.
• You have added a server for installing OpenSearch. For more information, see Add a server.
• You have added the OpenSearch image file.
• Your server meets the installation requirements of OpenSearch.

Install OpenSearch

To install OpenSearch, perform the following steps:

1. In the left-side navigation pane, choose Product Service > Component Management.

2. On the Component Management page, click Create Component in the upper-right corner and then select Create OpenSearch.

3. On the Create OpenSearch page, configure the parameters.

   The following table describes the basic parameters of OpenSearch.

   Parameter	Description
   OpenSearch Image	The Docker image of OpenSearch. If an OpenSearch image of the required version is available in the list, directly select it. If no OpenSearch image of the required version is available in the list, click Manage Image Files in the lower part to upload an image.
   Component Name	The name of the component, which must be unique. Default value: opensearch.
   Server	The IP address of the server where OpenSearch is to be installed.
   CPU	The number of CPU cores on the server available for OpenSearch. Default value: 4C.
   Memory	The size of memory on the server available for OpenSearch. Default value: 16 GB.

   The following table describes the installation parameters, which are optional.

   Parameter	Description
   Data Directory	The installation path of OpenSearch. Default value: /data/opensearch.
   Username	The username of OpenSearch. Default value: admin.
   Password	The password corresponding to the username of OpenSearch. Default value: a random password.
   Listening port	The listening port of OpenSearch. Valid values: OPENSEARCH_HTTP_PORT: optional. The port used by OpenSearch for external communication. Default value: 9200. OPENSEARCH_TCP_PORT: optional. The port used for communication between OpenSearch nodes. Default value: 9300. CEREBRO_PORT: optional. The port for cerebro. Default value: 9100. ELASTICSEARCH_EXPORTER_PORT: optional. The port for elasticsearch_exporter. Default value: 9114.

4. After you configure these parameters, click Submit.

   You can also click Reset to restore to the default configurations.

   After submission, you will be redirected to the Component Management page where you can see the created OpenSearch component. You can click View Tasks in the Actions column to view the creation progress of the current OpenSearch component. You can click the OpenSearch tab to display the OpenSearch component or directly search for OpenSearch in the upper-right corner.

View OpenSearch

After you install OpenSearch, you can perform the following steps to view its information on the Component Management page.

1. In the left-side navigation pane, choose Product Service > Component Management.

2. On the Component Management page, click the OpenSearch tab to display only the OpenSearch component or directly search for OpenSearch in the upper-right corner.

3. Click the name of the target OpenSearch component in the Name column to view its information, including Basic configuration, Installation settings, and Associated Products.

   • Basic parameters and installation parameters are configured during the creation. If you do not configure the installation parameters, the default values take effect.

   • When you install OCP, you can select the OpenSearch component to associate. For more information, see Install, upgrade, and uninstall OCP.

Uninstall OpenSearch

To uninstall OpenSearch, perform the following steps:

1. In the left-side navigation pane, choose Product Service > Product Management.

2. Find the target OpenSearch service and click Uninstall in the Actions column.

   You can also search for the OpenSearch service by name at the top of the page.

3. In the confirmation dialog box that appears, click OK.

   OAT displays a message indicating that the service is being uninstalled. OAT also creates an uninstallation task. In the confirmation dialog box that appears, you can click the task ID to view the task progress.

   Notice

   If the OpenSearch to be uninstalled is associated with another product, the uninstallation will fail.

What to do next

After you install OpenSearch, you can install other OceanBase products.