Skip to content

Latest commit

 

History

History
177 lines (140 loc) · 7.16 KB

README.md

File metadata and controls

177 lines (140 loc) · 7.16 KB
Raw

Docker Images for VerneMQ

This repository houses Dockerfiles for VerneMQ including the build process of VerneMQ binaries. As it is not using the VerneMQ binaries built by OctavoLabs, the VerneMQ End User License Agreement does not apply. Hence you are free to use it for any use case without the obligation of a subscription. It also allows you to build the Docker image with newer versions of Erlang or the Alpine base image if you need to update them for security reasons. On the other hand, this is just a "standard" build without any optimizations applied during the build process by the experts from Octavo Labs. It's your choice.

1. Quickstart

Use an existing image from ghcr.io:

docker run --name vmq1 -p 8888:8888 -p 1883:1883 -d ghcr.io/marcbrandner/vernemq:1.12.3-build.1-alpine

2. Easy Build

Clone the repository, i.e. like this:

git clone https://github.com/marcbrandner/vernemq-docker.git -b 1.12.3-build.1

(The version number (1.12.3-build.1) may be replaced with one of the available tags.)

Build the image based on the alpine base image:

docker build -t vernemq:1.12.3-build.1-alpine vernemq-docker/alpine

Or build the image based on the debian-slim base image:

docker build -t vernemq:1.12.3-build.1-debian-slim vernemq-docker/debian-slim

3. Build a Specific Version

If the VerneMQ version you require is not available as a tag in this repository, you can set a valid combination of component versions using Docker Build Arguments.

Example:

git clone https://github.com/marcbrandner/vernemq-docker.git -b main

# alpine
docker build -t vernemq:foobar-alpine \
    --build-arg VMQ_VERSION=1.12.3 \
    --build-arg ERLANG_VERSION=23.3.2.0 \
    --build-arg ALPINE_VERSION=3.13.6 \
    vernemq-docker/alpine

# debian-slim
docker build -t vernemq:foobar-debian-slim \
    --build-arg VMQ_VERSION=1.12.3 \
    --build-arg ERLANG_VERSION=23.3.2.0 \
    --build-arg DEBIAN_SLIM_VERSION=stable-20211011-slim \
    vernemq-docker/debian-slim

4. Use Image

If you don't want to build the images yourself, already built images can be found on Github's container registry at ghcr.io/marcbrandner/vernemq.

Images are not regularly built for newlypublished VerneMQ releases. If you want a specific version that is not available in this repo's tags, build it yourself.

Run a VerneMQ container using an image from ghcr.io:

# alpine
docker run --name vmq1 -p 8888:8888 -p 1883:1883 -d ghcr.io/marcbrandner/vernemq:1.12.3-build.1-alpine

# debian
docker run --name vmq1 -p 8888:8888 -p 1883:1883 -d ghcr.io/marcbrandner/vernemq:1.12.3-build.1-debian-slim

Run a VerneMQ container using your own image:

docker run --name vmq1 -p 8888:8888 -p 1883:1883 -d vernemq:<your-tag>

Check the logs:

docker logs vmq1 -f

Check the VerneMQ instance's status:

docker exec vmq1 vmq-admin cluster show

Use curl to test the status page:

curl localhost:8888/status --verbose

Enter a container a running VerneMQ instance:

docker exec -it vmq1  /bin/sh

Run a container without starting a VerneMQ instance and get an interactive shell (i.e for troubleshooting):

# alpine
docker run -it --rm vernemq:1.12.3-build.1-alpine /bin/sh

# debian-slim
docker run -it --rm vernemq:1.12.3-build.1-debian-slim /bin/sh

5. Troubleshooting

5.1. Errors Fetching Plugins

Error:

===> Fetching rebar3_cuttlefish (from {git,"git://github.com/vernemq/rebar3_cuttlefish",
                             {ref,"4cf5e1c8133bb54be7badbd8aa57aa5f79763452"}})
===> Errors loading plugin {rebar3_cuttlefish,
                               {git,
                                   "git://github.com/vernemq/rebar3_cuttlefish",
                                   {ref,
                                       "4cf5e1c8133bb54be7badbd8aa57aa5f79763452"}}}. Run rebar3 with DEBUG=1 set to see errors.

Possible Cause: Most likely your network does not allow you to clone from GitHub using git:// which uses SSH.

Possible Solution: Changing to https:// in the rebar.config does not cover all plugins, which is why so far there is no other way than poking a hole into your firewall for SSH on port 22 or using a another way to access the Internet.

5.2. Build Failures

Error: Obscure build failures after all plugins are fetched.

Possible Cause: If a build fails, the Docker build leaves behind some residual layers which are picked up by subsequent builds (with repository <none> and tag <none>).

Possible Solution: Delete those dangling layers to clean up:

for image_id in $(docker images | awk '{print $1 " " $3}' | grep '<none>' | awk '{print $2}'); do
    docker rmi -f $image_id
done

6. Roadmap

  • Reduce image size by removing nano from all images
  • Automation with GitHub Actions:
    • Automate Docker image build
    • Trigger builds on each new VerneMQ release

7. Maintenance

A few things useful for maintenance of this repository:

7.1. Push Images to GitHub Container Registry

  • Authenticate in browser with GitHub account
  • Generate a new Personal Access Token (see GitHub documentation)
  • Login to ghcr.io:
export CR_PAT=YOUR_TOKEN
echo $CR_PAT | docker login ghcr.io -u USERNAME --password-stdin
  • Tag and push the images:
# alpine
docker tag vernemq:1.12.3-build.1-alpine ghcr.io/marcbrandner/vernemq:1.12.3-build.1-alpine
docker push ghcr.io/marcbrandner/vernemq:1.12.3-build.1-alpine

# debian-slim
docker tag vernemq:1.12.3-build.1-debian-slim ghcr.io/marcbrandner/vernemq:1.12.3-build.1-debian-slim
docker push ghcr.io/marcbrandner/vernemq:1.12.3-build.1-debian-slim