Docker Consul 注册与发现

一、Consul 概述

1. 什么是服务注册与发现

服务注册与发现是微服务架构中不可或缺的重要组件。起初服务都是单节点的，不保障高可用性，也不考虑服务的压力承载，服务之间调用单纯的通过接口访问。

直到后来出现了多个节点的分布式架构，起初的解决手段是在服务前端负载均衡，这样前端必须要知道所有后端服务的网络位置，并配置在配置文件中。这里就会有几个问题：

• 如果需要调用后端服务A-N，就需要配置N个服务的网络位置，配置很麻烦
• 后端服务的网络位置变化，都需要改变每个调用者的配置

既然有这些问题，那么服务注册与发现就是解决这些问题的。后端服务A-N可以把当前自己的网络位置注册到服务发现模块，服务发现就以K-V的方式记录下来，K一般是服务名，V就是IP:PORT。

服务发现模块定时的进行健康检查，轮询查看这些后端服务能不能访问的了。前端在调用后端服务A-N的时候，就跑去服务发现模块问下它们的网络位置，然后再调用它们的服务。这样的方式就可以解决上面的问题了，前端完全不需要记录这些后端服务的网络位置，前端和后端完全解耦！

2. 什么是consul

consul是google开源的一个使用go语言开发的服务管理软件。支持多数据中心、分布式高可用的、服务发现和配置共享。采用Raft算法，用来保证服务的高可用。

内置了服务注册与发现框架、分布一致性协议实现、健康检查、Key/Value存储、多数据中心方案，不再需要依赖其他工具（比如ZooKeeper等）。

服务部署简单，只有一个可运行的二进制的包。每个节点都需要运行agent，他有两种运行模式server 和 client。 每个数据中心官方建议需要3或5个server节点(大于或等于3的奇数台)以保证数据安全，同时保证server-leader的选举能够正确的进行。

在client模式下，所有注册到当前节点的服务会被转发到server节点，本身是不持久化这些信息。

在server模式下，功能和client模式相似，唯一不同的是，它会把所有的信息持久化到本地，这样遇到故障，信息是可以被保留的。

server-leader是所有server节点的老大，它和其它server节点不同的是，它需要负责同步注册的信息给其它的server节点，同时也要负责各个节点的健康监测。

consul提供的一些关键特性：

**服务注册与发现：**consul通过DNS或者HTTP接口使服务注册和服务发现变的很容易，一些外部服务，例如saas提供的也可以一样注册。

**健康检查：**健康检测使consul可以快速的告警在集群中的操作。和服务发现的集成，可以防止服务转发到故障的服务上面。

**Key/Value存储：**一个用来存储动态配置的系统。提供简单的HTTP接口，可以在任何地方操作。

**多数据中心：**无需复杂的配置，即可支持任意数量的区域。

安装consul是用于服务注册，也就是容器本身的一些信息注册到consul里面，其他程序可以通过consul获取注册的相关服务信息，这就是服务注册与发现。

二、Consul 部署

1. 环境

节点	IP地址	安装软件
consul-server 服务器	192.168.23.35	consul 服务 nginx 服务 consul-template 守护进程
registrator 服务器	192.168.23.40	registrator 容器 nginx 容器

关闭防火墙及SeLinux安全机制

systemctl stop firewalld.service
setenforce 0　　

2. Consul 服务端部署

（1）上传 consul 二进制包

mkdir /opt/consul
cd /opt/consul
# 上传 consul 的二进制包 consul_0.9.2_linux_amd64.zip
rz -E

unzip consul_0.9.2_linux_amd64.zip
mv consul /usr/local/bin/

（2）设置代理

在后台启动 consul 服务端

consul agent \
-server \
-bootstrap \
-ui \
-data-dir=/var/lib/consul-data \
-bind=192.168.23.35 \
-client=0.0.0.0 \
-node=consul-server01 &> /var/log/consul.log &

-server：以server身份启动。默认是client。

-bootstrap：用来控制一个server是否在bootstrap模式，在一个数据中心中只能有一个server处于bootstrap模式，当一个server处于 bootstrap模式时，可以自己选举为 server-leader。

