Consul服務(wù)注冊發(fā)現(xiàn)集群搭建
Consul 是一種用于服務(wù)發(fā)現(xiàn)、配置和分布式一致性的開源工具和平臺(tái)。它由 HashiCorp 公司開發(fā)和維護(hù),旨在簡化構(gòu)建和維護(hù)分布式系統(tǒng)的任務(wù)。
Consul 提供了許多功能,包括:
-
服務(wù)發(fā)現(xiàn):Consul允許服務(wù)注冊和發(fā)現(xiàn)。當(dāng)服務(wù)啟動(dòng)時(shí),它可以向Consul注冊自己的位置和元數(shù)據(jù)。其他服務(wù)可以通過Consul查詢來發(fā)現(xiàn)特定服務(wù)的位置,從而輕松實(shí)現(xiàn)服務(wù)之間的通信。
-
健康檢查:Consul可以周期性地對服務(wù)進(jìn)行健康檢查,以確保它們正常工作。如果服務(wù)不再健康,則Consul可以自動(dòng)將其標(biāo)記為不可用,并將流量路由到其他健康的實(shí)例。
-
KV存儲(chǔ):Consul包含一個(gè)分布式鍵/值存儲(chǔ)系統(tǒng),可以用于配置、功能標(biāo)志和其他臨時(shí)數(shù)據(jù)的存儲(chǔ)。
-
多數(shù)據(jù)中心支持:Consul支持多數(shù)據(jù)中心集群,允許在不同地理位置部署多個(gè)Consul集群,并在它們之間進(jìn)行通信和同步。
-
一致性保證:Consul使用Raft協(xié)議來確保數(shù)據(jù)的一致性和高可用性。它能夠在節(jié)點(diǎn)故障或網(wǎng)絡(luò)分區(qū)時(shí)繼續(xù)正常運(yùn)行。
-
DNS接口:Consul提供了一個(gè)DNS接口,允許使用域名進(jìn)行服務(wù)發(fā)現(xiàn),而無需依賴專門的服務(wù)發(fā)現(xiàn)庫。
總的來說,Consul是一個(gè)強(qiáng)大的工具,可以幫助開發(fā)人員和運(yùn)維人員構(gòu)建和管理可靠的分布式系統(tǒng),簡化了服務(wù)發(fā)現(xiàn)、配置管理和系統(tǒng)監(jiān)控等任務(wù)。
下載安裝Consul

選擇對應(yīng)linux 安裝consul
sudo yum install -y yum-utils
sudo yum-config-manager --add-repo https://rpm.releases.hashicorp.com/RHEL/hashicorp.repo
sudo yum -y install consul
國內(nèi)加速阿里云Consul v1.18.0備份
驗(yàn)證
$ consul version
Consul v1.18.0
Revision 349cec17
Build Date 2024-02-26T22:05:50Z
Protocol 2 spoken by default, understands 2 to 3 (agent will automatically use protocol >2 when speaking to compatible agents)
單機(jī)啟動(dòng)
consul agent -dev -client=0.0.0.0
在運(yùn)行Consul代理時(shí),你可以通過一些參數(shù)來優(yōu)化命令。這些參數(shù)可以幫助你更好地配置Consul:
-
指定數(shù)據(jù)中心:使用
-datacenter參數(shù)可以指定Consul代理所屬的數(shù)據(jù)中心。例如,-datacenter=mydc。 -
指定節(jié)點(diǎn)名稱:使用
-node參數(shù)可以指定Consul代理的節(jié)點(diǎn)名稱。例如,-node=myagent。 -
開啟UI界面:使用
-ui參數(shù)可以啟動(dòng)Consul的Web UI界面,方便可視化管理。例如,-ui。 -
指定日志級別:使用
-log-level參數(shù)可以指定Consul代理的日志級別。例如,-log-level=info。 -
開啟gRPC API:使用
-grpc參數(shù)可以開啟Consul的gRPC API,允許使用gRPC接口與Consul進(jìn)行交互。例如,-grpc。 -
指定綁定地址:使用
-bind參數(shù)可以指定Consul代理綁定的地址。例如,-bind=192.168.1.100。 -
禁用DNS緩存:使用
-disable-host-node-id參數(shù)可以禁用Consul的DNS緩存。例如,-disable-host-node-id。
綜合使用這些參數(shù),你可以優(yōu)化你的Consul代理命令,使其更適合你的環(huán)境和需求。例如:
consul agent -dev -client=0.0.0.0 -datacenter=mydc -node=myagent -ui -log-level=info -grpc -bind=192.168.1.100 -disable-host-node-id
這個(gè)命令將啟動(dòng)一個(gè)綁定到所有接口的Consul代理,使用名為mydc的數(shù)據(jù)中心,節(jié)點(diǎn)名稱為myagent,開啟了Web UI界面、gRPC API,并設(shè)置了日志級別為info。
集群部署

