From cdf1d20e8a8eb1db0141a33ea18227d28abd5026 Mon Sep 17 00:00:00 2001
From: Aurelien DARRAGON <adarragon@haproxy.com>
Date: Tue, 11 Jun 2024 16:19:04 +0200
Subject: [PATCH] DOC: config: move "hash-key" from proxy to server options

As reported by Ashley Morris, "hash-key" keyword which was introduced in
commit faa8c3e0 ("MEDIUM: lb-chash: Deterministic node hashes based on
server address") doesn't belong to proxy keywords and should be found in
5.2 "Server and default-server options" instead.

It should be backported in 3.0 with faa8c3e0
---
 doc/configuration.txt | 46 +++++++++++++++++++++----------------------
 1 file changed, 22 insertions(+), 24 deletions(-)

diff --git a/doc/configuration.txt b/doc/configuration.txt
index 971c54d28..b98056550 100644
--- a/doc/configuration.txt
+++ b/doc/configuration.txt
@@ -5190,7 +5190,6 @@ filter                                    -          X         X         X
 fullconn                                  X          -         X         X
 guid                                      -          X         X         X
 hash-balance-factor                       X          -         X         X
-hash-key                                  X          -         X         X
 hash-type                                 X          -         X         X
 http-after-response                       X (!)      X         X         X
 http-check comment                        X          -         X         X
@@ -6994,29 +6993,6 @@ hash-balance-factor <factor>
   See also : "balance" and "hash-type".
 
 
-hash-key <key>
-  Specify how "hash-type consistent" node keys are computed
-
-  Arguments :
-    <key>   <key> may be one of the following :
-
-      id         The node keys will be derived from the server's numeric
-                 identifier as set from "id" or which defaults to its position
-                 in the server list.
-
-      addr       The node keys will be derived from the server's address, when
-                 available, or else fall back on "id".
-
-      addr-port  The node keys will be derived from the server's address and
-                 port, when available, or else fall back on "id".
-
-  The "addr" and "addr-port" options may be useful in scenarios where multiple
-  HAProxy processes are balancing traffic to the same set of servers. If the
-  server order of each process is different (because, for example, DNS records
-  were resolved in different orders) then this will allow each independent
-  HAProxy processes to agree on routing decisions.
-
-
 hash-type <method> <function> <modifier>
   Specify a method to use for mapping hashes to servers
 
@@ -17178,6 +17154,28 @@ guid <string>
   unique across all haproxy configuration on every object types. See "guid"
   proxy keyword description for more information on its format.
 
+hash-key <key>
+  Specify how "hash-type consistent" node keys are computed
+
+  Arguments :
+    <key>   <key> may be one of the following :
+
+      id         The node keys will be derived from the server's numeric
+                 identifier as set from "id" or which defaults to its position
+                 in the server list.
+
+      addr       The node keys will be derived from the server's address, when
+                 available, or else fall back on "id".
+
+      addr-port  The node keys will be derived from the server's address and
+                 port, when available, or else fall back on "id".
+
+  The "addr" and "addr-port" options may be useful in scenarios where multiple
+  HAProxy processes are balancing traffic to the same set of servers. If the
+  server order of each process is different (because, for example, DNS records
+  were resolved in different orders) then this will allow each independent
+  HAProxy processes to agree on routing decisions.
+
 id <value>
   May be used in the following contexts: tcp, http, log