consul命令行

• advertise：廣告地址用于將我們通告的地址更改為群集中的其他節點。默認情況下，-bind通告地址。但是，在某些情況下，可能存在無法綁定的可路由地址。此標志允許閑聊不同的地址以支持此功能。如果此地址不可路由，則該節點將處于恒定的振蕩狀態，因為其他節點將不可路由性視為故障。在Consul 1.0及更高版本中，可以將其設置為 go-sockaddr 模板。

• -advertise-wan：廣告WAN地址用于將我們通告的地址更改為通過WAN加入的服務器節點。當與translate_wan_addrs配置選項結合使用時，也可以在客戶端代理上設置此選項。默認情況下，-advertise通告地址。但是，在某些情況下，所有數據中心的所有成員都不能位于同一物理或虛擬網絡上，尤其是混合云和私有數據中心的混合設置。此標志使服務器節點通過公共網絡為WAN進行閑聊，同時使用專用VLAN互相閑聊及其客戶端代理，并且如果遠程數據中心是遠程數據中心，則允許從遠程數據中心訪問此地址時訪問客戶端代理。配置了translate_wan_addrs。在Consul 1.0及更高版本中，這可以設置為 go-sockaddr 模板

• -bootstrap： 此標志用于控制服務器是否處于“引導”模式。重要的是，在此模式下，每個數據中心只能運行一臺服務器。從技術上講，允許自舉模式的服務器作為Raft領導者自行選舉。重要的是只有一個節點處于這種模式; 否則，無法保證一致性，因為多個節點能夠自我選擇。在引導群集后，建議不要使用此標志。

• -bootstrap-expect：此標志提供數據中心中預期的服務器數。不應提供此值，或者該值必須與群集中的其他服務器一致。提供后，Consul將等待指定數量的服務器可用，然后引導群集。這允許自動選擇初始領導者。這不能與傳統-bootstrap標志一起使用。此標志需要-server模式。

• -bind：應綁定到內部群集通信的地址。這是群集中所有其他節點都應該可以訪問的IP地址。默認情況下，這是“0.0.0.0”，這意味著Consul將綁定到本地計算機上的所有地址，并將 第一個可用的私有IPv4地址通告給群集的其余部分。如果有多個私有IPv4地址可用，Consul將在啟動時退出并顯示錯誤。如果指定“[::]”，Consul將 通告第一個可用的公共IPv6地址。如果有多個可用的公共IPv6地址，Consul將在啟動時退出并顯示錯誤。Consul同時使用TCP和UDP以及相同的端口。如果您有防火墻，請務必同時允許這兩種協議。在Consul 1.0及更高版本中，可以將其設置為需要解析為單個地址的go-sockaddr模板。

• -serf-wan-bind ：應該綁定到Serf WAN八卦通信的地址。默認情況下，該值遵循與-bind命令行標志相同的規則，如果未指定，-bind則使用該選項。這可以在Consul 0.7.1及更高版本中找到。在Consul 1.0及更高版本中，可以將其設置為 go-sockaddr 模板

• -serf-lan-bind：應該綁定到Serf LAN八卦通信的地址。這是群集中所有其他LAN節點都應該可以訪問的IP地址。默認情況下，該值遵循與-bind命令行標志相同的規則，如果未指定，-bind則使用該選項。這可以在Consul 0.7.1及更高版本中找到。在Consul 1.0及更高版本中，可以將其設置為 go-sockaddr 模板

• -client：Consul將綁定客戶端接口的地址，包括HTTP和DNS服務器。默認情況下，這是“127.0.0.1”，僅允許環回連接。在Consul 1.0及更高版本中，可以將其設置為以空格分隔的要綁定的地址列表，或者設置為 可以解析為多個地址的 go-sockaddr模板。

• -config-file：要加載的配置文件。有關此文件格式的更多信息，請閱讀“ 配置文件”部分。可以多次指定此選項以加載多個配置文件。如果多次指定，則稍后加載的配置文件將與先前加載的配置文件合并。在配置合并期間，單值鍵（string，int，bool）將簡單地替換它們的值，而列表類型將被附加在一起。

