Consul和Kong的實踐（一）

花生和饅頭發表於2019-08-02

Consul和Kong的實踐（一）

這一篇先介紹consul叢集，以及consul和應用服務的結合使用，下一篇是和kong閘道器的結合。

一.Consul的叢集安裝

以其中一臺機器為例：

  1. mkdir /usr/local/consul   建立consul的安裝目錄
  2. cd /usr/local/consul
  3. wget https://releases.hashicorp.com/consul/1.5.2/consul_1.5.2_linux_amd64.zip 建議大家不要直接使用我給出的下載地址，可以開了代理下好了，再將consul壓縮包上傳到伺服器或者虛擬機器。官網下載地址：https://www.consul.io/downloads.html  （我是centos7.X 64位作業系統）
  4. unzip consul_1.5.2_linux_amd64.zip   解壓cconsul壓縮包，如果沒有unzip命名，先安裝（yum -y install unzip）consul的壓縮包解壓以後是非常乾淨的，只有一個consul的二進位制檔案。
  5. cp consul /usr/local/bin    將consul檔案複製到 /usr/local/bin 目錄下面，這樣我們不管在什麼目錄下都可以執行了。
  6. consul version   老規矩，版本號測試一下。
  7. 下一步就是開啟consul的server服務了，consul分為server和client兩種節點。我們現在是先搭建server叢集。開啟consul server節點有兩種方式。

     1）直接執行，控制檯可檢視日誌，ctrl+c可直接退出。
    consul agent -server -ui -bootstrap-expect=3 -data-dir=/tmp/consul -node=node1
    -client=0.0.0.0 -bind=192.168.0.171 -datacenter=dc1
     2)  後臺執行
          nohup consul agent -server -ui -bootstrap-expect=3 -data-dir=/tmp/consul -node=node1 
   -client=0.0.0.0 -bind=192.168.0.171 -datacenter=dc1  >/tmp/consul/nohup.out 2>&1 &

    簡單介紹一下引數的意思：

     ** -server ： 定義agent執行在server模式
      -ui：開啟ui管理
      -bootstrap-expect ：在一個datacenter中期望提供的server節點數目，當該值提供的時候，consul一直等到達     到指定sever數目的時候才會引導整個叢集，該標記不能和bootstrap共用
      -client：**consul服務偵聽地址，這個地址提供HTTP、DNS、RPC等服務，預設是127.0.0.1所以不對外提供服            務，如果你要對外提供服務改成0.0.0.0
     如果你對更多配置有興趣，可以移步以下地址： https://www.consul.io/docs/agent/options.html

  1. 啟動以後我們可以檢查一下埠是否監聽：netstat -tunlp （如果nestat沒裝，可以執行 yum -y install net-tools）。可以看到8300 8301 8302以及8500和8600埠都已經監聽了。

      其中8500是ui埠，在我們叢集啟動以後，可以用ip:8500/ui 檢視，8600是域名解析埠，在我的解決方案裡        面會使用到。
  9. consul members 檢視成員，目前只有改節點。

  1. 在另外兩臺虛擬機器或者伺服器上重複以上操作，第七步命令有一些不同。

      consul agent -server -ui -bootstrap-expect=3 -data-dir=/tmp/consul -node=node2 -client=0.0.0.0
-bind=192.168.0.155 -datacenter=dc1 -join 192.168.0.171
consul agent -server -ui -bootstrap-expect=3 -data-dir=/tmp/consul -node=node3 -client=0.0.0.0
-bind=192.168.0.169 -datacenter=dc1 -join 192.168.0.171

  1. consul members 此刻就可以看到有三個節點了

     image.png

12.consul operator raft list-peers
     image.png
    
    在這裡我們可以看到consul叢集已經啟動了，自動選舉node2節點，也就是ip為155的這臺機器為leader，如果你     斷開了這臺機器，叢集會自動選舉下一個leader。
13.現在你可以選擇選擇三臺機器的任意一臺機器的ip，訪問ip:8500，即可以看到ui管理。（請注意關閉防火牆，或       者開啟該埠。不然其他機器上訪問不到）
     image.png

二.Consul的架構以及和應用程式的結合

       目前我們的架構如圖：

   image.png

       我們這篇部落格要達到的目的：

    image.png
         
     consul提供的節點有兩種模式，上面我們已經提到了，我們之前搭建的就是server，每個應用程式application到consul server之間，需要client的互動。你說client和application是部署在一臺機器上面的，這是官方推薦的架構，當然我們也可以有其他選擇，這裡我採用的是這種，比較簡單。（client是一個非常輕量級的程式.用於註冊服務,執行健康檢查和轉發對server的查詢，client無狀態）
     為了做到高可用，我們application服務本身就必須是高可用的，如圖所示，比如serviceA（文中application等於service概念）我在三臺伺服器上都部署了，同時通過三個consul client註冊了。這樣，不管是某臺consul client或者某臺service掛了，或者某臺consul server，都不會影響到我們的使用，其實nginx也可以做到類似功能，不過在服務註冊和發現上面，consul更為靈活。
    簡單介紹了一下我的設計，讓我們來繼續搭建吧：
    機器有限，我就不換機器了，還是在這三臺伺服器上面去部署了，這次部署consul client 我給你介紹另外一種          方式部署，docker，其實consul server的部署也可以用docker，這個選擇自己習慣的就行。

