comparison xml/en/docs/http/ngx_http_upstream_module.xml @ 1636:44c4323144c5

Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 11 Jan 2016 11:10:08 +0300
parents 0ba4b2e561bd
children 57c3f36b3b6a
comparison
equal deleted inserted replaced
1635:280cf6c0888a 1636:44c4323144c5
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_upstream_module" 10 <module name="Module ngx_http_upstream_module"
11 link="/en/docs/http/ngx_http_upstream_module.html" 11 link="/en/docs/http/ngx_http_upstream_module.html"
12 lang="en" 12 lang="en"
13 rev="45"> 13 rev="46">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_upstream_module</literal> module 18 The <literal>ngx_http_upstream_module</literal> module
316 </para> 316 </para>
317 317
318 </directive> 318 </directive>
319 319
320 320
321 <directive name="state">
322 <syntax><value>file</value></syntax>
323 <default/>
324 <context>upstream</context>
325 <appeared-in>1.9.7</appeared-in>
326
327 <para>
328 Specifies a <value>file</value> that keeps the state
329 of the dynamically configurable group.
330 The state is currently limited to the list of servers with their parameters.
331 The file is read when parsing the configuration and is updated each time
332 the upstream configuration is
333 <link doc="ngx_http_upstream_conf_module.xml" id="upstream_conf">changed</link>.
334 Changing the file content directly should be avoided.
335 The directive cannot be used
336 along with the <link id="server"/> directive.
337 </para>
338
339 <para>
340 <note>
341 Changes made during
342 <link doc="../control.xml" id="reconfiguration">configuration reload</link>
343 or <link doc="../control.xml" id="upgrade">binary upgrade</link>
344 can be lost.
345 </note>
346 </para>
347
348 <para>
349 <note>
350 This directive is available as part of our
351 <commercial_version>commercial subscription</commercial_version>.
352 </note>
353 </para>
354
355 </directive>
356
357
321 <directive name="hash"> 358 <directive name="hash">
322 <syntax><value>key</value> [<literal>consistent</literal>]</syntax> 359 <syntax><value>key</value> [<literal>consistent</literal>]</syntax>
323 <default/> 360 <default/>
324 <context>upstream</context> 361 <context>upstream</context>
325 <appeared-in>1.7.2</appeared-in> 362 <appeared-in>1.7.2</appeared-in>
682 <literal>match</literal>=<value>name</value> 719 <literal>match</literal>=<value>name</value>
683 </tag-name> 720 </tag-name>
684 <tag-desc> 721 <tag-desc>
685 specifies the <literal>match</literal> block configuring the tests that a 722 specifies the <literal>match</literal> block configuring the tests that a
686 response should pass in order for a health check to pass; 723 response should pass in order for a health check to pass;
687 by default, the response should have status code 2xx or 3xx. 724 by default, the response should have status code 2xx or 3xx;
725 </tag-desc>
726
727 <tag-name id="health_check_port">
728 <literal>port</literal>=<value>number</value>
729 </tag-name>
730 <tag-desc>
731 defines the port used when connecting to a server
732 to perform a health check (1.9.7);
733 by default, equals the <link id="server"/> port.
688 </tag-desc> 734 </tag-desc>
689 735
690 </list> 736 </list>
691 </para> 737 </para>
692 738