服务发现系统consul--配置

http://my.oschina.net/guol/blog/353391

agent有各种各样的配置项可以在命令行或者配置文件进行定义，所有的配置项都是可选择的，当加载配置文件的时候，consul从配置文件或者配置目录加载配置。后面定义的配置会合并前面定义的配置，但是大多数情况下，合并的意思是后面定义的配置会覆盖前面定义的配置，但是有些情况，例如event句柄，合并仅仅是添加到前面定义的句柄后面。consul重新加载配置文件也支持以信号的方式接收update信号。

下面看看命令行参数：

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

-advertise：通知展现地址用来改变我们给集群中的其他节点展现的地址，一般情况下-bind地址就是展现地址 -bootstrap：用来控制一个server是否在bootstrap模式，在一个datacenter中只能有一个server处于bootstrap模式，当一个server处于bootstrap模式时，可以自己选举为raft leader。 -bootstrap-expect：在一个datacenter中期望提供的server节点数目，当该值提供的时候，consul一直等到达到指定sever数目的时候才会引导整个集群，该标记不能和bootstrap公用 -bind：该地址用来在集群内部的通讯，集群内的所有节点到地址都必须是可达的，默认是0.0.0.0 -client：consul绑定在哪个client地址上，这个地址提供HTTP、DNS、RPC等服务，默认是127.0.0.1 -config- file ：明确的指定要加载哪个配置文件 -config- dir ：配置文件目录，里面所有以.json结尾的文件都会被加载 -data- dir ：提供一个目录用来存放agent的状态，所有的agent允许都需要该目录，该目录必须是稳定的，系统重启后都继续存在 - dc ：该标记控制agent允许的datacenter的名称，默认是dc1 -encrypt：指定secret key，使consul在通讯时进行加密，key可以通过consul keygen生成，同一个集群中的节点必须使用相同的key - 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。 -node：节点在集群中的名称，在一个集群中必须是唯一的，默认是该节点的主机名 -protocol：consul使用的协议版本 -rejoin：使consul忽略先前的离开，在再次启动后仍旧尝试加入集群中。 -server：定义agent运行在server模式，每个集群至少有一个server，建议每个集群的server不要超过5个 -syslog：开启系统日志功能，只在linux /osx 上生效 -ui- dir :提供存放web ui资源的路径，该目录必须是可读的 -pid- file :提供一个路径来存放pid文件，可以使用该文件进行SIGINT /SIGHUP (关闭/更新)agent

       除了命令行参数外，配置也可以写入文件中，在某些情况下配置文件会更简单一些，例如：利用consul被用来管理系统。配置文件是json格式的，很容易编写。配置文件不仅被用来设置agent的启动，也可以用来提供健康检测和服务发现的定义。配置文件的一般样例如下：

?

1 2 3 4 5 6 7 8 9 10 11 12 13

{    "datacenter" : "east-aws" ,    "data_dir" : "/opt/consul" ,    "log_level" : "INFO" ,    "node_name" : "foobar" ,    "server" : true ,    "watches" : [      {          "type" : "checks" ,          "handler" : "/usr/bin/health-check-handler.sh"      }    ] }

下面看看详细的配置文件参数：

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

acl_datacenter：只用于server，指定的datacenter的权威ACL信息，所有的servers和datacenter必须同意ACL datacenter acl_default_policy：默认是allow acl_down_policy： acl_master_token： 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 recursor： 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：一个字符数组提供的节点地址会在启动时被加入 statsd_addr： statsite_addr： 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 一个详细名单

consul agent支持所有的网络通讯进行加密，关于加密的具体信息 这里有描述 ，有两个分开的系统，一个是gossip流量，一个是RPC。

      开启gossip加密，只需要你在启动consul agent的时候设置encryption key，可以在配置文件中通过encrypt参数进行设置，key必须是16bytes长度的base64加密，也可以通过consul keygen直接产生一个。注意，在同一个集群中的所有节点必须使用同一个key。

      使用TLS为RPC加密，主要是上面介绍的verify_incoming和verify_outgoing参数来设置。