Configuration

The gateway configuration block is similar to a cluster block:

  1. gateway {
  2.     name: "A"
  3.     listen: "localhost:7222"
  4.     authorization {
  5.         user: gwu
  6.         password: gwp
  7.     }
  9.     gateways: [
  10.         {name: "A", url: "nats://gwu:gwp@localhost:7222"},
  11.         {name: "B", url: "nats://gwu:gwp@localhost:7333"},
  12.         {name: "C", url: "nats://gwu:gwp@localhost:7444"},
  13.     ]
  14. }

One difference is that instead of routes you specify gateways. As expected self-gateway connections are ignored, so you can share gateway configurations with minimal fuss.

Starting a server:

  1. > nats-server -c A.conf
  2. [85803] 2019/05/07 10:50:55.902474 [INF] Starting nats-server version 2.0.0
  3. [85803] 2019/05/07 10:50:55.903669 [INF] Gateway name is A
  4. [85803] 2019/05/07 10:50:55.903684 [INF] Listening for gateways connections on localhost:7222
  5. [85803] 2019/05/07 10:50:55.903696 [INF] Address for gateway "A" is localhost:7222
  6. [85803] 2019/05/07 10:50:55.903909 [INF] Listening for client connections on 0.0.0.0:4222
  7. [85803] 2019/05/07 10:50:55.903914 [INF] Server id is NBHUDBF3TVJSWCDPG2HSKI4I2SBSPDTNYEXEMOFAZUZYXVA2IYRUGPZU
  8. [85803] 2019/05/07 10:50:55.903917 [INF] Server is ready
  9. [85803] 2019/05/07 10:50:56.830669 [INF] 127.0.0.1:50892 - gid:2 - Processing inbound gateway connection
  10. [85803] 2019/05/07 10:50:56.830673 [INF] 127.0.0.1:50891 - gid:1 - Processing inbound gateway connection
  11. [85803] 2019/05/07 10:50:56.831079 [INF] 127.0.0.1:50892 - gid:2 - Inbound gateway connection from "C" (NBHWDFO3KHANNI6UCEUL27VNWL7NWD2MC4BI4L2C7VVLFBSMZ3CRD7HE) registered
  12. [85803] 2019/05/07 10:50:56.831211 [INF] 127.0.0.1:50891 - gid:1 - Inbound gateway connection from "B" (ND2UJB3GFUHXOQ2UUMZQGOCL4QVR2LRJODPZH7MIPGLWCQRARJBU27C3) registered
  13. [85803] 2019/05/07 10:50:56.906103 [INF] Connecting to explicit gateway "B" (localhost:7333) at 127.0.0.1:7333
  14. [85803] 2019/05/07 10:50:56.906104 [INF] Connecting to explicit gateway "C" (localhost:7444) at 127.0.0.1:7444
  15. [85803] 2019/05/07 10:50:56.906404 [INF] 127.0.0.1:7333 - gid:3 - Creating outbound gateway connection to "B"
  16. [85803] 2019/05/07 10:50:56.906444 [INF] 127.0.0.1:7444 - gid:4 - Creating outbound gateway connection to "C"
  17. [85803] 2019/05/07 10:50:56.906647 [INF] 127.0.0.1:7444 - gid:4 - Outbound gateway connection to "C" (NBHWDFO3KHANNI6UCEUL27VNWL7NWD2MC4BI4L2C7VVLFBSMZ3CRD7HE) registered
  18. [85803] 2019/05/07 10:50:56.906772 [INF] 127.0.0.1:7333 - gid:3 - Outbound gateway connection to "B" (ND2UJB3GFUHXOQ2UUMZQGOCL4QVR2LRJODPZH7MIPGLWCQRARJBU27C3) registered

Once all the gateways are up, these clusters of one will forward messages as expected:

  1. > nats-sub -s localhost:4333 ">"
  2. Listening on [>]
  4. # On a different session...
  5. > nats-pub -s localhost:4444 foo bar
  6. Published [foo] : 'bar'
  8. # nats-sub should print 
  9. [#1] Received on [foo] : 'bar'

Gateway Configuration Block

Property Description
name Name for this cluster, all gateways belonging to the same cluster, should specify the same name.
reject_unknown_cluster If true, gateway will reject connections from cluster that are not configured in gateways. It does so by checking if the cluster name, provided by the incomming connection, exists as named gateway. This effectively disables gossiping of new cluster. It does not restrict a configured gateway, thus cluster, from dynamically growing.
gateways List of Gateway entries - see below.
host Interface where the gateway will listen for incoming gateway connections.
port Port where the gateway will listen for incoming gateway connections.
listen Combines host and port as <host>:<port>
tls A tls configuration map for securing gateway connections. verify is always enabled. Unless otherwise specified in a gateway, cert_file will be the default client certificate. See for certificate pitfalls.
advertise Hostport <host>:<port> to advertise how this server can be contacted by other gateway members. This is useful in setups with NAT.
connect_retries After how many failed connect attempts to give up establishing a connection to a discovered gateway. Default is 0, do not retry. When enabled, attempts will be made once a second. This, does not apply to explicitly configured gateways.
authorization Authorization map for gateways. When token or a single username/password are used, they define the authentication mechanism this server expects. What authentication values other server have to provide when connecting. They also specify how this server will authenticate itself when establishing a connection to a discovered gateway. This will not be used for gateways explicitly listed in gateways and therefore have to be provided as part of the URL. If you use token or password based authentication, either use the same credentials throughout the system or list every gateway explicitly on every server. If the tls configuration map specifies verify_and_map only provide the expected username. Here different certificates can be used, but they do have to map to the same username. The authorization map also allows for timeout which is honored but users and permissions are ignored.

Gateway Entry

The gateways configuration block is a list of gateway entries with the following properties:

Property Description
name Gateway name.
url Hostport <host>:<port> describing where the remote gateway can be reached. If multiple IPs are returned, one is randomly selected.
urls A list of url strings.
tls A tls configuration map for creating a secure gateway connection. If the top-level gateway{} tls block contains certificates that have both client and server purposes, it is possible to omit this one and the server will use the certificates from the gateway{tls{}} section. See additional advice below in TLS Entry.

By using urls and an array, you can specify a list of endpoints that form part of a cluster as below. A NATS Server will pick one of those addresses randomly and only establish a single outbound gateway connection to one of the members from another cluster:

  1. gateway {
  2.     name: "DC-A"
  3.     listen: "localhost:7222"
  5.     gateways: [
  6.         {name: "DC-A", urls: ["nats://localhost:7222", "nats://localhost:7223", "nats://localhost:7224"]},
  7.         {name: "DC-B", urls: ["nats://localhost:7332", "nats://localhost:7333", "nats://localhost:7334"]},
  8.         {name: "DC-C", urls: ["nats://localhost:7442", "nats://localhost:7333", "nats://localhost:7335"]}
  9.     ]
  10. }

TLS Entry

In addition to the normal TLS configuration advice, bear in mind that TLS keys and certificates for multiple clusters, or servers in different locations, rarely rotate at the exact same time and that Certificate Authorities do roll between multiple Intermediate certificates.

If using a certificate bundle which accompanied the issuance of a certificate then the CA in that bundle will typically be for just that certificate. Using only that CA as the CA for gateway authentication is ill-advised. You should ensure that you allow for rolling between Certificate Authorities, even if only between multiple CAs from the same organization entity, and use a separate certificate bundle for verification of peers. This way when DC-B rolls before DC-A, it will not be cut off from your supercluster.