taigrr/nats.docs
1
0
Fork 0
mirror of https://github.com/taigrr/nats.docs synced 2025-01-18 04:03:23 -08:00
Code Issues Projects Releases Wiki Activity

clarify leafnodes

Browse Source 
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
This commit is contained in:
R.I.Pienaar 2019-07-02 16:10:08 +02:00
parent 76f8321b8a
commit 3fbc6e620e
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
leafnodes/leafnode_conf.md
View File

@ -1,28 +1,27 @@
## `LeafNode` Configuration Block ## `leafnodes` Configuration Block
| Property | Description | | Property | Description |
| :------ | :---- | | :------ | :---- |
| `advertise` | Hostport `<host>:<port>` to advertise to other gateways. | | `advertise` | Hostport `<host>:<port>` to advertise to other gateways. |
| `authorization` | Authorization block (same as other nats-server `authorization` configuration). | | `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 `<host>:<port>` | | `listen` | Combines `host` and `port` as `<host>:<port>` |
| `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. | | `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. | | `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). | | `tls` | TLS configuration block (same as other nats-server `tls` configuration). |
### LeafNode `Remote` Entry Block ### LeafNode `remotes` Entry Block
| Property | Description | | 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. | | `account` | Account public key identifying the leafnode. Account must be defined locally. |
| `credentials` | Credential file for connecting to the leafnode server. | | `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 | | Property | Description |
| :------ | :---- | | :------ | :---- |