Mercurial > hg > nginx-site

comparison xml/en/docs/stream/ngx_stream_upstream_module.xml @ 1636:44c4323144c5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
1635:280cf6c0888a 1636:44c4323144c5
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_stream_upstream_module" 9 <module name="Module ngx_stream_upstream_module"
10 link="/en/docs/stream/ngx_stream_upstream_module.html" 10 link="/en/docs/stream/ngx_stream_upstream_module.html"
11 lang="en" 11 lang="en"
12 rev="8"> 12 rev="9">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_stream_upstream_module</literal> module (1.9.0) 17 The <literal>ngx_stream_upstream_module</literal> module (1.9.0)
286 or modifying the settings of a particular server 286 or modifying the settings of a particular server
287 without the need of restarting nginx. 287 without the need of restarting nginx.
288 The configuration is accessible via a special location 288 The configuration is accessible via a special location
289 handled by 289 handled by
290 <link doc="../http/ngx_http_upstream_conf_module.xml" id="upstream_conf"/>. 290 <link doc="../http/ngx_http_upstream_conf_module.xml" id="upstream_conf"/>.
291 </para>
292
293 </directive>
294
295
296 <directive name="state">
297 <syntax><value>file</value></syntax>
298 <default/>
299 <context>upstream</context>
300 <appeared-in>1.9.7</appeared-in>
301
302 <para>
303 Specifies a <value>file</value> that keeps the state
304 of the dynamically configurable group.
305 The state is currently limited to the list of servers with their parameters.
306 The file is read when parsing the configuration and is updated each time
307 the upstream configuration is
308 <link doc="ngx_http_upstream_conf_module.xml" id="upstream_conf">changed</link>.
309 Changing the file content directly should be avoided.
310 The directive cannot be used
311 along with the <link id="server"/> directive.
312 </para>
313
314 <para>
315 <note>
316 Changes made during
317 <link doc="../control.xml" id="reconfiguration">configuration reload</link>
318 or <link doc="../control.xml" id="upgrade">binary upgrade</link>
319 can be lost.
320 </note>
321 </para>
322
323 <para>
324 <note>
325 This directive is available as part of our
326 <commercial_version>commercial subscription</commercial_version>.
327 </note>
291 </para> 328 </para>
292 329
293 </directive> 330 </directive>
294 331
295 332
421 <literal>match</literal>=<value>name</value> 458 <literal>match</literal>=<value>name</value>
422 </tag-name> 459 </tag-name>
423 <tag-desc> 460 <tag-desc>
424 specifies the <literal>match</literal> block configuring the tests that a 461 specifies the <literal>match</literal> block configuring the tests that a
425 successful connection should pass in order for a health check to pass; 462 successful connection should pass in order for a health check to pass;
426 by default, only the ability to connect to the server is checked. 463 by default, only the ability to connect to the server is checked;
464 </tag-desc>
465
466 <tag-name id="health_check_port">
467 <literal>port</literal>=<value>number</value>
468 </tag-name>
469 <tag-desc>
470 defines the port used when connecting to a server
471 to perform a health check (1.9.7);
472 by default, equals the <link id="server"/> port.
427 </tag-desc> 473 </tag-desc>
428 474
429 </list> 475 </list>
430 </para> 476 </para>
431 477