DOC: config: fix confusing init-state examples
authorAurelien DARRAGON <adarragon@haproxy.com>
Fri, 6 Dec 2024 11:04:11 +0000 (12:04 +0100)
committerWilly Tarreau <w@1wt.eu>
Tue, 10 Dec 2024 10:09:53 +0000 (11:09 +0100)
in 50322dff ("MEDIUM: server: add init-state"), some examples on how to
use init-state server keyword were added alongside with the keyword
documentation.

However, as reported by Nick Ramirez, there was an error because the
example that stated that haproxy will pass the traffic to the server after
3 successful health checks used the "init-state down" instead of the
"init-state fully-down". Thus the behavior wouldn't match what the
comment said (only 1 successful health check was required).

Here we fix the example in itself to match with the comment. Also the
following example ("# or") was also affected, but it is kind of
redundant as the main purpose of the examples are to illustrate the
feature in itself and not how to use server-template directive, so we
remove it.

This should be backported in 3.1 with 50322dff

(cherry picked from commit 7934eef25d1207392a1b4a915d21889babfb1fb0)
Signed-off-by: Willy Tarreau <w@1wt.eu>

doc/configuration.txt

index a48452f..4d4c744 100644 (file)
@@ -18123,13 +18123,8 @@ init-state { fully-up | up | down | fully-down }
       # pass traffic to the server only after 3 successful health checks
       backend google-backend
         mode http
-        server srv1 google.com:80 check init-state down rise 3
-        server srv2 google.com:80 check init-state down rise 3
-
-      # or
-      listen
-        mode http
-        server-template srv 2 google.com:80 check init-state down rise 3
+        server srv1 google.com:80 check init-state fully-down rise 3
+        server srv2 google.com:80 check init-state fully-down rise 3
 
 See also: "option tcp-check", "option httpchk"