Performing administrative actions on Amazon OpenSearch Service domains - Amazon OpenSearch Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Performing administrative actions on Amazon OpenSearch Service domains

Amazon OpenSearch Service offers several administrative options that provide granular control if you need to troubleshoot issues with your domain. These options include the ability to restart the OpenSearch process on a data node and the ability to restart a data node.

OpenSearch Service monitors node health parameters and, when there are anomalies, takes corrective actions to keep domains stable. With the administrative options to restart the OpenSearch process on a node, and restart a node itself, you have control over some of these mitigation actions.

You can use the Amazon Web Services Management Console, Amazon CLI, or the Amazon SDK to perform these actions. The following sections cover how to perform these actions with the console.

Restart the OpenSearch process on a node

To restart the OpenSearch process on a node
  1. Navigate to the OpenSearch Service console at https://console.aws.amazon.com/aos/.

  2. In the left navigation pane, choose Domains. Choose the name of the domain that you want to work with.

  3. After the domain details page opens, navigate to the Instance health tab.

  4. Under Data nodes, select the button next to the node that you want to restart the process on.

  5. Select the Actions dropdown and choose Restart OpenSearch/Elasticsearch process.

  6. Choose Confirm on the modal.

  7. To see the status of the action that you initiated, select the name of the node. After the node details page opens, choose the Events tab under the name of the node to see a list of events associated with that node.

Reboot a data node

To reboot a data node
  1. Navigate to the OpenSearch Service console at https://console.aws.amazon.com/aos/.

  2. In the left navigation pane, choose Domains. Choose the name of the domain that you want to work with.

  3. After the domain details page opens, navigate to the Instance health tab.

  4. Under Data nodes, select the button next to the node that you want to restart the process on.

  5. Select the Actions dropdown and choose Reboot node.

  6. Choose Confirm on the modal.

  7. To see the status of the action that you initiated, select the name of the node. After the node details page opens, choose the Events tab under the name of the node to see a list of events associated with that node.

Restart the Dashboard or Kibana process on a node

To restart the Dashboard or Kibana process on a node
  1. Navigate to the OpenSearch Service console at https://console.aws.amazon.com/aos/.

  2. In the left navigation pane, choose Domains. Choose the name of the domain that you want to work with.

  3. After the domain details page opens, navigate to the Instance health tab.

  4. Under Data nodes, select the button next to the node that you want to restart the process on.

  5. Select the Actions dropdown and choose Restart Dashboard/Kibana process.

  6. Choose Confirm on the modal.

  7. To see the status of the action that you initiated, select the name of the node. After the node details page opens, choose the Events tab under the name of the node to see a list of events associated with that node.

Limitations

Administrative options have the following limitations:

  • Administrative options are supported on Elasticsearch versions 7.x and higher.

  • Administrative options don't support domains with Multi-AZ with Standby enabled.

  • The OpenSearch and Elasticsearch process restart is supported on domains with three or more data nodes.

  • The Dashboards and Kibana process support is supported on domains with two or more data nodes.

  • To restart the OpenSearch process on a node or reboot a node, the domain must not be in red state and all indexes must have replicas configured.