diff xml/en/docs/stream/ngx_stream_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 201bf8fa69e5
children f5dcf57c5eb5
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_upstream_module.xml	Mon Jan 11 10:50:40 2016 +0300
+++ b/xml/en/docs/stream/ngx_stream_upstream_module.xml	Mon Jan 11 11:10:08 2016 +0300
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_upstream_module"
         link="/en/docs/stream/ngx_stream_upstream_module.html"
         lang="en"
-        rev="8">
+        rev="9">
 
 <section id="summary">
 
@@ -293,6 +293,43 @@
 </directive>
 
 
+<directive name="state">
+<syntax><value>file</value></syntax>
+<default/>
+<context>upstream</context>
+<appeared-in>1.9.7</appeared-in>
+
+<para>
+Specifies a <value>file</value> that keeps the state
+of the dynamically configurable group.
+The state is currently limited to the list of servers with their parameters.
+The file is read when parsing the configuration and is updated each time
+the upstream configuration is
+<link doc="ngx_http_upstream_conf_module.xml" id="upstream_conf">changed</link>.
+Changing the file content directly should be avoided.
+The directive cannot be used
+along with the <link id="server"/> directive.
+</para>
+
+<para>
+<note>
+Changes made during
+<link doc="../control.xml" id="reconfiguration">configuration reload</link>
+or <link doc="../control.xml" id="upgrade">binary upgrade</link>
+can be lost.
+</note>
+</para>
+
+<para>
+<note>
+This directive is available as part of our
+<commercial_version>commercial subscription</commercial_version>.
+</note>
+</para>
+
+</directive>
+
+
 <directive name="hash">
 <syntax><value>key</value> [<literal>consistent</literal>]</syntax>
 <default/>
@@ -423,7 +460,16 @@
 <tag-desc>
 specifies the <literal>match</literal> block configuring the tests that a
 successful connection should pass in order for a health check to pass;
-by default, only the ability to connect to the server is checked.
+by default, only the ability to connect to the server is checked;
+</tag-desc>
+
+<tag-name id="health_check_port">
+<literal>port</literal>=<value>number</value>
+</tag-name>
+<tag-desc>
+defines the port used when connecting to a server
+to perform a health check (1.9.7);
+by default, equals the <link id="server"/> port.
 </tag-desc>
 
 </list>