Getting Started & Downloads

Ready to get started?

I want to...

Try Open Distro for Elasticsearch

Learn how to try out Open Distro for Elasticsearch

Install Open Distro for Elasticsearch for production

Get the required binaries to install the Open Distro for Elasticsearch in a production environment

Develop with Open Distro for Elasticsearch

All you need to start developing on Open Distro for Elasticsearch

Get tools to help run, tune, and connect to Open Distro for Elasticsearch

Download and install tools from the Open Distro project.

Ingest data to Open Distro for Elasticsearch

Tools that ease ingestion and processing of various data into Open Distro For Elasticsearch

Find out what’s included in an installation of Open Distro for Elasticsearch

Learn about the components included in our downloads

Get a list of all the Open Distro for Elasticsearch downloads

Everything we build as part of the Open Distro for Elasticsearch project

Try Open Distro for Elasticsearch

The best way to try out Open Distro for Elasticsearch is to use Docker Compose. These steps will setup a two node cluster of Elasticsearch plus Kibana:

  1. Download docker-compose.yml into your desired directory
  2. Run docker-compose up
  3. Have a nice coffee while everything is downloading and starting up
  4. Navigate to http://localhost:5601/ for Kibana
  5. Login with the default username (admin) and password (admin)

For further details about using Open Distro on Docker, see our documentation.

You can also find the standalone docker images on Docker Hub:
version: '3'
services:
  odfe-node1:
    image: amazon/opendistro-for-elasticsearch:1.13.2
    container_name: odfe-node1
    environment:
      - cluster.name=odfe-cluster
      - node.name=odfe-node1
      - discovery.seed_hosts=odfe-node1,odfe-node2
      - cluster.initial_master_nodes=odfe-node1,odfe-node2
      - bootstrap.memory_lock=true # along with the memlock settings below, disables swapping
      - "ES_JAVA_OPTS=-Xms512m -Xmx512m" # minimum and maximum Java heap size, recommend setting both to 50% of system RAM
    ulimits:
      memlock:
        soft: -1
        hard: -1
      nofile:
        soft: 65536 # maximum number of open files for the Elasticsearch user, set to at least 65536 on modern systems
        hard: 65536
    volumes:
      - odfe-data1:/usr/share/elasticsearch/data
    ports:
      - 9200:9200
      - 9600:9600 # required for Performance Analyzer
    networks:
      - odfe-net
  odfe-node2:
    image: amazon/opendistro-for-elasticsearch:1.13.2
    container_name: odfe-node2
    environment:
      - cluster.name=odfe-cluster
      - node.name=odfe-node2
      - discovery.seed_hosts=odfe-node1,odfe-node2
      - cluster.initial_master_nodes=odfe-node1,odfe-node2
      - bootstrap.memory_lock=true
      - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
    ulimits:
      memlock:
        soft: -1
        hard: -1
      nofile:
        soft: 65536
        hard: 65536
    volumes:
      - odfe-data2:/usr/share/elasticsearch/data
    networks:
      - odfe-net
  kibana:
    image: amazon/opendistro-for-elasticsearch-kibana:1.13.2
    container_name: odfe-kibana
    ports:
      - 5601:5601
    expose:
      - "5601"
    environment:
      ELASTICSEARCH_URL: https://odfe-node1:9200
      ELASTICSEARCH_HOSTS: https://odfe-node1:9200
    networks:
      - odfe-net

volumes:
  odfe-data1:
  odfe-data2:

networks:
  odfe-net:

Install Open Distro for Elasticsearch for production

For production we recommend using Docker or a package manager.

Develop with Open Distro for Elasticsearch

If you want to run Open Distro for Elasticsearch in a non-production environment, these artifacts are a great place to start. On a Mac, we suggest using Docker.

Get tools to help run, tune, and connect to Open Distro for Elasticsearch

These tools are not packed in with Open Distro for Elasticsearch but are designed to specifically work with the distribution.

Drivers

Open Distro for Elasticsearch has a built in REST API that can run Query DSL, SQL and PPL queries, but you can also connect with any ODBC or JDBC compatible tool.

Command line management / odfe-cli

Parts of Open Distro for Elasticsearch can be managed from the command line directly using odfe-cli. Current Version: 1.1.0

Performance Monitoring / PerfTop

Open Distro ships with Performance Analyzer that helps you understand the cluster performance dynamics. PerfTop allows you to get a command-line visual dashboard of cluster performance metrics based on these data.

Ingest data to Open Distro for Elasticsearch

Open Distro for Elasticsearch is compatible with a variety of ingestion and processing tools including beats, logstash, fluentbit and fluentd. The project also maintains specific ingestion tools:

Data Prepper

Data Prepper is an beta component of Open Distro for Elasticsearch that receives trace data from the OpenTelemetry collector, and aggregates, transforms, and normalizes it for analysis and visualization in Kibana.

Also available on Docker. A version without the bundled JDK is in the full downloads list

Trace Analytics Demo

The best way to try trace analytics with Data Prepper is to use Docker Compose.

  1. Git clone the Data Prepper github project: git clone https://github.com/opendistro-for-elasticsearch/Data-Prepper.git

  2. Change to example trace-analytics-sample-app directory: cd Data-Prepper/examples/trace-analytics-sample-app

  3. Launch Docker Compose: docker-compose up -d

  4. Access the sample application: Point your browser at http://localhost:8089/

From here you can follow the instructions on the Introduction to Trace Analytics announcement blog post.

Find out what’s included in an installation of Open Distro for Elasticsearch

Open Distro for Elasticsearch is made up of two primary components - Elasticsearch and Kibana. Each component consists of the core binaries plus plugins, everything licensed under Apache 2.0. We also provide previous releases and standalone plugins.

Latest: 1.13.2 / Date: April 07, 2021 / Release Notes

Get a list of all the Open Distro for Elasticsearch downloads

A comprehensive list of all artifacts associated with the Open Distro for Elasticsearch project.

Open Distro for Elasticsearch is open source software and licensed under Apache 2.0