Move httpclient keywords into its own section and explain adding
an introductory paragraph.
Also see Github issue #2409
Should be backported to 2.6 ; but note that:
2.7 does not have httpclient.resolvers.disabled
2.6 does not have httpclient.retries and httpclient.timeout.connect
---
doc/configuration.txt | 131 ++
1 file changed, 69 insertions(+), 62 deletions(-)
diff --git a/doc/configuration.txt b/doc/configuration.txt
index 208b474471..402fa3d317 100644
--- a/doc/configuration.txt
+++ b/doc/configuration.txt
@@ -58,6 +58,7 @@ Summary
3.8. HTTP-errors
3.9. Rings
3.10. Log forwarding
+3.11. httpclient
4.Proxies
4.1. Proxy keywords matrix
@@ -1953,68 +1954,6 @@ http-fail-codes [+-][,...] [...]
exactly the same as for http-err-codes above. See also "http-err-codes" and
"http_fail_cnt".
-httpclient.resolvers.disabled
- Disable the DNS resolution of the httpclient. Prevent the creation of the
- "default" resolvers section.
-
- Default value is off.
-
-httpclient.resolvers.id
- This option defines the resolvers section with which the httpclient will try
- to resolve.
-
- Default option is the "default" resolvers ID. By default, if this option is
- not used, it will simply disable the resolving if the section is not found.
-
- However, when this option is explicitly enabled it will trigger a
- configuration error if it fails to load.
-
-httpclient.resolvers.prefer
- This option allows to chose which family of IP you want when resolving,
- which is convenient when IPv6 is not available on your network. Default
- option is "ipv6".
-
-httpclient.retries
- This option allows to configure the number of retries attempt of the
- httpclient when a request failed. This does the same as the "retries" keyword
- in a backend.
-
- Default value is 3.
-
-httpclient.ssl.ca-file
- This option defines the ca-file which should be used to verify the server
- certificate. It takes the same parameters as the "ca-file" option on the
- server line.
-
- By default and when this option is not used, the value is
- "@system-ca" which tries to load the CA of the system. If it fails the SSL
- will be disabled for the httpclient.
-
- However, when this option is explicitly enabled it will trigger a
- configuration error if it fails.
-
-httpclient.ssl.verify [none|required]
- Works the same way as the verify option on server lines. If specified to
'none',
- servers certificates are not verified. Default option is "required".
-
- By default and when this option is not used, the value is
- "required". If it fails the SSL will be disabled for the httpclient.
-
- However, when this option is explicitly enabled it will trigger a
- configuration error if it fails.
-
-httpclient.timeout.connect
- Set the maximum time to wait for a connection attempt by default for the
- httpclient.
-
- Arguments :
- is the timeout value specified in milliseconds by default, but
- can be in any other unit if the number is suffixed by the unit,
- as explained at the top of this document.
-
- The default value is 5000ms.
-
-
insecure-fork-wanted
By default HAProxy tries hard to prevent any thread and process creation
after it starts. Doing so is particularly important when using Lua files of
@@ -4597,6 +4536,74 @@ maxconn
timeout client
Set the maximum inactivity time on the client side.
+3.11. httpclient
+
+
+httpclient is an internal HTTP library, it can be used by various subsystems,
+for example in LUA scripts. httpclient is not used in the data path, in other
+words it has nothing with HTTP traffic passing through HAProxy.
+
+httpclient.resolvers.disabled
+ Disable the DNS resolution of the httpclient. Prevent the creation of the
+ "default" resolvers section.
+
+ Default value is off.
+
+httpclient.resolvers.id
+ This option defines the resolvers section with which the httpclient will try
+ to resolve.
+
+ Default option is the "default" resolvers ID. By default, if this option is
+ not used, it will simply disable the resolving if the section is not found.
+
+ However, when this option is explicitly enabled it will trigger a
+ configuration error if it fails to load.
+
+httpclient.resolvers.prefer
+ This option allows to chose which family of IP you want when resolving,
+ which is convenient when IPv6 is not available on your network. Default
+ option is "ipv6".
+
+httpclient.retries
+ This option allows to configure the number of retries attempt of the
+ httpclient when a request failed. This does the same as the "retries" keyword
+ in a backend.
+
+ Default value is 3.
+
+httpclient.ssl.ca-file
+ This option defines the ca-file which should be used to verify the server
+ certificate. It takes the same parameters as the "ca-file" option on the
+ server line.
+
+ By default and when this option is not used, the value is
+ "@system-ca" which tries to
