diff options
author | Christophe Jaillet <jailletc36@apache.org> | 2018-05-26 08:21:19 +0000 |
---|---|---|
committer | Christophe Jaillet <jailletc36@apache.org> | 2018-05-26 08:21:19 +0000 |
commit | 98d9944670be19aba9918c2fe75503ec4051ecf8 (patch) | |
tree | 6359b652f6f2224146d380dd40d0b698e0204e43 | |
parent | b6530df60f09563569262ca84319ac06bbbafe1b (diff) | |
download | httpd-98d9944670be19aba9918c2fe75503ec4051ecf8.tar.gz |
backport r1817908 which fixes some example (see PR 61650) + make some cosmetic changes (r1832294 in trunk)
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1832295 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r-- | docs/manual/mod/mod_proxy.xml | 2 | ||||
-rw-r--r-- | docs/manual/mod/mod_proxy_hcheck.xml | 47 |
2 files changed, 32 insertions, 17 deletions
diff --git a/docs/manual/mod/mod_proxy.xml b/docs/manual/mod/mod_proxy.xml index 834274b04b..b16a2cc83e 100644 --- a/docs/manual/mod/mod_proxy.xml +++ b/docs/manual/mod/mod_proxy.xml @@ -1178,7 +1178,7 @@ ProxyPass "/mirror/foo/i" "!" <td>Route of the worker when used inside load balancer. The route is a value appended to session id. </td></tr> - <tr><td>status</td> + <tr><td><a name="status_table">status</a></td> <td>-</td> <td>Single letter value defining the initial status of this worker. diff --git a/docs/manual/mod/mod_proxy_hcheck.xml b/docs/manual/mod/mod_proxy_hcheck.xml index 72a26d5484..6ab8d35d4f 100644 --- a/docs/manual/mod/mod_proxy_hcheck.xml +++ b/docs/manual/mod/mod_proxy_hcheck.xml @@ -40,10 +40,11 @@ <note><title>Parameters</title> <p>The health check mechanism is enabled via the use of additional - BalancerMember parameters, which are configured in the standard - way via <directive module="mod_proxy">ProxyPass</directive>:</p> + <directive module="mod_proxy">BalancerMember</directive> parameters, which are configured + in the standard way via <directive module="mod_proxy">ProxyPass</directive>:</p> - <p>A new BalancerMember status state (flag) is defined via this module: "<code>C</code>". + <p>A new BalancerMember <a href="mod_proxy.html#status_table">status</a> state (flag) + is defined via this module: "<code>C</code>". When the worker is taken offline due to failures as determined by the health check module, this flag is set, and can be seen (and modified) via the <code>balancer-manager</code>.</p> @@ -84,10 +85,12 @@ <td>Additional URI to be appended to the worker URL for the health check.</td></tr> <tr><td>hctemplate</td> <td> </td> - <td>Name of template, created via <directive>ProxyHCTemplate</directive> to use for setting health check parameters for this worker</td></tr> + <td>Name of template, created via <directive module="mod_proxy_hcheck">ProxyHCTemplate</directive>, + to use for setting health check parameters for this worker</td></tr> <tr><td>hcexpr</td> <td> </td> - <td>Name of expression, created via <directive>ProxyHCExpr</directive>, used to check response headers for health.<br/> + <td>Name of expression, created via <directive module="mod_proxy_hcheck">ProxyHCExpr</directive>, + used to check response headers for health.<br/> <em>If not used, 2xx thru 3xx status codes imply success</em></td></tr> </table> </note> @@ -109,7 +112,7 @@ ProxyHCExpr in_maint {hc('body') !~ /Under maintenance/} <Proxy balancer://foo> BalancerMember http://www.example.com/ hcmethod=GET hcexpr=in_maint hcuri=/status.php - BalancerMember http://www2.example.com/ hcmethod=HEAD hcexpr=ok234 hcinterval=10 + BalancerMember http://www2.example.com/ hcmethod=HEAD hcexpr=ok234 hcinterval=10 BalancerMember http://www3.example.com/ hcmethod=TCP hcinterval=5 hcpasses=2 hcfails=3 BalancerMember http://www4.example.com/ </Proxy> @@ -135,8 +138,8 @@ not dynamically checked at all.</p> <directivesynopsis> <name>ProxyHCExpr</name> -<description>Creates a named condition expression to use to determine health of the backend based on its response.</description> -<syntax>ProxyHCExpr name {ap_expr expression}</syntax> +<description>Creates a named condition expression to use to determine health of the backend based on its response</description> +<syntax>ProxyHCExpr <em>name</em> {<em>ap_expr expression</em>}</syntax> <contextlist><context>server config</context><context>virtual host</context> </contextlist> @@ -145,12 +148,16 @@ not dynamically checked at all.</p> for creating a named condition expression that checks the response headers of the backend server to determine its health. This named condition can then be assigned to balancer members via the <code>hcexpr</code> - parameter</p> + parameter.</p> <example><title>ProxyHCExpr: Allow for 2xx/3xx/4xx as passing</title> <highlight language="config"> ProxyHCExpr ok234 {%{REQUEST_STATUS} =~ /^[234]/} -ProxyPass "/apps" "http://backend.example.com/" hcexpr=ok234 +ProxyPass "/apps" "balancer://foo" + +<Proxy balancer://foo> + BalancerMember http://www2.example.com/ hcmethod=HEAD hcexpr=ok234 hcinterval=10 +</Proxy> </highlight> </example> @@ -170,7 +177,11 @@ ProxyPass "/apps" "http://backend.example.com/" hcexpr=ok234 <example><title>ProxyHCExpr: Checking response body</title> <highlight language="config"> ProxyHCExpr in_maint {hc('body') !~ /Under maintenance/} -ProxyPass "/apps" "http://backend.example.com/" hcexpr=in_maint hcmethod=get hcuri=/status.php +ProxyPass "/apps" "balancer://foo" + +<Proxy balancer://foo> + BalancerMember http://www.example.com/ hcexpr=in_maint hcmethod=get hcuri=/status.php +</Proxy> </highlight> </example> @@ -182,7 +193,7 @@ ProxyPass "/apps" "http://backend.example.com/" hcexpr=in_maint hcmethod=get <directivesynopsis> <name>ProxyHCTemplate</name> <description>Creates a named template for setting various health check parameters</description> -<syntax>ProxyHCTemplate name parameter=setting <...></syntax> +<syntax>ProxyHCTemplate <em>name</em> <em>parameter</em>=<em>setting</em> [...]</syntax> <contextlist><context>server config</context><context>virtual host</context> </contextlist> @@ -190,12 +201,16 @@ ProxyPass "/apps" "http://backend.example.com/" hcexpr=in_maint hcmethod=get <p>The <directive>ProxyHCTemplate</directive> directive allows for creating a named set (template) of health check parameters that can then be assigned to balancer members via the <code>hctemplate</code> - parameter</p> + parameter.</p> <example><title>ProxyHCTemplate</title> <highlight language="config"> ProxyHCTemplate tcp5 hcmethod=tcp hcinterval=5 -ProxyPass "/apps" "http://backend.example.com/" hctemplate=tcp5 +ProxyPass "/apps" "balancer://foo" + +<Proxy balancer://foo> + BalancerMember http://www2.example.com/ hctemplate=tcp5 +</Proxy> </highlight> </example> @@ -204,8 +219,8 @@ ProxyPass "/apps" "http://backend.example.com/" hctemplate=tcp5 <directivesynopsis> <name>ProxyHCTPsize</name> -<description>Sets the total server-wide size of the threadpool used for the health check workers.</description> -<syntax>ProxyHCTPsize <size></syntax> +<description>Sets the total server-wide size of the threadpool used for the health check workers</description> +<syntax>ProxyHCTPsize <em>size</em></syntax> <contextlist><context>server config</context> </contextlist> |