DDEV OpenSearch

Overview

OpenSearch is a community-driven, Apache 2.0-licensed open source search and analytics suite that makes it easy to ingest, search, visualize, and analyze data.

This add-on sets up two services in your DDEV project:

• OpenSearch service (Docker image: opensearchproject/opensearch:latest)
• OpenSearch Dashboards service (Docker image: opensearchproject/opensearch-dashboards:latest)

We activate these OpenSearch plugins out-of-the-box:

• analysis-icu
• analysis-phonetic

Installation

ddev add-on get ddev/ddev-opensearch
ddev restart

After installation, make sure to commit the .ddev directory to version control.

Usage

Command	Description
ddev launch :9201	Open OpenSearch in your browser
ddev launch :5602	Open OpenSearch Dashboards in your browser
ddev describe	View service status and used ports for OpenSearch
ddev logs -s opensearch	View OpenSearch logs
ddev logs -s opensearch-dashboards	View OpenSearch Dashboards logs

Advanced Customization

To upgrade or downgrade:

# remove old opensearch volume (if this is downgrade)
ddev stop
docker volume rm ddev-$(ddev status -j | docker run -i --rm ddev/ddev-utilities jq -r '.raw.name')_opensearch

# set the desired versions for OpenSearch
ddev dotenv set .ddev/.env.opensearch --opensearch-tag="2" --opensearch-dashboards-tag="2"
ddev add-on get ddev/ddev-opensearch
ddev restart

Make sure to commit the .ddev/.env.opensearch file to version control.

To change the installed plugins:

# https://opensearch.org/docs/latest/install-and-configure/additional-plugins/index/
ddev dotenv set .ddev/.env.opensearch --opensearch-plugins="analysis-icu analysis-phonetic"
ddev add-on get ddev/ddev-opensearch
# rebuild opensearch image
ddev debug rebuild -s opensearch

Make sure to commit the .ddev/.env.opensearch file to version control.

All customization options (use with caution):

Variable	Flag	Default
OPENSEARCH_PLUGINS	--opensearch-plugins	analysis-icu analysis-phonetic
OPENSEARCH_TAG	--opensearch-tag	latest
OPENSEARCH_DASHBOARDS_TAG	--opensearch-dashboards-tag	latest

Credits

Contributed and maintained by @cmuench from @netz98 org

Co-maintained by the DDEV team