xref: /linux-6.15/net/netfilter/ipvs/Kconfig (revision 758ff033)
1#
2# IP Virtual Server configuration
3#
4menuconfig IP_VS
5	tristate "IP virtual server support"
6	depends on NET && INET && NETFILTER
7	---help---
8	  IP Virtual Server support will let you build a high-performance
9	  virtual server based on cluster of two or more real servers. This
10	  option must be enabled for at least one of the clustered computers
11	  that will take care of intercepting incoming connections to a
12	  single IP address and scheduling them to real servers.
13
14	  Three request dispatching techniques are implemented, they are
15	  virtual server via NAT, virtual server via tunneling and virtual
16	  server via direct routing. The several scheduling algorithms can
17	  be used to choose which server the connection is directed to,
18	  thus load balancing can be achieved among the servers.  For more
19	  information and its administration program, please visit the
20	  following URL: <http://www.linuxvirtualserver.org/>.
21
22	  If you want to compile it in kernel, say Y. To compile it as a
23	  module, choose M here. If unsure, say N.
24
25if IP_VS
26
27config	IP_VS_IPV6
28	bool "IPv6 support for IPVS"
29	depends on IPV6 = y || IP_VS = IPV6
30	---help---
31	  Add IPv6 support to IPVS. This is incomplete and might be dangerous.
32
33	  See http://www.mindbasket.com/ipvs for more information.
34
35	  Say N if unsure.
36
37config	IP_VS_DEBUG
38	bool "IP virtual server debugging"
39	---help---
40	  Say Y here if you want to get additional messages useful in
41	  debugging the IP virtual server code. You can change the debug
42	  level in /proc/sys/net/ipv4/vs/debug_level
43
44config	IP_VS_TAB_BITS
45	int "IPVS connection table size (the Nth power of 2)"
46	range 8 20
47	default 12
48	---help---
49	  The IPVS connection hash table uses the chaining scheme to handle
50	  hash collisions. Using a big IPVS connection hash table will greatly
51	  reduce conflicts when there are hundreds of thousands of connections
52	  in the hash table.
53
54	  Note the table size must be power of 2. The table size will be the
55	  value of 2 to the your input number power. The number to choose is
56	  from 8 to 20, the default number is 12, which means the table size
57	  is 4096. Don't input the number too small, otherwise you will lose
58	  performance on it. You can adapt the table size yourself, according
59	  to your virtual server application. It is good to set the table size
60	  not far less than the number of connections per second multiplying
61	  average lasting time of connection in the table.  For example, your
62	  virtual server gets 200 connections per second, the connection lasts
63	  for 200 seconds in average in the connection table, the table size
64	  should be not far less than 200x200, it is good to set the table
65	  size 32768 (2**15).
66
67	  Another note that each connection occupies 128 bytes effectively and
68	  each hash entry uses 8 bytes, so you can estimate how much memory is
69	  needed for your box.
70
71	  You can overwrite this number setting conn_tab_bits module parameter
72	  or by appending ip_vs.conn_tab_bits=? to the kernel command line
73	  if IP VS was compiled built-in.
74
75comment "IPVS transport protocol load balancing support"
76
77config	IP_VS_PROTO_TCP
78	bool "TCP load balancing support"
79	---help---
80	  This option enables support for load balancing TCP transport
81	  protocol. Say Y if unsure.
82
83config	IP_VS_PROTO_UDP
84	bool "UDP load balancing support"
85	---help---
86	  This option enables support for load balancing UDP transport
87	  protocol. Say Y if unsure.
88
89config	IP_VS_PROTO_AH_ESP
90	def_bool IP_VS_PROTO_ESP || IP_VS_PROTO_AH
91
92config	IP_VS_PROTO_ESP
93	bool "ESP load balancing support"
94	---help---
95	  This option enables support for load balancing ESP (Encapsulation
96	  Security Payload) transport protocol. Say Y if unsure.
97
98config	IP_VS_PROTO_AH
99	bool "AH load balancing support"
100	---help---
101	  This option enables support for load balancing AH (Authentication
102	  Header) transport protocol. Say Y if unsure.
103
104config  IP_VS_PROTO_SCTP
105	bool "SCTP load balancing support"
106	select LIBCRC32C
107	---help---
108	  This option enables support for load balancing SCTP transport
109	  protocol. Say Y if unsure.
110
111comment "IPVS scheduler"
112
113config	IP_VS_RR
114	tristate "round-robin scheduling"
115	---help---
116	  The robin-robin scheduling algorithm simply directs network
117	  connections to different real servers in a round-robin manner.
118
119	  If you want to compile it in kernel, say Y. To compile it as a
120	  module, choose M here. If unsure, say N.
121
122config	IP_VS_WRR
123	tristate "weighted round-robin scheduling"
124	select GCD
125	---help---
126	  The weighted robin-robin scheduling algorithm directs network
127	  connections to different real servers based on server weights
128	  in a round-robin manner. Servers with higher weights receive
129	  new connections first than those with less weights, and servers
130	  with higher weights get more connections than those with less
131	  weights and servers with equal weights get equal connections.
132
133	  If you want to compile it in kernel, say Y. To compile it as a
134	  module, choose M here. If unsure, say N.
135
136config	IP_VS_LC
137        tristate "least-connection scheduling"
138	---help---
139	  The least-connection scheduling algorithm directs network
140	  connections to the server with the least number of active
141	  connections.
142
143	  If you want to compile it in kernel, say Y. To compile it as a
144	  module, choose M here. If unsure, say N.
145
146config	IP_VS_WLC
147        tristate "weighted least-connection scheduling"
148	---help---
149	  The weighted least-connection scheduling algorithm directs network
150	  connections to the server with the least active connections
151	  normalized by the server weight.
152
153	  If you want to compile it in kernel, say Y. To compile it as a
154	  module, choose M here. If unsure, say N.
155
156config	IP_VS_LBLC
157	tristate "locality-based least-connection scheduling"
158	---help---
159	  The locality-based least-connection scheduling algorithm is for
160	  destination IP load balancing. It is usually used in cache cluster.
161	  This algorithm usually directs packet destined for an IP address to
162	  its server if the server is alive and under load. If the server is
163	  overloaded (its active connection numbers is larger than its weight)
164	  and there is a server in its half load, then allocate the weighted
165	  least-connection server to this IP address.
166
167	  If you want to compile it in kernel, say Y. To compile it as a
168	  module, choose M here. If unsure, say N.
169
170config  IP_VS_LBLCR
171	tristate "locality-based least-connection with replication scheduling"
172	---help---
173	  The locality-based least-connection with replication scheduling
174	  algorithm is also for destination IP load balancing. It is
175	  usually used in cache cluster. It differs from the LBLC scheduling
176	  as follows: the load balancer maintains mappings from a target
177	  to a set of server nodes that can serve the target. Requests for
178	  a target are assigned to the least-connection node in the target's
179	  server set. If all the node in the server set are over loaded,
180	  it picks up a least-connection node in the cluster and adds it
181	  in the sever set for the target. If the server set has not been
182	  modified for the specified time, the most loaded node is removed
183	  from the server set, in order to avoid high degree of replication.
184
185	  If you want to compile it in kernel, say Y. To compile it as a
186	  module, choose M here. If unsure, say N.
187
188config	IP_VS_DH
189	tristate "destination hashing scheduling"
190	---help---
191	  The destination hashing scheduling algorithm assigns network
192	  connections to the servers through looking up a statically assigned
193	  hash table by their destination IP addresses.
194
195	  If you want to compile it in kernel, say Y. To compile it as a
196	  module, choose M here. If unsure, say N.
197
198config	IP_VS_SH
199	tristate "source hashing scheduling"
200	---help---
201	  The source hashing scheduling algorithm assigns network
202	  connections to the servers through looking up a statically assigned
203	  hash table by their source IP addresses.
204
205	  If you want to compile it in kernel, say Y. To compile it as a
206	  module, choose M here. If unsure, say N.
207
208config	IP_VS_SED
209	tristate "shortest expected delay scheduling"
210	---help---
211	  The shortest expected delay scheduling algorithm assigns network
212	  connections to the server with the shortest expected delay. The
213	  expected delay that the job will experience is (Ci + 1) / Ui if
214	  sent to the ith server, in which Ci is the number of connections
215	  on the ith server and Ui is the fixed service rate (weight)
216	  of the ith server.
217
218	  If you want to compile it in kernel, say Y. To compile it as a
219	  module, choose M here. If unsure, say N.
220
221config	IP_VS_NQ
222	tristate "never queue scheduling"
223	---help---
224	  The never queue scheduling algorithm adopts a two-speed model.
225	  When there is an idle server available, the job will be sent to
226	  the idle server, instead of waiting for a fast one. When there
227	  is no idle server available, the job will be sent to the server
228	  that minimize its expected delay (The Shortest Expected Delay
229	  scheduling algorithm).
230
231	  If you want to compile it in kernel, say Y. To compile it as a
232	  module, choose M here. If unsure, say N.
233
234comment 'IPVS application helper'
235
236config	IP_VS_FTP
237  	tristate "FTP protocol helper"
238        depends on IP_VS_PROTO_TCP && NF_CONNTRACK && NF_NAT
239	select IP_VS_NFCT
240	---help---
241	  FTP is a protocol that transfers IP address and/or port number in
242	  the payload. In the virtual server via Network Address Translation,
243	  the IP address and port number of real servers cannot be sent to
244	  clients in ftp connections directly, so FTP protocol helper is
245	  required for tracking the connection and mangling it back to that of
246	  virtual service.
247
248	  If you want to compile it in kernel, say Y. To compile it as a
249	  module, choose M here. If unsure, say N.
250
251config	IP_VS_NFCT
252	bool "Netfilter connection tracking"
253	depends on NF_CONNTRACK
254	---help---
255	  The Netfilter connection tracking support allows the IPVS
256	  connection state to be exported to the Netfilter framework
257	  for filtering purposes.
258
259config	IP_VS_PE_SIP
260	tristate "SIP persistence engine"
261        depends on IP_VS_PROTO_UDP
262	depends on NF_CONNTRACK_SIP
263	---help---
264	  Allow persistence based on the SIP Call-ID
265
266endif # IP_VS
267