wdijkerman/consul

wdijkerman/consul

!Docker Stars !Docker Pulls https://github.com/dj-wasabi/consul/workflows/CI/badge.svg](https://github.com/dj-wasabi/consul/actions?query=workflow%3ACI)

介绍

这是一个在Alpine上运行Consul的Docker容器。该容器体积小巧，大小仅75MB多一点。

此Docker容器中的版本：

• alpine: 3.13
• consul: 1.9.4
• python: 3.8.5

卷

Consul应用程序安装在容器的/bin目录中，启动脚本也位于此目录。Consul的数据存储在/consul目录中：

• /consul/config
• /consul/data

/consul/config config.json文件的位置。这也是一个卷，可以挂载到主机上。

/consul/data Consul存储所有数据的位置。这也是一个卷，可以挂载到主机上。

用户

Consul以consul用户身份运行。通过配置以下功能，Consul可以作为非root用户运行：

• cap_ipc_lock（不应交换。启动Consul服务器时，命令行应添加--cap-add IPC_LOCK）
• cap_net_bind_service（可以作为非root用户绑定<1023的服务端口）

此容器中使用的UID是1050。因此，当使用主机挂载时，确保该ID在运行容器的主机上可用。

Python?

容器中还安装了Python。Python用于测试容器，通过testinfra工具进行。您可以在tests目录中看到一个名为test_consul.py的文件，该文件将被执行。

安装容器

只需运行以下命令下载容器：

bash
docker pull wdijkerman/consul

使用容器

有多种使用此容器的方式。

单节点（集群）服务器

此示例将启动一个单节点Consul服务器，不包含任何代理。

需要将以下json文件存储在某个位置：

json
{
    "data_dir": "/consul/data",
    "log_level": "INFO",
    "client_addr": "0.0.0.0",
    "ports": {
        "dns": 53
    },
    "ui": true,
    "server": true,
    "bootstrap_expect": 1,
    "disable_update_check": true
}

然后可以使用以下命令启动单节点集群：

bash
docker run  -p 8400:8400 -p 8500:8500 \
            -p 8600:53/udp -h server1 \
            -v path/to/file.json:/consul/config/my_config.json:ro \
            wdijkerman/consul

多节点集群

根据Hashicorp的Consul官方文档，最佳（或最优）集群大小为3或5个节点。集群中的第一个节点与其他节点的启动方式不同。第一个节点的启动方式如下：

bash
docker run  -p 8300-8302:8300-8302 \
            -p 8301-8302:8301-8302/udp \
            -p 8400:8400 -p 8500:8500 \
            -p 8600:53 -p 8600:53/udp \
            -v /data/consul/cluster:/consul/data \
            -v /data/consul/config:/consul/config \
            -h server1 wdijkerman/consul

如您所见，我们使用-bootstrap-expect 3选项启动Consul集群。我们让Consul集群知道服务器节点的大小将是3个。使用多少个代理节点并不重要。我们将本地目录'/data/consul/cluster'挂载到容器中，因此当容器重新启动时，Consul数据不会丢失。（确保目录的UID设置为995）

其余节点使用-join命令启动。我们首先需要第一个Consul服务器的IP。

bash
docker run  -p 8300-8302:8300-8302 \
            -p 8301-8302:8301-8302/udp \
            -p 8400:8400 -p 8500:8500 \
            -p 8600:53 -p 8600:53/udp \
            -v /data/consul/cluster:/consul/data \
            -v /data/consul/config:/consul/config \
            -h server[2-5] wdijkerman/consul

其余服务器将最初连接到第一个启动的服务器并加入集群。

代理

当我们有Consul集群时，可以向集群添加代理。它们将处理来自其他Docker服务的请求

bash
docker run  -p 8301-8302:8301-8302 \
            -p 8301-8302:8301-8302/udp \
            -p 8400:8400 -p 8500:8500 \
            -p 8600:53 -p 8600:53/udp \
            -h agent[1-??] wdijkerman/consul

docker-compose

根目录中存在一个docker-compose.yml文件，可用于启动基本的单节点Consul服务器。

bash
docker-compose -f docker-compose.yml up consul

配置

有许多配置Consul的选项。有关所有选项，请参见此页面：[***]

环境变量

您可以使用以下环境变量配置Consul：

• CONSUL_INTERFACE_ADVERTISE: 当配置了网络接口时，它将使用该接口的IP作为广告地址。
• CONSUL_INTERFACE_BIND: 当配置了网络接口时，它将使用该接口的IP作为绑定地址。
• CONSUL_INTERFACE_CLIENT: 当配置了网络接口时，它将使用该接口的IP作为客户端地址。

示例：

bash
-e CONSUL_INTERFACE_BIND=eth0

添加命令行参数

您可以在命令行中添加选项，参见以下示例：

bash
docker run  -p 8301-8302:8301-8302 \
            -p 8301-8302:8301-8302/udp \
            -p 8400:8400 -p 8500:8500 \
            -p 8600:53 -p 8600:53/udp \
            -h agent[1-??] wdijkerman/consul

在上面的配置中，我们添加了-advertise配置选项。

添加配置文件

您还可以添加json配置文件。将json文件放在/data/consul/config目录中（或使用您用于存储配置的目录）。

cat /data/consul/config/datacenter.json
{
  "datacenter": "nwg"
}

当Consul重新启动时，您将看到数据中心设置为"nwg"。

==> Starting Consul agent...
==> Starting Consul agent RPC...
==> Consul agent running!
           Version: 'v0.7.2'
         Node name: 'server1'
        Datacenter: 'nwg'
            Server: true (bootstrap: true)
       Client Addr: 0.0.0.0 (HTTP: 8500, HTTPS: -1, DNS: 53, RPC: 8400)
      Cluster Addr: 172.17.0.2 (LAN: 8301, WAN: 8302)
    Gossip encrypt: false, RPC-TLS: false, TLS-Incoming: false
             Atlas: <disabled>

端口

Consul需要最多5个不同的端口才能正常工作，有些使用TCP、UDP或两种协议。下面我们记录每个端口的要求。

• 服务器RPC（默认8300）。服务器用于处理来自其他代理的传入请求。仅TCP。
• Serf LAN（默认8301）。用于处理LAN中的 gossip。所有代理都需要。TCP和UDP。
• Serf WAN（默认8302）。服务器用于通过WAN与其他服务器进行gossip。TCP和UDP。
• CLI RPC（默认8400）。所有代理用于处理来自CLI的RPC。仅TCP。
• HTTP API（默认8500）。客户端用于与HTTP API通信。仅TCP。
• gRPC（默认8502）。用于向Envoy代理公开Envoy xDS API
• DNS接口（默认8600）。用于解析DNS查询。TCP和UDP。

使用指南

设置安全的Consul集群 配置访问控制列表

许可证

MIT许可证（MIT）

参见文件：License

问题

请在https://github.com/dj-wasabi/consul/issues%E6%8A%A5%E5%91%8A%E9%97%AE%E9%A2%98

欢迎提交Pull Requests！