Skip to content

Commit e79e3f1

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent 1b2276d commit e79e3f1

File tree

3 files changed

+41
-21
lines changed

3 files changed

+41
-21
lines changed

docs/dev/configuration.html

Lines changed: 33 additions & 13 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-dev0-47 - Configuration Manual</title>
5+
<title>HAProxy version 3.2-dev0-56 - 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/28</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/12/05</b></small>
44284428
</p>
44294429
</div>
44304430
<!-- /.sidebar -->
@@ -4435,7 +4435,7 @@
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.2-dev0-47</strong></p>
4438+
<p><strong>version 3.2-dev0-56</strong></p>
44394439
<p>
44404440
2024/11/26<br>
44414441

@@ -9741,13 +9741,19 @@ <h2 id="chapter-3.5" data-target="3.5"><small><a class="small" href="#3.5">3.5.<
97419741
<div><pre class="text">It is possible to propagate entries of any data-types in stick-tables between
97429742
several HAProxy instances over TCP connections in a multi-master fashion. Each
97439743
instance pushes its local updates and insertions to remote peers. The pushed
9744-
values overwrite remote ones without aggregation. As an exception, the data
9745-
type &quot;conn_cur&quot; is never learned from peers, as it is supposed to reflect local
9746-
values. Earlier versions used to synchronize it and to cause negative values in
9747-
active-active setups, and always-growing values upon reloads or active-passive
9744+
values overwrite remote ones without aggregation.
9745+
9746+
One exception is the data type &quot;conn_cur&quot; which is never learned from peers by
9747+
default as it is supposed to reflect local values. Earlier versions used to
9748+
synchronize it by default which was known to cause negative values in active-
9749+
active setups, and always-growing values upon reloads or active-passive
97489750
switches because the local value would reflect more connections than locally
9749-
present. This information, however, is pushed so that monitoring systems can
9750-
watch it.
9751+
present. However there are some setups where it could be relevant to learn
9752+
this value from peers, for instance when the table is a passive remote table
9753+
solely used to learn/monitor data from it without relying on it for write-
9754+
oriented operations or updates. To achieve this, the &quot;recv-only&quot; keyword can
9755+
be added on the table declaration. In any case, the &quot;conn_cur&quot; info is always
9756+
pushed so that monitoring systems can watch it.
97519757

97529758
Interrupted exchanges are automatically detected and recovered from the last
97539759
known point. In addition, during a soft restart, the old process connects to
@@ -9847,7 +9853,8 @@ <h2 id="chapter-3.5" data-target="3.5"><small><a class="small" href="#3.5">3.5.<
98479853
number of peer involved in this stick-table contents distribution.
98489854
See also &quot;<a href="#shard">shard</a>&quot; server parameter.
98499855
</pre><a class="anchor" name="table"></a><a class="anchor" name="3-table"></a><a class="anchor" name="3.5-table"></a><a class="anchor" name="table (Global parameters)"></a><a class="anchor" name="table (Peers)"></a><div class="keyword"><b><a class="anchor" name="table"></a><a href="#3.5-table">table</a></b> <span style="color: #080">&lt;tablename&gt;</span> type <span style="color: #800">{ip | integer | string <span style="color: #008">[len <span style="color: #080">&lt;length&gt;</span>]</span> | binary <span style="color: #008">[len <span style="color: #080">&lt;length&gt;</span>]</span>}</span>
9850-
size <span style="color: #080">&lt;size&gt;</span> <span style="color: #008">[expire <span style="color: #080">&lt;expire&gt;</span>]</span> <span style="color: #008">[write-to <span style="color: #080">&lt;wtable&gt;</span>]</span> <span style="color: #008">[nopurge]</span> <span style="color: #008">[store <span style="color: #080">&lt;data_type&gt;</span>]</span>*</div><pre class="text">Configure a stickiness table for the current section. This line is parsed
9856+
size <span style="color: #080">&lt;size&gt;</span> <span style="color: #008">[expire <span style="color: #080">&lt;expire&gt;</span>]</span> <span style="color: #008">[write-to <span style="color: #080">&lt;wtable&gt;</span>]</span> <span style="color: #008">[nopurge]</span> <span style="color: #008">[store <span style="color: #080">&lt;data_type&gt;</span>]</span>*
9857+
<span style="color: #008">[recv-only]</span></div><pre class="text">Configure a stickiness table for the current section. This line is parsed
98519858
exactly the same way as the &quot;<a href="#stick-table">stick-table</a>&quot; keyword in others section, except
98529859
for the &quot;<a href="#peers">peers</a>&quot; argument which is not required here and with an additional
98539860
mandatory first parameter to designate the stick-table. Contrary to others
@@ -17282,7 +17289,8 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1728217289
</div><div class="page-header"><b>See also :</b> &quot;<a href="#stick-table">stick-table</a>&quot;, &quot;<a href="#stick%20on">stick on</a>&quot;, about ACLs and sample fetching.</div>
1728317290
<a class="anchor" name="stick-table"></a><a class="anchor" name="4-stick-table"></a><a class="anchor" name="4.2-stick-table"></a><a class="anchor" name="stick-table (Proxies)"></a><a class="anchor" name="stick-table (Alphabetically sorted keywords reference)"></a><a class="anchor" name="stick-table type"></a><a class="anchor" name="4-stick-table type"></a><a class="anchor" name="4.2-stick-table type"></a><a class="anchor" name="stick-table type (Proxies)"></a><a class="anchor" name="stick-table type (Alphabetically sorted keywords reference)"></a><div class="keyword"><b><a class="anchor" name="stick-table type"></a><a href="#4.2-stick-table%20type">stick-table type</a></b> <span style="color: #800">{ip | integer | string <span style="color: #008">[len <span style="color: #080">&lt;length&gt;</span>]</span> | binary <span style="color: #008">[len <span style="color: #080">&lt;length&gt;</span>]</span>}</span>
1728417291
size <span style="color: #080">&lt;size&gt;</span> <span style="color: #008">[expire <span style="color: #080">&lt;expire&gt;</span>]</span> <span style="color: #008">[nopurge]</span> <span style="color: #008">[peers <span style="color: #080">&lt;peersect&gt;</span>]</span> <span style="color: #008">[srvkey <span style="color: #080">&lt;srvkey&gt;</span>]</span>
17285-
<span style="color: #008">[write-to <span style="color: #080">&lt;wtable&gt;</span>]</span> <span style="color: #008">[store <span style="color: #080">&lt;data_type&gt;</span>]</span>* <span style="color: #008">[brates-factor <span style="color: #080">&lt;factor&gt;</span>]</span></div><pre class="text">Configure the stickiness table for the current section
17292+
<span style="color: #008">[write-to <span style="color: #080">&lt;wtable&gt;</span>]</span> <span style="color: #008">[store <span style="color: #080">&lt;data_type&gt;</span>]</span>* <span style="color: #008">[brates-factor <span style="color: #080">&lt;factor&gt;</span>]</span>
17293+
<span style="color: #008">[recv-only]</span></div><pre class="text">Configure the stickiness table for the current section
1728617294

