changeset 1700:1dbef8ab47c7

Updated description of service parameter in upstream.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 26 Apr 2016 19:31:57 +0300
parents 6c96a644b0b3
children 0108c6525d2a
files xml/en/docs/http/ngx_http_upstream_module.xml xml/en/docs/stream/ngx_stream_upstream_module.xml xml/ru/docs/http/ngx_http_upstream_module.xml
diffstat 3 files changed, 64 insertions(+), 36 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_upstream_module.xml	Thu May 05 14:43:40 2016 +0300
+++ b/xml/en/docs/http/ngx_http_upstream_module.xml	Tue Apr 26 19:31:57 2016 +0300
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_upstream_module"
         link="/en/docs/http/ngx_http_upstream_module.html"
         lang="en"
-        rev="47">
+        rev="48">
 
 <section id="summary">
 
@@ -266,26 +266,35 @@
 </tag-desc>
 
 <tag-name id="service">
-<literal>service</literal>=<value>name</value> | <value>_name._protocol</value>
+<literal>service</literal>=<value>name</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>
+records and sets the service <value>name</value> (1.9.13).
 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:
+and specify a hostname without a port number.
+<para>
+If the service name does not contain a dot (“<literal>.</literal>”), then
+the <link url="https://tools.ietf.org/html/rfc2782">RFC</link>-compliant name
+is constructed
+and the TCP protocol is added to the service prefix.
+For example, to look up the
+<literal>_http._tcp.backend.example.com</literal> SRV record,
+it is necessary to specify the directive:
 <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>.
+If the service name contains one or more dots, then the name is constructed
+by joining the service prefix and the server name.
+For example, to look up the <literal>_http._tcp.backend.example.com</literal>
+and <literal>server1.backend.example.com</literal> SRV records,
+it is necessary to specify the directives:
+<example>
+server backend.example.com service=_http._tcp resolve;
+server example.com service=server1.backend resolve;
+</example>
 </para>
 
 <para>
--- a/xml/en/docs/stream/ngx_stream_upstream_module.xml	Thu May 05 14:43:40 2016 +0300
+++ b/xml/en/docs/stream/ngx_stream_upstream_module.xml	Tue Apr 26 19:31:57 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="11">
+        rev="12">
 
 <section id="summary">
 
@@ -243,26 +243,35 @@
 </tag-desc>
 
 <tag-name id="service">
-<literal>service</literal>=<value>name</value> | <value>_name._protocol</value>
+<literal>service</literal>=<value>name</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>
+records and sets the service <value>name</value> (1.9.13).
 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:
+and specify a hostname without a port number.
+<para>
+If the service name does not contain a dot (“<literal>.</literal>”), then
+the <link url="https://tools.ietf.org/html/rfc2782">RFC</link>-compliant name
+is constructed
+and the TCP protocol is added to the service prefix.
+For example, to look up the
+<literal>_http._tcp.backend.example.com</literal> SRV record,
+it is necessary to specify the directive:
 <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>.
+If the service name contains one or more dots, then the name is constructed
+by joining the service prefix and the server name.
+For example, to look up the <literal>_http._tcp.backend.example.com</literal>
+and <literal>server1.backend.example.com</literal> SRV records,
+it is necessary to specify the directives:
+<example>
+server backend.example.com service=_http._tcp resolve;
+server example.com service=server1.backend resolve;
+</example>
 </para>
 
 <para>
--- a/xml/ru/docs/http/ngx_http_upstream_module.xml	Thu May 05 14:43:40 2016 +0300
+++ b/xml/ru/docs/http/ngx_http_upstream_module.xml	Tue Apr 26 19:31:57 2016 +0300
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_upstream_module"
         link="/ru/docs/http/ngx_http_upstream_module.html"
         lang="ru"
-        rev="47">
+        rev="48">
 
 <section id="summary">
 
@@ -265,26 +265,36 @@
 </tag-desc>
 
 <tag-name id="service">
-<literal>service</literal>=<value>имя</value> | <value>_имя._протокол</value>
+<literal>service</literal>=<value>имя</value>
 </tag-name>
 <tag-desc>
 включает преобразование
 <link url="https://tools.ietf.org/html/rfc2782">SRV</link>-записей
-DNS и задаёт <value>имя</value> сервиса
-или <value>имя</value> и <value>протокол</value> в следующем формате:
-<value>_имя._протокол</value> (1.9.13).
-Если задано только <value>имя</value>, то
-используется протокол <literal>TCP</literal>.
-<para>
+DNS и задаёт <value>имя</value> сервиса (1.9.13).
 Для работы параметра необходимо указать
 параметр <link id="resolve"/> для сервера
-и не указывать порт сервера:
+и не указывать порт сервера.
+<para>
+Если имя сервиса не содержит точку (“<literal>.</literal>”), то
+имя составляется в соответствии с
+<link url="https://tools.ietf.org/html/rfc2782">RFC</link>
+и в префикс службы добавляется протокол TCP.
+Например, для получения
+SRV-записи <literal>_http._tcp.backend.example.com</literal>
+необходимо указать директиву:
 <example>
 server backend.example.com service=http resolve;
-server backend.example.com service=_http._tcp resolve;
 </example>
-Обе директивы задают одну и ту же SRV-запись:
-<literal>_http._tcp.backend.example.com</literal>.
+Если имя сервиса содержит одну и более точек, то имя составляется
+при помощи соединения префикса службы и имени сервера.
+Например, для получения SRV-записей
+<literal>_http._tcp.backend.example.com</literal>
+и <literal>server1.backend.example.com</literal>
+необходимо указать директивы:
+<example>
+server backend.example.com service=_http._tcp resolve;
+server example.com service=server1.backend resolve;
+</example>
 </para>
 
 <para>