nginx-site: xml/en/docs/stream/ngx_stream_upstream

comparison xml/en/docs/stream/ngx_stream_upstream_module.xml @ 1680:57c3f36b3b6a

Updated docs for the upcoming NGINX Plus release.

author	Ruslan Ermilov <ru@nginx.com>
date	Sun, 10 Apr 2016 00:12:49 +0300
parents	f5dcf57c5eb5
children	1dbef8ab47c7

comparison

equal deleted inserted replaced

-:e9ad1cae4401
+:57c3f36b3b6a
 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
 <module name="Module ngx_stream_upstream_module"
 link="/en/docs/stream/ngx_stream_upstream_module.html"
 lang="en"
-rev="10">
+rev="11">
 <section id="summary">
 <para>
 The <literal>ngx_stream_upstream_module</literal> module (1.9.0)
 server backend1.example.com:12345 weight=5;
 server backend2.example.com:12345 fail_timeout=5s slow_start=30s;
 server 192.0.2.1:12345            max_fails=3;
 server backend3.example.com:12345 resolve;
+server backend4.example.com       service=http resolve;
 server backup1.example.com:12345  backup;
 server backup2.example.com:12345  backup;
 }
 ...
 server example.com:12345 resolve;
 }
 }
 </example>
+</para>
+</tag-desc>
+<tag-name id="service">
+<literal>service</literal>=<value>name</value> | <value>_name._protocol</value>
+</tag-name>
+<tag-desc>
+enables resolving of DNS
+<link url="https://tools.ietf.org/html/rfc2782">SRV</link>
+records and sets the service <value>name</value>,
+or <value>name</value> and <value>protocol</value> in the following format:
+<value>_name._protocol</value> (1.9.13).
+If only the <value>name</value> is specified,
+the <literal>TCP</literal> protocol is used.
+<para>
+In order for this parameter to work, it is necessary to specify
+the <link id="resolve"/> parameter for the server
+and specify a hostname without a port number:
+<example>
+server backend.example.com service=http resolve;
+server backend.example.com service=_http._tcp resolve;
+</example>
+Both directives specify the same SRV record:
+<literal>_http._tcp.backend.example.com</literal>.
+</para>
+<para>
+Highest-priority SRV records
+(records with the same lowest-number priority value)
+are resolved as primary servers,
+the rest of SRV records are resolved as backup servers.
+If the <link id="backup"/> parameter is specified for the server,
+high-priority SRV records are resolved as backup servers,
+the rest of SRV records are ignored.
 </para>
 </tag-desc>
 <tag-name id="slow_start">
 <literal>slow_start</literal>=<value>time</value>
 <tag-name id="hc_match">
 <literal>match</literal>=<value>name</value>
 </tag-name>
 <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;
+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 establish a TCP connection with 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.
+by default, equals the <link id="server"/> port;
+</tag-desc>
+<tag-name id="health_check_udp">
+<literal>udp</literal>
+</tag-name>
+<tag-desc>
+specifies that the <literal>UDP</literal> protocol should be used for
+health checks instead of the default <literal>TCP</literal> protocol (1.9.13);
+requires a <link id="hc_match">match</link> block with the
+<link id="match_send">send</link> and <link id="match_expect">expect</link>
+parameters.
 </tag-desc>
 </list>
 </para>
 server {
 proxy_pass backend;
 health_check;
 }
 </example>
-will check the ability to connect to each
+will check the ability to establish a TCP connection to each server
-server in the <literal>backend</literal> group every five seconds.
+in the <literal>backend</literal> group every five seconds.
 When a connection to the server cannot be established,
 the health check will fail, and the server will
 be considered unhealthy.
 Client connections are not passed to unhealthy servers.
 </para>
 <para>
 The following parameters can be configured:
 <list type="tag">
-<tag-name>
+<tag-name id="match_send">
 <literal>send</literal> <value>string</value>;
 </tag-name>
 <tag-desc>
 sends a <value>string</value> to the server;
 </tag-desc>
-<tag-name>
+<tag-name id="match_expect">
-<literal>expect</literal> <literal>~</literal> <value>regexp</value>;
+<literal>expect</literal> <value>string</value> |
-</tag-name>
+<literal>~</literal> <value>regex</value>;
-<tag-desc>
+</tag-name>
-a regular expression that the data obtained from the server should match.
+<tag-desc>
+a literal string (1.9.12) or a regular expression
+that the data obtained from the server should match.
 The regular expression is specified with the preceding
 “<literal>~*</literal>” modifier (for case-insensitive matching), or the
 “<literal>~</literal>” modifier (for case-sensitive matching).
 </tag-desc>
 </list>
+Both <literal>send</literal> and <literal>expect</literal> parameters
+can contain hexadecimal literals with the prefix “<literal>\x</literal>”
+followed by two hex digits, for example, “<literal>\x80</literal>” (1.9.12).
 </para>
 <para>
 Health check is passed if:
 <list type="bullet">
 <listitem>
-the connection was successfully established;
+the TCP connection was successfully established;
 </listitem>
 <listitem>
 the <value>string</value> from the <literal>send</literal> parameter,
 if specified, was sent;
 </listitem>
 <listitem>
-the data obtained from the server matched the regular expression
+the data obtained from the server matched the string or regular expression
 from the <literal>expect</literal> parameter, if specified;
 </listitem>
 <listitem>
 the time elapsed does not exceed the value specified

Mercurial > hg > nginx-site

comparison xml/en/docs/stream/ngx_stream_upstream_module.xml @ 1680:57c3f36b3b6a