leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: networking: convert ipvs-sysctl.txt to ReST

Browse Source 
- add SPDX header;
- add a document title;
- mark lists as such;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Simon Horman <horms@verge.net.au>
Signed-off-by: David S. Miller <davem@davemloft.net>
This commit is contained in:
Mauro Carvalho Chehab
2020-04-28 00:01:52 +02:00
committed by David S. Miller
parent 1dc2a78595
commit 82a07bf33d
4 changed files with 98 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/admin-guide/sysctl/net.rst
View File

@@ -353,8 +353,8 @@ socket's buffer. It will not take effect unless PF_UNIX flag is specified.
3. /proc/sys/net/ipv4 - IPV4 settings 3. /proc/sys/net/ipv4 - IPV4 settings
------------------------------------- -------------------------------------
Please see: Documentation/networking/ip-sysctl.rst and ipvs-sysctl.txt for Please see: Documentation/networking/ip-sysctl.rst and
descriptions of these entries. Documentation/admin-guide/sysctl/net.rst for descriptions of these entries.
4. Appletalk 4. Appletalk

1
Documentation/networking/index.rst
View File

@@ -72,6 +72,7 @@ Contents:
ip-sysctl ip-sysctl
ipv6 ipv6
ipvlan ipvlan
ipvs-sysctl
.. only:: subproject and html .. only:: subproject and html

180
Documentation/networking/ipvs-sysctl.txt → Documentation/networking/ipvs-sysctl.rst
View File

