Skip to content

Commit 2b093d3

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent e3b1331 commit 2b093d3

File tree

3 files changed

+31
-31
lines changed

3 files changed

+31
-31
lines changed

docs/dev/configuration.html

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.2-dev4-18 - Configuration Manual</title>
5+
<title>HAProxy version 3.2-dev4-29 - Configuration Manual</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -4191,6 +4191,8 @@
41914191

41924192
<a class="list-group-item" href="#tune.quic.cc.cubic.min-losses">tune.quic.cc.cubic.min-losses</a>
41934193

4194+
<a class="list-group-item" href="#tune.quic.disable-tx-pacing">tune.quic.disable-tx-pacing</a>
4195+
41944196
<a class="list-group-item" href="#tune.quic.disable-udp-gso">tune.quic.disable-udp-gso</a>
41954197

41964198
<a class="list-group-item" href="#tune.quic.frontend.default-max-window-size">tune.quic.frontend.default-max-window-size</a>
@@ -4450,7 +4452,7 @@
44504452
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
44514453
</p>
44524454
<p class="text-right">
4453-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/01/27</b></small>
4455+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/01/30</b></small>
44544456
</p>
44554457
</div>
44564458
<!-- /.sidebar -->
@@ -4461,7 +4463,7 @@
44614463
<div class="text-center">
44624464
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
44634465
<h2>Configuration Manual</h2>
4464-
<p><strong>version 3.2-dev4-18</strong></p>
4466+
<p><strong>version 3.2-dev4-29</strong></p>
44654467
<p>
44664468
2025/01/24<br>
44674469

@@ -7229,6 +7231,7 @@ <h2 id="chapter-2.9" data-target="2.9"><small><a class="small" href="#2.9">2.9.<
72297231
- <a href="#tune.pool-low-fd-ratio">tune.pool-low-fd-ratio</a>
72307232
- <a href="#tune.pt.zero-copy-forwarding">tune.pt.zero-copy-forwarding</a>
72317233
- <a href="#tune.quic.cc-hystart">tune.quic.cc-hystart</a>
7234+
- <a href="#tune.quic.disable-tx-pacing">tune.quic.disable-tx-pacing</a>
72327235
- <a href="#tune.quic.disable-udp-gso">tune.quic.disable-udp-gso</a>
72337236
- <a href="#tune.quic.frontend.glitches-threshold">tune.quic.frontend.glitches-threshold</a>
72347237
- <a href="#tune.quic.frontend.max-idle-timeout">tune.quic.frontend.max-idle-timeout</a>
@@ -9330,6 +9333,14 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.<
93309333
of congested links. The value 2 may be used for short periods of time to
93319334
compare some metrics. Never go beyond 2 without an expert's prior analysis of
93329335
the situation. The default and minimum value is 1. Always use 1.
9336+
</pre><a class="anchor" name="tune.quic.disable-tx-pacing"></a><a class="anchor" name="3-tune.quic.disable-tx-pacing"></a><a class="anchor" name="3.2-tune.quic.disable-tx-pacing"></a><a class="anchor" name="tune.quic.disable-tx-pacing (Global parameters)"></a><a class="anchor" name="tune.quic.disable-tx-pacing (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.quic.disable-tx-pacing"></a><a href="#3.2-tune.quic.disable-tx-pacing">tune.quic.disable-tx-pacing</a></b></div><pre class="text">Disables pacing support for QUIC emission. The purpose of pacing is to smooth
9337+
emission of data to reduce network losses. In most scenario, it will
9338+
significantly improve network throughput by avoiding retransmissions.
9339+
However, it can be useful to deactivate it for networks with very high
9340+
bandwidth/low latency characteristics to prevent unwanted delay and reduce
9341+
CPU consumption.
9342+
9343+
See also the &quot;<a href="#quic-cc-algo">quic-cc-algo</a>&quot; bind option.
93339344
</pre><a class="anchor" name="tune.quic.disable-udp-gso"></a><a class="anchor" name="3-tune.quic.disable-udp-gso"></a><a class="anchor" name="3.2-tune.quic.disable-udp-gso"></a><a class="anchor" name="tune.quic.disable-udp-gso (Global parameters)"></a><a class="anchor" name="tune.quic.disable-udp-gso (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.quic.disable-udp-gso"></a><a href="#3.2-tune.quic.disable-udp-gso">tune.quic.disable-udp-gso</a></b></div><pre class="text">Disable UDP GSO emission. This kernel feature allows to emit multiple
93349345
datagrams via a single system call which is more efficient for large
93359346
transfer. It may be useful to disable it on developers suggestion when
@@ -21399,41 +21410,30 @@ <h2 id="chapter-5.1" data-target="5.1"><small><a class="small" href="#5.1">5.1.<
2139921410
instance, it is possible to force the http/2 on clear TCP by specifying &quot;proto
2140021411
h2&quot; on the bind line.
2140121412
</pre><a class="anchor" name="quic-cc-algo"></a><a class="anchor" name="5-quic-cc-algo"></a><a class="anchor" name="5.1-quic-cc-algo"></a><a class="anchor" name="quic-cc-algo (Bind and server options)"></a><a class="anchor" name="quic-cc-algo (Bind options)"></a><div class="keyword"><b><a class="anchor" name="quic-cc-algo"></a><a href="#5.1-quic-cc-algo">quic-cc-algo</a></b> <span style="color: #800">{ cubic | newreno | bbr | nocc }</span><span style="color: #008">[(<span style="color: #080">&lt;args,...&gt;</span>)]</span></div><pre class="text">This is a QUIC specific setting to select the congestion control algorithm
21402-
for any connection attempts to the configured QUIC listeners. They are similar
21403-
to those used by TCP.
21413+
for any connection attempts to the configured QUIC listeners. They are
21414+
similar to those used by TCP.
2140421415

