微服务Consul系列之服务部署、搭建、使用

使用Consul解决了哪些问题

• 是否在为不同环境来维护不同项目配置而发愁
• 是否有因为配置的更改导致代码还要进行修改、发布因为客流量大了还要规避开高峰期等到半夜来发布
• 微服务架构下应用的分解业务系统与服务系统之间的调用管理

以上只是列举的笔者曾经遇到的几点问题当然问题还不止于这些下面介绍的Consul可以有效解决这些问题当然还有一些其它的优点让我们一起期待下文的Consul的讲解。

Consul的四大核心特性:

• 服务发现可以方便的实现服务注册通过DNS或者HTTP应用程序可以很容易的找到他所依赖的服务.
• Key/Value存储使用Key/Value进行数据存储。
• 多数据中心Consul支持开箱即用的多数据中心。这意味着用户不需要担心建立额外的抽象层让业务扩展到多个区域
• 健康检查可以对指定服务进行健康检查例如Response Status是否为200避免将流量转发到不健康的服务上。

Consul架构

图片来自官网 Consul Architecture

上图很好的展示了Consul对于多数据中心的支持另外在两个数据中心之间只有Service层可以相互通信。

Consul是一个分布式高可用的系统一个发现和配置服务的工具。客户端可以利用它提供的API注册和发现服务及监控检测功能实现服务的高可用深入的架构描述具体细节可以参考官网Consul Architecture下面开始进入实战操作部分。

安装部署

本处主要以linux来讲解其他操作平台见官网Download Consul

下载 wget https://releases.hashicorp.com/consul/1.4.0/consul_1.4.0_linux_amd64.zip

解压 unzip consul_1.4.0_linux_amd64.zip 得到目录consul
复制 consul到你的系统的任何一个地方如果你想使用命令行直接访问确保复制的目录在你的PATH里 cp consul /usr/local/bin/

验证consul是否安装成功出现以下窗口则安装成功

[root@iZbp1isjfk2rw8fpnxx8wgZ ~]# consul
Usage: consul [--version] [--help] <command> [<args>]

Available commands are:
    acl            Interact with Consul's ACLs
    agent          Runs a Consul agent
    catalog        Interact with the catalog
    connect        Interact with Consul Connect
    debug          Records a debugging archive for operators
    event          Fire a new event
    exec           Executes a command on Consul nodes
    force-leave    Forces a member of the cluster to enter the "left" state
    info           Provides debugging information for operators.
    intention      Interact with Connect service intentions
    join           Tell Consul agent to join cluster
    keygen         Generates a new encryption key
    keyring        Manages gossip layer encryption keys
    kv             Interact with the key-value store
    leave          Gracefully leaves the Consul cluster and shuts down
    lock           Execute a command holding a lock
    maint          Controls node or service maintenance mode
    members        Lists the members of a Consul cluster
    monitor        Stream logs from a Consul agent
    operator       Provides cluster-level tools for Consul operators
    reload         Triggers the agent to reload configuration files
    rtt            Estimates network round trip time between nodes
    services       Interact with services
    snapshot       Saves, restores and inspects snapshots of Consul server state
    validate       Validate config files/directories
    version        Prints the Consul version
    watch          Watch for changes in Consul

Consul Agent

执行consul agent -dev启动开发模式这个模式会快速启动一个单节点的Consul。注意这个模式不能数据持久化因此不能用于生产环境

启动命令简介

• -server定义agent运行在server模式每个数据中心的Server建议在35个避免失败情况下数据的丢失
• -client定义agent运行在client模式
• -bootstrap-expect在一个datacenter中期望提供的server节点数目当该值提供的时候consul一直等到达到指定sever数目的时候才会引导整个集群
• -bind节点的ip地址一般是0.0.0.0或云服务内网地址用于被集群中的其他节点所访问
• -node指定节点在集群中的唯一名称默认为机器的hostname
• -config-dir配置文件目录里面所有以.json结尾的文件都会被加载
• 更多可选参数参考Consul Command-line Options

Start Agent