@@ -1,23 +1,30 @@
.. SPDX-License-Identifier: GPL-2.0
===========
IPvs-sysctl
===========
/proc/sys/net/ipv4/vs/* Variables: /proc/sys/net/ipv4/vs/* Variables:
==================================
am_droprate - INTEGER am_droprate - INTEGER
default 10 default 10
It sets the always mode drop rate, which is used in the mode 3 It sets the always mode drop rate, which is used in the mode 3
of the drop_rate defense. of the drop_rate defense.
amemthresh - INTEGER amemthresh - INTEGER
default 1024 default 1024
It sets the available memory threshold (in pages), which is It sets the available memory threshold (in pages), which is
used in the automatic modes of defense. When there is no used in the automatic modes of defense. When there is no
enough available memory, the respective strategy will be enough available memory, the respective strategy will be
enabled and the variable is automatically set to 2, otherwise enabled and the variable is automatically set to 2, otherwise
the strategy is disabled and the variable is set to 1. the strategy is disabled and the variable is set to 1.
backup_only - BOOLEAN backup_only - BOOLEAN
0 - disabled (default) - 0 - disabled (default)
not 0 - enabled - not 0 - enabled
If set, disable the director function while the server is If set, disable the director function while the server is
in backup mode to avoid packet loops for DR/TUN methods. in backup mode to avoid packet loops for DR/TUN methods.
@@ -44,8 +51,8 @@ conn_reuse_mode - INTEGER
real servers to a very busy cluster. real servers to a very busy cluster.
conntrack - BOOLEAN conntrack - BOOLEAN
0 - disabled (default) - 0 - disabled (default)
not 0 - enabled - not 0 - enabled
If set, maintain connection tracking entries for If set, maintain connection tracking entries for
connections handled by IPVS. connections handled by IPVS.
@@ -61,28 +68,28 @@ conntrack - BOOLEAN
Only available when IPVS is compiled with CONFIG_IP_VS_NFCT enabled. Only available when IPVS is compiled with CONFIG_IP_VS_NFCT enabled.
cache_bypass - BOOLEAN cache_bypass - BOOLEAN
0 - disabled (default) - 0 - disabled (default)
not 0 - enabled - not 0 - enabled
If it is enabled, forward packets to the original destination If it is enabled, forward packets to the original destination
directly when no cache server is available and destination directly when no cache server is available and destination
address is not local (iph->daddr is RTN_UNICAST). It is mostly address is not local (iph->daddr is RTN_UNICAST). It is mostly
used in transparent web cache cluster. used in transparent web cache cluster.
debug_level - INTEGER debug_level - INTEGER
0 - transmission error messages (default) - 0 - transmission error messages (default)
1 - non-fatal error messages - 1 - non-fatal error messages
2 - configuration - 2 - configuration
3 - destination trash - 3 - destination trash
4 - drop entry - 4 - drop entry
5 - service lookup - 5 - service lookup
6 - scheduling - 6 - scheduling
7 - connection new/expire, lookup and synchronization - 7 - connection new/expire, lookup and synchronization
8 - state transition - 8 - state transition
9 - binding destination, template checks and applications - 9 - binding destination, template checks and applications
10 - IPVS packet transmission - 10 - IPVS packet transmission
11 - IPVS packet handling (ip_vs_in/ip_vs_out) - 11 - IPVS packet handling (ip_vs_in/ip_vs_out)
12 or more - packet traversal - 12 or more - packet traversal
Only available when IPVS is compiled with CONFIG_IP_VS_DEBUG enabled. Only available when IPVS is compiled with CONFIG_IP_VS_DEBUG enabled.
@@ -92,58 +99,58 @@ debug_level - INTEGER
the level. the level.
drop_entry - INTEGER drop_entry - INTEGER
0 - disabled (default) - 0 - disabled (default)
The drop_entry defense is to randomly drop entries in the The drop_entry defense is to randomly drop entries in the
connection hash table, just in order to collect back some connection hash table, just in order to collect back some
memory for new connections. In the current code, the memory for new connections. In the current code, the
drop_entry procedure can be activated every second, then it drop_entry procedure can be activated every second, then it
randomly scans 1/32 of the whole and drops entries that are in randomly scans 1/32 of the whole and drops entries that are in
the SYN-RECV/SYNACK state, which should be effective against the SYN-RECV/SYNACK state, which should be effective against
syn-flooding attack. syn-flooding attack.
The valid values of drop_entry are from 0 to 3, where 0 means The valid values of drop_entry are from 0 to 3, where 0 means
that this strategy is always disabled, 1 and 2 mean automatic that this strategy is always disabled, 1 and 2 mean automatic
modes (when there is no enough available memory, the strategy modes (when there is no enough available memory, the strategy
is enabled and the variable is automatically set to 2, is enabled and the variable is automatically set to 2,
otherwise the strategy is disabled and the variable is set to otherwise the strategy is disabled and the variable is set to
1), and 3 means that that the strategy is always enabled. 1), and 3 means that that the strategy is always enabled.
drop_packet - INTEGER drop_packet - INTEGER
0 - disabled (default) - 0 - disabled (default)
The drop_packet defense is designed to drop 1/rate packets The drop_packet defense is designed to drop 1/rate packets
before forwarding them to real servers. If the rate is 1, then before forwarding them to real servers. If the rate is 1, then
drop all the incoming packets. drop all the incoming packets.
The value definition is the same as that of the drop_entry. In The value definition is the same as that of the drop_entry. In
the automatic mode, the rate is determined by the follow the automatic mode, the rate is determined by the follow
formula: rate = amemthresh / (amemthresh - available_memory) formula: rate = amemthresh / (amemthresh - available_memory)
when available memory is less than the available memory when available memory is less than the available memory
threshold. When the mode 3 is set, the always mode drop rate threshold. When the mode 3 is set, the always mode drop rate
is controlled by the /proc/sys/net/ipv4/vs/am_droprate. is controlled by the /proc/sys/net/ipv4/vs/am_droprate.
expire_nodest_conn - BOOLEAN expire_nodest_conn - BOOLEAN
0 - disabled (default) - 0 - disabled (default)
not 0 - enabled - not 0 - enabled
The default value is 0, the load balancer will silently drop The default value is 0, the load balancer will silently drop
packets when its destination server is not available. It may packets when its destination server is not available. It may
be useful, when user-space monitoring program deletes the be useful, when user-space monitoring program deletes the
destination server (because of server overload or wrong destination server (because of server overload or wrong
detection) and add back the server later, and the connections detection) and add back the server later, and the connections
to the server can continue. to the server can continue.
If this feature is enabled, the load balancer will expire the If this feature is enabled, the load balancer will expire the
connection immediately when a packet arrives and its connection immediately when a packet arrives and its
destination server is not available, then the client program destination server is not available, then the client program
will be notified that the connection is closed. This is will be notified that the connection is closed. This is
equivalent to the feature some people requires to flush equivalent to the feature some people requires to flush
connections when its destination is not available. connections when its destination is not available.
expire_quiescent_template - BOOLEAN expire_quiescent_template - BOOLEAN
0 - disabled (default) - 0 - disabled (default)
not 0 - enabled - not 0 - enabled
When set to a non-zero value, the load balancer will expire When set to a non-zero value, the load balancer will expire
persistent templates when the destination server is quiescent. persistent templates when the destination server is quiescent.
@@ -158,8 +165,8 @@ expire_quiescent_template - BOOLEAN
connection and the destination server is quiescent. connection and the destination server is quiescent.
ignore_tunneled - BOOLEAN ignore_tunneled - BOOLEAN
0 - disabled (default) - 0 - disabled (default)
not 0 - enabled - not 0 - enabled
If set, ipvs will set the ipvs_property on all packets which are of If set, ipvs will set the ipvs_property on all packets which are of
unrecognized protocols. This prevents us from routing tunneled unrecognized protocols. This prevents us from routing tunneled
@@ -168,30 +175,30 @@ ignore_tunneled - BOOLEAN
ipvs routing loops when ipvs is also acting as a real server). ipvs routing loops when ipvs is also acting as a real server).
nat_icmp_send - BOOLEAN nat_icmp_send - BOOLEAN
0 - disabled (default) - 0 - disabled (default)
not 0 - enabled - not 0 - enabled
It controls sending icmp error messages (ICMP_DEST_UNREACH) It controls sending icmp error messages (ICMP_DEST_UNREACH)
for VS/NAT when the load balancer receives packets from real for VS/NAT when the load balancer receives packets from real
servers but the connection entries don't exist. servers but the connection entries don't exist.
pmtu_disc - BOOLEAN pmtu_disc - BOOLEAN
0 - disabled - 0 - disabled
not 0 - enabled (default) - not 0 - enabled (default)
By default, reject with FRAG_NEEDED all DF packets that exceed By default, reject with FRAG_NEEDED all DF packets that exceed
the PMTU, irrespective of the forwarding method. For TUN method the PMTU, irrespective of the forwarding method. For TUN method
the flag can be disabled to fragment such packets. the flag can be disabled to fragment such packets.
secure_tcp - INTEGER secure_tcp - INTEGER
0 - disabled (default) - 0 - disabled (default)
The secure_tcp defense is to use a more complicated TCP state The secure_tcp defense is to use a more complicated TCP state
transition table. For VS/NAT, it also delays entering the transition table. For VS/NAT, it also delays entering the
TCP ESTABLISHED state until the three way handshake is completed. TCP ESTABLISHED state until the three way handshake is completed.
The value definition is the same as that of drop_entry and The value definition is the same as that of drop_entry and
drop_packet. drop_packet.
sync_threshold - vector of 2 INTEGERs: sync_threshold, sync_period sync_threshold - vector of 2 INTEGERs: sync_threshold, sync_period
default 3 50 default 3 50
@@ -248,8 +255,8 @@ sync_ports - INTEGER
8848+sync_ports-1. 8848+sync_ports-1.
snat_reroute - BOOLEAN snat_reroute - BOOLEAN
0 - disabled - 0 - disabled
not 0 - enabled (default) - not 0 - enabled (default)
If enabled, recalculate the route of SNATed packets from If enabled, recalculate the route of SNATed packets from
realservers so that they are routed as if they originate from the realservers so that they are routed as if they originate from the
@@ -270,6 +277,7 @@ sync_persist_mode - INTEGER
Controls the synchronisation of connections when using persistence Controls the synchronisation of connections when using persistence
0: All types of connections are synchronised 0: All types of connections are synchronised
1: Attempt to reduce the synchronisation traffic depending on 1: Attempt to reduce the synchronisation traffic depending on
the connection type. For persistent services avoid synchronisation the connection type. For persistent services avoid synchronisation
for normal connections, do it only for persistence templates. for normal connections, do it only for persistence templates.

2
MAINTAINERS
View File

@@ -8934,7 +8934,7 @@ L: lvs-devel@vger.kernel.org
S: Maintained S: Maintained
T: git git://git.kernel.org/pub/scm/linux/kernel/git/horms/ipvs-next.git T: git git://git.kernel.org/pub/scm/linux/kernel/git/horms/ipvs-next.git
T: git git://git.kernel.org/pub/scm/linux/kernel/git/horms/ipvs.git T: git git://git.kernel.org/pub/scm/linux/kernel/git/horms/ipvs.git
F: Documentation/networking/ipvs-sysctl.txt F: Documentation/networking/ipvs-sysctl.rst
F: include/net/ip_vs.h F: include/net/ip_vs.h
F: include/uapi/linux/ip_vs.h F: include/uapi/linux/ip_vs.h
F: net/netfilter/ipvs/ F: net/netfilter/ipvs/