21405-
Default value: cubic
21416+
Pacing is activated on top of the congestion algorithm to reduce loss and
21417+
improve throughput. It can be turned off via &quot;<a href="#tune.quic.disable-tx-pacing">tune.quic.disable-tx-pacing</a>&quot;
21418+
global keyword. In most cases, pacing should remain activated, especially
21419+
when using BBR as it relies on it to work as expected. Using BBR without
21420+
pacing may cause slowdowns or high loss rates during transfers.
2140621421

21407-
It is possible to enable pacing if the algorithm is compatible. This is done
21408-
by setting an optional integer argument as described in the next paragraph.
21409-
The purpose of pacing is to smooth emission of data to reduce network losses.
21410-
In most scenario, it can significantly improve network throughput by avoiding
21411-
retransmissions. Pacing support is still experimental, as such it requires
21412-
&quot;<a href="#expose-experimental-directives">expose-experimental-directives</a>&quot;. The BBR congestion control algorithm
21413-
depends on the pacing support which is in this case implicitly enabled by
21414-
choosing the &quot;bbr&quot; algorithm. Note that haproxy's BBR implementation is still
21415-
considered as experimental and cannot be enabled without
21416-
&quot;<a href="#expose-experimental-directives">expose-experimental-directives</a>&quot;.
21422+
Default value: cubic
2141721423

2141821424
For further customization, a list of parameters can be specified after the
2141921425
algorithm token. It must be written between parenthesis, separated by a
2142021426
comma. Each argument is optional and can be empty if needed. Here is the
2142121427
mandatory order of each parameters :
2142221428
- maximum window size in bytes. It must be greater than 10k and smaller than
2142321429
4g. By default &quot;<a href="#tune.quic.frontend.default-max-window-size">tune.quic.frontend.default-max-window-size</a>&quot; value is used.
21424-
- pacing activation. By default, it is set to 0, which means pacing is not
21425-
used. To activate it, specify a positive value. Burst size will be
21426-
dynamically adjusted to adapt to the network conditions. This parameter is
21427-
ignored by BBR as pacing is automatically activated for this algorithm.
2142821430
</pre><div class="separator">
2142921431
<span class="label label-success">Example:</span>
2143021432
<pre class="prettyprint">
2143121433
<code><span class="comment"># newreno congestion control algorithm</span>
2143221434
quic-cc-algo newreno
2143321435
<span class="comment"># cubic congestion control algorithm with one megabytes as window</span>
2143421436
quic-cc-algo cubic(1m)
21435-
<span class="comment"># cubic with pacing activated on top of it</span>
21436-
quic-cc-algo cubic(,1)
2143721437
</code></pre>
2143821438
</div><pre class="text">A special value &quot;nocc&quot; may be used to force a fixed congestion window always
2143921439
set at the maximum size. It is reserved for debugging scenarios to remove any
@@ -31792,7 +31792,7 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
3179231792
<br>
3179331793
<hr>
3179431794
<div class="text-right">
31795-
HAProxy 3.2-dev4-18 &ndash; Configuration Manual<br>
31795+
HAProxy 3.2-dev4-29 &ndash; Configuration Manual<br>
3179631796
<small>, 2025/01/24</small>
3179731797
</div>
3179831798
</div>

docs/dev/intro.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.2-dev4-18 - Starter Guide</title>
5+
<title>HAProxy version 3.2-dev4-29 - Starter Guide</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -484,7 +484,7 @@
484484
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
485485
</p>
486486
<p class="text-right">
487-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/01/27</b></small>
487+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/01/30</b></small>
488488
</p>
489489
</div>
490490
<!-- /.sidebar -->
@@ -495,7 +495,7 @@
495495
<div class="text-center">
496496
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
497497
<h2>Starter Guide</h2>
498-
<p><strong>version 3.2-dev4-18</strong></p>
498+
<p><strong>version 3.2-dev4-29</strong></p>
499499
<p>
500500
<br>
501501

@@ -2515,7 +2515,7 @@ <h2 id="chapter-4.4" data-target="4.4"><small><a class="small" href="#4.4">4.4.<
25152515
<br>
25162516
<hr>
25172517
<div class="text-right">
2518-
HAProxy 3.2-dev4-18 &ndash; Starter Guide<br>
2518+
HAProxy 3.2-dev4-29 &ndash; Starter Guide<br>
25192519
<small>, </small>
25202520
</div>
25212521
</div>

docs/dev/management.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.2-dev4-18 - Management Guide</title>
5+
<title>HAProxy version 3.2-dev4-29 - Management Guide</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -654,7 +654,7 @@
654654
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
655655
</p>
656656
<p class="text-right">
657-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/01/27</b></small>
657+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/01/30</b></small>
658658
</p>
659659
</div>
660660
<!-- /.sidebar -->
@@ -665,7 +665,7 @@
665665
<div class="text-center">
666666
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
667667
<h2>Management Guide</h2>
668-
<p><strong>version 3.2-dev4-18</strong></p>
668+
<p><strong>version 3.2-dev4-29</strong></p>
669669
<p>
670670
<br>
671671

@@ -5455,7 +5455,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
54555455
<br>
54565456
<hr>
54575457
<div class="text-right">
5458-
HAProxy 3.2-dev4-18 &ndash; Management Guide<br>
5458+
HAProxy 3.2-dev4-29 &ndash; Management Guide<br>
54595459
<small>, </small>
54605460
</div>
54615461
</div>

0 commit comments

Comments
 (0)