changeset 1948:25962922969a

Moved info from stream "health_check" to intro.
author Yaroslav Zhuravlev <yar@nginx.com>
date Fri, 24 Mar 2017 19:53:23 +0300
parents 6b6d0e844bf7
children 8f9c685dfabd
files xml/en/docs/stream/ngx_stream_upstream_hc_module.xml xml/ru/docs/stream/ngx_stream_upstream_hc_module.xml
diffstat 2 files changed, 46 insertions(+), 70 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_upstream_hc_module.xml
+++ b/xml/en/docs/stream/ngx_stream_upstream_hc_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_upstream_hc_module"
         link="/en/docs/stream/ngx_stream_upstream_hc_module.html"
         lang="en"
-        rev="1">
+        rev="2">
 
 <section id="summary">
 
@@ -22,6 +22,15 @@ The server group must reside in the
 </para>
 
 <para>
+If a health check fails, the server will be considered unhealthy.
+If several health checks are defined for the same group of servers,
+a single failure of any check will make the corresponding server be
+considered unhealthy.
+Client connections are not passed to unhealthy servers
+and servers in the “checking” state.
+</para>
+
+<para>
 <note>
 This module is available as part of our
 <commercial_version>commercial subscription</commercial_version>.
@@ -52,6 +61,19 @@ server {
     health_check;
 }
 </example>
+With this configuration, nginx
+will check the ability to establish a TCP connection to each server
+in the <literal>tcp</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.
+</para>
+
+<para>
+Health checks can also be configured to test data obtained from the server.
+Tests are configured separately using the <link id="match"/> directive
+and referenced in the <literal>match</literal> parameter
+of the <link id="health_check"/> directive.
 </para>
 
 </section>
@@ -158,40 +180,6 @@ health checks instead of the default <li
 </list>
 </para>
 
-<para>
-For example,
-<example>
-server {
-    proxy_pass backend;
-    health_check;
-}
-</example>
-will check the ability to establish a TCP connection to each server
-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
-and servers in the “checking” state.
-</para>
-
-<para>
-Health checks can also be configured to test data obtained from the server.
-Tests are configured separately using the <link id="match"/> directive
-and referenced in the <literal>match</literal> parameter.
-</para>
-
-<para>
-The server group must reside in the
-<link doc="ngx_stream_upstream_module.xml" id="zone">shared memory</link>.
-</para>
-
-<para>
-If several health checks are defined for the same group of servers,
-a single failure of any check will make the corresponding server be
-considered unhealthy.
-</para>
-
 </directive>
 
 
--- a/xml/ru/docs/stream/ngx_stream_upstream_hc_module.xml
+++ b/xml/ru/docs/stream/ngx_stream_upstream_hc_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_stream_upstream_hc_module"
         link="/ru/docs/stream/ngx_stream_upstream_hc_module.html"
         lang="ru"
-        rev="1">
+        rev="2">
 
 <section id="summary">
 
@@ -22,6 +22,16 @@
 </para>
 
 <para>
+Если проверка работоспособности была неуспешной,
+то сервер признаётся неработоспособным.
+Если для группы задано несколько проверок,
+то при любой неуспешной проверке соответствующий сервер будет
+считаться неработоспособным.
+На неработоспособные серверы и серверы в состоянии “checking”
+клиентские соединения передаваться не будут.
+</para>
+
+<para>
 <note>
 Модуль доступен как часть
 <commercial_version>коммерческой подписки</commercial_version>.
@@ -52,6 +62,18 @@ server {
     health_check;
 }
 </example>
+Для каждого сервера группы <literal>backend</literal>
+с интервалом в 5 секунд проверяется возможность установки TCP-соединения.
+Если соединение с сервером не может быть установлено,
+проверка считается неуспешной и сервер
+признаётся неработоспособным.
+</para>
+
+<para>
+Проверки работоспособности могут тестировать данные, полученные от сервера.
+Тесты настраиваются отдельно при помощи директивы <link id="match"/>
+и указываются в параметре <literal>match</literal> директивы
+<link id="health_check"/>.
 </para>
 
 </section>
@@ -158,40 +180,6 @@ server {
 </list>
 </para>
 
-<para>
-В примере
-<example>
-server {
-    proxy_pass backend;
-    health_check;
-}
-</example>
-для каждого сервера группы <literal>backend</literal>
-с интервалом в 5 секунд проверяется возможность установки TCP-соединения.
-Если соединение с сервером не может быть установлено,
-проверка считается неуспешной и сервер
-признаётся неработоспособным.
-На неработоспособные серверы и серверы в состоянии “checking”
-клиентские соединения передаваться не будут.
-</para>
-
-<para>
-Проверки работоспособности могут тестировать данные, полученные от сервера.
-Тесты настраиваются отдельно при помощи директивы <link id="match"/>
-и указываются в параметре <literal>match</literal>.
-</para>
-
-<para>
-Группа должна находиться в
-<link doc="ngx_stream_upstream_module.xml" id="zone">зоне разделяемой памяти</link>.
-</para>
-
-<para>
-Если для группы задано несколько проверок,
-то при любой неуспешной проверке соответствующий сервер будет
-считаться неработоспособным.
-</para>
-
 </directive>