-bootstrap-expect=2：集群要求的最少server数量，当低于这个数量，集群即失效。

-ui：指定开启 UI 界面，这样可以通过 http://localhost:8500/ui 这样的地址访问 consul 自带的 web UI 界面。

-data-dir：指定数据存储目录。

-bind：指定用来在集群内部的通讯地址，集群内的所有节点到此地址都必须是可达的，默认是0.0.0.0。

-client：指定 consul 绑定在哪个 client 地址上，这个地址提供 HTTP、DNS、RPC 等服务，默认是 127.0.0.1。

-node：节点在集群中的名称，在一个集群中必须是唯一的，默认是该节点的主机名。

-datacenter：指定数据中心名称，默认是dc1。

&> /var/log/consul.log &：将代理的日志输出重定向到/var/log/consul.log文件，并在后台运行代理。

（3）查看 consul 进程

netstat -natp | grep consul

启动 consul 后默认会监听5个端口

端口	作用
8300	用于Consul集群内部节点之间的RPC通信和复制（replication） replication、leader farwarding 的端口
8301	用于LAN Gossip协议通信，主要负责在局域网中广播成员关系信息、检测故障和进行状态同步
8302	用于WAN Gossip协议通信，主要负责在广域网中进行跨数据中心的通信和状态同步
8500	用于Consul的HTTP API服务和Web UI界面访问。您可以通过该端口与Consul进行交互、查询和管理集群
8600	用于DNS协议查询，允许您通过DNS接口查看Consul集群中的节点信息和服务发现

（4）查看集群信息

① 查看 members 状态

consul members 是一个用于查看当前Consul集群成员的命令。执行该命令将显示出当前运行的Consul节点的详细信息，包括节点名称、节点ID、节点地址、角色和健康状态等。

consul members

② 查看集群状态

consul operator raft list-peers 是一个用于查看Consul Raft共识协议的Peers（节点）列表的命令。执行该命令将显示当前Consul集群中参与Raft共识的节点信息，包括节点ID、节点地址和节点角色等。

通过执行 consul info | grep leader 命令，可以获取当前Consul集群的Leader节点信息。该命令会从 consul info 的输出中筛选出包含 “leader” 关键字的行，以显示当前的Leader节点。

consul operator raft list-peers

consul info | grep leader

（5）通过 http api 获取集群信息

# 查看集群 server 成员
curl 127.0.0.1:8500/v1/status/peers

# 集群 server-leader
curl 127.0.0.1:8500/v1/status/leader

# 注册的所有服务
curl 127.0.0.1:8500/v1/catalog/services

# 查看 nginx 的服务信息
curl 127.0.0.1:8500/v1/catalog/nginx

# 集群节点详细信息
curl 127.0.0.1:8500/v1/catalog/nodes

3. registrator 服务器

需要先安装docker

容器服务自动加入 Nginx 集群

Gliderlabs/Registrator 可检查容器运行状态自动注册，还可注销 docker 容器的服务到服务配置中心。目前支持 Consul、Etcd 和 SkyDNS2。

• Consul：Consul 是一个开源的分布式服务发现和配置管理系统。它提供了服务注册与发现、健康检查、键值存储等功能。通过使用Consul，你可以轻松地将容器化的服务注册到Consul中，并且其他服务或应用程序可以通过Consul来发现和访问这些服务。
• Etcd：Etcd 是一个高可用的分布式键值存储系统，由CoreOS团队开发。它主要用于共享配置和服务发现。Etcd提供了简单的接口，可以让你将容器化的服务注册到Etcd中，并且可以在需要时从Etcd中获取服务的相关信息。
• SkyDNS2：SkyDNS2 是一个基于DNS协议的服务发现工具，由etcd驱动。它使用域名解析的方式来实现服务的发现和访问。通过SkyDNS2，你可以将容器化的服务注册为域名，并且其他服务或应用程序可以通过解析该域名来发现和访问服务

（1）安装 Gliderlabs/Registrator

