thewiwcorp/vernemq

docker-vernemq

什么是VerneMQ？

VerneMQ是一款高性能、分布式的MQTT消息broker。它可在普通硬件上进行水平和垂直扩展，支持大量并发发布者和消费者，同时保持低延迟和容错能力。VerneMQ是IoT平台或智能产品的可靠消息枢纽，基于Erlang开发，采用Apache2许可协议。

关于本仓库

本仓库是官方vernemq/docker-vernemq项目的分叉。我们添加了Dockerfile步骤以移除商业镜像，因此您无需为商业使用接受VerneMQ最终用户许可协议（EULA）。我们将跟随vernemq/docker-vernemq的主要版本发布，通常不提供中间提交。

如何使用该镜像

1. 使用Helm在Kubernetes上部署

首先根据https://helm.sh/docs/using_helm/#quickstart-guide%E5%AE%89%E8%A3%85%E5%B9%B6%E9%85%8D%E7%BD%AEHelm%EF%BC%8C%E7%84%B6%E5%90%8E%E6%B7%BB%E5%8A%A0VerneMQ Helm图表仓库：

bash
helm repo add vernemq https://vernemq.github.io/docker-vernemq

现在您可以在Kubernetes集群上部署VerneMQ：

bash
helm install thewiwcorp/vernemq

更多信息请查看Helm图表README。

2. 使用纯Docker命令

bash
docker run --name vernemq1 -d docker.xuanyuan.run/thewiwcorp/vernemq

有时需要配置端口转发（例如在Mac上）：

bash
docker run -p 1883:1883 --name vernemq1 -d docker.xuanyuan.run/thewiwcorp/vernemq

这将启动一个新节点，监听1883端口（MQTT连接）和8080端口（MQTT over WebSocket连接）。但此时broker无法认证连接的客户端，若允许***客户端，可使用环境变量DOCKER_VERNEMQ_ALLOW_ANONYMOUS=on：

bash
docker run -e "DOCKER_VERNEMQ_ALLOW_ANONYMOUS=on" --name vernemq1 -d docker.xuanyuan.run/thewiwcorp/vernemq

自动加入VerneMQ集群

新启动的容器可自动加入VerneMQ集群。假设您已按上述示例启动第一个节点，可通过以下命令让新容器加入集群（当前集群仅包含vernemq1容器）：

bash
docker run -e "DOCKER_VERNEMQ_DISCOVERY_NODE=<VERNEMQ1的IP地址>" --name vernemq2 -d docker.xuanyuan.run/thewiwcorp/vernemq

（注：可通过docker inspect <容器名/ID> | grep \"IPAddress\"获取Docker容器的IP地址）

3. 在Kubernetes上无需Helm的自动集群

在Kubernetes中运行VerneMQ时，可让匹配特定标签的pod自动集群。该功能使用Kubernetes API发现其他节点，依赖https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/%EF%BC%88%E9%9C%80%E5%90%AF%E7%94%A8%EF%BC%89%E3%80%82

只需在pod环境中设置DOCKER_VERNEMQ_DISCOVERY_KUBERNETES=1，并通过MY_POD_NAME暴露自身pod名称。默认情况下，同一命名空间中带有app=vernemq标签的所有pod将加入同一集群。集群名称（默认cluster.local）、命名空间和标签设置可通过DOCKER_VERNEMQ_KUBERNETES_CLUSTER_NAME、DOCKER_VERNEMQ_KUBERNETES_NAMESPACE和DOCKER_VERNEMQ_KUBERNETES_LABEL_SELECTOR覆盖。

pod环境配置示例：

yaml
env:
  - name: DOCKER_VERNEMQ_DISCOVERY_KUBERNETES
    value: "1"
  - name: MY_POD_NAME
    valueFrom:
      fieldRef:
        fieldPath: metadata.name
  - name: DOCKER_VERNEMQ_KUBERNETES_LABEL_SELECTOR
    value: "app=vernemq,release=myinstance"

启用Kubernetes自动集群时，请勿设置DOCKER_VERNEMQ_DISCOVERY_NODE。

若遇到“SSL认证错误（主题名称与主机名不匹配）”，可尝试设置DOCKER_VERNEMQ_KUBERNETES_INSECURE=1：

text
kubectl logs vernemq-0
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0curl: (51) SSL: certificate subject name 'client' does not match target host name 'kubernetes.default.svc.cluster.local'
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0curl: (51) SSL: certificate subject name 'client' does not match target host name 'kubernetes.default.svc.cluster.local'
vernemq failed to start within 15 seconds,
see the output of 'vernemq console' for more information.
If you want to wait longer, set the environment variable
WAIT_FOR_ERLANG to the number of seconds to wait.
...

