Skip to content

Commit e180f36

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent 4e20248 commit e180f36

File tree

3 files changed

+29
-28
lines changed

3 files changed

+29
-28
lines changed

docs/dev/configuration.html

Lines changed: 21 additions & 20 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.1-dev13-100 - Configuration Manual</title>
5+
<title>HAProxy version 3.1-dev14 - 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" />
@@ -4424,7 +4424,7 @@
44244424
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
44254425
</p>
44264426
<p class="text-right">
4427-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/11/20</b></small>
4427+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/11/21</b></small>
44284428
</p>
44294429
</div>
44304430
<!-- /.sidebar -->
@@ -4435,9 +4435,9 @@
44354435
<div class="text-center">
44364436
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
44374437
<h2>Configuration Manual</h2>
4438-
<p><strong>version 3.1-dev13-100</strong></p>
4438+
<p><strong>version 3.1-dev14</strong></p>
44394439
<p>
4440-
2024/11/15<br>
4440+
2024/11/21<br>
44414441

44424442
</p>
44434443
</div>
@@ -6528,7 +6528,7 @@ <h2 id="chapter-2.3" data-target="2.3"><small><a class="small" href="#2.3">2.3.<
65286528
| HAPROXY_MWORKER | X | | | | | X | X |
65296529
| HAPROXY_CLI | | | | | | | X |
65306530
| HAPROXY_MASTER_CLI | | | | | | X | |
6531-
| HAPROXY_LOCALPEER | | | | | | | X |
6531+
| HAPROXY_LOCALPEER | | | X | | | | X |
65326532
| HAPROXY_HTTP_LOG_FMT | | | X | | X | | |
65336533
| HAPROXY_HTTP_CLF_LOG_FMT | | | X | | X | | |
65346534
| HAPROXY_HTTPS_LOG_FMT | | | X | | X | | |
@@ -21297,31 +21297,32 @@ <h2 id="chapter-5.1" data-target="5.1"><small><a class="small" href="#5.1">5.1.<
2129721297
protocol for all connections instantiated from this listening socket. For
2129821298
instance, it is possible to force the http/2 on clear TCP by specifying &quot;proto
2129921299
h2&quot; on the bind line.
21300-
</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<span style="color: #008">[-pacing]</span> | 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
21300+
</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
2130121301
for any connection attempts to the configured QUIC listeners. They are similar
2130221302
to those used by TCP.
2130321303

2130421304
Default value: cubic
2130521305

2130621306
It is possible to active pacing if the algorithm is compatible. This is done
21307-
by using the suffix &quot;-pacing&quot; after the algorithm name. Pacing purpose is to
21308-
smooth emission of data without burst to reduce network loss. In some
21309-
scenario, it can significantly improve network throughput. However, it can
21310-
also increase CPU usage if haproxy is forced to wait too long between each
21311-
emission. Pacing support is still experimental, as such it requires
21312-
&quot;<a href="#expose-experimental-directives">expose-experimental-directives</a>&quot;. BBR congestion control algorithm depends on
21313-
the pacing support which is in this case implicitely activated by &quot;bbr&quot;.
21314-
Note that BBR haproxy implementation is still considered as experimental and
21315-
cannot be enabled without &quot;<a href="#expose-experimental-directives">expose-experimental-directives</a>&quot;.
21307+
by specifying optional burst argument as described in the next paragraph.
21308+
Pacing purpose is to smooth emission of data without burst to reduce network
21309+
loss. In some scenario, it can significantly improve network throughput.
21310+
However, it can also increase CPU usage if haproxy is forced to wait too long
21311+
between each emission. Pacing support is still experimental, as such it
21312+
requires &quot;<a href="#expose-experimental-directives">expose-experimental-directives</a>&quot;. BBR congestion control algorithm
21313+
depends on the pacing support which is in this case implicitely activated by
21314+
&quot;bbr&quot;. Note that BBR haproxy implementation is still considered as
21315+
experimental and cannot be enabled without &quot;<a href="#expose-experimental-directives">expose-experimental-directives</a>&quot;.
2131621316

2131721317
For further customization, a list of parameters can be specified after the
2131821318
algorithm token. It must be written between parenthesis, separated by a comma
2131921319
operator. Each argument is optional and can be empty if needed. Here is the
2132021320
mandatory order of each parameters :
2132121321
- maximum window size in bytes. It must be greater than 10k and smaller than
2132221322
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.
21323-
- count of datagrams to emit in a burst if pacing is activated. It must be
21324-
between the default value of 1 and 1024.
21323+
- burst size in bytes. By default, it is set to 0, which means unlimited. A
21324+
positive value up to 1024 can be specified to smooth emission with pacing.
21325+
See above paragraph for more explanation.
2132521326
</pre><div class="separator">
2132621327
<span class="label label-success">Example:</span>
2132721328
<pre class="prettyprint">
@@ -21330,7 +21331,7 @@ <h2 id="chapter-5.1" data-target="5.1"><small><a class="small" href="#5.1">5.1.<
2133021331
<span class="comment"># cubic congestion control algorithm with one megabytes as window</span>
2133121332
quic-cc-algo cubic(1m)
2133221333
<span class="comment"># cubic with pacing on top of it, with burst limited to 12 datagrams</span>
21333-
quic-cc-algo cubic-pacing(,12)
21334+
quic-cc-algo cubic(,12)
2133421335
</code></pre>
2133521336
</div><pre class="text">A special value &quot;nocc&quot; may be used to force a fixed congestion window always
2133621337
set at the maximum size. It is reserved for debugging scenarios to remove any
@@ -31687,8 +31688,8 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
3168731688
<br>
3168831689
<hr>
3168931690
<div class="text-right">
31690-
HAProxy 3.1-dev13-100 &ndash; Configuration Manual<br>
31691-
<small>, 2024/11/15</small>
31691+
HAProxy 3.1-dev14 &ndash; Configuration Manual<br>
31692+
<small>, 2024/11/21</small>
3169231693
</div>
3169331694
</div>
3169431695
<!-- /.col-lg-12 -->

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.1-dev13-100 - Starter Guide</title>
5+
<title>HAProxy version 3.1-dev14 - 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>2024/11/20</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>2024/11/21</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.1-dev13-100</strong></p>
498+
<p><strong>version 3.1-dev14</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.1-dev13-100 &ndash; Starter Guide<br>
2518+
HAProxy 3.1-dev14 &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.1-dev13-100 - Management Guide</title>
5+
<title>HAProxy version 3.1-dev14 - 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" />
@@ -652,7 +652,7 @@
652652
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
653653
</p>
654654
<p class="text-right">
655-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/11/20</b></small>
655+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/11/21</b></small>
656656
</p>
657657
</div>
658658
<!-- /.sidebar -->
@@ -663,7 +663,7 @@
663663
<div class="text-center">
664664
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
665665
<h2>Management Guide</h2>
666-
<p><strong>version 3.1-dev13-100</strong></p>
666+
<p><strong>version 3.1-dev14</strong></p>
667667
<p>
668668
<br>
669669

@@ -5391,7 +5391,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
53915391
<br>
53925392
<hr>
53935393
<div class="text-right">
5394-
HAProxy 3.1-dev13-100 &ndash; Management Guide<br>
5394+
HAProxy 3.1-dev14 &ndash; Management Guide<br>
53955395
<small>, </small>
53965396
</div>
53975397
</div>

0 commit comments

Comments
 (0)