docker: add pulsar example

.github/workflows/test_readme.yml

@@ -181,3 +181,9 @@ jobs:
           build-bin/docker/docker_test_image openzipkin/zipkin-rabbitmq:test
         env:
           DOCKER_FILE: docker/test-images/zipkin-rabbitmq/Dockerfile
+      - name: docker/test-images/zipkin-pulsar/README.md
+        run: |
+          build-bin/docker/docker_build openzipkin/zipkin-pulsar:test &&
+          build-bin/docker/docker_test_image openzipkin/zipkin-pulsar:test
+        env:
+          DOCKER_FILE: docker/test-images/zipkin-pulsar/Dockerfile

docker/README.md

@@ -22,6 +22,7 @@ base layer `openzipkin/zipkin`, and setting up schema where relevant.
 * [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
+* [ghcr.io/openzipkin/zipkin-pulsar](test-images/zipkin-pulsar/README.md) - runs Pulsar
 * [ghcr.io/openzipkin/zipkin-rabbitmq](test-images/zipkin-rabbitmq/README.md) - runs RabbitMQ
 * [ghcr.io/openzipkin/zipkin-ui](test-images/zipkin-ui/README.md) - serves the (Lens) UI directly with NGINX
 

docker/examples/README.md

@@ -118,6 +118,18 @@ $ docker compose -f docker-compose-rabbitmq.yml up
 Then configure the [RabbitMQ sender](https://github.com/openzipkin/zipkin-reporter-java/blob/master/amqp-client/src/main/java/zipkin2/reporter/amqp/RabbitMQSender.java)
 using a `host` value of `localhost` or a non-local hostname if in docker.
 
+
+## Pulsar
+
+You can collect traces from [Pulsar](../test-images/zipkin-pulsar/README.md) in addition to HTTP, using the
+`docker-compose-pulsar.yml` file. This configuration starts `zipkin` and `zipkin-pulsar` in their
+own containers.
+
+To add Pulsar configuration, run:
+```bash
+$ docker compose -f docker-compose-pulsar.yml up
+```
+
 ## Eureka
 
 You can register Zipkin for service discovery in [Eureka](../test-images/zipkin-eureka/README.md)

docker/examples/docker-compose-pulsar.yml

@@ -0,0 +1,32 @@
+#
+# Copyright The OpenZipkin Authors
+# SPDX-License-Identifier: Apache-2.0
+#
+
+# This file uses the version 2 docker compose file format, described here:
+# https://docs.docker.com/compose/compose-file/#version-2
+#
+# It extends the default configuration from docker-compose.yml to add a test
+# pulsar server, which is used as a span transport.
+
+version: '2.4'
+
+services:
+  pulsar:
+    image: ghcr.io/openzipkin/zipkin-pulsar:${TAG:-latest}
+    container_name: pulsar
+    ports: # expose the pulsar port so apps can publish spans.
+      - "6650:6650"
+      - "8080:8080"
+
+  zipkin:
+    extends:
+      file: docker-compose.yml
+      service: zipkin
+    # slim doesn't include Pulsar support, so switch to the larger image
+    image: ghcr.io/openzipkin/zipkin:${TAG:-latest}
+    environment:
+      - PULSAR_SERVICE_URL=pulsar://pulsar:6650
+    depends_on:
+      pulsar:
+        condition: service_healthy

docker/test-images/zipkin-pulsar/Dockerfile

@@ -0,0 +1,35 @@
+#
+# Copyright The OpenZipkin Authors
+# SPDX-License-Identifier: Apache-2.0
+#
+
+
+# Use latest from https://hub.docker.com/r/apachepulsar/pulsar/tags
+ARG pulsar_version=4.0.2
+
+# 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
+
+WORKDIR /docker-bin
+COPY build-bin/docker/docker-healthcheck /docker-bin/
+
+ARG pulsar_version
+
+FROM apachepulsar/pulsar:${pulsar_version} as zipkin-pulsar
+LABEL pulsar-version=$pulsar_version
+LABEL org.opencontainers.image.description="Apache Pulsar on Alpine Linux"
+
+# 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"]
+
+# Usually, we read env set from pid 1 to get docker-healthcheck parameters.
+# However, pulsar-server has to start as root even if permissions are dropped
+# later. So, we expose it in the Dockerfile instead.
+ENV HEALTHCHECK_PORT=8080
+ENV HEALTHCHECK_KIND=tcp
+EXPOSE 8080 6650
+CMD ["bin/pulsar", "standalone"]

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

@@ -0,0 +1,8 @@
+## zipkin-pulsar Docker image
+
+The `zipkin-pulsar` testing image runs Pulsar for Pulsar collector integration.
+
+To build `openzipkin/zipkin-pulsar:test`, from the top-level of the repository, run:
+```bash
+$ DOCKER_FILE=docker/test-images/zipkin-pulsar/Dockerfile build-bin/docker/docker_build openzipkin/zipkin-pulsar:test
+```