若使用vernemq.conf.local文件，可在配置中插入占位符###IPADDRESS###，该占位符将在pod创建时替换为VerneMQ运行的pod实际IP地址，使VMQ集群成为可能。

若启用Istio，需设置DOCKER_VERNEMQ_KUBERNETES_ISTIO_ENABLED=1，以便初始化脚本检查Istio是否就绪。

4. 使用Docker Swarm

请遵循官方Docker指南正确设置包含一个或多个节点的Swarm集群。

Swarm设置完成后，可部署VerneMQ栈。以下代码片段通过docker-compose.yml文件描述栈：

yaml
version: "3.7"
services:
  vmq0:
    image: docker.xuanyuan.run/thewiwcorp/vernemq
    environment:
      DOCKER_VERNEMQ_SWARM: 1
  vmq:
    image: docker.xuanyuan.run/thewiwcorp/vernemq
    depends_on:
      - vmq0
    environment:
      DOCKER_VERNEMQ_SWARM: 1
      DOCKER_VERNEMQ_DISCOVERY_NODE: vmq0
    deploy:
      replicas: 2

运行docker stack deploy -c docker-compose.yml my-vernemq-stack部署3节点VerneMQ集群。

注：Docker Swarm目前缺乏类似Kubernetes中StatefulSet的功能，因此VerneMQ必须依赖特定的发现服务（上述vmq0服务），该服务需在其他副本之前启动。

检查集群状态

要检查上述容器是否成功集群，可执行vmq-admin命令：

bash
docker exec vernemq1 vmq-admin cluster show
+--------------------+-------+
|        Node        |Running|
+--------------------+-------+
|VerneMQ@172.17.0.151| true  |
|VerneMQ@172.17.0.152| true  |
+--------------------+-------+

若在Kubernetes中使用DOCKER_VERNEMQ_DISCOVERY_KUBERNETES=1启动VerneMQ集群，可通过kubectl执行vmq-admin：

bash
kubectl exec vernemq-0 -- vmq-admin cluster show
+---------------------------------------------------+-------+
|                       Node                        |Running|
+---------------------------------------------------+-------+
|VerneMQ@vernemq-0.vernemq.default.svc.cluster.local| true  |
|VerneMQ@vernemq-1.vernemq.default.svc.cluster.local| true  |
+---------------------------------------------------+-------+

所有vmq-admin命令均可用，更多信息请查看vernemq.com/docs/administration/。

VerneMQ配置

vernemq.conf中所有可用的配置参数均可通过DOCKER_VERNEMQ前缀+配置参数名定义。例如：allow_anonymous=on对应-e "DOCKER_VERNEMQ_ALLOW_ANONYMOUS=on"，allow_register_during_netsplit=on对应-e "DOCKER_VERNEMQ_ALLOW_REGISTER_DURING_NETSPLIT=on"。所有可用配置参数可在vernemq.com/docs/configuration/找到。

Erlang VM参数

Erlang VM参数可通过以下环境变量更新：

日志

VerneMQ将崩溃和错误日志存储在/var/log/vernemq/，默认不将控制台日志写入磁盘以避免填满容器磁盘空间。但可通过设置环境变量DOCKER_VERNEMQ_LOG__CONSOLE=both改变此行为，让VerneMQ将日志发送到stdout和/var/log/vernemq/console.log。更多信息请查看VerneMQ日志文档：vernemq.com/docs/configuring-vernemq/logging。

备注

部分配置变量包含点.。例如，若要调整VerneMQ的日志级别，需使用-e "DOCKER_VERNEMQ_LOG.CONSOLE.LEVEL=debug"。但部分容器平台（如Kubernetes）不支持环境变量中的点和其他特殊字符，此时可将点替换为两个下划线__，上述示例变为-e "DOCKER_VERNEMQ_LOG__CONSOLE__LEVEL=debug"。

部分包含点的配置名称有例外，示例如下：

文件认证

您可通过添加用户和密码作为环境变量来设置文件认证： DOCKER_VERNEMQ_USER_<用户名>='密码' 其中<用户名>是您要使用的用户名，可多次添加以创建所需用户，用户名将自动转为小写。

注意：密码中不能包含=字符。

感谢所有贡献者！

https://contributors-img.web.app/image?repo=vernemq/docker-vernemq](https://github.com/vernemq/docker-vernemq/graphs/contributors)