• -config-dir：要加載的配置文件的目錄。Consul將使用后綴“.json”或“.hcl”加載此目錄中的所有文件。加載順序是按字母順序排列的，并且使用與上述config-file選項相同的合并例程 。可以多次指定此選項以加載多個目錄。未加載config目錄的子目錄。有關配置文件格式的詳細信息，請參閱“ 配置文件”部分。

• config-format：要加載的配置文件的格式。通常，Consul會從“.json”或“.hcl”擴展名中檢測配置文件的格式。將此選項設置為“json”或“hcl”會強制Consul解釋具有或不具有擴展名的任何文件，以便以該格式進行解釋。

• data-dir：此標志為代理程序存儲狀態提供數據目錄。這是所有代理商都需要的。該目錄在重新啟動后應該是持久的。這對于在服務器模式下運行的代理尤其重要，因為它們必須能夠持久化群集狀態。此外，該目錄必須支持使用文件系統鎖定，這意味著某些類型的已安裝文件夾（例如VirtualBox共享文件夾）可能不適合。注意：服務器代理和非服務器代理都可以在此目錄中的狀態中存儲ACL令牌，因此讀訪問可以授予對服務器上的任何令牌以及非服務器上的服務注冊期間使用的任何令牌的訪問權限。在基于Unix的平臺上，文件使用0600權限編寫，因此您應確保只有受信任的進程才能與Consul作為同一用戶執行。在Windows上，您應確保該目錄具有適當的權限，因為這些權限將被繼承。

• datacenter：此標志控制代理程序運行的數據中心。如果未提供，則默認為“dc1”。Consul擁有對多個數據中心的一流支持，但它依賴于正確的配置。同一數據中心中的節點應位于單個LAN上。

• dev：啟用開發服務器模式。這對于快速啟動Consul代理并關閉所有持久性選項非常有用，可以啟用內存服務器，該服務器可用于快速原型設計或針對API進行開發。在此模式下， Connect已啟用，默認情況下將在啟動時創建新的根CA證書。此模式不適用于生產用途，因為它不會將任何數據寫入磁盤。

• disable-host-node-id：將此設置為true將阻止Consul使用來自主機的信息生成確定性節點ID，而是生成將保留在數據目錄中的隨機節點ID。在同一主機上運行多個Consul代理進行測試時，這非常有用。在版本0.8.5之前的Consul中默認為false，在0.8.5及更高版本中默認為true，因此您必須選擇加入基于主機的ID。使用https://github.com/shirou/gopsutil/tree/master/host生成基于主機的ID ，這是與HashiCorp的Nomad共享的 ，因此如果您選擇使用基于主機的ID，那么Consul和Nomad將使用信息在主機上自動在兩個系統中分配相同的ID。

• disable-keyring-file：如果設置，密鑰環將不會持久保存到文件中。關機時任何已安裝的密鑰都將丟失，-encrypt啟動時只有給定的 密鑰可用。默認為false。

• dns-port：要偵聽的DNS端口。這將覆蓋默認端口8600.這在Consul 0.7及更高版本中可用。

• domain：默認情況下，Consul在“consul”中響應DNS查詢。域。此標志可用于更改該域。假定此域中的所有查詢都由Consul處理，不會以遞歸方式解析。

• enable-script-checks：這可以控制是否在此代理上啟用了執行腳本的運行狀況檢查，默認為false運營商必須選擇允許這些檢查。如果啟用，建議還啟用ACL以控制允許哪些用戶注冊新檢查以執行腳本。這是在Consul 0.9.0中添加的。

• encrypt：指定用于加密Consul網絡流量的密鑰。該密鑰必須是16字節的Base64編碼。創建加密密鑰的最簡單方法是使用 consul keygen。群集中的所有節點必須共享相同的加密密鑰才能進行通信。提供的密鑰將自動持久保存到數據目錄，并在重新啟動代理時自動加載。這意味著要加密Consul的八卦協議，只需在每個代理的初始啟動序列上提供一次該選項。如果在使用加密密鑰初始化Consul之后提供，則忽略提供的密鑰并顯示警告。

• hcl：HCL配置片段。此HCL配置片段將附加到配置中，并允許在命令行上指定配置文件的所有選項。可以多次指定此選項。這是在Consul 1.0中添加的。

