Patchwork [1/4] IPVS: Add documentation for new sysctl entries

login
register
mail settings
Submitter Simon Horman
Date Sept. 26, 2011, 1:23 a.m.
Message ID <1317000233-11169-2-git-send-email-horms@verge.net.au>
Download mbox | patch
Permalink /patch/116342/
State Awaiting Upstream
Delegated to: David Miller
Headers show

Comments

Simon Horman - Sept. 26, 2011, 1:23 a.m.
Add missing documentation for conntrack, snat_reroute and sync_version.

Also fix up a typo, IPVS_DEBUG should be IP_VS_DEBUG.

Signed-off-by: Simon Horman <horms@verge.net.au>

conntrack
---
 Documentation/networking/ipvs-sysctl.txt |   53 +++++++++++++++++++++++++++++-
 1 files changed, 52 insertions(+), 1 deletions(-)
Randy.Dunlap - Sept. 26, 2011, 5:16 p.m.
On 09/25/2011 06:23 PM, Simon Horman wrote:
> Add missing documentation for conntrack, snat_reroute and sync_version.
> 
> Also fix up a typo, IPVS_DEBUG should be IP_VS_DEBUG.
> 
> Signed-off-by: Simon Horman <horms@verge.net.au>
> 
> conntrack
> ---
>  Documentation/networking/ipvs-sysctl.txt |   53 +++++++++++++++++++++++++++++-
>  1 files changed, 52 insertions(+), 1 deletions(-)
> 
> diff --git a/Documentation/networking/ipvs-sysctl.txt b/Documentation/networking/ipvs-sysctl.txt
> index 4ccdbca..5214339 100644
> --- a/Documentation/networking/ipvs-sysctl.txt
> +++ b/Documentation/networking/ipvs-sysctl.txt
> @@ -15,6 +15,23 @@ amemthresh - INTEGER
>          enabled and the variable is automatically set to 2, otherwise
>          the strategy is disabled and the variable is  set  to 1.
>  
> +conntrack - BOOLEAN
> +	0 - disabled (default)
> +	not 0 - enabled
> +
> +	If set, maintain connection tracking entries for
> +	connections handled by IPVS.
> +
> +	This should be enabled if connections handled by IPVS are to be
> +	also handled by stateful firewall rules. That is, iptables rules
> +	that make use of connection tracking.  It is a performance
> +	optimisation to disable this setting otherwise.
> +
> +	Connections handled by the IPVS FTP application module
> +	will have connection tracking entries regardless of this setting.
> +
> +	Only available when IPVS is compiled with the CONFIG_IP_VS_NFCT

seems to be missing something.  Maybe

	Only available when IPVS is compiled with CONFIG_IP_VS_NFCT enabled.
or
	Only available when IPVS is compiled with the CONFIG_IP_VS_NFCT
	symbol enabled.

> +
>  cache_bypass - BOOLEAN
>          0 - disabled (default)
>          not 0 - enabled
> @@ -39,7 +56,7 @@ debug_level - INTEGER
>  	11         - IPVS packet handling (ip_vs_in/ip_vs_out)
>  	12 or more - packet traversal
>  
> -	Only available when IPVS is compiled with the CONFIG_IPVS_DEBUG
> +	Only available when IPVS is compiled with the CONFIG_IP_VS_DEBUG

	                                     with CONFIG_IP_VS_DEBUG enabled.

