Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing config options #4339

Merged
merged 4 commits into from
Aug 29, 2022
Merged

Add missing config options #4339

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fe07af9
add missing ipv6only and so_keepalive options
lena-larionova Aug 26, 2022
8764488
add info on missing config options
lena-larionova Aug 27, 2022
82edcf1
Apply suggestions from code review
lena-larionova Aug 29, 2022
1194696
Apply suggestions from code review
lena-larionova Aug 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 34 additions & 2 deletions src/gateway/reference/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,6 +537,16 @@ Some suffixes can be specified for each pair:
parameter. In order for the larger `backlog` set here to take effect it is
necessary to raise `net.core.somaxconn` at the same time to match or exceed
the `backlog` number set.
- `ipv6only=on|off` whether an IPv6 socket listening on a wildcard address [::]
will accept only IPv6 connections or both IPv6 and IPv4 connections.
- `so_keepalive=on|off|[keepidle]:[keepintvl]:[keepcnt]` configures the
“TCP keepalive” behavior for the listening socket. If this parameter is
omitted then the operating system’s settings will be in effect for the socket.
If it is set to the value `on`, the `SO_KEEPALIVE` option is turned
on for the socket. If it is set to the value `off`, the `SO_KEEPALIVE` option
is turned off for the socket. Some operating systems support setting of
TCP keepalive parameters on a per-socket basis using the `TCP_KEEPIDLE`,
`TCP_KEEPINTVL`, and `TCP_KEEPCNT` socket options.

This value can be set to `off`, thus disabling the HTTP/HTTPS proxy port for
this node.
Expand Down Expand Up @@ -612,6 +622,16 @@ Some suffixes can be specified for each pair:
parameter. In order for the larger `backlog` set here to take effect it is
necessary to raise `net.core.somaxconn` at the same time to match or exceed
the `backlog` number set.
- `ipv6only=on|off` whether an IPv6 socket listening on a wildcard address [::]
will accept only IPv6 connections or both IPv6 and IPv4 connections.
- `so_keepalive=on|off|[keepidle]:[keepintvl]:[keepcnt]` configures the
`TCP keepalive` behavior for the listening socket. If this parameter is
omitted then the operating system’s settings will be in effect for the socket.
If it is set to the value `on`, the `SO_KEEPALIVE` option is turned
on for the socket. If it is set to the value `off`, the `SO_KEEPALIVE` option
is turned off for the socket. Some operating systems support setting of
TCP keepalive parameters on a per-socket basis using the `TCP_KEEPIDLE`,
`TCP_KEEPINTVL`, and `TCP_KEEPCNT` socket options.

Examples:

Expand Down Expand Up @@ -674,6 +694,16 @@ Some suffixes can be specified for each pair:
parameter. In order for the larger `backlog` set here to take effect it is
necessary to raise `net.core.somaxconn` at the same time to match or exceed
the `backlog` number set.
- `ipv6only=on|off` whether an IPv6 socket listening on a wildcard address [::]
will accept only IPv6 connections or both IPv6 and IPv4 connections.
- `so_keepalive=on|off|[keepidle]:[keepintvl]:[keepcnt]` configures the
“TCP keepalive” behavior for the listening socket. If this parameter is
omitted then the operating system’s settings will be in effect for the socket.
If it is set to the value `on`, the `SO_KEEPALIVE` option is turned
on for the socket. If it is set to the value `off`, the `SO_KEEPALIVE` option
is turned off for the socket. Some operating systems support setting of
TCP keepalive parameters on a per-socket basis using the `TCP_KEEPIDLE`,
`TCP_KEEPINTVL`, and `TCP_KEEPCNT` socket options.

This value can be set to `off`, thus disabling the Admin interface for this
node, enabling a 'data-plane' mode (without configuration capabilities) pulling
Expand Down Expand Up @@ -1166,7 +1196,8 @@ block.
Changes the limit on the maximum number of open files for worker processes.

The special and default value of `auto` sets this value to `ulimit -n` with the
upper bound limited to 16384 as a measure to protect against excess memory use.
upper bound limited to 16384 as a measure to protect against excess memory use,
and the lower bound of 1024 as a good default.

See http://nginx.org/en/docs/ngx_core_module.html#worker_rlimit_nofile

Expand All @@ -1180,7 +1211,8 @@ Sets the maximum number of simultaneous connections that can be opened by a
worker process.

The special and default value of `auto` sets this value to `ulimit -n` with the
upper bound limited to 16384 as a measure to protect against excess memory use.
upper bound limited to 16384 as a measure to protect against excess memory use,
and the lower bound of 1024 as a good default.

See http://nginx.org/en/docs/ngx_core_module.html#worker_connections

Expand Down