Install and uninstall OpenSearch

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

Prerequisites

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

• You have installed OAT and logged in as a super administrator or an O&M engineer. For more information, see Install OAT.
• You have added a server to install OpenSearch. For more information, see Add a server.
• You have added an OpenSearch image file.
• The server meets the requirements for installing OpenSearch.

Install OpenSearch

To install OpenSearch, perform the following steps:

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

2. On the Components page, click Create Component in the upper-right corner and choose 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, select the image. If no OpenSearch image is available, 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 on which you want to install OpenSearch.
   CPU	The number of CPU cores available to OpenSearch. Default value: 4.
   Memory	The size of memory available to OpenSearch, in GB. Default value: 16.

   The following table describes the installation parameters. The parameters 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. By default, a random password is used.
   Listening port	The listening port of OpenSearch. Valid values: OPENSEARCH_HTTP_PORT: the port used by OpenSearch for external communication. Default value: 9200. OPENSEARCH_TCP_PORT: the port used for communication between OpenSearch nodes. Default value: 9300. CEREBRO_PORT: the port for cerebro. Default value: 9100. ELASTICSEARCH_EXPORTER_PORT: the port for elasticsearch_exporter. Default value: 9114.

4. After you configure the parameters, click Submit.

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

   After the configurations are submitted, you are redirected to the Components page. On this page, you can find the OpenSearch component and click View Tasks in the Actions column to view the installation progress. You can click the OpenSearch tab to display only OpenSearch components or search for the OpenSearch component in the upper-right corner.

View OpenSearch

After you install an OpenSearch component, you can perform the following steps to view its information on the Components page:

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

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

3. Click the name of the OpenSearch component in the Name column to view information about the component, including the basic configurations, installation settings, and associated services.

   • You need to configure the basic parameters and installation parameters when you install OpenSearch. If you do not configure the installation parameters, the default values are used.

   • When you create an OceanBase Cloud Platform (OCP) instance, you can associate the instance with an OpenSearch component. 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 > Components.

2. Find the OpenSearch component that you want to uninstall and click Uninstall in the Actions column.

   Note

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

3. In the message that appears, click OK.

   Then, OAT displays a message indicating that the component is being uninstalled and creates an uninstallation task. You can click the task ID in the message to view the task progress.

   Note

   If the OpenSearch component is associated with another service, the uninstallation fails.

What to do next

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