From 0e4d7f01f29c10831b3612db2fd3a40e22bc20db Mon Sep 17 00:00:00 2001 From: Casey Allen Shobe Date: Wed, 1 Apr 2020 07:50:50 -0600 Subject: [PATCH] Correct documentation for consul.host (#1438) Close #1434 --- docs/ENVIRONMENT.rst | 4 ++-- docs/SETTINGS.rst | 24 ++++++++++++------------ 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/ENVIRONMENT.rst b/docs/ENVIRONMENT.rst index f95d125b..987b8b34 100644 --- a/docs/ENVIRONMENT.rst +++ b/docs/ENVIRONMENT.rst @@ -35,8 +35,8 @@ Example: defining ``PATRONI_admin_PASSWORD=strongpasswd`` and ``PATRONI_admin_OP Consul ------ -- **PATRONI\_CONSUL\_HOST**: the host:port for the Consul endpoint. -- **PATRONI\_CONSUL\_URL**: url for the Consul, in format: http(s)://host:port +- **PATRONI\_CONSUL\_HOST**: the host:port for the Consul local agent. +- **PATRONI\_CONSUL\_URL**: url for the Consul local agent, in format: http(s)://host:port - **PATRONI\_CONSUL\_PORT**: (optional) Consul port - **PATRONI\_CONSUL\_SCHEME**: (optional) **http** or **https**, defaults to **http** - **PATRONI\_CONSUL\_TOKEN**: (optional) ACL token diff --git a/docs/SETTINGS.rst b/docs/SETTINGS.rst index c1198a55..1dca57b7 100644 --- a/docs/SETTINGS.rst +++ b/docs/SETTINGS.rst @@ -87,20 +87,20 @@ Consul ------ Most of the parameters are optional, but you have to specify one of the **host** or **url** -- **host**: the host:port for the Consul endpoint, in format: http(s)://host:port -- **url**: url for the Consul endpoint -- **port**: (optional) Consul port -- **scheme**: (optional) **http** or **https**, defaults to **http** -- **token**: (optional) ACL token -- **verify**: (optional) whether to verify the SSL certificate for HTTPS requests +- **host**: the host:port for the Consul local agent. +- **url**: url for the Consul local agent, in format: http(s)://host:port. +- **port**: (optional) Consul port. +- **scheme**: (optional) **http** or **https**, defaults to **http**. +- **token**: (optional) ACL token. +- **verify**: (optional) whether to verify the SSL certificate for HTTPS requests. - **cacert**: (optional) The ca certificate. If present it will enable validation. -- **cert**: (optional) file with the client certificate +- **cert**: (optional) file with the client certificate. - **key**: (optional) file with the client key. Can be empty if the key is part of **cert**. - **dc**: (optional) Datacenter to communicate with. By default the datacenter of the host is used. - **consistency**: (optional) Select consul consistency mode. Possible values are ``default``, ``consistent``, or ``stale`` (more details in `consul API reference `__) - **checks**: (optional) list of Consul health checks used for the session. By default an empty list is used. -- **register\_service**: (optional) whether or not to register a service with the name defined by the scope parameter and the tag master, replica or standby-leader depending on the node's role. Defaults to **false** -- **service\_check\_interval**: (optional) how often to perform health check against registered url +- **register\_service**: (optional) whether or not to register a service with the name defined by the scope parameter and the tag master, replica or standby-leader depending on the node's role. Defaults to **false**. +- **service\_check\_interval**: (optional) how often to perform health check against registered url. Etcd ---- @@ -109,8 +109,8 @@ Most of the parameters are optional, but you have to specify one of the **host** - **host**: the host:port for the etcd endpoint. - **hosts**: list of etcd endpoint in format host1:port1,host2:port2,etc... Could be a comma separated string or an actual yaml list. - **use\_proxies**: If this parameter is set to true, Patroni will consider **hosts** as a list of proxies and will not perform a topology discovery of etcd cluster. -- **url**: url for the etcd -- **proxy**: proxy url for the etcd. If you are connecting to the etcd using proxy, use this parameter instead of **url** +- **url**: url for the etcd. +- **proxy**: proxy url for the etcd. If you are connecting to the etcd using proxy, use this parameter instead of **url**. - **srv**: Domain to search the SRV record(s) for cluster autodiscovery. - **protocol**: (optional) http or https, if not specified http is used. If the **url** or **proxy** is specified - will take protocol from them. - **username**: (optional) username for etcd authentication. @@ -126,7 +126,7 @@ ZooKeeper Exhibitor --------- - **hosts**: initial list of Exhibitor (ZooKeeper) nodes in format: 'host1,host2,etc...'. This list updates automatically whenever the Exhibitor (ZooKeeper) cluster topology changes. -- **poll\_interval**: how often the list of ZooKeeper and Exhibitor nodes should be updated from Exhibitor +- **poll\_interval**: how often the list of ZooKeeper and Exhibitor nodes should be updated from Exhibitor. - **port**: Exhibitor port. .. _kubernetes_settings: