bitnami-containers/bitnami/opensearch

Bitnami package for OpenSearch

What is OpenSearch?

OpenSearch is a scalable open-source solution for search, analytics, and observability. Features full-text queries, natural language processing, custom dictionaries, amongst others.

Overview of OpenSearch Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

docker run --name opensearch bitnami/opensearch:latest

Docker Compose

curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/opensearch/docker-compose.yml > docker-compose.yml
docker-compose up -d

You can find the available configuration options in the Environment Variables section.

Why use Bitnami Images?

• Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
• With Bitnami images the latest bug fixes and features are available as soon as possible.
• Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
• All our images are based on minideb -a minimalist Debian based container image that gives you a small base container image and the familiarity of a leading Linux distribution- or scratch -an explicitly empty image-.
• All Bitnami images available in Docker Hub are signed with Docker Content Trust (DCT). You can use DOCKER_CONTENT_TRUST=1 to verify the integrity of the images.
• Bitnami container images are released on a regular basis with the latest distribution packages available.

Looking to use OpenSearch in production? Try VMware Tanzu Application Catalog, the enterprise edition of Bitnami Application Catalog.

How to deploy OpenSearch in Kubernetes?

Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami OpenSearch Chart GitHub repository.

Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Why use a non-root container?

Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.

Supported tags and respective Dockerfile links

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.

You can see the equivalence between the different tags by taking a look at the tags-info.yaml file present in the branch folder, i.e bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml.

Subscribe to project updates by watching the bitnami/containers GitHub repo.

Get this image

The recommended way to get the Bitnami OpenSearch Docker Image is to pull the prebuilt image from the Docker Hub Registry.

docker pull bitnami/opensearch:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.

docker pull bitnami/opensearch:[TAG]

If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build command. Remember to replace the APP, VERSION and OPERATING-SYSTEM path placeholders in the example command below with the correct values.

git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .

Persisting your application

If you remove the container all your data will be lost, and the next time you run the image the application will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a directory at the /bitnami path. If the mounted directory is empty, it will be initialized on the first run.

docker run \
    -v /path/to/opensearch-data-persistence:/bitnami/opensearch/data \
    bitnami/opensearch:latest

or by making a minor change to the docker-compose.yml file present in this repository:

opensearch:
  ...
  volumes:
    - /path/to/opensearch-data-persistence:/bitnami/opensearch/data
  ...

NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID 1001.

It is also possible to use multiple volumes for data persistence by using the OPENSEARCH_DATA_DIR_LIST environment variable:

opensearch:
  ...
  volumes:
    - /path/to/opensearch-data-persistence-1:/opensearch/data-1
    - /path/to/opensearch-data-persistence-2:/opensearch/data-2
  environment:
    - OPENSEARCH_DATA_DIR_LIST=/opensearch/data-1,/opensearch/data-2
  ...

Connecting to other containers

Using Docker container networking, an OpenSearch server running inside a container can easily be accessed by your application containers.

Containers attached to the same network can communicate with each other using the container name as the hostname.

Using the Command Line

Step 1: Create a network

docker network create app-tier --driver bridge

Step 2: Launch the OpenSearch server instance

Use the --network app-tier argument to the docker run command to attach the OpenSearch container to the app-tier network.

docker run -d --name opensearch-server \
    --network app-tier \
    bitnami/opensearch:latest

Step 3: Launch your application container

docker run -d --name myapp \
    --network app-tier \
    YOUR_APPLICATION_IMAGE

IMPORTANT:

1. Please update the YOUR_APPLICATION_IMAGE_ placeholder in the above snippet with your application image
2. In your application container, use the hostname opensearch-server to connect to the OpenSearch server

Using a Docker Compose file

When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new bridge network named app-tier. In this example we assume that you want to connect to the OpenSearch server from your own custom application image which is identified in the following snippet by the service name myapp.

version: '2'

networks:
  app-tier:
    driver: bridge

services:
  opensearch:
    image: 'bitnami/opensearch:latest'
    networks:
      - app-tier
  myapp:
    image: 'YOUR_APPLICATION_IMAGE'
    networks:
      - app-tier

IMPORTANT:

1. Please update the YOUR_APPLICATION_IMAGE_ placeholder in the above snippet with your application image
2. In your application container, use the hostname opensearch to connect to the OpenSearch server

Launch the containers using:

docker-compose up -d

Configuration

Environment variables

When you start the opensearch image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the docker run command line. If you want to add a new environment variable:

• For Docker Compose, add the variable name and value under the application section:

opensearch:
  ...
  environment:
    - OPENSEARCH_PORT_NUMBER=9201
  ...

• For manual execution add a -e option with each variable and value:

 $ docker run -d --name opensearch \
    -p 9201:9201 --network=opensearch_network \
    -e OPENSEARCH_PORT_NUMBER=9201 \
    -v /path/to/opensearch-data-persistence:/bitnami/opensearch/data \
    bitnami/opensearch

Available variables:

• BITNAMI_DEBUG: Increase verbosity on initialization logs. Default false
• OPENSEARCH_EXTRA_FLAGS: Extra command-line arguments for the opensearch daemon
• OPENSEARCH_CLUSTER_NAME: The OpenSearch Cluster Name. Default: opensearch-cluster
• OPENSEARCH_CLUSTER_HOSTS: List of opensearch hosts to set the cluster. Available separators are ' ', ',' and ';'. No defaults.
• OPENSEARCH_CLUSTER_MASTER_HOSTS: List of opensearch master-eligible hosts. Available separators are ' ', ',' and ';'. If no values are provided, it will have the same value as OPENSEARCH_CLUSTER_HOSTS.
• OPENSEARCH_IS_DEDICATED_NODE: OpenSearch node to behave as a 'dedicated node'. Default: no
• OPENSEARCH_NODE_TYPE: OpenSearch node type when behaving as a 'dedicated node'. Valid values: master, data, coordinating or ingest.
• OPENSEARCH_NODE_NAME: OpenSearch node name. No defaults.
• OPENSEARCH_BIND_ADDRESS: Address/interface to bind by OpenSearch. Default: 0.0.0.0
• OPENSEARCH_PORT_NUMBER: OpenSearch port. Default: 9200
• OPENSEARCH_NODE_PORT_NUMBER: OpenSearch Node to Node port. Default: 9300
• OPENSEARCH_PLUGINS: Comma, semi-colon or space separated list of plugins to install at initialization. No defaults.
• OPENSEARCH_KEYS: Comma, semi-colon or space separated list of key-value pairs (key=value) to store. No defaults.
• OPENSEARCH_HEAP_SIZE: Memory used for the Xmx and Xms java heap values. Default: 1024m
• OPENSEARCH_FS_SNAPSHOT_REPO_PATH: OpenSearch file system snapshot repository path. No defaults.
• OPENSEARCH_DATA_DIR_LIST: Comma, semi-colon or space separated list of directories to use for data storage. No defaults.

Setting up a cluster

A cluster can easily be setup with the Bitnami OpenSearch Docker Image using the following environment variables:

• OPENSEARCH_CLUSTER_NAME: The OpenSearch Cluster Name. Default: opensearch-cluster
• OPENSEARCH_CLUSTER_HOSTS: List of opensearch hosts to set the cluster. Available separators are ' ', ',' and ';'. No defaults.
• OPENSEARCH_CLIENT_NODE: OpenSearch node to behave as a 'smart router' for Kibana app. Default: false
• OPENSEARCH_NODE_NAME: OpenSearch node name. No defaults.
• OPENSEARCH_MINIMUM_MASTER_NODES: Minimum OpenSearch master nodes for a quorum. No defaults.

For larger cluster, you can setup 'dedicated nodes' using the following environment variables:

• OPENSEARCH_IS_DEDICATED_NODE: OpenSearch node to behave as a 'dedicated node'. Default: no
• OPENSEARCH_NODE_TYPE: OpenSearch node type when behaving as a 'dedicated node'. Valid values: master, data, coordinating or ingest.
• OPENSEARCH_CLUSTER_MASTER_HOSTS: List of opensearch master-eligible hosts. Available separators are ' ', ',' and ';'. If no values are provided, it will have the same value as OPENSEARCH_CLUSTER_HOSTS.

Find more information about 'dedicated nodes' in the official documentation.

Step 1: Create a new network

docker network create opensearch_network

Step 2: Create the first node

docker run --name opensearch-node1 \
  --net=opensearch_network \
  -p 9200:9200 \
  -e OPENSEARCH_CLUSTER_NAME=opensearch-cluster \
  -e OPENSEARCH_CLUSTER_HOSTS=opensearch-node1,opensearch-node2 \
  -e OPENSEARCH_NODE_NAME=elastic-node1 \
  bitnami/opensearch:latest

In the above command the container is added to a cluster named opensearch-cluster using the OPENSEARCH_CLUSTER_NAME. The OPENSEARCH_CLUSTER_HOSTS parameter set the name of the nodes that set the cluster so we will need to launch other container for the second node. Finally the OPENSEARCH_NODE_NAME parameter allows to indicate a known name for the node, otherwise opensearch will generate a random one.

Step 3: Create a second node

docker run --name opensearch-node2 \
  --link opensearch-node1:opensearch-node1 \
  --net=opensearch_network \
  -e OPENSEARCH_CLUSTER_NAME=opensearch-cluster \
  -e OPENSEARCH_CLUSTER_HOSTS=opensearch-node1,opensearch-node2 \
  -e OPENSEARCH_NODE_NAME=elastic-node2 \
  bitnami/opensearch:latest

In the above command a new opensearch node is being added to the opensearch cluster indicated by OPENSEARCH_CLUSTER_NAME.

You now have a two node OpenSearch cluster up and running which can be scaled by adding/removing nodes.

With Docker Compose the cluster configuration can be setup using:

version: '2'
services:
  opensearch-node1:
    image: bitnami/opensearch:latest
    environment:
      - OPENSEARCH_CLUSTER_NAME=opensearch-cluster
      - OPENSEARCH_CLUSTER_HOSTS=opensearch-node1,opensearch-node2
      - OPENSEARCH_NODE_NAME=elastic-node1

  opensearch-node2:
    image: bitnami/opensearch:latest
    environment:
      - OPENSEARCH_CLUSTER_NAME=opensearch-cluster
      - OPENSEARCH_CLUSTER_HOSTS=opensearch-node1,opensearch-node2
      - OPENSEARCH_NODE_NAME=elastic-node2

Configuration file

In order to use a custom configuration file instead of the default one provided out of the box, you can create a file named opensearch.yml and mount it at /opt/bitnami/opensearch/config/opensearch.yml to overwrite the default configuration:

docker run -d --name opensearch \
    -p 9201:9201 \
    -v /path/to/opensearch.yml:/opt/bitnami/opensearch/config/opensearch.yml \
    -v /path/to/opensearch-data-persistence:/bitnami/opensearch/data \
    bitnami/opensearch:latest

or by changing the docker-compose.yml file present in this repository:

opensearch:
  ...
  volumes:
    - /path/to/opensearch.yml:/opt/bitnami/opensearch/config/opensearch.yml
    - /path/to/opensearch-data-persistence:/bitnami/opensearch/data
  ...

Please, note that the whole configuration file will be replaced by the provided, default one; ensure that the syntax and fields you provide are properly set and exhaustive.

If you would rather extend than replace the default configuration with your settings, mount your custom configuration file at /opt/bitnami/opensearch/config/my_opensearch.yml.

Plugins

The Bitnami OpenSearch Docker image comes with the S3 Repository plugin installed by default.

You can add extra plugins by setting the OPENSEARCH_PLUGINS environment variable. To specify multiple plugins, separate them by spaces, commas or semicolons. When the container is initialized it will install all of the specified plugins before starting OpenSearch.

docker run -d --name opensearch \
    -e OPENSEARCH_PLUGINS=analysis-icu \
    bitnami/opensearch:latest

The Bitnami OpenSearch Docker image will also install plugin .zip files mounted at the /bitnami/opensearch/plugins directory inside the container, making it possible to install them from disk without requiring Internet access.

Adding plugins at build time (persisting plugins)

The Bitnami OpenSearch image provides a way to create your custom image installing plugins on build time. This is the preferred way to persist plugins when using Opensearch, as they will not be installed every time the container is started but just once at build time.

To create your own image providing plugins execute the following command. Remember to replace the VERSION and OPERATING-SYSTEM path placeholders in the example command below with the correct values.

git clone https://github.com/bitnami/containers.git
cd bitnami/opensearch/VERSION/OPERATING-SYSTEM
docker build --build-arg OPENSEARCH_PLUGINS=<plugin1,plugin2,...> -t bitnami/opensearch:latest .

The command above will build the image providing this GitHub repository as build context, and will pass the list of plugins to install to the build logic.

Initializing a new instance

When the container is executed for the first time, it will execute the files with extension .sh located at /docker-entrypoint-initdb.d.

In order to have your custom files inside the Docker image, you can mount them as a volume.

Logging

The Bitnami OpenSearch Docker image sends the container logs to the stdout. To view the logs:

docker logs opensearch

or using Docker Compose:

docker-compose logs opensearch

You can configure the containers logging driver using the --log-driver option if you wish to consume the container logs differently. In the default configuration docker uses the json-file driver.

Additionally, in case you'd like to modify OpenSearch logging configuration, it can be done by overwriting the file /opt/bitnami/opensearch/config/log4j2.properties. The syntax of this file can be found in OpenSearch logging documentation.

Maintenance

Upgrade this image

Bitnami provides up-to-date versions of OpenSearch, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.

Step 1: Get the updated image

docker pull bitnami/opensearch:latest

or if you're using Docker Compose, update the value of the image property to bitnami/opensearch:latest.

Step 2: Stop and backup the currently running container

Stop the currently running container using the command

docker stop opensearch

or using Docker Compose:

docker-compose stop opensearch

Next, take a snapshot of the persistent volume /path/to/opensearch-data-persistence using:

rsync -a /path/to/opensearch-data-persistence /path/to/opensearch-data-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)

You can use this snapshot to restore the application state should the upgrade fail.

Step 3: Remove the currently running container

docker rm -v opensearch

or using Docker Compose:

docker-compose rm -v opensearch

Step 4: Run the new image

Re-create your container from the new image, restoring your backup if necessary.

docker run --name opensearch bitnami/opensearch:latest

or using Docker Compose:

docker-compose up opensearch

Contributing

We'd love for you to contribute to this Docker image. You can request new features by creating an [issue], or submitting a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:

• Host OS and version
• Docker version (docker version)
• Output of docker info
• Version of this container
• The command you used to run the container, and any relevant output you saw (masking any sensitive information)

License

Copyright © 2023 Bitnami

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.