1、consul agent 命令说明
consul agent [options]
参数说明：
| 参数名 | 描述 |
|---|---|
-datacenter=<value> |
agent 所属的数据中心名称，默认dc1，一个数据中心的所有节点都必须在一个LAN中。 |
-advertise=<value> |
设置要使用的 发布 地址 |
-advertise-wan=<value> |
设置在广域网上发布的地址而不是-advertise地址 |
-allow-write-http-from=<value> |
只允许从给定网络写端点调用。CIDR格式，可以多次指定。 |
-alt-domain=<value> |
备用域用于DNS接口 |
-auto-reload-config |
监视配置文件的更改，并在修改时自动重新加载文件。 |
-bind=<value> |
设置集群通信的绑定地址，默认0.0.0.0，即，所有的本地地址，会将第一个可用的ip地址散播到集群中，如果有多个可用的ipv4，则consul启动报错。 [::]ipv6，TCP>[::]ipv6，TCP UDP协议，相同的端口。防火墙配置。 |
-bootstrap |
将服务器设置为引导模式，启动模式，此模式下，节点可以选举自己为leader，一个数据中心只能有一个此模式启动的节点。 机群启动后，新启动的节点不建议使用这种模式。 |
-bootstrap-expect=<value> |
设定一个数据中心需要的服务节点数，可以不设置，设置的数字必须和实际的服务节点数匹配。 consul会等待直到数据中心下的服务节点满足设定才会启动集群服务。初始化leader选举，不能和bootstrap混用。必须配合 -server配置。 |
-check_output_max_size=<value> |
设置此代理上检查的最大输出大小 |
-client=<value> |
为客户端访问设置要绑定的地址。这包括RPC, DNS，HTTP, HTTPS和gRPC(如果配置)。 客户端模式，http dns，默认127.0.0.1，回环令牌网址。 |
-config-dir=<value> |
读取配置文件的目录的路径，会读取其目录下以“.json”结尾的文件，加载顺序为字母表顺序。 可以多次指定 |
-config-file=<value> |
具有匹配文件扩展名的JSON或HCL格式文件的路径，可以多次指定。 |
-config-format=<string> |
配置文件格式，配置了，则加载相应个是的文件。 不配置，则consul自动识别。 |
-data-dir=<value> |
用于存储 agent 状态的数据目录的路径， 所有的节点都需要。 文件夹位置需要不受 consul节点重启影响，必须能够使用操作系统文件锁，unix-based系统下，文件夹文件权限为0600，注意做好账户权限控制 |
-default-query-time=<value> |
阻塞查询在Consul强制响应之前等待的时间。这个值可以被’wait’查询参数覆盖。 |
-dev |
以开发模式启动，开发模式，去掉所有持久化选项，内存服务器模式。 |
-disable-host-node-id |
将此设置为true将阻止Consul使用来自主机的信息生成 node ID，并将导致Consul生成一个随机的 node ID。 适用于同一台服务器部署多个实例用于测试的情况。 |
-disable-keyring-file |
禁用将密匙环备份到文件 |
-dns-port=<value> |
v7.0以后，自定义dns 端口，覆盖默认8600 |
-domain=<value> |
用于DNS接口的域 |
-enable-local-script-checks |
从配置文件中启用健康检查脚本 |
-enable-script-checks |
是否允许使用脚本进行健康检查，默认false，最好配置enable acl |
-encrypt=<value> |
consul网络通讯加密key，base64加密，16比特；consul keygen产生。 集群中的每个实例必须提供相同的，只需提供一次，然后会保存到数据文件。 重启自动加载。consul节点启动后提供，会被忽略。 |
-grpc-port=<value> |
设置监听的gRPC API端口 |
-grpc-tls-port=<value> |
设置要监听的gRPC-TLS API端口 |
-hcl=<value> |
添加hcl格式配置，和已有的配置合并。可以使用多个此配置。 |
-http-port=<value> |
http api端口，覆盖默认的8500。适用于云环境指定。 |
-https-port=<value> |
设置监听的HTTPS API端口 |
-join=<value> |
需要加入的其它节点地址，可以多次使用，加入多个节点。 (已弃用)-retry-join的别名。-join标志将为在未来的版本中删除。 |
-join-wan=<value> |
(已弃用)-retry-join-wan的别名。-join-wan标志将在未来的版本中删除。 |
-log-file=<value> |
写入日志的文件的路径，如果没有提供文件名，则默认Consul-时间戳.log |
-log-json |
以JSON格式输出日志 |
-log-level=<value> |
日志级别，默认info，包含：trace，debug，info，warn，err；consul monitor监控 |
-log-rotate-bytes=<value> |
新日志文件生成大小阈值。 |
-log-rotate-duration=<value> |
新日志生成时间阈值 |
-log-rotate-max-files=<value> |
要保留的日志文件存档的最大数量 |
-max-query-time=<value> |
在Consul强制响应之前，阻塞查询可以等待的最大时间。 Consul将抖动应用于等待时间。抖动时间上限为MaxQueryTime。 |
-node=<value> |
节点名称。集群中必须唯一，默认主机名 |
-node-id=<value> |
节点ID，跨空间和时间的该节点的唯一ID。 默认为一个随机生成的ID，该ID保存在数据目录中。 |
-node-meta=<key:value> |
此节点的任意元数据键/值对，格式为key:value。可以多次指定。 |
-non-voting-server |
(企业版)弃用:应该使用-read-replica，服务节点不参与选举，接受日志复制，用于横向扩展，服务查询请求。（类比zookeeper 观察者节点） |
-pid-file=<value> |
存储 agent PID 的文件路径 |
-primary-gateway=<value> |
主数据中心中用于在启动时引导WAN联合并启用重试的网格网关的地址。可以指定多次。 |
-protocol=<value> |
设置协议版本。默认为最新。consul -v查看协议版本。 |
-raft-protocol=<value> |
设置Raft协议版本。默认为最新。 |
-read-replica |
(企业专用)该标志用于使服务器不参与Raft仲裁，只接收数据复制流。 这可以用于在需要对服务器进行大量读取的情况下向集群添加读取可伸缩性。 |
-recursor=<value> |
上行DNS服务器地址。可以多次指定。 |
-rejoin |
忽略之前的离开,试图重新加入集群。 |
-retry-interval=<value> |
再次尝试连接之间的等待时间 |
-retry-interval-wan=<value> |
再次加入尝试wan之间的等待时间 |
-retry-join=<value> |
会进行加入重试，适用于认定加入节点最终会正常的情况。ipv4，ipv6，dns |
-retry-join-wan=<value> |
再次加入尝试wan的地址 |
-retry-max=<value> |
最大重试次数。默认值为0，将无限重试。 |
-retry-max-wan=<value> |
最大wan重试次数。默认值为0，将无限重试。 |
-segment=<value> |
(企业版)设置要加入的网段 |
-serf-lan-allowed-cidrs=<value> |
网络(例如:192.168.1.0/24)允许 Serf LAN。可以多次指定。 |
-serf-lan-bind=<value> |
要绑定Serf LAN侦听器的地址 |
-serf-lan-port=<value> |
设置Serf LAN端口监听 |
-serf-wan-allowed-cidrs=<value> |
网络(例如:192.168.1.0/24)允许用于Serf WAN(其他数据中心)。可以多次指定。 |
-serf-wan-bind=<value> |
绑定Serf WAN监听器的地址 |
-serf-wan-port=<value> |
设置Serf WAN端口监听 |
-server |
将 agent 切换到服务器模式 |
-server-port=<value> |
设置要监听的服务器端口，服务端RPC端口，v1.2.2后提供。 |
-syslog |
启用日志记录到syslog |
-ui |
启用内置的静态web UI服务器 |
-ui-content-path=<value> |
将外部UI路径设置为字符串。默认为:/ui/ |
-ui-dir=<value> |
web UI资源所在目录的路径，使用此配置，则不需也不能使用再-ui配置。 |
2、使用示例
以开发模式启动consul，客户端允许访问地址为：0.0.0.0
consul agent -dev -ui -client=0.0.0.0以server方式来启动consul，输入命令：
consul agent -server -ui -bootstrap-expect=1 -data-dir=/usr/local/consul/data/ -node=consul-dev -client=0.0.0.0 -bind=127.0.0.1 -datacenter=dc1作者：admin 创建时间：2023-03-09 19:19
最后编辑：joker.liu 更新时间：2023-05-16 17:03
最后编辑：joker.liu 更新时间：2023-05-16 17:03
