eureka官方已經正式宣布:自2.0起不再維護該項目,並在github 項目wiki上放出了一段嚇唬人的話:
大意就是:從2.x起,官方不會繼續開發了,如果需要使用2.x,風險自負。但其實我覺得問題並不大,eureka目前的功能已經非常穩定,就算不升級,服務注冊/發現這些功能已經夠用。
如果想尋找替代方案的話,建議采用功能更為豐富的consul,除了服務注冊、發現,consul還提供了k-v存儲等其它功能,consul的官網針對其它同類軟件也做了詳細比較,詳見 consul vs other software,有興趣的可以看看,特別是有一句話,翻譯成大白話就是:我不是針對在座的各位,我想說除我之外其它的都是渣渣(足見其相當的自信!)
進入正題,先來看consul的部署安裝:
一、集群規划
consul借助agent來運行,類似elk的logstash agent 或 zabbix監控系統的agent ,每個需要被發現的服務上,通過consul agent client 來收集服務本身的信息,然后向consul agent server匯報, consul server 可以集群部署。
規划一下:
序號 | 節點ip | 節點名稱 | 角色 |
1 | 10.0.xx.55 | server1 | server |
2 | 10.0.xx.203 | server2 | server |
3 | 10.0.xx.204 | server3 | server |
4 | 10.0.xx.205 | client1 | client & web ui |
這是按正式生產環境來規划的,如果本機開發,有一個方便的dev模式(后面再講)。 上述表格中,我們打算組建3個server節點的consul server cluster,另外有1個client,模擬客戶端以及充當consul的web admin ui(管理界面)。
二、下載安裝
目前consul的最高版本為1.2.0,只需要把相應的release壓縮包 下載到機器上解壓即可。
➜ ~ consul version Consul v1.2.0 Protocol 2 spoken by default, understands 2 to 3 (agent will automatically use protocol >2 when speaking to compatible agents)
如果出現版本輸出,就表示可以了(4個節點上,每台機器上都重復上述操作,全安裝好)
三、啟動
3.1 啟動server端
基本的命令為:
consul agent -server -bind=10.0.xx.55 -client=0.0.0.0 -bootstrap-expect=3 -data-dir=/data/application/consul_data/ -node=server1
看着一大堆參數,其實不復雜
-server 表示是以服務端身份啟動
-bind 表示綁定到哪個ip(有些服務器會綁定多塊網卡,可以通過bind參數強制指定綁定的ip)
-client 指定客戶端訪問的ip(consul有豐富的api接口,這里的客戶端指瀏覽器或調用方),0.0.0.0表示不限客戶端ip
-bootstrap-expect=3 表示server集群最低節點數為3,低於這個值將工作不正常(注:類似zookeeper一樣,通常集群數為奇數,方便選舉,consul采用的是raft算法)
-data-dir 表示指定數據的存放目錄(該目錄必須存在)
-node 表示節點在web ui中顯示的名稱
啟動成功后,終端窗口不要關閉,可以在瀏覽器里,訪問下,類似 http://10.0.xx.55:8500/,正常的話,應該會看到一行文字:Consul Agent。
為了防止終端關閉后,consul退出,可以在剛才命令上,加點東西,類似:
nohup xxx > /dev/null 2>&1 &
即:
nohup consul agent -server -bind=10.0.xx.55 -client=0.0.0.0 -bootstrap-expect=3 -data-dir=/data/application/consul_data/ -node=server1 > /dev/null 2>&1 &
將其轉入后台運行。
另外2台節點上,也做類似操作:
nohup consul agent -server -bind=10.0.xx.203 -client=0.0.0.0 -bootstrap-expect=3 -data-dir=/data/application/consul_data/ -node=server2 > /dev/null 2>&1 &
注意更改bind參數的ip,以及node參數里的節點名稱。
nohup consul agent -server -bind=10.0.xx.204 -client=0.0.0.0 -bootstrap-expect=3 -data-dir=/data/application/consul_data/ -node=server3 > /dev/null 2>&1 &
3.2 啟動client端
幾乎完全一樣,只是把-server 去掉,在10.0.xx.205上運行:
nohup consul agent -client=0.0.0.0 -data-dir=/data/application/consul_data/ -node=client1 -ui > /dev/null 2>&1 &
四、組建cluster
現在我們有了3個server node + 1個client node,但是這4個節點都是相互獨立的,可以在任一節點上運行:
consul members
可以看到,只有自身節點的信息。
要加自己加入集群,可以運行以下命令(假設:其它3個節點,都加入10.0.xx.55)
consul join 10.0.xx.55
成功后,會輸出:
Successfully joined cluster by contacting 1 nodes.
其它2個節點(指:10.0.xx.55之外的節點)上類似上述操作,都加入集群中,完成后,可以再次驗證
可以看到4台節點的信息都有了。
tips: 如果反過來,要將1個節點從集群中撤掉,可以在該節點上運行consul leave 即可。
五、web ui
10.0.xx.205上,可能有同學注意到了,啟動consul時,我們加了一個 -ui 的參數,這代表將啟動consul自帶的web管理界面,訪問 http://10.0.xx.205:8500/ui
可以看到各節點的信息。
六、服務注冊/發現/注銷
現在services里,除了consul外,並沒有其它服務注冊進來。可以通過api 手動注冊一個服務:
用postman(或其它rest api工具、curl都行),向 http://10.0.xx.55:8500/v1/agent/service/register ,發送以下json,http method指定為PUT, Content-Type指定為application/json
{ "ID": "my-service-id", "Name": "my-service-name", "Tags": [ "release=1", "mytag=xyz" ], "Address": "192.168.1.1", "Port": 8000, "Meta": { "my_version": "4.0" }, "EnableTagOverride": false, "Check": { "DeregisterCriticalServiceAfter": "90m", "HTTP": "http://yjmyzz.cnblogs.com/", "Interval": "10s" } }
其中的參數名一看就能大概猜出含義,就不詳細解釋了,想深入研究的,建議參看consul api文檔。發送完成后,再看web ui
就能看到新注冊的服務my-service-name,特別要提一下的是tags,eureka中有metadata-map可以提供元數據,consul中對應的特性為tags。
除了web ui,還可以通過rest接口,發現服務的詳細信息:
http://10.0.21.55:8500/v1/agent/services 這個rest api可以列出所有服務:
{ "my-service-id": { "Kind": "", "ID": "my-service-id", "Service": "my-service-name", "Tags": [ "release=1", "mytag=xyz" ], "Meta": { "my_version": "4.0" }, "Port": 8000, "Address": "192.168.1.1", "EnableTagOverride": false, "CreateIndex": 0, "ModifyIndex": 0, "ProxyDestination": "", "Connect": null } }
服務發現,其實就是通過這個api實現的,有服務注冊就會有反向操作:服務注銷。同樣也是通過api完成
curl -X PUT http://10.0.21.55:8500/v1/agent/service/deregister/my-service-id
這樣就把my-service-id這個服務給注銷了
七、dev開發者模式
前面這一陣折騰需要好幾台機器,本機調試開發時不太方便,為此consul體貼的提供了dev模式,使用方式極為簡單
consul agent -dev
開發模式,自帶了web ui,直接http://localhost:8500/ 即可,非常方便。
八、與spring-cloud的集成
前面這些鋪墊,其實就是為了與spring-cloud的集成,非常簡單:
compile('org.springframework.cloud:spring-cloud-starter-consul-discovery')
添加對org.springframework.cloud:spring-cloud-starter-consul-discovery的依賴
然后application.yml中配置如下節點:
spring: ... cloud: consul: host: 127.0.0.1 port: 8500 discovery: tags: version=1.0,author=yjmyzz healthCheckPath: /info.json healthCheckInterval: 5s instanceId: ${spring.application.name}:${vcap.application.instance_id:${spring.application.instance_id:${random.value}}}
注:
一般在需要部署的微服務機器上,都約定安裝consul agent,所以這里host通常指定為127.0.0.1 (本機測試consul可用dev模式啟動);
tags 相當於eureka里的metadata-map,大家根據實際需要設置
healthCheckPath 為健康檢查的url,可以配置成/health或其它能檢測出微服務運行狀態的url
healthCheckInterval 為healthcheck的時間間隔
instanceId這一長串,spring cloud官網文檔的推薦,為了保證生成一個唯一的id ,也可以換成
${spring.application.name}:${spring.cloud.client.ipAddress}
(即:以ip結尾),這個instanceId即為consul service列表中的service id
最后提醒一下:如果使用consul來替換eureka,而你的項目中又依賴了eureka的jar包,最好將eureka的自動配置從啟動類里排除掉,參考下面:
注:如果項目的pom/gradle依賴項里,已經移除了org.springframework.cloud:spring-cloud-starter-eureka-server 就不用exclude排除EurekaClientAutoConfiguration,另外上圖中@EnableEurekaClient 也可以換成@EnableDiscoveryClient
參考文檔:
1、https://www.consul.io/api/index.html
2、https://www.consul.io/intro/getting-started/install.html