[root@iZbp1isjfk2rw8fpnxx8wgZ ~]# consul agent -dev
==> Starting Consul agent...
==> Consul agent running!
           Version: 'v1.4.0'
           Node ID: '9e05f4d6-56c1-e57c-c726-15d9ab1c0dd5'
         Node name: 'iZbp1isjfk2rw8fpnxx8wgZ'
        Datacenter: 'dc1' (Segment: '<all>')
            Server: true (Bootstrap: false)
       Client Addr: [127.0.0.1] (HTTP: 8500, HTTPS: -1, gRPC: 8502, DNS: 8600)
      Cluster Addr: 127.0.0.1 (LAN: 8301, WAN: 8302)
           Encrypt: Gossip: false, TLS-Outgoing: false, TLS-Incoming: false

==> Log data will now stream in as it occurs:

看下 consul agent 输出的几个重要信息

• Node name代理的唯一名称默认是机器的hostname可以通过-node标志自定义例如consul agent -dev -node myNode
• Datacenter数据中心Consul支持多个数据中心为了有效的工作每个节点必须被配置且上报到数据中心-datacenter标志用来设置数据中心对于单一的DC配置这个代理默认为dc1
• Server表示代理是以服务器还是客户端的模式来运行。
• Client Addr用于代理的客户端接口地址。
• Cluster Addr用于集群中的Consul代理之间通信的地址和端口集改地址必须可供其它节点访问。

查看集群成员

打开一个新终端执行consul members可以看到集群的成员。

• Node节点名称
• Address节点地址
• Statusalive表示节点为健康状态
• Type节点的运行模式Server

Stop Agent

Agent两种停止方式gracefully或forcefully
gracefully方式停止则是发送中断信号到Agent进程两种方法Ctrl+C、kill -INT consul_pid

服务注册

Consul服务搭建好之后通过提供服务定义或HTTP API注册一个服务通用的模式是通过提供服务定义的方式下文还会介绍怎么应用Consul进行健康检查

提供服务定义方式服务注册

创建目录/etc/consul.d(.d 后缀意思是这个路径包含了一组配置文件Consul会载入该目录下的所有文件。

例如我现在有个测试服务test01端口为3010

sudo mkdir /etc/consul.d/test01.json

{
    "service":{
        "name":"test01",
        "tags":[
            "",
            ""
        ],
        "address":"127.0.0.1",
        "port":3010,
        "enable_tag_override": false,
        "check":{
            "deregisterCriticalServiceAfter":"90m",
            "http":"http://127.0.0.1:3010/health",
            "interval":"10s"
        }
    }
}

服务定义配置文件含义

• name服务名
• tags服务的tag自定义可以根据这个tag来区分同一个服务名的服务
• address服务注册到consul的IP服务发现发现的就是这个IP
• port服务注册consul的PORT发现的就是这个PORT
• enable_tag_override标签是否允许覆盖
• check健康检查部分
  • deregisterCriticalServiceAfter
  • http指定健康检查的URL调用后只要返回20Xconsul都认为是健康的
  • interval健康检查间隔时间每隔10s调用一次上面的URL

重启Agent设置配置目录

consul agent -dev -config-dir /etc/consul.d

看以下运行结果

启动之后控制台输出了Synced service "test01"意思是Agent从配置文件中载入了服务定义且成功注册到服务目录另外右边的服务test01也收到了健康检查接口调用

采用HTTP API服务注册

调用/v1/agent/service/register接口进行注册请求Method为PUT方式

请求Body值为服务定义中的service值看一下示例

curl -X PUT \
  http://127.0.0.1:8301/v1/agent/service/register \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'postman-token: 6b672c02-350f-3d1c-7793-1a0d9e800fc9' \
  -d '{
	"id": "test01",
    "name":"test01",
    "tags":[
        "",
        ""
    ],
    "address":"127.0.0.1",
    "port":3010,
    "check":{
        "deregisterCriticalServiceAfter":"90m",
        "http":"http://127.0.0.1:3010/health",
        "interval":"10s"
    }
}'

本篇为微服务架构中基于Consul实现的服务注册系列文章目录如下

• 微服务Consul系列之服务部署、搭建、使用
• 微服务Consul系列之集群搭建
• 微服务Consul系列之服务注册与服务发现
• 微服务Consul系列之问题汇总篇