consul服务配置维护

Posted 2020-10-14 梦幻轩辕之康

1、命令参数

-advertise：通知展现地址用来改变我们给集群中的其他节点展现的地址，默认情况下-bind地址就是展现地址，然而也存在一些路由地址是不能受约束的，这时候会激活一个不同的地址来供应，如果这个地址不能路由，这个路由将不能被加入集群

-bootstrap：用来控制一个server是否在bootstrap模式，在一个datacenter中只能有一个server处于bootstrap模式，当一个server处于bootstrap模式时，可以自己选举为raft leader，在一个节点的模式下这种方式很重要，否则在集群中的一致性不能保证，不推荐在集群中应用这个标识

-bootstrap-expect：在一个datacenter中期望提供的server节点数目，当该值提供的时候，consul一直等到达到指定sever数目的时候才会引导整个集群，该标记不能和bootstrap公用（推荐使用的方式）

-bind：该地址用来在集群内部的通讯，集群内的所有节点到地址都必须是可达的，默认是0.0.0.0，这意味着Consulo会使用第一个可用的私有IP地址，Consul可以使用TCP和UDP并且可以使用共同的端口，如果存在防火墙，这两者协议必须是允许的。

-client：consul绑定在哪个client地址上，这个地址提供HTTP、DNS、RPC等服务，默认是127.0.0.1，只允许回路连接。RPC地址用于Consul命令，比如Consul members可以查询当前运行的Consul代理

-config-file：明确的指定要加载哪个配置文件，文件下的所有配置会合并在一起进行加载

-config-dir：配置文件目录，里面所有以.json结尾的文件都会被加载

-data-dir：提供一个目录用来存放agent的状态，所有的agent允许都需要该目录，该目录必须是稳定的，系统重启后都继续存在

-dc：该标记控制agent运行的datacenter的名称，默认是dc1

-encrypt：指定secret key，使consul在通讯时进行加密，key可以通过consul keygen生成，同一个集群中的节点必须使用相同的key

-http-port:HTTP API侦听端口,默认端口8500，可以在环境变量中进行设置，非常有用，可以用于与Consul进行通讯

-join：加入一个已经启动的agent的ip地址，可以多次指定多个agent的地址。如果consul不能加入任何指定的地址中，则agent会启动失败，默认agent启动时不会加入任何节点。

-retry-join：和join类似，但是允许你在第一次失败后进行尝试。

-retry-interval：两次join之间的时间间隔，默认是30s

-retry-max：尝试重复join的次数，默认是0，也就是无限次尝试

-log-level：consul agent启动后显示的日志信息级别。默认是info，可选：trace、debug、info、warn、err。跟踪 调试 详情 警告 错误，可以通过Consul monitor使用任何级别，也可以通过重启加载新的配置级别

-node：节点在集群中的名称，在一个集群中必须是唯一的，默认是该节点的主机名（代表一个机器）

-pid-file:提供一个路径来存放pid文件，可以使用该文件进行SIGINT/SIGHUP(关闭/更新)agent

-protocol：consul使用的协议版本 consul -v

-rejoin：使consul忽略先前的离开，在再次启动后仍旧尝试加入集群中。

-server：定义agent运行在server模式还是Client模式，提供时即为Server端，每个集群至少有一个server并且每台机器上不要超过5个dataceter.所有服务器采用一致性算法Raft保证数据一致,确保在故障的情况下的可用性。

-syslog：开启系统日志功能，只在linux/osx上生效

-ui-dir:提供存放web ui资源的路径，该目录必须是可读的

2、配置参数

Consul配置信心可以填写在.json文件中，配置文件加载时会按照文件名字母排序的顺序读取，效果与命令行一致。

acl_datacenter：只用于server，指定的datacenter的权威ACL信息，所有的servers和datacenter必须同意ACL datacenter

acl_default_policy：默认是allow

acl_token：agent会使用这个token和consul server进行请求

acl_ttl：控制TTL的cache，默认是30s

addresses：一个嵌套对象，可以设置以下key：dns、http、rpc

advertise_addr：等同于-advertise

bootstrap：等同于-bootstrap

bootstrap_expect：等同于-bootstrap-expect

bind_addr：等同于-bind

ca_file：提供CA文件路径，用来检查客户端或者服务端的链接

cert_file：必须和key_file一起

check_update_interval：

client_addr：等同于-client

datacenter：等同于-dc

data_dir：等同于-data-dir

disable_anonymous_signature：在进行更新检查时禁止匿名签名

disable_remote_exec：禁止支持远程执行，设置为true，agent会忽视所有进入的远程执行请求

disable_update_check：禁止自动检查安全公告和新版本信息

dns_config：是一个嵌套对象，可以设置以下参数：allow_stale、max_stale、node_ttl 、service_ttl、enable_truncate

domain：默认情况下consul在进行DNS查询时，查询的是consul域，可以通过该参数进行修改

enable_debug：开启debug模式

enable_syslog：等同于-syslog

encrypt：等同于-encrypt

key_file：提供私钥的路径

leave_on_terminate：默认是false，如果为true，当agent收到一个TERM信号的时候，它会发送leave信息到集群中的其他节点上。

log_level：等同于-log-level

node_name:等同于-node

ports：这是一个嵌套对象，可以设置以下key：dns(dns地址：8600)、http(http api地址：8500)、rpc(rpc:8400)、serf_lan(lan port:8301)、serf_wan(wan port:8302)、server(server rpc:8300）

protocol：等同于-protocol

rejoin_after_leave：等同于-rejoin

retry_join：等同于-retry-join

retry_interval：等同于-retry-interval

server：等同于-server

server_name：会覆盖TLS CA的node_name，可以用来确认CA name和hostname相匹配

skip_leave_on_interrupt：和leave_on_terminate比较类似，不过只影响当前句柄

start_join：一个字符数组提供的节点地址会在启动时被加入

syslog_facility：当enable_syslog被提供后，该参数控制哪个级别的信息被发送，默认Local0

ui_dir：等同于-ui-dir

verify_incoming：默认false，如果为true，则所有进入链接都需要使用TLS，需要客户端使用ca_file提供ca文件，只用于consul server端，因为client从来没有进入的链接

verify_outgoing：默认false，如果为true，则所有出去链接都需要使用TLS，需要服务端使用ca_file提供ca文件，consul server和client都需要使用，因为两者都有出去的链接

watches：watch一个详细名单