Consul-template, Nginx 实现Thrift Consul负载均衡

发表于 | 分类于

Hello 大家好，我是阿粉，今天给大家分享一个采用 Consul 实现的负载均衡的方案，很多小伙伴都知道 Nginx 可以实现负载均衡，但是可能没实现过结合 Consul，今天就给大家分享一下。

整体架构

我们先看下整个框架的架构是什么样子的，这里我们有三个服务提供者和三个服务调用者，它们通过 Consul 和 Nginx，以及 Consul-template 来实现负载均衡。

说明 本例子是进行 RPC 的负载均衡，RPC 是 tcp协议，所以 Nginx 要配置 tcp 模块，支持 tcp 负载均衡。

  1. Consul 集群 用于服务注册，注册多个服务实例，对外提供 RPC 服务。
  2. Consul-template 用于实时监测 Consul 中服务的状态，配合自身一个模板文件，生成 Nginx 的配置文件。
  3. Nginx 使用自身的配置文件和第二步生成的配置文件，进行负载均衡。

Nginx安装

  1. 安装最新版 Nginx，保证 Nginx 版本在1.9.0以上
  2. 1.9.0 版本以上才支持 TCP 转发，据说不是默认安装了该模块，安装完成可以查询一下，如果有--with-stream参数，表示已经支持TCP。如果没有就重新编译增加参数安装。
  4. 我的 Nginx 安装在/etc/nginx目录下
  5. 安装完成使用nginx -t监测一下是否成功。

Consul-template

本文旨在负载均衡，Consul 集群搭建不作介绍。

  1. 下载对应系统版本文件 https://releases.hashicorp.com/consul-template/
  2. 解压，并复制到PATH路径下
1
2
[silence@centos145 ~]$ tar xzvf consul-template_0.19.4_linux_amd64.tgz
[silence@centos145 ~]$ mv ./consul-template /usr/sbin/consul-template
  1. 找个地方新建个文件夹，并创建三个文件

  2. config.hcl 主要用来配置consul-template的启动参数项，包括consul服务器的地址，模板文件的位置，生成的配置文件的位置等等。除了consul和template块，其他参数可选。参考https://github.com/hashicorp/consul-template

  3. Consul块配置Consul服务器地址和端口
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
consul {
  auth {
    enabled  = false
    username = "test"
    password = "test"
  }

  address = "172.20.132.196:8500"
  retry {
    enabled = true
    attempts = 12
    backoff = "250ms"
    max_backoff = "1m"
  }

}
  1. template块配置模板的路径和生成文件的位置，以及生成文件后需要执行的命令。在我们这里我们需要nginx重新加载配置文件，所以设置的命令为nginx -s reload
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
template {
  source = "/etc/nginx/consul-template/template.ctmpl"
  destination = "/etc/nginx/consul-template/nginx.conf"
  create_dest_dirs = true
  command = "/usr/sbin/nginx -s reload"
  command_timeout = "30s"
  error_on_missing_key = false
  perms = 0600
  backup = true
  left_delimiter  = "
  right_delimiter = "
  wait {
    min = "2s"
    max = "10s"
  }
}
  1. template.ctmpl编写，因为这里只需要服务器地址和端口号就可以，所以模板文件如下：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[root@centos145 consul-template]# cat template.ctmpl
stream {

    log_format main '$remote_addr - [$time_local] '
		    '$status';

    access_log /var/log/nginx/tcp_access.log main;

    upstream cloudsocket {
	\{\{range service "ad-rpc-device-server"}}server \{\{.Address}}:\{\{.Port}};
    }

    server {
	listen 8888;
	proxy_pass cloudsocket;
    }
}
  1. 启动consul-template consul-template -config=./config.hcl

使用config.hcl配置文件是为了简化命令 consul-template -consul-addr=172.20.132.196:8500 -template=./template.ctmpl:./nginx.conf

  1. 初始的nignx.conf文件为空的，在启动后内容为
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[root@centos145 consul-template]# cat nginx.conf
stream {

    log_format main '$remote_addr - [$time_local] '
		    '$status';

    access_log /var/log/nginx/tcp_access.log main;

    upstream cloudsocket {
	server 172.20.139.77:8183;
    }

    server {
	listen 8888;
	proxy_pass cloudsocket;
    }
}

确保服务已经成功注册到Consul中，即可以看到服务器地址和端口已经配置进去了。

  1. 在nginx的安装目录的nginx.conf中引入consul-template生成的配置文件 include /etc/nginx/consul-template/nginx.conf;

注意生成的配置文件不能喝nginx本身的配置文件中内容重复！！！

  1. 启动一个服务实例，查看生成的nginx.conf文件会发现在upstream cloudsocket{}中会动态增加服务列表，并且随着服务的加入和离开，动态变化。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[root@centos145 consul-template]# cat nginx.conf
stream {

    log_format main '$remote_addr - [$time_local] '
		    '$status';

    access_log /var/log/nginx/tcp_access.log main;

    upstream cloudsocket {
	server 172.20.139.77:8183;
    }

    server {
	listen 8888;
	proxy_pass cloudsocket;
    }
}

再启动一个，服务列表变成两个了

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[root@centos145 consul-template]# cat nginx.conf
stream {

    log_format main '$remote_addr - [$time_local] '
		    '$status';

    access_log /var/log/nginx/tcp_access.log main;

    upstream cloudsocket {
	server 172.20.139.77:8183;server 172.20.139.77:8184;
    }

    server {
	listen 8888;
	proxy_pass cloudsocket;
    }
}
  1. thrift客户端在调用的时候只需要配置Nginx的地址和端口就可以了，不需要配置服务的地址和端口了，Nginx会自动做转发。

总结

今天阿粉给大家介绍了一个新的负载均衡实现方案，这种方案对于一些小规模的集群还是很不错的，当然如果是大集群，还是采用阿里云或者腾讯云提供的方案才是最好的。想自己实现的小伙伴环境去尝试搭建一下，还是很好玩的。

写在最后

最后邀请你加入我们的知识星球，这里有 1800+ 优秀的人与你一起进步，如果你是小白那你是稳赚了，很多业内经验和干活分享给你；如果你是大佬，那可以进来我们一起交流分享你的经验，说不定日后我们还可以有合作，给你的人生多一个可能。

Java Geek Tech wechat
欢迎订阅 Java 极客技术，这里分享关于 Java 的一切。