Self-host OpenSearch with Levelrail

A single node OpenSearch search and analytics engine with the security plugin on, a persistent volume, a generated admin password and a 512 MB Java heap. The API speaks HTTPS with a self signed certificate and is not published on the host, so reach it from other services in this project at opensearch:9200.

How to self-host OpenSearch

  1. Pull the images

    One image is pulled on your server.

    Show images
    • opensearchproject/opensearch:3.3.0
  2. Create the app

    One service starts in a single Compose app, with 1 named volume mount for your data, on port 9200.

  3. Fill in the secrets

    1 secret is generated and stored encrypted, 3 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

After the first start

  • Read the generated admin password from the app secrets, then call the API over HTTPS as the admin user from a service in the same project.

OpenSearch requirements

Memory
About 1.5 GiB
Architectures
amd64 unknown, arm64 unknown
Ports
9200
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
Apache-2.0, permissive license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then OpenSearch. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the OpenSearch docs page.

Deploy OpenSearch your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy OpenSearch from the CLI

levelrail-cli templates deploy opensearch --name my-opensearch

Deploy OpenSearch with the API

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/opensearch/deploy

OpenSearch configuration

OpenSearch services

ServiceImagePortsVolumes
opensearch opensearchproject/opensearch:3.3.0 9200 opensearch_data -> /usr/share/opensearch/data

OpenSearch environment variables

VariableServiceValue
OPENSEARCH_INITIAL_ADMIN_PASSWORD opensearch Generated at deploy
OPENSEARCH_JAVA_OPTS opensearch Preset by the template
bootstrap.memory_lock opensearch Preset by the template
discovery.type opensearch Preset by the template

Ports and volumes

Ports
9200
Volumes
1 named mount: opensearch_data -> /usr/share/opensearch/data

OpenSearch FAQ

How much memory does OpenSearch need?

The catalog lists about 1.5 GiB of memory for OpenSearch.

Does OpenSearch run on arm64?

For OpenSearch, arm64 support is not confirmed; amd64 is unknown.

What licence is OpenSearch under?

OpenSearch is licensed under Apache-2.0, which is permissive, with few conditions on reuse.

Does OpenSearch need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which ports does OpenSearch use?

OpenSearch listens on port 9200 inside the stack.

Where does OpenSearch keep its data?

In a named volume: opensearch_data mounted at /usr/share/opensearch/data.

Can I deploy OpenSearch on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for OpenSearch, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image opensearchproject/opensearch:3.3.0 is what you deploy there.

levelrail-cli templates deploy opensearch --name my-opensearch