network.asciidoc 3.5 KB

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