You're viewing version 2.13 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Run OpenSearch Dashboards using RPM Package Manager (RPM)

OpenSearch Dashboards is the default visualization tool for data in OpenSearch. It also serves as a user interface for many of the OpenSearch plugins, including security, alerting, Index State Management, SQL, and more.

Install OpenSearch Dashboards from a package

1. Download the RPM package for the desired version directly from the OpenSearch downloads page. The RPM package can be download for both x64 and arm64 architectures.
2. Import the public GPG key. This key verifies that your OpenSearch instance is signed.

    sudo rpm --import https://artifacts.opensearch.org/publickeys/opensearch.pgp
   

3. From the command line interface (CLI), you can install the package with rpm or yum. x64

    # Install the x64 package using yum.
    sudo yum install opensearch-dashboards-2.13.0-linux-x64.rpm
    # Install the x64 package using rpm.
    sudo rpm -ivh opensearch-dashboards-2.13.0-linux-x64.rpm
   

   arm64

    # Install the arm64 package using yum.
    sudo yum install opensearch-dashboards-2.13.0-linux-arm64.rpm
    # Install the arm64 package using rpm.
    sudo rpm -ivh opensearch-dashboards-2.13.0-linux-arm64.rpm
   

4. After the installation succeeds, enable OpenSearch Dashboards as a service.

    sudo systemctl enable opensearch-dashboards
   

5. Start OpenSearch Dashboards.

    sudo systemctl start opensearch-dashboards
   

6. Verify that OpenSearch Dashboards launched correctly.

    sudo systemctl status opensearch-dashboards
   

Install OpenSearch Dashboards from a local YUM repository

YUM, the primary package management tool for Red Hat-based operating systems, allows you to download and install the RPM package from the YUM repository library.

1. Create a local repository file for OpenSearch Dashboards:

   sudo curl -SL https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/2.x/opensearch-dashboards-2.x.repo -o /etc/yum.repos.d/opensearch-dashboards-2.x.repo
   

2. Verify that the repository was created successfully.

    sudo yum repolist
   

3. Clean your YUM cache, to ensure a smooth installation:

   sudo yum clean all
   

4. With the repository file downloaded, list all available versions of OpenSearch-Dashboards:

   sudo yum list opensearch-dashboards --showduplicates
   

5. Choose the version of OpenSearch Dashboards you want to install:
   • Unless otherwise indicated, the highest minor version of OpenSearch installs.

     sudo yum install opensearch-dashboards
     

   • To install a specific version of OpenSearch Dashboards:

     sudo yum install 'opensearch-dashboards-2.13.0'
     

6. During installation, the installer will present you with the GPG key fingerprint. Verify that the information matches the following:

   Fingerprint: c5b7 4989 65ef d1c2 924b a9d5 39d3 1987 9310 d3fc
   

   • If correct, enter yes or y. The OpenSearch installation continues.
7. Once complete, you can run OpenSearch Dashboards.

    sudo systemctl start opensearch-dashboards
   

Upgrade to a newer version

OpenSearch Dashboards instances installed using RPM or YUM can be easily upgraded to a newer version. We recommend using YUM, but you can also choose RPM.

Manual upgrade with RPM

Download the RPM package for the desired upgrade version directly from the OpenSearch Project downloads page.

Navigate to the directory containing the distribution and run the following command:

rpm -Uvh opensearch-dashboards-2.13.0-linux-x64.rpm

YUM

To upgrade to the latest version of OpenSearch Dashboards using YUM, run the following command:

sudo yum update opensearch-dashboards

You can also upgrade to a specific OpenSearch Dashboards version by providing the version number:

 sudo yum update opensearch-dashboards-<version-number>

Automatically restart the service after a package upgrade

The OpenSearch Dashboards RPM package does not currently support automatically restarting the service after a package upgrade.