Link Search Menu Expand Document Documentation Menu
Documentation

Installing OpenSearch Dashboards using 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.

Prerequisites

Install OpenSearch. For more information, see Installing OpenSearch using RPM.

Install OpenSearch Dashboards from a package

  1. Download the RPM Package Manager (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-release.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-3.9.0-linux-x64.rpm

    Install the x64 package using rpm:

     sudo rpm -ivh opensearch-dashboards-3.9.0-linux-x64.rpm

    arm64

    Install the arm64 package using yum:

     sudo yum install opensearch-dashboards-3.9.0-linux-arm64.rpm

    Install the arm64 package using rpm:

     sudo rpm -ivh opensearch-dashboards-3.9.0-linux-arm64.rpm

    For new installations of OpenSearch Dashboards 3.7 and later, you can disable the Security Dashboards plugin by adding the DISABLE_SECURITY_DASHBOARDS_PLUGIN=true environment variable before the installation command with the env keyword:

     sudo env DISABLE_SECURITY_DASHBOARDS_PLUGIN=true rpm -ivh opensearch-dashboards-3.9.0-linux-x64.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

  7. In a web browser, go to http://localhost:5601 and log in as the admin user using the custom admin password that you set when you installed OpenSearch. If OpenSearch Dashboards runs on a remote host, replace localhost with the IP address or DNS name of that host. For more information, see Accessing 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/3.x/opensearch-dashboards-3.x.repo -o /etc/yum.repos.d/opensearch-dashboards-3.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-3.9.0'

  6. The first time YUM downloads the repository metadata (for example, when you list the available versions) and again during installation, YUM prompts you to import the GPG key and presents the key fingerprint. Verify that the information matches the following: 
    Fingerprint: A8B2 D9E0 4CD5 1FEF 6AA2 DB53 BA81 D999 8119 1457
    • If correct, enter yes or y. The OpenSearch installation continues.
  7. Start OpenSearch Dashboards: 
     sudo systemctl start opensearch-dashboards

  8. In a web browser, go to http://localhost:5601 and log in as the admin user using the custom admin password that you set when you installed OpenSearch. If OpenSearch Dashboards runs on a remote host, replace localhost with the IP address or DNS name of that host. For more information, see Accessing 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.

Upgrade manually using 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:

sudo rpm -Uvh opensearch-dashboards-3.9.0-linux-x64.rpm

Upgrade using 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 support automatically restarting the service after a package upgrade. The upgrade stops OpenSearch Dashboards, so start the service after the upgrade completes:

sudo systemctl start opensearch-dashboards

350 characters left

Have a question? .

Want to contribute? or .