• http-port：要監聽的HTTP API端口。這將覆蓋默認端口8500.將Consul部署到通過環境傳輸HTTP端口的環境（例如CloudFoundry等PaaS）時，此選項非常有用，允許您通過Procfile直接設置端口。

• join：啟動時加入的另一個代理的地址?？梢远啻沃付?，以指定要加入的多個代理。如果Consul無法加入任何指定的地址，則代理啟動將失敗。默認情況下，代理在啟動時不會加入任何節點。請注意，retry_join在自動執行Consul群集部署時，使用 可能更適合幫助緩解節點啟動競爭條件。

  在Consul 1.1.0及更高版本中，可以將其設置為 go-sockaddr 模板

• -retry-join：類似-join但允許在第一次嘗試失敗時重試連接。這對于您知道地址最終可用的情況很有用。該列表可以包含IPv4，IPv6或DNS地址。在Consul 1.1.0及更高版本中，可以將其設置為 go-sockaddr 模板。如果Consul在非默認的Serf LAN端口上運行，則必須同時指定。IPv6必須使用“括號”語法。如果給出了多個值，則會按列出的順序嘗試和重試它們，直到第一個成功為止。這里有些例子：

  # Using a DNS entry
  $ consul agent -retry-join "consul.domain.internal"
  

  # Using IPv4
  $ consul agent -retry-join "10.0.4.67"
  

  # Using IPv6
  $ consul agent -retry-join "[::1]:8301"
  

• -retry-interval：加入嘗試之間等待的時間。默認為30秒。

• -retry-max- -join：退出返回代碼之前嘗試的最大嘗試次數1.默認情況下，將其設置為0，將其解釋為無限次重試。

• -join-wan：啟動時加入另一個萬人代理的地址。可以多次指定此選項以指定要加入的多個WAN代理。如果Consul無法加入任何指定的地址，則代理啟動將失敗。默認情況下，代理-join-wan在啟動時不會顯示任何節點。

• -retry-join-wan：類似retry-join但允許在第一次嘗試失敗時重試wan連接。這對于我們知道地址最終可用的情況很有用。從Consul 0.9.3開始，云支持自動加入也是如此。

• -retry-interval-wan- -join-wan：嘗試之間等待的時間。默認為30秒。

• -retry-max-wan- -join-wan：退出返回代碼之前嘗試的最大嘗試次數1.默認情況下，將其設置為0，將其解釋為無限次重試。

• -log-level：Consul代理啟動后顯示的日志記錄級別。默認為“info”。可用的日志級別是“trace”，“debug”，“info”，“warn”和“err”。您始終可以通過consul monitor并使用任何日志級別連接到代理。此外，可以在配置重新加載期間更改日志級別。

• -node：群集中此節點的名稱。這在群集中必須是唯一的。默認情況下，這是計算機的主機名。

• -node-id：在Consul 0.7.3及更高版本中可用，即使節點或地址的名稱發生更改，這也是該節點的唯一標識符。這必須是十六進制字符串的形式，長度為36個字符，例如 adf4238a-882b-9ddc-4a9d-5b6758e4159e。如果未提供（這是最常見的情況），則代理將在啟動時生成標識符并將其保留在數據目錄中， 以便在代理重新啟動時保持相同。如果可能，來自主機的信息將用于生成確定性節點ID，除非-disable-host-node-id設置為true。

• -node-meta：在Consul 0.7.3及更高版本中可用，它指定與表單節點關聯的任意元數據鍵/值對key:value。這可以多次指定。節點元數據對具有以下限制：

  • 每個節點最多可以注冊64個鍵/值對。
  • 元數據鍵的長度必須介于1到128個字符（包括1和128個字符）之間
  • 元數據鍵必須僅包含字母數字-和_字符。
  • 元數據鍵不能以consul-前綴開頭; 保留供Consul內部使用。
  • 元數據值的長度必須介于0到512（含）之間。
  • 開頭的密鑰的元數據值rfc1035-在DNS TXT請求中逐字編碼，否則元數據kv對根據RFC1464編碼。

• -pid-file：此標志提供代理程序存儲其PID的文件路徑。這對于發送信號很有用（例如，SIGINT 關閉代理或SIGHUP更新檢查確定

