From 3fbc6e620e34300696cc9e712f5437c4afe972e6 Mon Sep 17 00:00:00 2001 From: "R.I.Pienaar" Date: Tue, 2 Jul 2019 16:10:08 +0200 Subject: [PATCH 1/2] clarify leafnodes This corrects a few config item key names and shows the key names as lowercase as they would appear in the actual config Also use `nats-leaf` as shown in the tutorial section on leaf nodes server.LeafNodeOpts has no `name` and I can't find it in parseLeafNodes --- leafnodes/leafnode_conf.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/leafnodes/leafnode_conf.md b/leafnodes/leafnode_conf.md index d01ed7d..922c7e9 100644 --- a/leafnodes/leafnode_conf.md +++ b/leafnodes/leafnode_conf.md @@ -1,28 +1,27 @@ -## `LeafNode` Configuration Block +## `leafnodes` Configuration Block | Property | Description | | :------ | :---- | | `advertise` | Hostport `:` to advertise to other gateways. | | `authorization` | Authorization block (same as other nats-server `authorization` configuration). | -| `host` | Interface where the gateway will listen for incomming gateway connections. | +| `host` | Interface where the gateway will listen for incoming leafnode connections. | | `listen` | Combines `host` and `port` as `:` | -| `name` | Name for this cluster, all gateways belonging to the same cluster, should specify the same name. | | `no_advertise` | if `true` the leafnode shouldn't be advertised. | -| `port` | Port where the gateway will listen for incomming gateway connections. | +| `port` | Port where the leafnode will listen for incoming leafnode connections. | | `remotes` | List of `remote` entries specifying servers where leafnode client connection can be made. | | `tls` | TLS configuration block (same as other nats-server `tls` configuration). | -### LeafNode `Remote` Entry Block +### LeafNode `remotes` Entry Block | Property | Description | | :------ | :---- | -| `url` | Leafnode URL (URL protocol should be `leafnode`). | +| `url` | Leafnode URL (URL protocol should be `nats-leaf`). | | `account` | Account public key identifying the leafnode. Account must be defined locally. | | `credentials` | Credential file for connecting to the leafnode server. | -| `tls` | A TLS configuration block. Gateway client will use specified TLS certificates when connecting/authenticating. | +| `tls` | A TLS configuration block. Leafnode client will use specified TLS certificates when connecting/authenticating. | -### `TLS` Configuration Block +### `tls` Configuration Block | Property | Description | | :------ | :---- | From 357ff95d85d51a53fbae0abca8cf45470a4d142b Mon Sep 17 00:00:00 2001 From: "R.I.Pienaar" Date: Tue, 2 Jul 2019 16:23:57 +0200 Subject: [PATCH 2/2] clarify around servers, gateways an leafenodes --- leafnodes/leafnode_conf.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/leafnodes/leafnode_conf.md b/leafnodes/leafnode_conf.md index 922c7e9..7d75678 100644 --- a/leafnodes/leafnode_conf.md +++ b/leafnodes/leafnode_conf.md @@ -2,12 +2,12 @@ | Property | Description | | :------ | :---- | -| `advertise` | Hostport `:` to advertise to other gateways. | +| `advertise` | Hostport `:` to advertise to other servers. | | `authorization` | Authorization block (same as other nats-server `authorization` configuration). | -| `host` | Interface where the gateway will listen for incoming leafnode connections. | +| `host` | Interface where the server will listen for incoming leafnode connections. | | `listen` | Combines `host` and `port` as `:` | | `no_advertise` | if `true` the leafnode shouldn't be advertised. | -| `port` | Port where the leafnode will listen for incoming leafnode connections. | +| `port` | Port where the server will listen for incoming leafnode connections. | | `remotes` | List of `remote` entries specifying servers where leafnode client connection can be made. | | `tls` | TLS configuration block (same as other nats-server `tls` configuration). |