docker run -d \
--name=registrator \
--net=host \
-v /var/run/docker.sock:/tmp/docker.sock \
--restart=always \
gliderlabs/registrator:latest \
--ip=192.168.23.40 \
consul://192.168.23.35:8500

--net=host：把运行的docker容器设定为host网络模式。

-v /var/run/docker.sock:/tmp/docker.sock：把宿主机的Docker守护进程(Docker daemon)默认监听的Unix域套接字挂载到容器中。

--restart=always：设置在容器退出时总是重启容器。

--ip：刚才把network指定了host模式，所以我们指定ip为宿主机的ip。

consul：指定consul服务器的IP和端口。

（2）启动 nginx和 apache 容器

被监控的节点服务器上，nginx容器的服务启动后，并做了端口映射后，会将映射的信息写入到宿主机的docker.sock文件

registrator 自动发现模块会监控宿主机的docker.sock ，就会发现nginx服务。

registrator 会将信息写入到consul的自动注册模块，通过8500 web ui 展示

---

# -h：设置容器主机名
docker run -itd -p:83:80 --name test-01 -h test01 nginx
docker run -itd -p:84:80 --name test-02 -h test02 nginx
docker run -itd -p:88:80 --name test-03 -h test03 httpd
docker run -itd -p:89:80 --name test-04 -h test04 httpd

4. 测试服务发现发现功能是否正常

（1）验证 nginx 服务是否注册到 consul

浏览器中，输入 http://192.168.23.35:8500，在 Web 页面中“单击 NODES”，然后单击“consurl-server01”，会出现5个服务。

（2）在 consul 服务器使用 curl 测试连接服务器

curl 127.0.0.1:8500/v1/catalog/services
{"consul":[],"httpd":[],"nginx":[]}

三、Consul-Template

Consul-Template是基于Consul的自动替换配置文件的应用。Consul-Template是一个守护进程，用于实时查询Consul集群信息，并更新文件系统上任意数量的指定模板，生成配置文件。更新完成以后，可以选择运行 shell 命令执行更新操作，重新加载 Nginx。

Consul-Template可以查询Consul中的服务目录、Key、Key-values 等。这种强大的抽象功能和查询语言模板可以使 Consul-Template 特别适合动态的创建配置文件。例如：创建Apache/Nginx Proxy Balancers 、 Haproxy Backends等。

1. 准备 tempate nginx 模板文件

在 consul 服务器上操作

mkdir /opt/consul
vim /opt/consul/nginx.ctmpl

# 定义一个 nginx upstream 模板
upstream http_backend {
        {{range service "nginx"}}
        server {{.Address}}:{{.port}};
        {{end}}
}

# 定义一个server，监听8000端口，反向代理到upstream
server {
	# 监听端口号为8000的请求
    listen 8000;  
	# 设置服务器名称为localhost和192.168.23.35，用于匹配请求的域名或IP地址
    server_name localhost 192.168.23.35;  
	# 记录访问日志的路径和文件名为/var/log/nginx/n-access.log
    access_log /var/log/nginx/n-access.log;  
	# 设置默认的索引文件为index.html和index.php
    index index.html index.php;  
     
    location / {
    	# 设置请求头中的HOST字段为客户端发送的Host字段值
        proxy_set_header HOST $host;  
        # 设置请求头中的X-Real-IP字段为客户端真实IP地址
        proxy_set_header X-Real-IP $remote_addr; 
        # 设置请求头中的Client-IP字段为客户端IP地址
        proxy_set_header Client-IP $remote_addr;
        # 设置请求头中的X-Forwarded-For字段为客户端的原始IP列表
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;  
		# 将请求转发给名为http_backend的upstream后端服务器组
        proxy_pass http://http_backend;  
    }
}

2. 编译安装 Nginx

（1）上传 Nginx 安装包

cd /opt
# 上传 Nginx-1.12.0.tar.gz 安装包
rz -E

（2）安装依赖环境

yum -y install pcre-devel zlib-devel gcc gcc-c++ make

useradd -M -s /sbin/nologin nginx

（3）编译及安装