要列出 rpm 安裝 Consul 后所產(chǎn)生的文件,可以使用以下命令
# 查看yum下載安裝consul
rpm -ql consul
/etc/consul.d/consul.env
/etc/consul.d/consul.hcl
/usr/bin/consul
/usr/lib/systemd/system/consul.service
這些文件的功能介紹如下:
-
/etc/consul.d/consul.env: 這個(gè)文件通常用于設(shè)置 Consul 運(yùn)行時(shí)的環(huán)境變量。環(huán)境變量可以影響 Consul 的行為,例如設(shè)置日志級別、數(shù)據(jù)目錄路徑等。在這個(gè)文件中,你可以配置一些 Consul 運(yùn)行時(shí)所需的環(huán)境變量。 -
/etc/consul.d/consul.hcl: 這是 Consul 的主要配置文件。在這個(gè)文件中,你可以配置 Consul 的各種選項(xiàng),包括集群配置、數(shù)據(jù)中心、節(jié)點(diǎn)名稱、綁定地址、廣告地址、加入集群的地址、監(jiān)聽端口、日志設(shè)置等。通過編輯這個(gè)文件,你可以定制 Consul 的行為和功能。 -
/usr/bin/consul: 這是 Consul 的可執(zhí)行文件。通過執(zhí)行這個(gè)文件,你可以啟動(dòng) Consul Agent,并根據(jù)配置文件中的設(shè)置來運(yùn)行 Consul。 -
/usr/lib/systemd/system/consul.service: 這是 Consul 的 Systemd 服務(wù)單元文件。它定義了 Consul 作為 Systemd 服務(wù)的配置,包括服務(wù)的啟動(dòng)方式、依賴關(guān)系等。通過 Systemd,你可以使用systemctl命令來管理 Consul 服務(wù)的啟動(dòng)、停止、重啟等操作。
這些文件是安裝 Consul 包后在系統(tǒng)上生成的關(guān)鍵文件,用于配置和管理 Consul 的運(yùn)行。通過修改配置文件,你可以調(diào)整 Consul 的行為,使其適應(yīng)特定的需求和環(huán)境。
編輯Consul配置文件
以下是根據(jù)配置內(nèi)容的重要性和功能進(jìn)行分組,并添加了注釋和適當(dāng)?shù)呐渲眠x項(xiàng)的配置文件示例:
vim /etc/consul.d/consul.hcl
配置文件名為consul.hcl,而 JSON 是另一種格式,通常使用 .json 擴(kuò)展名。如果你要使用 HCL(HashiCorp Configuration Language)格式,你可以像下面這樣編輯:
# Consul 配置文件
# 數(shù)據(jù)中心設(shè)置
datacenter = "dc1"
# 節(jié)點(diǎn)名稱設(shè)置(注意:不可重名)
node_name = "consul-36"
# 數(shù)據(jù)目錄設(shè)置
data_dir = "/opt/consul"
# 日志級別設(shè)置(可選值:TRACE, DEBUG, INFO, WARN, ERR)
log_level = "ERR"
# 綁定地址設(shè)置(監(jiān)聽所有 IPv6 地址和所有 IPv4 地址)
bind_addr = "[::]"
bind_addr = "0.0.0.0"
# 廣播自己地址給集群訪問(用于集群內(nèi)部通信)
advertise_addr = "192.168.3.36"
# 加入集群的地址列表(需要提供至少一個(gè)已知的集群節(jié)點(diǎn)地址,:8301默認(rèn)端口可省略)
retry_join = ["192.168.3.39:8301", "192.168.3.53", "192.168.3.54"]
# 用于指定 Consul Agent 在啟動(dòng)時(shí)嘗試通過加入集群節(jié)點(diǎn)。
start_join = ["192.168.3.39", "192.168.3.53", "192.168.3.54"]
# 服務(wù)節(jié)點(diǎn)設(shè)置(是否為服務(wù)器節(jié)點(diǎn))
server = true
# 這會(huì)告訴Consul在引導(dǎo)期間等待2個(gè)服務(wù)器節(jié)點(diǎn)就緒,然后再引導(dǎo)整個(gè)集群。
bootstrap_expect = 2
# 加密設(shè)置(consul keygen 生成的用于集群網(wǎng)絡(luò)通信的加密)
encrypt = "KUZZ6X4oQhUvXeu+aN1EHL4DVgep8jk4ltflcLQ2DvQ="
# 客戶端地址設(shè)置(用于監(jiān)聽客戶端請求的地址)
client_addr = "0.0.0.0"
# UI 配置(用于啟用內(nèi)置的 Web UI)
ui_config {
enabled = true
content_path = "/ui/" #可自定義路徑
}
# 默認(rèn)端口設(shè)置
ports {
# HTTP API 端口(默認(rèn)值:8500)與 Consul 進(jìn)行交互,包括服務(wù)注冊、UI、健康檢查等
http = 8500
# DNS 端口(默認(rèn)值:8600)用于提供 DNS 查詢服務(wù),允許客戶端通過 DNS 協(xié)議來查詢服務(wù)實(shí)例的地址
dns = 8600
# Serf LAN 端口(默認(rèn)值:8301)局域網(wǎng)內(nèi)進(jìn)行集群節(jié)點(diǎn)間的通信
serf_lan = 8301
# Serf WAN 端口(默認(rèn)值:8302) 廣域網(wǎng)(WAN)內(nèi)進(jìn)行集群節(jié)點(diǎn)間的通信,用于跨數(shù)據(jù)中心的通信
serf_wan = 8302
# 服務(wù)器 RPC 端口(默認(rèn)值:8300)服務(wù)器節(jié)點(diǎn)之間進(jìn)行 RPC 通信
server = 8300
}
這個(gè)配置文件根據(jù)不同的功能進(jìn)行了分組,并添加了注釋以說明各個(gè)配置項(xiàng)的作用和用法。
# 啟動(dòng)
consul agent -config-file=/etc/consul.d
Consul 會(huì)在這個(gè)目錄中尋找配置文件并加載。
常用命令
以下是一些常用的 Consul 集群管理命令:
- 啟動(dòng) Consul Agent:
consul agent -config-file=<config_file>
這個(gè)命令用于啟動(dòng) Consul Agent,并指定配置文件。
- 加入集群:
consul join <address>
這個(gè)命令用于將當(dāng)前節(jié)點(diǎn)加入到 Consul 集群中,<address> 是一個(gè)已存在的集群節(jié)點(diǎn)的地址。
- 離開集群:
consul leave
這個(gè)命令用于將當(dāng)前節(jié)點(diǎn)從 Consul 集群中移除。
- 查看集群節(jié)點(diǎn):
consul members
這個(gè)命令用于查看當(dāng)前 Consul 集群中的成員節(jié)點(diǎn)列表。
- 查看 Leader:
consul operator raft list-peers
這個(gè)命令用于列出當(dāng)前的 Consul 集群中的領(lǐng)導(dǎo)者節(jié)點(diǎn)。
- 手動(dòng)推選 Leader:
consul operator raft promote <node_id>
這個(gè)命令用于手動(dòng)推選指定節(jié)點(diǎn)為 Consul 集群的領(lǐng)導(dǎo)者。
- 重啟集群節(jié)點(diǎn):
consul reload
這個(gè)命令用于重新加載 Consul 配置文件并重啟 Consul Agent。
- 查看服務(wù)列表:
consul catalog services
這個(gè)命令用于列出所有在 Consul 中注冊的服務(wù)。
- 注冊服務(wù):
consul services register <service.json>
這個(gè)命令用于注冊一個(gè)新的服務(wù)到 Consul 中,<service.json> 是包含服務(wù)定義的 JSON 文件。
- 移除服務(wù):
consul services deregister <service_id>
這個(gè)命令用于從 Consul 中移除一個(gè)已注冊的服務(wù),<service_id> 是服務(wù)的唯一標(biāo)識(shí)符。
這些命令可以幫助你管理和維護(hù) Consul 集群,確保其正常運(yùn)行并滿足你的需求。

浙公網(wǎng)安備 33010602011771號