Link Search Menu Expand Document

This documentation remains in a beta state. It has content gaps and might contain bugs.


The tarball installation provides a self-contained directory with everything you need to run OpenSearch, including an integrated Java Development Kit (JDK). The tarball is a good option for testing and development.

The tarball supports most Linux distributions, including CentOS 7, Amazon Linux 2, and Ubuntu 18.04. If you have your own Java installation and set JAVA_HOME in the terminal, macOS works, as well.

  1. Download the tarball from the OpenSearch downloads page.

  2. Extract the TAR file to a directory and change to that directory:

    # x64
    tar -zxf opensearch-1.0.0-rc1-linux-x64.tar.gz
    cd opensearch-1.0.0-rc1
  3. Run OpenSearch:

  4. Open a second terminal session, and send requests to the server to verify that OpenSearch is up and running:

    curl -XGET https://localhost:9200 -u 'admin:admin' --insecure
    curl -XGET https://localhost:9200/_cat/plugins?v -u 'admin:admin' --insecure


You can modify config/opensearch.yml or specify environment variables as arguments using -E:

./ -Ediscovery.type=single-node

For other settings, see Important settings.

(Optional) Set up Performance Analyzer

In a tarball installation, Performance Analyzer collects data when it is enabled. But in order to read that data using the REST API on port 9600, you must first manually launch the associated reader agent process:

  1. Make Performance Analyzer accessible outside of the host machine

    cd /usr/share/opensearch # navigate to the OpenSearch home directory
    cd plugins/opensearch_performance_analyzer/pa_config/

    Uncomment the line #webservice-bind-host and set it to

    # ======================== OpenSearch performance analyzer plugin config =========================
    # NOTE: this is an example for Linux. Please modify the config accordingly if you are using it under other OS.
    # WebService bind host; default to all interfaces
    webservice-bind-host =
    # Metrics data location
    metrics-location = /dev/shm/performanceanalyzer/
    # Metrics deletion interval (minutes) for metrics data.
    # Interval should be between 1 to 60.
    metrics-deletion-interval = 1
    # If set to true, the system cleans up the files behind it. So at any point, we should expect only 2
    # metrics-db-file-prefix-path files. If set to false, no files are cleaned up. This can be useful, if you are archiving
    # the files and wouldn't like for them to be cleaned up.
    cleanup-metrics-db-files = true
    # WebService exposed by App's port
    webservice-listener-port = 9600
    # Metric DB File Prefix Path location
    metrics-db-file-prefix-path = /tmp/metricsdb_
    https-enabled = false
    #Setup the correct path for certificates
    certificate-file-path = specify_path
    private-key-file-path = specify_path
    # Plugin Stats Metadata file name, expected to be in the same location
    plugin-stats-metadata = plugin-stats-metadata
    # Agent Stats Metadata file name, expected to be in the same location
    agent-stats-metadata = agent-stats-metadata
  2. Make the CLI executable:

    sudo chmod +x ./bin/performance-analyzer-agent-cli
  3. Launch the agent CLI:

    ES_HOME="$PWD" ./bin/performance-analyzer-agent-cli
  4. In a separate window, enable the Performance Analyzer plugin:

    curl -XPOST localhost:9200/_plugins/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}'

    If you receive the curl: (52) Empty reply from server error, you are likely protecting your cluster with the security plugin and you need to provide credentials. Modify the following command to use your username and password:

    curl -XPOST https://localhost:9200/_plugins/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k
  5. Finally, enable the Root Cause Analyzer (RCA) framework

    curl -XPOST localhost:9200/_plugins/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}'

    Similar to step 4, if you run into curl: (52) Empty reply from server, run the command below to enable RCA

    curl -XPOST https://localhost:9200/_plugins/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k