tar -xf nginx-1.12.0.tar.gz -C /opt/
cd /opt/nginx-1.12.0/
./configure \
--prefix=/usr/local/nginx \
--user=nginx \
--group=nginx && make && make install

ln -s /usr/local/nginx/sbin/nginx /usr/local/sbin

3. 配置 Nginx

vim /usr/local/nginx/conf/nginx.conf

http {
# 添加虚拟主机目录
include vhost/*.conf;
}


# 创建虚拟主机目录
mkdir /usr/local/nginx/conf/vhost

# 创建数据目录
mkdir /var/log/nginx

# 启动 Nginx
nginx

4. 配置并启动 template

cd /opt
# 上传 consul-template_0.19.3_linux_amd64.zip 安装包
rz -E
unzip consul-template_0.19.3_linux_amd64.zip -d /opt
mv 

5. 在前台启动 template 服务

在前台启动 template 服务，启动后不要按 ctrl+c 中止 consul-template 进程

consul-template \
--consul-addr 192.168.23.35:8500 \
--template "/opt/consul/nginx.ctmpl:/usr/local/nginx/conf/vhost/mcl.conf:/usr/local/nginx/sbin/nginx -s reload" \
--log-level=info

• --consul-addr 192.168.23.35:8500：指定 Consul 服务器的地址和端口号为 192.168.23.35:8500。consul-template 将连接到该地址的 Consul 实例，以获取配置信息。
• --template "/opt/consul/nginx.ctmpl:/usr/local/nginx/conf/vhost/mcl.conf:/usr/local/nginx/sbin/nginx -s reload"：指定模板的路径和生成配置文件的目标路径，以及在配置文件更新后重新加载 Nginx 的命令。
  • /opt/consul/nginx.ctmpl 是模板文件的路径，其中包含了要生成的 Nginx 配置文件的模板。
  • /usr/local/nginx/conf/vhost/mcl.conf 是生成的 Nginx 配置文件的目标路径，即 consul-template 将会将模板文件渲染为该路径下的真实配置文件。
  • /usr/local/nginx/sbin/nginx -s reload 是 Nginx 重新加载配置文件的命令。当模板文件发生变化时，consul-template 会渲染新的配置文件并执行该命令，以使 Nginx 重新加载新的配置。
• --log-level=info：指定日志级别为 info，表示将打印信息级别的日志。这样可以在控制台上查看 consul-template 的运行日志。

这段命令的目的是使用模板文件生成 Nginx 的配置文件，并在配置文件发生更新时重新加载 Nginx。同时，它通过连接到 Consul 实例来获取配置信息。

6. 检验

（1）另外打开一个终端查看生成配置文件

cd /usr/local/nginx/conf/vhost
ls
mcl.conf

cat mcl.conf

（2）registrator节点创建一个新的 nginx 容器

docker run -itd -p:90:80 --name test-05 -h test05 nginx
docker images

server节点查看 mcl.conf 文件

cat /usr/local/nginx/conf/vhost/mcl.conf

（3）registrator 停止 nginx容器

docker stop test-05

server节点查看 mcl.conf 文件

cat /usr/local/nginx/conf/vhost/mcl.conf

四、Consul 多节点

1. 添加一台已有docker环境的服务器到集群

consul agent \
-server \
-ui \
-data-dir=/var/lib/consul-data \
-bind=192.168.23.5 \
-client=0.0.0.0 \
-node=consul-server02 \
-enable-script-checks=true \
-datacenter-dc1 \
-join 192.168.23.35 &> /var/log/consul.log &

-enable-script-checks=true ：设置检查服务为可用

-datacenter : 数据中心名称

-join ：加入到已有的集群中

2. 查看集群成员以及状态

consul members

consul operator raft list-peers

• consul members 用于查看当前 Consul 集群的成员列表。它会列出集群中的每个成员的详细信息，包括名称、地址、角色等。
• consul operator raft list-peers 用于查看 Consul 集群的 Raft 对等体列表。Raft 是 Consul 集群使用的一致性协议。此命令将显示当前集群中所有的 Raft 对等体的 ID 和地址。