Skip to content
This repository has been archived by the owner on Aug 13, 2022. It is now read-only.

Latest commit

 

History

History
executable file
·
86 lines (55 loc) · 3.66 KB

index.md

File metadata and controls

executable file
·
86 lines (55 loc) · 3.66 KB
Raw
layout title nav_order redirect_from permalink
default
About
1
/404.html
/

Open Distro Documentation

This site contains the technical documentation for Open Distro, 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{: .btn .btn-purple }

Why use Open Distro?

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

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

Open Distro combines the OSS distributions of Elasticsearch and Kibana with a large number of open source plugins. These plugins fill important feature gaps in the OSS distributions.

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 or a piped processing language 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
Asynchronous Search Run search requests in the background

You can install Elasticsearch plugins individually on existing OSS clusters or use the all-in-one packages for new clusters. Most of these Elasticsearch plugins have corresponding Kibana plugins that provide a convenient, unified user interface.

Get started

Docker {: .label .label-green }

  1. Install and start Docker Desktop.

  2. Run the following commands:

    docker pull amazon/opendistro-for-elasticsearch:{{site.odfe_version}}
docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" amazon/opendistro-for-elasticsearch:{{site.odfe_version}}

  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 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.

Get involved

Open Distro 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 website.

OpenSearch includes certain Apache-licensed Elasticsearch code from Elasticsearch B.V. and other source code. Elasticsearch B.V. is not the source of that other source code. ELASTICSEARCH is a registered trademark of Elasticsearch B.V.