| layout | title | nav_order | redirect_from | permalink |
|---|---|---|---|---|
default |
Get started |
1 |
/404.html |
/ |
This site contains the technical documentation for OpenSearch, the Apache 2.0-licensed search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more.
Get started{: .btn .btn-blue }
OpenSearch is well-suited to the following use cases:
- Log analytics
- Real-time application monitoring
- Clickstream analytics
- Search backend
| Component | Purpose |
|---|---|
| OpenSearch | Data store and search engine |
| OpenSearch Dashboards | 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 |
Most of OpenSearch plugins have a corresponding OpenSearch Dashboards plugin that provide a convenient, unified user interface.
For specifics around the project, see the FAQ.
Docker {: .label .label-green }
-
Install and start Docker Desktop.
-
Run the following commands:
docker pull opensearchproject/opensearch:{{site.opensearch_version}} docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" opensearchproject/opensearch:{{site.opensearch_version}} -
In a new terminal session, run:
curl -XGET --insecure https://localhost:9200 -u admin:admin
To learn more, see Install and configure OpenSearch and Install and configure OpenSearch Dashboards.
OpenSearch includes a demo configuration so that you can get up and running quickly, but before using OpenSearch in a production environment, you must configure the security plugin manually: your own certificates, your own authentication method, your own users, and your own passwords.
See opensearch.org/docs/javadocs/.
OpenSearch 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 Contributing on the OpenSearch website.