Skip to main content
search

Download & Get Started

OpenSearch v2.19.2

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:

  1. Set up your Docker host environment
    • macOS & Windows: In Docker Preferences > Resources, set RAM to at least 4 GB.
    • Linux: Ensure vm.max_map_count is set to at least 262144 as per the documentation.
  2. 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_PASSWORD environment variable — when configuring the security demo. For more information, see Setting up a demo configuration.
  3. Run docker-compose up
  4. Have a nice coffee while everything is downloading and starting up
  5. Navigate to http://localhost:5601/ for OpenSearch Dashboards
  6. 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.

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

Ingest Tools

OpenSearch is compatible with a variety of ingestion and processing tools including beats, fluentbit and fluentd. The project also maintains specific ingestion tools:

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

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

Drivers

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.

OpenSearch is open source software that uses the Apache License version 2 (ALv2). ALv2 grants you well-understood usage rights; you can use, modify, extend, embed, monetize, resell, and offer OpenSearch as part of your products and services. The source for the entire project is available on GitHub and you’re welcome to build from source for customized deployments. Downloadable artifacts for OpenSearch and OpenSearch Dashboards include plugins and tools, ready for you to use with minimal configuration.

Version: 2.19.2
Release Date: Apr 29, 2025
Release Notes
Version Artifacts

This is a release in the 2.x line. Available release lines:

For artifacts of all components of the project, see our artifacts directory for a complete list or a list just for this version.

Subscribe for updates, event info, and the latest community news

Close Menu