Reference
gateway
Configuration for setting up gateway connections between clusters.
- Default value: n/a
- Hot reloadable: No
Values
| Type | Description | Choices |
|---|---|---|
object | An object with a set of explicit properties that can be set. | - |
Properties
| Name | Description | Type | Default |
|---|---|---|---|
name | Name of this cluster. All gateway connections belonging to the same cluster must specify the same name. | string | - |
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. | boolean | false |
host | Interface where the gateway will listen for incoming gateway connections. | string | 0.0.0.0 |
port | Port where the gateway will listen for incoming gateway connections. | integer | 7222 |
listen | <host>:<port> format. Alternative to host/port. | string | - |
tls | A tls configuration map for securing gateway connections. verify is always enabled. Unless otherwise, cert_file will be the default client certificate. | object | - |
advertise | <host>:<port> to advertise how this server can be contacted by other gateway members. This is useful in setups with NAT. | string | - |
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. | integer | 0 |
authorization | Authorization map for gateways. When a single username/password is used, it defines the authentication mechanism this server expects, and 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. With this authentication mode, 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 token configuration are not supported and will prevent the server from starting. The permissions block is ignored. | object | - |
gateways | List of gateway entries. | object | - |