Mercurial > hg > nginx-site

changeset 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 280cf6c0888a
children 634017216056
files xml/en/docs/http/ngx_http_core_module.xml xml/en/docs/http/ngx_http_upstream_module.xml xml/en/docs/http/ngx_http_v2_module.xml xml/en/docs/stream/ngx_stream_upstream_module.xml xml/ru/docs/http/ngx_http_core_module.xml xml/ru/docs/http/ngx_http_upstream_module.xml
diffstat 6 files changed, 147 insertions(+), 30 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_core_module.xml
+++ b/xml/en/docs/http/ngx_http_core_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_core_module"
         link="/en/docs/http/ngx_http_core_module.html"
         lang="en"
-        rev="51">
+        rev="52">
 
 <section id="directives" name="Directives">
 
@@ -1233,12 +1233,6 @@ The <literal>http2</literal> parameter (
 Normally, for this to work the <literal>ssl</literal> parameter should be
 specified as well, but nginx can also be configured to accept HTTP/2
 connections without SSL.
-<note>
-The <literal>http2</literal> parameter is also available in the
-<literal>nginx-plus-http2</literal> package (NGINX Plus release 7).
-Since HTTP/2 supersedes SPDY, the <literal>nginx-plus-http2</literal>
-package does not support the <literal>spdy</literal> parameter.
-</note>
 </para>
 
 <para>
--- a/xml/en/docs/http/ngx_http_upstream_module.xml
+++ b/xml/en/docs/http/ngx_http_upstream_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_upstream_module"
         link="/en/docs/http/ngx_http_upstream_module.html"
         lang="en"
-        rev="45">
+        rev="46">
 
 <section id="summary">
 
@@ -318,6 +318,43 @@ handled by
 </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/>
@@ -684,7 +721,16 @@ by default, “<literal>/</literal>”;
 <tag-desc>
 specifies the <literal>match</literal> block configuring the tests that a
 response should pass in order for a health check to pass;
-by default, the response should have status code 2xx or 3xx.
+by default, the response should have status code 2xx or 3xx;
+</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>
--- a/xml/en/docs/http/ngx_http_v2_module.xml
+++ b/xml/en/docs/http/ngx_http_v2_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_http_v2_module"
         link="/en/docs/http/ngx_http_v2_module.html"
         lang="en"
-        rev="3">
+        rev="4">
 
 <section id="summary">
 
@@ -26,15 +26,6 @@ the <literal>--with-http_v2_module</lite
 configuration parameter.
 </para>
 
-<para>
-<note>
-This module is also available as part of our
-<commercial_version>commercial subscription</commercial_version>
-in the <literal>nginx-plus-http2</literal> package of NGINX Plus
-<link url="https://www.nginx.com/blog/nginx-plus-r7-released/">release 7</link>.
-</note>
-</para>
-
 </section>
 
 
--- a/xml/en/docs/stream/ngx_stream_upstream_module.xml
+++ b/xml/en/docs/stream/ngx_stream_upstream_module.xml
@@ -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 @@ handled by
 </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 @@ by default, 1;
 <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>
--- a/xml/ru/docs/http/ngx_http_core_module.xml
+++ b/xml/ru/docs/http/ngx_http_core_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_core_module"
         link="/ru/docs/http/ngx_http_core_module.html"
         lang="ru"
-        rev="51">
+        rev="52">
 
 <section id="directives" name="Директивы">
 
@@ -1226,12 +1226,6 @@ id="single_http_https_server">конфигурацию</link> для сервера,
 Обычно, чтобы это работало, следует также указать параметр
 <literal>ssl</literal>, однако nginx можно также настроить и на приём
 HTTP/2-соединений без SSL.
-<note>
-Параметр <literal>http2</literal> также доступен в пакете
-<literal>nginx-plus-http2</literal> (NGINX Plus release 7).
-Так как HTTP/2 заменяет SPDY, пакет <literal>nginx-plus-http2</literal>
-не поддерживает параметр <literal>spdy</literal>.
-</note>
 </para>
 
 <para>
--- a/xml/ru/docs/http/ngx_http_upstream_module.xml
+++ b/xml/ru/docs/http/ngx_http_upstream_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_upstream_module"
         link="/ru/docs/http/ngx_http_upstream_module.html"
         lang="ru"
-        rev="45">
+        rev="46">
 
 <section id="summary">
 
@@ -318,6 +318,43 @@ http {
 </directive>
 
 
+<directive name="state">
+<syntax><value>file</value></syntax>
+<default/>
+<context>upstream</context>
+<appeared-in>1.9.7</appeared-in>
+
+<para>
+Задаёт <value>файл</value>, в котором хранится состояние
+динамически настраиваемой группы.
+В данный момент состояние ограничено списком серверов с их параметрами.
+Файл читается при парсинге конфигурации и обновляется каждый раз при
+<link doc="ngx_http_upstream_conf_module.xml" id="upstream_conf">изменении</link>
+конфигурации группы.
+Изменение содержимого файла напрямую не рекомендуется.
+Директиву нельзя использовать
+совместно с директивой <link id="server"/>.
+</para>
+
+<para>
+<note>
+Изменения, совершённые в момент
+<link doc="../control.xml" id="reconfiguration">перезагрузки конфигурации</link>
+или <link doc="../control.xml" id="upgrade">обновления бинарного файла</link>,
+могут быть потеряны.
+</note>
+</para>
+
+<para>
+<note>
+Эта директива доступна как часть
+<commercial_version>коммерческой подписки</commercial_version>.
+</note>
+</para>
+
+</directive>
+
+
 <directive name="hash">
 <syntax><value>ключ</value> [<literal>consistent</literal>]</syntax>
 <default/>
@@ -688,7 +725,16 @@ server {
 <tag-desc>
 указывает на блок <literal>match</literal> с условиями, которым должен
 удовлетворять ответ, чтобы результат проверки считался успешным;
-по умолчанию код ответа должен быть 2xx или 3xx.
+по умолчанию код ответа должен быть 2xx или 3xx;
+</tag-desc>
+
+<tag-name id="health_check_port">
+<literal>port</literal>=<value>число</value>
+</tag-name>
+<tag-desc>
+задаёт порт, используемый при подключении к серверу
+для проверки его работоспособности (1.9.7);
+по умолчанию совпадает с портом <link id="server">сервера</link>.
 </tag-desc>
 
 </list>