Link Search Menu Expand Document

Open Distro for Elasticsearch Documentation

This site contains the technical documentation for Open Distro for Elasticsearch, the community-driven, 100% open source distribution of Elasticsearch with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more.

Get started


Why use Open Distro for Elasticsearch?

Open Distro for Elasticsearch is well-suited to the following use cases:

  • Log analytics
  • Real-time application monitoring
  • Clickstream analytics
  • Search backend

Compared to the open source distribution of Elasticsearch, Open Distro for Elasticsearch offers many extra features:

Component Purpose
Elasticsearch Data store and search engine
Kibana Search frontend and visualizations
Security Authentication and access control for your cluster
Alerting Receive notifications when your data meets certain conditions
SQL Use SQL to query your data
Index State Management Automate index operations
KNN Find “nearest neighbors” in your vector data
Performance Analyzer Monitor and optimize your cluster
Anomaly Detection Identify atypical data and receive automatic notifications

Get started

Docker

  1. Install and start Docker Desktop.
  2. Run the following commands:

    docker pull amazon/opendistro-for-elasticsearch:1.11.0
    docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" amazon/opendistro-for-elasticsearch:1.11.0
    
  3. In a new terminal session, run:

    curl -XGET --insecure https://localhost:9200 -u admin:admin
    

To learn more, see Install.


Builds

If you want to modify the Open Distro for Elasticsearch code and build from source, instructions are in elasticsearch/README.md and kibana/README.md of the opendistro-build repository. Likewise, you can find build instructions for the various plugins in their individual repositories. If your changes could benefit others, please consider submitting a pull request.


About Open Distro for Elasticsearch

Open Distro for Elasticsearch is supported by Amazon Web Services. All components are available under the Apache License, Version 2.0 on GitHub.

The project welcomes GitHub issues, bug fixes, features, plugins, documentation—anything at all. To get involved, see Contribute on the Open Distro for Elasticsearch website.