Skip to main content

Overview

This repository provides OpenSearch runnables for local dev or small clusters. You can:
  • Run a single-node OpenSearch + Dashboards quickly
  • Inherit the runnable in your stack and wire services via connections
  • Scale to a simple two-node demo with dashboards

What’s included

  • Runnable opensearch/single-node exposing ports 9200 (HTTP) and 9600 (REST)
  • Optional OpenSearch Dashboards runnables
  • Persistent data volume at ${monk-volume-path}/opensearch
  • Tunable environment via variables (image, cluster name, security, Java opts)

Quick start (single-node)

OpenSearch API: http://localhost:9200 Dashboards (optional):

Configuration

Key variables in opensearch.yaml:
Note: when running the base runnable directly, these values come from the template. To keep secrets out of YAML, prefer inheriting and referencing Monk secrets.

Inherit and connect from your app

Then run your group:

Ports

  • 9200/tcp: OpenSearch HTTP
  • 9600/tcp: REST API
  • 5601/tcp: Dashboards (if enabled)

Persistence

Data is stored at ${monk-volume-path}/opensearch:/usr/share/opensearch/data.

Troubleshooting

  • If security plugin is enabled, ensure OPENSEARCH_INITIAL_ADMIN_PASSWORD is set and meets complexity rules.
  • For multi-node demos, verify discovery.seed_hosts and cluster.initial_cluster_manager_nodes match connection hostnames.