1.部署client 

      1）yum install -y docker  如果機器已經安裝了docker 請直接跳至第四步
      2）systemctl start docker
      3）systemctl status docker
      4)  docker pull consul:1.5.2
      5）docker images  檢視映象，可以看到已經拉到了。
      6）docker run --name nodeclient1 -d -p 8501:8500  -p 8311:8301 -p 8312:8302 -p 8601:8600      consul:1.5.2  agent  -ui -bind=0.0.0.0 -client=0.0.0.0  -join 192.168.0.171               
      7）consul members
          image.png
       8）按照架構圖裡面還需要部署兩臺，這裡就不做演示了，按照上述步驟，大家可以自行部署。
 9）部署完了可以在ui介面裡面看一下。
image.png

2.註冊services

    consul提供http api的方式註冊，如果是.NET core的程式可以採用這種方式手動去寫指令碼，或者程式碼去註冊。我這邊是java程式，採用的框架都是springboot，所以引用了springcloud就直接結合了consul的註冊，我先介紹一下這種。
    1）引用maven包  

 <dependency>
   <groupId>org.springframework.cloud</groupId>
   <artifactId>spring-cloud-starter-consul-all</artifactId>
   <version>2.1.1.RELEASE</version>
</dependency>
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-actuator</artifactId>
   <version>2.1.5.RELEASE</version>
</dependency>

   2）配置bootstrap.yml配置檔案，如果你本來專案是application.yml可以直接換成bootstrap.yml.
        核心配置貼個圖：
       image.png

spring:
 application:
    name: operating #Operating
 cloud:
    consul:
      host: 192.168.0.171  
      port: 8501
      discovery:
        register: true
        hostname: 192.168.0.159
        serviceName: ${spring.application.name}
        healthCheckPath: /api/operating/actuator/health
        healthCheckInterval: 15s
        tags: urlprefix-/${spring.application.name}
        #instanceId: ${spring.application.name}:${spring.cloud.client.ip-address}

     老規矩給大家介紹一下配置的意思：
     host：        consul client 的ip。
     port:           client 的port 。正常是8500，但是我用docker部署的時候用了8501對映了容器的8500,。
     hostname：健康檢查的ip 也就是你當前應用的ip，其實和前面host一樣，你把application和consul client部署                           在同一臺機器的時候，這兩個地方可以都填127.0.0.1。
     healthCheckPath：如果你沒配置context-path，那麼就是/actuator/health，我這裡配置context-path，所以                         加上來了。
     tags：        後期做版本管理，我會用起來，現在無所謂。
     instanceId: consul 註冊的時候預設是applicationName+port ，我這裡將他重寫了。所以你看到我將它註釋掉                          了。 
3）啟動springboot程式。服務註冊成功，檢視ui管理

image.png

三.基於consul叢集架構，呼叫服務

現在我們的服務已經註冊到了consul上面了，那麼針對目前架構，我們肯定還有兩個疑惑。
1.公司伺服器內部之間的呼叫，比如我們已經註冊了的rpc服務之間的呼叫，當然你是Restful也所謂。
2.閘道器層面怎麼呼叫consul。
針對第一點，springcloud是提供部分sdk的，當然如果你是.NET CORE，我不太清楚是否有相關sdk，沒有也可以自己寫。我先介紹一下，你如果想實現自己sdk的思路。
consul任何一個節點都提供了
http://192.168.0.155:8500/v1/agent/services      節點內部所有存活服務查詢
http://192.168.0.155:8500/v1/catalog/services    叢集內部所有存活服務查詢

http://192.168.0.155:8500/v1/agent/service/serviceName   節點內部單個服務查詢 
http://192.168.0.155:8500/v1/catalog/service/serviceName 叢集內部單個服務查詢
Tip：serviceName替換成你註冊的名稱

根據上述consul api介面我們是可以拿到你註冊的service實際ip和content-path，並且還有tags，那麼你還可以利用tags進行版本控制。
那我們先來看看，springcloud替我們做了什麼？
引用的包，我們已經引用了。
直接上程式碼：

public class ServerInvoke {
    @Autowired
    private LoadBalancerClient loadBalancer;
    @Autowired
    private DiscoveryClient discoveryClient;
    
     /**
     * 獲取所有服務
     *
     * @return
     */
    private List<ServiceInstance> services(String serverName) {
        return discoveryClient.getInstances(serverName);
    }

    /**
     * 從所有服務中選擇一個服務（輪詢）
     */
    private ServiceInstance discover(String serverName) {
        return loadBalancer.choose(serverName);
    }
}

很明顯可以發現我們可以拿到服務的實際地址，如果你的服務是高可用的，會輪訓拿到不同的地址。

針對服務以jsonrpc協議內部呼叫時

由於公司之前都是基於jsonrpc在呼叫（.NET平臺）為了相容。我寫了一個非常簡單的sdk，傳到了github，如果你公司不是jsonrpc協議，你可以自己寫一個，思路上面已經給了提供，在參考一下我寫的。（草稿版）
https://github.com/xiaoxiaobanxian/discoveryrpcsdk/tree/master

針對服務被外部（閘道器層呼叫）

     前文已經介紹了，consul是8600埠作為域名解析的，並且consul會為你的服務提供一個域名：serviceName.service.consul。所以只需要將你的請求轉發到8600即可，你可以採用serviceName.service.consul/XXX來訪問你的服務，前提是已經轉發到了consul的域名解析埠。
    測試一下 dig @127.0.0.1 -p 8600 Operating.service.consul SRV  （dig命令安裝 yum install bind-utils）
  image.png

可以看到通過consul域名解析是沒有問題的。

關於consul的叢集安裝，client安裝和services註冊我已經介紹完了，他們之間的呼叫也介紹了。下一篇文章就是介紹如何和kong閘道器結合起來。即使你不選擇Kong作為你的閘道器，這篇文章也可以幫你完善你的服務註冊和發現，以及呼叫。謝謝大家。

相關文章