network.asciidoc 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. [[modules-network]]
  2. == Network Settings
  3. There are several modules within a Node that use network based
  4. configuration, for example, the
  5. <<modules-transport,transport>> and
  6. <<modules-http,http>> modules. Node level
  7. network settings allows to set common settings that will be shared among
  8. all network based modules (unless explicitly overridden in each module).
  9. The `network.bind_host` setting allows to control the host different
  10. network components will bind on. By default, the bind host will be
  11. `anyLocalAddress` (typically `0.0.0.0` or `::0`).
  12. The `network.publish_host` setting allows to control the host the node
  13. will publish itself within the cluster so other nodes will be able to
  14. connect to it. Of course, this can't be the `anyLocalAddress`, and by
  15. default, it will be the first non loopback address (if possible), or the
  16. local address.
  17. The `network.host` setting is a simple setting to automatically set both
  18. `network.bind_host` and `network.publish_host` to the same host value.
  19. Both settings allows to be configured with either explicit host address
  20. or host name. The settings also accept logical setting values explained
  21. in the following table:
  22. [cols="<,<",options="header",]
  23. |=======================================================================
  24. |Logical Host Setting Value |Description
  25. |`_local_` |Will be resolved to the local ip address.
  26. |`_non_loopback_` |The first non loopback address.
  27. |`_non_loopback:ipv4_` |The first non loopback IPv4 address.
  28. |`_non_loopback:ipv6_` |The first non loopback IPv6 address.
  29. |`_[networkInterface]_` |Resolves to the ip address of the provided
  30. network interface. For example `_en0_`.
  31. |`_[networkInterface]:ipv4_` |Resolves to the ipv4 address of the
  32. provided network interface. For example `_en0:ipv4_`.
  33. |`_[networkInterface]:ipv6_` |Resolves to the ipv6 address of the
  34. provided network interface. For example `_en0:ipv6_`.
  35. |=======================================================================
  36. When the `cloud-aws` plugin is installed, the following are also allowed
  37. as valid network host settings:
  38. [cols="<,<",options="header",]
  39. |==================================================================
  40. |EC2 Host Value |Description
  41. |`_ec2:privateIpv4_` |The private IP address (ipv4) of the machine.
  42. |`_ec2:privateDns_` |The private host of the machine.
  43. |`_ec2:publicIpv4_` |The public IP address (ipv4) of the machine.
  44. |`_ec2:publicDns_` |The public host of the machine.
  45. |`_ec2_` |Less verbose option for the private ip address.
  46. |`_ec2:privateIp_` |Less verbose option for the private ip address.
  47. |`_ec2:publicIp_` |Less verbose option for the public ip address.
  48. |==================================================================
  49. [float]
  50. [[tcp-settings]]
  51. === TCP Settings
  52. Any component that uses TCP (like the HTTP, Transport and Memcached)
  53. share the following allowed settings:
  54. [cols="<,<",options="header",]
  55. |=======================================================================
  56. |Setting |Description
  57. |`network.tcp.no_delay` |Enable or disable tcp no delay setting.
  58. Defaults to `true`.
  59. |`network.tcp.keep_alive` |Enable or disable tcp keep alive. Defaults
  60. to `true`.
  61. |`network.tcp.reuse_address` |Should an address be reused or not.
  62. Defaults to `true` on non-windows machines.
  63. |`network.tcp.send_buffer_size` |The size of the tcp send buffer size
  64. (in size setting format). By default not explicitly set.
  65. |`network.tcp.receive_buffer_size` |The size of the tcp receive buffer
  66. size (in size setting format). By default not explicitly set.
  67. |=======================================================================