5.7.1 Prerequisites

Use the instructions in this section to run OpenSearch Dashboards as a service on a Linux host, and to start automatically upon rebooting. Ensure that you fulfill these requirements:

  • The OpenSearch Dashboards process should not be running.

    If OpenSearch Dashboards is running, ensure that it is not being used, and then stop the process.

    See Starting and Stopping an OpenSearch Service.

  • The script to install the service must be run by the root user.

  • OpenSearch Dashboards is installed on the Linux server where you run this procedure.

  • The OpenSearch Dashboards and JDK installation folders are located under the DPK base directory; that is:

    • The DPK base directory is referred to in this documentation as BASE_DIR, such as /home/opensearch.

    • The OpenSearch Dashboards installation directory, DASHBOARDS_HOME, is found in BASE_DIR/pt/opensearch-dashboards-3.2.0.

    • The Java installation directory, JAVA_HOME, is found in BASE_DIR/pt/os_jdk21.0.yy, where yy is the JDK version.

  • OpenSearch Dashboards must be run by the user who owns DASHBOARDS_HOME.

    This is due to the fact that the script does not input the user name.

  • You have downloaded and extracted the required OSK DPK for Linux, in a directory referred to as OSK_INSTALL.

Note:

OpenSearch Dashboards as a service is not available for Microsoft Windows.