Try OpenSearch with Docker Compose
The best way to try out OpenSearch is to use Docker Compose. These steps will set up a two node cluster of OpenSearch plus OpenSearch Dashboards:
- Set up your Docker host environment
- macOS & Windows: In Docker Preferences > Resources, set RAM to at least 4 GB.
- Linux: Ensure
vm.max_map_countis set to at least 262144 as per the documentation.
- Download docker-compose.yml into your desired directory
- Note for OpenSearch 2.12 or later:
Fresh installs of 2.12 or later require that you define an admin password — using the
OPENSEARCH_INITIAL_ADMIN_PASSWORDenvironment variable — when configuring the security demo. For more information, see Setting up a demo configuration.
- Note for OpenSearch 2.12 or later:
Fresh installs of 2.12 or later require that you define an admin password — using the
- Run
docker-compose up - Have a nice coffee while everything is downloading and starting up
- Navigate to http://localhost:5601/ for OpenSearch Dashboards
- Login with the default username (
admin) and password (<custom-admin-password>)
OpenSearch
OpenSearch is a distributed search and analytics engine based on Apache Lucene. After adding your data to OpenSearch, you can perform full-text searches on it with all of the features you might expect: search by field, search multiple indices, boost fields, rank results by score, sort results by field, and aggregate results.
Install from FreeBSD packages:
# pkg install opensearch
Install from FreeBSD packages:
# pkg install opensearch
Install from Arch Linux packages:
# pacman -S opensearch
View on Docker Hub Docker Hub
docker pull opensearchproject/opensearch:2.17.0View on Amazon ECR Amazon ECR
docker pull public.ecr.aws/opensearchproject/opensearch:2.17.0View on Docker Hub Docker Hub
docker pull opensearchproject/opensearch:2.17.0View on Amazon ECR Amazon ECR
docker pull public.ecr.aws/opensearchproject/opensearch:2.17.0OpenSearch Dashboards
OpenSearch Dashboards is the default visualization tool for data in OpenSearch. It also serves as a user interface for many of the OpenSearch plugins, including security, alerting, Index State Management, SQL, and more.
Install from FreeBSD packages:
# pkg install opensearch-dashboards
Install from FreeBSD packages:
# pkg install opensearch-dashboards
Install from Arch Linux packages:
# pacman -S opensearch-dashboards
View on Docker Hub Docker Hub
docker pull opensearchproject/opensearch-dashboards:2.17.0View on Amazon ECR Amazon ECR
docker pull public.ecr.aws/opensearchproject/opensearch-dashboards:2.17.0View on Docker Hub Docker Hub
docker pull opensearchproject/opensearch-dashboards:2.17.0View on Amazon ECR Amazon ECR
docker pull public.ecr.aws/opensearchproject/opensearch-dashboards:2.17.0Ingest Tools
OpenSearch is compatible with a variety of ingestion and processing tools including beats, fluentbit and fluentd. The project also maintains specific ingestion tools:
Data Prepper
Data Prepper is a component of the OpenSearch project that accepts, filters, transforms, enriches, and routes data at scale. Distributions without a bundled JDK are also available in the artifacts directory.
View on Docker Hub Docker Hub
docker pull opensearchproject/data-prepper:2.10.2View on Amazon ECR Amazon ECR
docker pull public.ecr.aws/opensearchproject/data-prepper:2.10.2Logstash OSS with OpenSearch Output Plugin
This package includes open source Logstash bundled with the OpenSearch output plugin (v2.0.1). The output plugin is compatible with OpenSearch and Open Source versions of Elasticsearch (7.10.2 or lower). The output plugin is also available as a Ruby Gem.
View on Docker Hub
docker pull opensearchproject/logstash-oss-with-opensearch-output-plugin:8.9.0View on Amazon ECR
docker pull public.ecr.aws/opensearchproject/logstash-oss-with-opensearch-output-plugin:8.9.0View on Docker Hub
docker pull opensearchproject/logstash-oss-with-opensearch-output-plugin:8.9.0View on Amazon ECR
docker pull public.ecr.aws/opensearchproject/logstash-oss-with-opensearch-output-plugin:8.9.0Command Line Tools
The OpenSearch command line interface (opensearch-cli) lets you manage your cluster from the command line and automate tasks.
OpenSearch SQL CLI
The SQL CLI component in OpenSearch is a stand-alone Python application and can be launched by a 'wake' word opensearchsql.
It only supports OpenSearch SQL Plugin. You must have the OpenSearch SQL plugin installed in your OpenSearch instance to connect. Users can run this CLI from Linux or Windows, and they can connect to any valid OpenSearch endpoint, such as Amazon OpenSearch Service.
Please visit PyPI for more details.
View on PyPI Command To Install
pip install opensearchsqlDrivers
OpenSearch provides SQL drivers like ODBC and JDBC that let you integrate OpenSearch with business intelligence software and other tools.
ODBC Driver
The Open Database Connectivity (ODBC) driver is a read-only ODBC driver for Windows and macOS that lets you connect business intelligence (BI) and data visualization applications like Tableau, Microsoft Excel, and Power BI to the SQL plugin.
JDBC Driver
The Java Database Connectivity (JDBC) driver is a read-only driver for connecting business intelligence and data visualization applications with OpenSearch using SQL.
Minimal Distributions
The following distributions include the bare minimum features required for a functioning OpenSearch and OpenSearch Dashboards. It is intended for those who already have custom plugins or are intending to integrate/embed OpenSearch with other services.
If you are an end user, you probably do not want these distributions.
OpenSearch Minimum
This distribution lacks important security features and should be only used in carefully controlled environments.
OpenSearch Dashboards Minimum
This distribution lacks important security features and should be only used in carefully controlled environments.
For artifacts of all components of the project, see our artifacts directory for a complete list or a list just for this version.
Releases in the 2.x line:
2.18.0 / 2.17.1 / 2.17.0 / 2.16.0 / 2.15.0 / 2.14.0 / 2.13.0 / 2.12.0 / 2.11.1 / 2.11.0 / 2.10.0 / 2.9.0 / 2.8.0 / 2.7.0 / 2.6.0 / 2.5.0 / 2.4.1 / 2.4.0 / 2.3.0 / 2.2.1 / 2.2.0 / 2.1.0 / 2.0.1 / 2.0.0 / 2.0.0-rc1
Release sequence (all release lines):
Next Release Previous Release