Commit 82a07bf3 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by David S. Miller
Browse files

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



- 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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: default avatarSimon Horman <horms@verge.net.au>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 1dc2a785

Documentation/admin-guide/sysctl/net.rst

+2 −2
Original line number Diff line number Diff line
@@ -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

-------------------------------------

Please see: Documentation/networking/ip-sysctl.rst and ipvs-sysctl.txt for

descriptions of these entries.

Please see: Documentation/networking/ip-sysctl.rst and

Documentation/admin-guide/sysctl/net.rst for descriptions of these entries.





4. Appletalk

Documentation/networking/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -72,6 +72,7 @@ Contents: 
   ip-sysctl

   ipv6

   ipvlan

   ipvs-sysctl



.. only::  subproject and html

Documentation/networking/ipvs-sysctl.txt→Documentation/networking/ipvs-sysctl.rst

+98 −90
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



===========

IPvs-sysctl

===========



/proc/sys/net/ipv4/vs/* Variables:

==================================



am_droprate - INTEGER

	default 10
@@ -16,8 +23,8 @@ amemthresh - INTEGER 
	the strategy is disabled and the variable is  set  to 1.



backup_only - BOOLEAN

	0 - disabled (default)

	not 0 - enabled

	- 0 - disabled (default)

	- not 0 - enabled



	If set, disable the director function while the server is

	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.



conntrack - BOOLEAN

	0 - disabled (default)

	not 0 - enabled

	- 0 - disabled (default)

	- not 0 - enabled



	If set, maintain connection tracking entries for

	connections handled by IPVS.
@@ -61,8 +68,8 @@ conntrack - BOOLEAN 
	Only available when IPVS is compiled with CONFIG_IP_VS_NFCT enabled.



cache_bypass - BOOLEAN

        0 - disabled (default)

        not 0 - enabled

	- 0 - disabled (default)

	- not 0 - enabled



	If it is enabled, forward packets to the original destination

	directly when no cache server is available and destination
@@ -70,19 +77,19 @@ cache_bypass - BOOLEAN 
	used in transparent web cache cluster.



debug_level - INTEGER

	0          - transmission error messages (default)

	1          - non-fatal error messages

	2          - configuration

	3          - destination trash

	4          - drop entry

	5          - service lookup

	6          - scheduling

	7          - connection new/expire, lookup and synchronization

	8          - state transition

	9          - binding destination, template checks and applications

	10         - IPVS packet transmission

	11         - IPVS packet handling (ip_vs_in/ip_vs_out)

	12 or more - packet traversal

	- 0          - transmission error messages (default)

	- 1          - non-fatal error messages

	- 2          - configuration

	- 3          - destination trash

	- 4          - drop entry

	- 5          - service lookup

	- 6          - scheduling

	- 7          - connection new/expire, lookup and synchronization

	- 8          - state transition

	- 9          - binding destination, template checks and applications

	- 10         - IPVS packet transmission

	- 11         - IPVS packet handling (ip_vs_in/ip_vs_out)

	- 12 or more - packet traversal



	Only available when IPVS is compiled with CONFIG_IP_VS_DEBUG enabled.
@@ -92,7 +99,7 @@ debug_level - INTEGER 
	the level.



drop_entry - INTEGER

        0  - disabled (default)

	- 0  - disabled (default)



	The drop_entry defense is to randomly drop entries in the

	connection hash table, just in order to collect back some
@@ -110,7 +117,7 @@ drop_entry - INTEGER 
	1), and 3 means that that the strategy is always enabled.



drop_packet - INTEGER

        0  - disabled (default)

	- 0  - disabled (default)



	The drop_packet defense is designed to drop 1/rate packets

	before forwarding them to real servers. If the rate is 1, then
@@ -124,8 +131,8 @@ drop_packet - INTEGER 
	is controlled by the /proc/sys/net/ipv4/vs/am_droprate.



expire_nodest_conn - BOOLEAN

        0 - disabled (default)

        not 0 - enabled

	- 0 - disabled (default)

	- not 0 - enabled



	The default value is 0, the load balancer will silently drop

	packets when its destination server is not available. It may
@@ -142,8 +149,8 @@ expire_nodest_conn - BOOLEAN 
	connections when its destination is not available.



expire_quiescent_template - BOOLEAN

	0 - disabled (default)

	not 0 - enabled

	- 0 - disabled (default)

	- not 0 - enabled



	When set to a non-zero value, the load balancer will expire

	persistent templates when the destination server is quiescent.
@@ -158,8 +165,8 @@ expire_quiescent_template - BOOLEAN 
	connection and the destination server is quiescent.



ignore_tunneled - BOOLEAN

	0 - disabled (default)

	not 0 - enabled

	- 0 - disabled (default)

	- not 0 - enabled



	If set, ipvs will set the ipvs_property on all packets which are of

	unrecognized protocols.  This prevents us from routing tunneled
@@ -168,23 +175,23 @@ ignore_tunneled - BOOLEAN 
	ipvs routing loops when ipvs is also acting as a real server).



nat_icmp_send - BOOLEAN

        0 - disabled (default)

        not 0 - enabled

	- 0 - disabled (default)

	- not 0 - enabled



	It controls sending icmp error messages (ICMP_DEST_UNREACH)

	for VS/NAT when the load balancer receives packets from real

	servers but the connection entries don't exist.



pmtu_disc - BOOLEAN

	0 - disabled

	not 0 - enabled (default)

	- 0 - disabled

	- not 0 - enabled (default)



	By default, reject with FRAG_NEEDED all DF packets that exceed

	the PMTU, irrespective of the forwarding method. For TUN method

	the flag can be disabled to fragment such packets.



secure_tcp - INTEGER

        0  - disabled (default)

	- 0  - disabled (default)



	The secure_tcp defense is to use a more complicated TCP state

	transition table. For VS/NAT, it also delays entering the
@@ -248,8 +255,8 @@ sync_ports - INTEGER 
	8848+sync_ports-1.



snat_reroute - BOOLEAN

	0 - disabled

	not 0 - enabled (default)

	- 0 - disabled

	- not 0 - enabled (default)



	If enabled, recalculate the route of SNATed packets from

	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



	0: All types of connections are synchronised



	1: Attempt to reduce the synchronisation traffic depending on

	the connection type. For persistent services avoid synchronisation

	for normal connections, do it only for persistence templates.

MAINTAINERS

+1 −1
Original line number Diff line number Diff line
@@ -8934,7 +8934,7 @@ L: lvs-devel@vger.kernel.org 
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.git

F:	Documentation/networking/ipvs-sysctl.txt

F:	Documentation/networking/ipvs-sysctl.rst

F:	include/net/ip_vs.h

F:	include/uapi/linux/ip_vs.h

F:	net/netfilter/ipvs/

CRA Git | Maintained and supported by SUSTech CRA and CCSE