Skip to content

README.md

Latest commit

 

History

History
94 lines (68 loc) · 3.64 KB

README.md

File metadata and controls

94 lines (68 loc) · 3.64 KB
Raw

Running AlmostServiceBus in Docker

This folder contains everything needed to build and run the emulator as a container:

  • Dockerfile — a minimal runtime image that copies a pre-published build.
  • build-docker.sh — publishes the app on the host and packages it into the image.

How the build works

Unlike a typical multi-stage Dockerfile, the .NET/Node build runs on the host, not inside the image. build-docker.sh:

  1. Applies any submodule patches under the repo's patches/ folder (idempotent; none are needed for the emulator itself today — they exist for the framework conformance suites).
  2. Runs dotnet publish for AlmostServiceBus.Host, which also builds the Vue dashboard, into artifacts/publish/ at the repo root.
  3. Runs docker build with artifacts/publish/ as the build context. Because the context is just the published output, the daemon never receives the whole repo and there is no .dockerignore to maintain — the Dockerfile is a single COPY . ./.

Prerequisites

Because the build happens on the host, the machine running the script needs:

  • .NET 10 SDK
  • Node.js (for the dashboard build)
  • Docker
  • Bash — on Windows use Git Bash or WSL

Building

Run from anywhere; the script resolves the repo root relative to itself:

./docker/build-docker.sh                       # builds almostservicebus:local
./docker/build-docker.sh --tag my/image:1.2.3  # custom image tag
./docker/build-docker.sh --configuration Debug # publish configuration (default Release)
./docker/build-docker.sh --skip-patches        # skip the submodule patch step

Running

Expose the AMQP (5672), admin HTTP (5300), and dashboard (15672) ports:

docker run --rm -p 5672:5672 -p 5300:5300 -p 15672:15672 almostservicebus:local

From the host, connect to localhost:5672 exactly as with the standalone tool:

Endpoint=sb://localhost:5672;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=emulator;UseDevelopmentEmulator=true

Using RootManageSharedAccessKey as the SharedAccessKeyName maps to the default namespace.

Reaching the emulator from another container

When your app runs in the same Docker network it connects using the emulator's service/container name rather than localhost. The emulator detects that it is running in a container and advertises the right host automatically, and it treats its own container hostname as the default namespace, so RootManageSharedAccessKey keeps working. For example, with Docker Compose:

services:
  servicebus:
    image: almostservicebus:local
    ports:
      - "5672:5672"
      - "5300:5300"
      - "15672:15672"

  app:
    build: ./app
    depends_on: [servicebus]
    environment:
      # Host matches the service name above
      ConnectionStrings__ServiceBus: "Endpoint=sb://servicebus:5672;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=emulator;UseDevelopmentEmulator=true"

If clients reach the emulator under a name that differs from the container hostname, set ASB_HOST to that name.

Configuration

The image's entrypoint starts the host on the standard ports. Common overrides:

Environment variable Purpose
ASB_HOST Host name the emulator advertises and treats as the default namespace (plus comma-separated aliases). Set this when clients reach the emulator under a name other than the container hostname.
ASB_BIND_HOST Interface to bind (defaults to 0.0.0.0 in a container).

The entrypoint passes --Port 5672 --DashboardPort 15672; override by supplying your own arguments after the image name in docker run.