>  
>  	Higher debugging levels include the messages for lower debugging
>  	levels, so setting debug level 2, includes level 0, 1 and 2
Simon Horman - Sept. 26, 2011, 10:07 p.m.
On Mon, Sep 26, 2011 at 10:16:41AM -0700, Randy Dunlap wrote:
> On 09/25/2011 06:23 PM, Simon Horman wrote:
> > Add missing documentation for conntrack, snat_reroute and sync_version.
> > 
> > Also fix up a typo, IPVS_DEBUG should be IP_VS_DEBUG.
> > 
> > Signed-off-by: Simon Horman <horms@verge.net.au>
> > 
> > conntrack
> > ---
> >  Documentation/networking/ipvs-sysctl.txt |   53 +++++++++++++++++++++++++++++-
> >  1 files changed, 52 insertions(+), 1 deletions(-)
> > 
> > diff --git a/Documentation/networking/ipvs-sysctl.txt b/Documentation/networking/ipvs-sysctl.txt
> > index 4ccdbca..5214339 100644
> > --- a/Documentation/networking/ipvs-sysctl.txt
> > +++ b/Documentation/networking/ipvs-sysctl.txt
> > @@ -15,6 +15,23 @@ amemthresh - INTEGER
> >          enabled and the variable is automatically set to 2, otherwise
> >          the strategy is disabled and the variable is  set  to 1.
> >  
> > +conntrack - BOOLEAN
> > +	0 - disabled (default)
> > +	not 0 - enabled
> > +
> > +	If set, maintain connection tracking entries for
> > +	connections handled by IPVS.
> > +
> > +	This should be enabled if connections handled by IPVS are to be
> > +	also handled by stateful firewall rules. That is, iptables rules
> > +	that make use of connection tracking.  It is a performance
> > +	optimisation to disable this setting otherwise.
> > +
> > +	Connections handled by the IPVS FTP application module
> > +	will have connection tracking entries regardless of this setting.
> > +
> > +	Only available when IPVS is compiled with the CONFIG_IP_VS_NFCT
> 
> seems to be missing something.  Maybe
> 
> 	Only available when IPVS is compiled with CONFIG_IP_VS_NFCT enabled.
> or
> 	Only available when IPVS is compiled with the CONFIG_IP_VS_NFCT
> 	symbol enabled.
> 
> > +
> >  cache_bypass - BOOLEAN
> >          0 - disabled (default)
> >          not 0 - enabled
> > @@ -39,7 +56,7 @@ debug_level - INTEGER
> >  	11         - IPVS packet handling (ip_vs_in/ip_vs_out)
> >  	12 or more - packet traversal
> >  
> > -	Only available when IPVS is compiled with the CONFIG_IPVS_DEBUG
> > +	Only available when IPVS is compiled with the CONFIG_IP_VS_DEBUG
> 
> 	                                     with CONFIG_IP_VS_DEBUG enabled.
> 
> >  
> >  	Higher debugging levels include the messages for lower debugging
> >  	levels, so setting debug level 2, includes level 0, 1 and 2

Thanks Randy,

I was just blindly copying the existing language.
I'll make a follow up patch which incorporates your suggestions.

--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

diff --git a/Documentation/networking/ipvs-sysctl.txt b/Documentation/networking/ipvs-sysctl.txt
index 4ccdbca..5214339 100644
--- a/Documentation/networking/ipvs-sysctl.txt
+++ b/Documentation/networking/ipvs-sysctl.txt
@@ -15,6 +15,23 @@  amemthresh - INTEGER
         enabled and the variable is automatically set to 2, otherwise
         the strategy is disabled and the variable is  set  to 1.
 
+conntrack - BOOLEAN
+	0 - disabled (default)
+	not 0 - enabled
+
+	If set, maintain connection tracking entries for
+	connections handled by IPVS.
+
+	This should be enabled if connections handled by IPVS are to be
+	also handled by stateful firewall rules. That is, iptables rules
+	that make use of connection tracking.  It is a performance
+	optimisation to disable this setting otherwise.
+
+	Connections handled by the IPVS FTP application module
+	will have connection tracking entries regardless of this setting.
+
+	Only available when IPVS is compiled with the CONFIG_IP_VS_NFCT
+
 cache_bypass - BOOLEAN
         0 - disabled (default)
         not 0 - enabled
@@ -39,7 +56,7 @@  debug_level - INTEGER
 	11         - IPVS packet handling (ip_vs_in/ip_vs_out)
 	12 or more - packet traversal
 
-	Only available when IPVS is compiled with the CONFIG_IPVS_DEBUG
+	Only available when IPVS is compiled with the CONFIG_IP_VS_DEBUG
 
 	Higher debugging levels include the messages for lower debugging
 	levels, so setting debug level 2, includes level 0, 1 and 2
@@ -141,3 +158,37 @@  sync_threshold - INTEGER
         synchronized, every time the number of its incoming packets
         modulus 50 equals the threshold. The range of the threshold is
         from 0 to 49.
+
+snat_reroute - BOOLEAN
+	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
+	director. Otherwise they are routed as if they are forwarded by the
+	director.
+
+	If policy routing is in effect then it is possible that the route
+	of a packet originating from a director is routed differently to a
+	packet being forwarded by the director.
+
+	If policy routing is not in effect then the recalculated route will
+	always be the same as the original route so it is an optimisation
+	to disable snat_reroute and avoid the recalculation.
+
+sync_version - INTEGER
+	default 1
+
+	The version of the synchronisation protocol used when sending
+	synchronisation messages.
+
+	0 selects the original synchronisation protocol (version 0). This
+	shuold be used Use this when sending synchronisation messages to a
+	legacy system that only understands the original synchronisation
+	protocol.
+
+	1 selects the current synchronisation protocol (version 1). This
+	should be used where possible.
+
+	Kernels with this sync_version entry are able to receive messages
+	of both version 1 and version 2 of the synchronisation protocol.