1728717295
May be used in the following contexts: tcp, http
1728817296
</pre><div><p> May be used in sections :</p><table class="table table-bordered" border="0" cellspacing="0" cellpadding="0">
@@ -17408,7 +17416,19 @@ <h2 id="chapter-4.2" data-target="4.2"><small><a class="small" href="#4.2">4.2.<
1740817416
Internally, rates are defined on 32-bits counters. By using this
1740917417
parameter, it is possible to have rates exceeding the 4G on the
1741017418
defined period. The factor must be greater than 0 and lower or
17411-
equal to 1024.</pre>
17419+
equal to 1024.
17420+
17421+
[recv-only] indicates that we don't intent to use the table to perform
17422+
updates on it, but thay we only plan on using the table to
17423+
retrieve data from a remote peer which we are interested in.
17424+
Indeed, the use of this keyword enables the retrieval of
17425+
local-only values such as conn_cur that are not learned by
17426+
default as they would conflict with local updates performed
17427+
on the table by the local peer. Use of this option is only
17428+
relevant for tables that are not involved in tracking rules or
17429+
methods that perform update operations on the table, or put
17430+
simpler: remote tables that are only used to retrieve
17431+
information.</pre>
1741217432
</div>
1741317433
<pre class="text">The data types that can be stored with an entry are the following :
1741417434
- server_id : this is an integer which holds the numeric ID of the server a
@@ -31702,7 +31722,7 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
3170231722
<br>
3170331723
<hr>
3170431724
<div class="text-right">
31705-
HAProxy 3.2-dev0-47 &ndash; Configuration Manual<br>
31725+
HAProxy 3.2-dev0-56 &ndash; Configuration Manual<br>
3170631726
<small>, 2024/11/26</small>
3170731727
</div>
3170831728
</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-dev0-47 - Starter Guide</title>
5+
<title>HAProxy version 3.2-dev0-56 - 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/28</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/12/05</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-dev0-47</strong></p>
498+
<p><strong>version 3.2-dev0-56</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-dev0-47 &ndash; Starter Guide<br>
2518+
HAProxy 3.2-dev0-56 &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-dev0-47 - Management Guide</title>
5+
<title>HAProxy version 3.2-dev0-56 - 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/28</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/12/05</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.2-dev0-47</strong></p>
666+
<p><strong>version 3.2-dev0-56</strong></p>
667667
<p>
668668
<br>
669669

@@ -5394,7 +5394,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
53945394
<br>
53955395
<hr>
53965396
<div class="text-right">
5397-
HAProxy 3.2-dev0-47 &ndash; Management Guide<br>
5397+
HAProxy 3.2-dev0-56 &ndash; Management Guide<br>
53985398
<small>, </small>
53995399
</div>
54005400
</div>

0 commit comments

Comments
 (0)