• -protocol：要使用的Consul協議版本。默認為最新版本。這應該僅在升級時設置。您可以通過運行查看Consul支持的協議版本consul -v。

• -raft-protocol：這控制用于服務器通信的Raft共識協議的內部版本。必須將其設置為3才能訪問自動駕駛儀功能，但會有例外cleanup_dead_servers。Consul 1.0.0及更高版本默認為3（默認為2之前）。有關 詳細信息，請參閱 Raft協議版本兼容性。

• -raft-snapshot-threshold：這可以控制保存到磁盤的快照之間的最小筏提交條目數。這是一個很少需要更改的低級參數。經歷過多磁盤IO的非常繁忙的群集可能會增加此值以減少磁盤IO，并最大限度地減少所有服務器同時拍攝快照的機會。由于日志將變得更大并且raft.db文件中的空間在下一個快照之前無法回收，因此增加此值將替換磁盤空間的磁盤空間。如果需要重播更多日志，服務器可能需要更長的時間才能從崩潰或故障轉移中恢復。在Consul 1.1.0及更高版本中，默認為16384，在先前版本中，它設置為8192。

• -raft-snapshot-interval：它控制服務器檢查是否需要將快照保存到磁盤的頻率。他是一個很少需要改變的低級參數。經歷過多磁盤IO的非常繁忙的群集可能會增加此值以減少磁盤IO，并最大限度地減少所有服務器同時拍攝快照的機會。由于日志將變得更大并且raft.db文件中的空間在下一個快照之前無法回收，因此增加此值將替換磁盤空間的磁盤空間。如果需要重播更多日志，服務器可能需要更長的時間才能從崩潰或故障轉移中恢復。在Consul 1.1.0及更高版本中，此默認設置為30s，并且在之前的版本中設置為5s。

• -recursor：指定上游DNS服務器的地址?？梢远啻翁峁┐诉x項，并且功能上與recursors配置選項等效。

• -rejoin：提供時，Consul將忽略之前的休假并在啟動時嘗試重新加入群集。默認情況下，Consul將離開視為永久意圖，并且在啟動時不會嘗試再次加入群集。此標志允許使用先前的狀態重新加入群集。

• -segment：（僅限企業）此標志用于設置代理所屬的網段名稱。代理只能加入其網段中的其他代理并與之通信。有關詳細信息，請參閱網絡細分指南。默認情況下，這是一個空字符串，這是默認網段。

• -serf-lan-port：收聽的Serf LAN端口。這將覆蓋默認的Serf LAN端口8301.這在Consul 1.2.2及更高版本中可用。

• -serf-wan-port：收聽的Serf WAN端口。這將覆蓋默認的Serf WAN端口8302.這在Consul 1.2.2及更高版本中可用。

• -server：此標志用于控制代理是處于服務器模式還是客戶端模式。提供時，代理將充當Consul服務器。每個Consul集群必須至少有一個服務器，理想情況下每個數據中心不得超過5個。所有服務器都參與Raft一致性算法，以確保事務以一致，可線性化的方式發生。事務修改集群狀態，該狀態在所有服務器節點上維護，以確保節點故障時的可用性。服務器節點還與其他數據中心中的服務器節點一起參與WAN八卦池。服務器充當其他數據中心的網關，并根據需要轉發流量。

• -server-port：要偵聽的服務器RPC端口。這將覆蓋默認服務器RPC端口8300.這在Consul 1.2.2及更高版本中可用。

• -non-voting-server：（僅限企業）此標志用于使服務器不參與Raft仲裁，并使其僅接收數據復制流。在需要大量讀取服務器的情況下，這可用于向集群添加讀取可伸縮性。

• -syslog1：此標志允許記錄到syslog。這僅在Linux和OSX上受支持。如果在Windows上提供，將導致錯誤。

• -ui：啟用內置Web UI服務器和所需的HTTP路由。這消除了將Consul Web UI文件與二進制文件分開維護的需要。

• -ui-dir：此標志提供包含Consul的Web UI資源的目錄。這將自動啟用Web UI。該目錄必須對代理可讀。從Consul 0.7.0及更高版本開始，Web UI資產包含在二進制文件中，因此不再需要此標志; 僅指定-ui標志就足以啟用Web UI。指定'-ui'和'-ui-dir'標志將導致錯誤。