Add Zipkin support of OpenSearch storage (add Docker images) (#3766)

Add Zipkin support of OpenSearch storage (add Docker images) as dicussed
#3765 (comment)

---------

Signed-off-by: Andriy Redko <drreta@gmail.com>

.dockerignore

@@ -24,6 +24,9 @@
 !docker/test-images/zipkin-elasticsearch8/config/
 !docker/test-images/zipkin-elasticsearch8/start-elasticsearch
 
+!docker/test-images/zipkin-opensearch2/config/
+!docker/test-images/zipkin-opensearch2/start-opensearch
+
 !docker/test-images/zipkin-eureka/src/
 !docker/test-images/zipkin-eureka/pom.xml
 !docker/test-images/zipkin-eureka/start-eureka

.github/workflows/test_readme.yml

@@ -158,6 +158,13 @@ jobs:
         env:
           DOCKER_TAG: openzipkin/zipkin-elasticsearch8:test
           DOCKER_FILE: docker/test-images/zipkin-elasticsearch8/Dockerfile
+      - name: docker/test-images/zipkin-opensearch2/README.md
+        run: |
+          build-bin/docker/docker_build ${DOCKER_TAG} &&
+          build-bin/docker/docker_test_image ${DOCKER_TAG}
+        env:
+          DOCKER_TAG: openzipkin/zipkin-opensearch2:test
+          DOCKER_FILE: docker/test-images/zipkin-opensearch2/Dockerfile
       - name: docker/test-images/zipkin-eureka/README.md
         run: |
           build-bin/docker/docker_build openzipkin/zipkin-eureka:test &&

docker/README.md

@@ -18,6 +18,7 @@ base layer `openzipkin/zipkin`, and setting up schema where relevant.
 * [ghcr.io/openzipkin/zipkin-cassandra](test-images/zipkin-cassandra/README.md) - runs Cassandra initialized with Zipkin's schema
 * [ghcr.io/openzipkin/zipkin-elasticsearch7](test-images/zipkin-elasticsearch7/README.md) - runs Elasticsearch 7.x
 * [ghcr.io/openzipkin/zipkin-elasticsearch8](test-images/zipkin-elasticsearch8/README.md) - runs Elasticsearch 8.x
+* [ghcr.io/openzipkin/zipkin-opensearch2](test-images/zipkin-opensearch2/README.md) - runs OpenSearch 2.x
 * [ghcr.io/openzipkin/zipkin-eureka](test-images/zipkin-eureka/README.md) - runs Eureka
 * [ghcr.io/openzipkin/zipkin-kafka](test-images/zipkin-kafka/README.md) - runs both Kafka+ZooKeeper
 * [ghcr.io/openzipkin/zipkin-mysql](test-images/zipkin-mysql/README.md) - runs MySQL initialized with Zipkin's schema

docker/test-images/zipkin-opensearch2/Dockerfile

@@ -0,0 +1,70 @@
+#
+# Copyright The OpenZipkin Authors
+# SPDX-License-Identifier: Apache-2.0
+#
+
+# java_version is used for install and runtime layers of zipkin-opensearch2
+#
+# Use latest version here: https://github.com/orgs/openzipkin/packages/container/package/java
+# This is defined in many places because Docker has no "env" script functionality unless you use
+# docker-compose: When updating, update everywhere.
+ARG java_version=21.0.2_p13
+
+# We copy files from the context into a scratch container first to avoid a problem where docker and
+# docker-compose don't share layer hashes https://github.com/docker/compose/issues/883 normally.
+# COPY --from= works around the issue.
+FROM scratch as scratch
+
+COPY build-bin/docker/docker-healthcheck /docker-bin/
+COPY docker/test-images/zipkin-opensearch2/start-opensearch /docker-bin/
+COPY docker/test-images/zipkin-opensearch2/config/ /config/
+
+FROM ghcr.io/openzipkin/java:${java_version} as install
+
+WORKDIR /install
+
+# Use latest 2.x version from https://opensearch.org/downloads.html
+# This is defined in many places because Docker has no "env" script functionality unless you use
+# docker-compose: When updating, update everywhere.
+ARG opensearch2_version=2.13.0
+
+# Download only the OSS distribution (lacks X-Pack)
+RUN \
+# Connection resets are frequent in GitHub Actions workflows \
+wget --random-wait --tries=5 -qO- \
+# We don't download bin scripts as we customize for reasons including BusyBox problems
+https://artifacts.opensearch.org/releases/bundle/opensearch/${opensearch2_version}/opensearch-${opensearch2_version}-linux-x64.tar.gz| tar xz \
+    --wildcards --strip=1 --exclude=jdk
+COPY --from=scratch /config/ ./config/
+
+# Use a full Java distribution rather than adding test modules to the
+# production -jre base layer used by zipkin and zipkin-slim.
+FROM ghcr.io/openzipkin/java:${java_version} as zipkin-opensearch2
+LABEL org.opencontainers.image.description="OpenSearch distribution on OpenJDK and Alpine Linux"
+ARG opensearch2_version=2.13.0
+LABEL opensearch-version=$opensearch2_version
+
+# The full license is also included in the image at /opensearch/LICENSE.txt.
+LABEL org.opencontainers.image.licenses="Apache-2.0"
+
+# Add HEALTHCHECK and ENTRYPOINT scripts into the default search path
+COPY --from=scratch /docker-bin/* /usr/local/bin/
+# We use start period of 30s to avoid marking the container unhealthy on slow or contended CI hosts
+HEALTHCHECK --interval=1s --start-period=30s --timeout=5s CMD ["docker-healthcheck"]
+ENTRYPOINT ["sh", "/usr/local/bin/start-opensearch"]
+
+# All content including binaries and logs write under WORKDIR
+ARG USER=opensearch
+WORKDIR /${USER}
+
+# Ensure the process doesn't run as root
+RUN adduser -g '' -h ${PWD} -D ${USER}
+USER ${USER}
+
+# Copy binaries and config we installed earlier
+COPY --from=install --chown=${USER} /install .
+
+# Use to set heap, trust store or other system properties.
+ENV OPENSEARCH_JAVA_OPTS="-Xms512m -Xmx512m -XX:+ExitOnOutOfMemoryError"
+ENV LIBFFI_TMPDIR=/tmp
+EXPOSE 9200

docker/test-images/zipkin-opensearch2/README.md

@@ -0,0 +1,27 @@
+## zipkin-opensearch2 Docker image
+
+The `zipkin-opensearch2` testing image runs OpenSearch 2.x for [Elasticsearch storage](../../../zipkin-storage/elasticsearch)
+integration.
+
+To build `openzipkin/zipkin-opensearch2:test`, from the top-level of the repository, run:
+```bash
+$ DOCKER_FILE=docker/test-images/zipkin-opensearch2/Dockerfile build-bin/docker/docker_build openzipkin/zipkin-opensearch2:test
+```
+
+You can use the env variable `OPENSEARCH_JAVA_OPTS` to change settings such as heap size for OpenSearch.
+
+#### Host setup
+
+OpenSearch is [strict](https://github.com/docker-library/docs/tree/master/elasticsearch#host-setup)
+about virtual memory. You will need to adjust accordingly (especially if you notice OpenSearch crash!)
+
+```bash
+# If docker is running on your host machine, adjust the kernel setting directly
+$ sudo sysctl -w vm.max_map_count=262144
+
+# If using docker-machine/Docker Toolbox/Boot2Docker, remotely adjust the same
+$ docker-machine ssh default "sudo sysctl -w vm.max_map_count=262144"
+
+# If using colima, it is similar as well
+$ colima ssh "sudo sysctl -w vm.max_map_count=262144"
+```

docker/test-images/zipkin-opensearch2/config/log4j2.properties

@@ -0,0 +1,14 @@
+#
+# Copyright The OpenZipkin Authors
+# SPDX-License-Identifier: Apache-2.0
+#
+
+status = error
+
+appender.console.type = Console
+appender.console.name = console
+appender.console.layout.type = PatternLayout
+appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] [%node_name]%marker %m%n
+
+rootLogger.level = info
+rootLogger.appenderRef.console.ref = console

docker/test-images/zipkin-opensearch2/config/opensearch.yml

@@ -0,0 +1,21 @@
+#
+# Copyright The OpenZipkin Authors
+# SPDX-License-Identifier: Apache-2.0
+#
+
+cluster.name: "docker-cluster"
+network.host: 0.0.0.0
+node.name: zipkin-opensearch
+
+# Enable development mode and disable bootstrap checks
+# See https://www.elastic.co/guide/en/elasticsearch/reference/current/bootstrap-checks.html
+discovery.type: single-node
+# Avoid deprecation errors: as of 2.x the only accepted value is true.
+cluster.routing.allocation.disk.watermark.enable_for_single_data_node: true
+
+# This is a test image, so we are not afraid to delete all indices. Avoids:
+#   Wildcard expressions or all indices are not allowed
+action.destructive_requires_name: false
+
+# Disable security
+plugins.security.disabled: true

docker/test-images/zipkin-opensearch2/start-opensearch

@@ -0,0 +1,39 @@
+#!/bin/sh
+#
+# Copyright The OpenZipkin Authors
+# SPDX-License-Identifier: Apache-2.0
+#
+
+# ENTRYPOINT script that starts OpenSearch
+#
+# This intentionally locates config using the current working directory, in order to consolidate
+# Dockerfile instructions to WORKDIR
+set -eu
+
+# Configure the Docker HEALTHCHECK
+export HEALTHCHECK_PORT=9200
+export HEALTHCHECK_PATH=/_cluster/health
+
+# Use the 'java.io.tmp' dir and precreate the 'opensearch' folder there
+export OPENSEARCH_TMPDIR=`java -cp 'classes:lib/*' org.opensearch.tools.launchers.TempDirectory`
+
+# The JVM options parser produces the final JVM options to start OpenSearch.
+# It does this by incorporating JVM options in the following way:
+#   - first, system JVM options are applied (these are hardcoded options in the
+#     parser)
+#   - second, JVM options are read from jvm.options and jvm.options.d/*.options
+#   - third, JVM options from OPENSEARCH_JAVA_OPTS are applied
+#   - fourth, ergonomic JVM options are applied
+OPENSEARCH_JAVA_OPTS=`java -cp 'classes:lib/*' org.opensearch.tools.launchers.JvmOptionsParser "$PWD/config"`
+
+# -cp 'classes:lib/*' allows layers to patch the image without packaging or overwriting jars
+# We allow security manager (via flag to prevent JRE 21 crash) as OpenSearch.main needs it.
+exec java -cp 'classes:lib/*' ${OPENSEARCH_JAVA_OPTS} \
+  -Djava.security.manager=allow \
+  -Djava.io.tmpdir=/tmp \
+  -Dlog4j2.disable.jmx=true \
+  -Dopensearch.path.home=$PWD \
+  -Dopensearch.path.conf=$PWD/config \
+  -Dopensearch.distribution.type=docker \
+  -Dopensearch.bundled_jdk=false \
+  org.opensearch.bootstrap.OpenSearch "$@"