Mercurial > hg > nginx-site
diff xml/ru/docs/http/ngx_http_upstream_conf_module.xml @ 1450:f5b5eefc43cb
Updated commercial docs for the upcoming release.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Thu, 09 Apr 2015 19:18:54 +0300 |
parents | xml/ru/docs/http/ngx_http_upstream_module.xml@23b409d1f5c7 |
children | d3c1a4e8c1fe |
line wrap: on
line diff
copy from xml/ru/docs/http/ngx_http_upstream_module.xml copy to xml/ru/docs/http/ngx_http_upstream_conf_module.xml --- a/xml/ru/docs/http/ngx_http_upstream_module.xml +++ b/xml/ru/docs/http/ngx_http_upstream_conf_module.xml @@ -1,28 +1,27 @@ <?xml version="1.0"?> <!-- - Copyright (C) Igor Sysoev Copyright (C) Nginx, Inc. --> <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> -<module name="Модуль ngx_http_upstream_module" - link="/ru/docs/http/ngx_http_upstream_module.html" +<module name="Модуль ngx_http_upstream_conf_module" + link="/ru/docs/http/ngx_http_upstream_conf_module.html" lang="ru" - rev="35"> + rev="1"> <section id="summary"> <para> -Модуль <literal>ngx_http_upstream_module</literal> -позволяет описывать группы серверов, -которые могут использоваться в директивах -<link doc="ngx_http_proxy_module.xml" id="proxy_pass"/>, -<link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass"/>, -<link doc="ngx_http_uwsgi_module.xml" id="uwsgi_pass"/>, -<link doc="ngx_http_scgi_module.xml" id="scgi_pass"/> и -<link doc="ngx_http_memcached_module.xml" id="memcached_pass"/>. +Модуль <literal>ngx_http_upstream_conf_module</literal> +позволяет оперативно настраивать группы серверов +при помощи простого HTTP-интерфейса без необходимости перезапуска nginx. +Группа серверов +<link doc="ngx_http_upstream_module.xml" id="zone">http</link> +или +<link doc="../stream/ngx_stream_upstream_module.xml" id="zone">stream</link> +должна находиться в разделяемой памяти. </para> </section> @@ -32,47 +31,15 @@ <para> <example> -upstream <emphasis>backend</emphasis> { - server backend1.example.com weight=5; - server backend2.example.com:8080; - server unix:/tmp/backend3; +upstream backend { + zone upstream_backend 64k; - server backup1.example.com:8080 backup; - server backup2.example.com:8080 backup; + ... } server { - location / { - proxy_pass http://<emphasis>backend</emphasis>; - } -} -</example> -</para> - -<para> -Динамически настраиваемая группа, -доступна как часть -<commercial_version>коммерческой подписки</commercial_version>: -<example> -upstream <emphasis>dynamic</emphasis> { - zone upstream_dynamic 64k; - - server backend1.example.com weight=5; - server backend2.example.com:8080 fail_timeout=5s slow_start=30s; - server 192.0.2.1 max_fails=3; - - server backup1.example.com:8080 backup; - server backup2.example.com:8080 backup; -} - -server { - location / { - proxy_pass http://<emphasis>dynamic</emphasis>; - health_check; - } - location /upstream_conf { - upstream_conf; + <emphasis>upstream_conf</emphasis>; allow 127.0.0.1; deny all; } @@ -85,960 +52,6 @@ server { <section id="directives" name="Директивы"> -<directive name="upstream"> -<syntax block="yes"><value>название</value></syntax> -<default/> -<context>http</context> - -<para> -Описывает группу серверов. -Серверы могут слушать на разных портах. -Кроме того, можно одновременно использовать серверы, -слушающие на TCP- и UNIX-сокетах. -</para> - -<para> -Пример: -<example> -upstream backend { - server backend1.example.com weight=5; - server 127.0.0.1:8080 max_fails=3 fail_timeout=30s; - server unix:/tmp/backend3; - - server backup1.example.com backup; -} -</example> -</para> - -<para> -По умолчанию запросы распределяются по серверам циклически -(в режиме round-robin) с учётом весов серверов. -В вышеприведённом примере каждые 7 запросов будут распределены так: -5 запросов на <literal>backend1.example.com</literal> -и по одному запросу на второй и третий серверы. -Если при попытке работы с сервером происходит ошибка, то запрос -передаётся следующему серверу, и так далее до тех пор, пока не будут опробованы -все работающие серверы. -Если не удастся получить успешный ответ -ни от одного из серверов, то клиенту будет возвращён результат работы -с последним сервером. -</para> - -</directive> - - -<directive name="server"> -<syntax><value>адрес</value> [<value>параметры</value>]</syntax> -<default/> -<context>upstream</context> - -<para> -Задаёт <value>адрес</value> и другие <value>параметры</value> -сервера. -Адрес может быть указан в виде доменного имени или IP-адреса, -и необязательного порта, или в виде пути UNIX-сокета, который -указывается после префикса “<literal>unix:</literal>”. -Если порт не указан, используется порт 80. -Доменное имя, которому соответствует несколько IP-адресов, -задаёт сразу несколько серверов. -</para> - -<para> -Могут быть заданы следующие параметры: -<list type="tag"> - -<tag-name id="weight"> -<literal>weight</literal>=<value>число</value> -</tag-name> -<tag-desc> -задаёт вес сервера, по умолчанию 1. -</tag-desc> - -<tag-name id="max_fails"> -<literal>max_fails</literal>=<value>число</value> -</tag-name> -<tag-desc> -задаёт число неудачных попыток работы с сервером, которые должны произойти -в течение времени, заданного параметром <literal>fail_timeout</literal>, -чтобы сервер считался недоступным на период времени, также заданный -параметром <literal>fail_timeout</literal>. -По умолчанию число попыток устанавливается равным 1. -Нулевое значение отключает учёт попыток. -Что считается неудачной попыткой, определяется директивами -<link doc="ngx_http_proxy_module.xml" id="proxy_next_upstream"/>, -<link doc="ngx_http_fastcgi_module.xml" id="fastcgi_next_upstream"/>, -<link doc="ngx_http_uwsgi_module.xml" id="uwsgi_next_upstream"/>, -<link doc="ngx_http_scgi_module.xml" id="scgi_next_upstream"/> и -<link doc="ngx_http_memcached_module.xml" id="memcached_next_upstream"/>. -</tag-desc> - -<tag-name id="fail_timeout"> -<literal>fail_timeout</literal>=<value>время</value> -</tag-name> -<tag-desc> -задаёт -<list type="bullet"> - -<listitem> -время, в течение которого должно произойти заданное число неудачных -попыток работы с сервером для того, чтобы сервер считался недоступным; -</listitem> - -<listitem> -и время, в течение которого сервер будет считаться недоступным. -</listitem> - -</list> -По умолчанию параметр равен 10 секундам. -</tag-desc> - -<tag-name id="backup"> -<literal>backup</literal> -</tag-name> -<tag-desc> -помечает сервер как запасной сервер. -На него будут передаваться запросы в случае, если не работают основные серверы. -</tag-desc> - -<tag-name id="down"> -<literal>down</literal> -</tag-name> -<tag-desc> -помечает сервер как постоянно недоступный. -</tag-desc> - -</list> -</para> - -<para> -Кроме того, -следующие параметры доступны как часть -<commercial_version>коммерческой подписки</commercial_version>: -<list type="tag"> - -<tag-name id="max_conns"> -<literal>max_conns</literal>=<value>число</value> -</tag-name> -<tag-desc> -ограничивает максимальное <value>число</value> одновременных соединений -к проксируемому серверу (1.5.9). -Значение по умолчанию равно 0 и означает, что ограничения нет. -</tag-desc> - -<tag-name id="resolve"> -<literal>resolve</literal> -</tag-name> -<tag-desc> -отслеживает изменения IP-адресов, соответствующих доменному имени сервера, -и автоматически изменяет конфигурацию группы -без необходимости перезапуска nginx (1.5.12). -<para> -Для работы этого параметра -директива <link doc="ngx_http_core_module.xml" id="resolver"/> -должна быть задана в блоке -<link doc="ngx_http_core_module.xml" id="http"/>. -Пример: -<example> -http { - resolver 10.0.0.1; - - upstream u { - zone ...; - ... - server example.com resolve; - } -} -</example> -</para> -</tag-desc> - -<tag-name id="route"> -<literal>route</literal>=<value>строка</value> -</tag-name> -<tag-desc> -задаёт имя маршрута к серверу. -</tag-desc> - -<tag-name id="slow_start"> -<literal>slow_start</literal>=<value>время</value> -</tag-name> -<tag-desc> -задаёт <value>время</value>, в течение которого вес сервера -восстановится от нуля до своего номинального значения в ситуации, когда -неработоспособный (unhealthy) сервер вновь становится работоспособным -(<link id="health_check">healthy</link>) -или когда сервер становится доступным по прошествии времени, -в течение которого он считался <link id="fail_timeout">недоступным</link>. -Значение по умолчанию равно нулю и означает, что медленный старт выключен. -</tag-desc> - -</list> -</para> - -<para> -<note> -Если в группе только один сервер, параметры <literal>max_fails</literal>, -<literal>fail_timeout</literal> и <literal>slow_start</literal> -игнорируются и такой сервер никогда не будет считаться недоступным. -</note> -</para> - -</directive> - - -<directive name="zone"> -<syntax><value>имя</value> <value>размер</value></syntax> -<default/> -<context>upstream</context> - -<para> -Задаёт <value>имя</value> и <value>размер</value> зоны разделяемой памяти, -в которой хранятся конфигурация группы и её рабочее состояние, -разделяемые между рабочими процессами. -В таких группах для изменения состава группы -или настроек отдельных серверов -нет необходимости перезапускать nginx. -Конфигурация доступна через специальный location, -в котором указана директива <link id="upstream_conf"/>. -</para> - -<para> -<note> -Эта директива доступна как часть -<commercial_version>коммерческой подписки</commercial_version>. -</note> -</para> - -</directive> - - -<directive name="hash"> -<syntax><value>ключ</value> [<literal>consistent</literal>]</syntax> -<default/> -<context>upstream</context> -<appeared-in>1.7.2</appeared-in> - -<para> -Задаёт метод балансировки нагрузки для группы, при котором -соответствие клиента серверу определяется при помощи -хэшированного значения <value>ключа</value>. -В качестве <value>ключа</value> может использоваться -текст, переменные и их комбинации. -Следует отметить, что любое добавление или удаление серверов в группе -может привести к перераспределению большинства ключей на другие серверы. -Метод совместим с библиотекой Perl -<link url="http://search.cpan.org/perldoc?Cache%3A%3AMemcached">Cache::Memcached</link>. -</para> - -<para> -Если задан параметр <literal>consistent</literal>, то вместо -вышеописанного метода будет использоваться метод консистентного хэширования -<link url="http://www.last.fm/user/RJ/journal/2007/04/10/392555/">ketama</link>. -Метод гарантирует, что при добавлении сервера в группу или его удалении -на другие серверы будет перераспределено минимальное число ключей. -Применение метода для кэширующих серверов обеспечивает -больший процент попаданий в кэш. -Метод совместим с библиотекой Perl -<link url="http://search.cpan.org/perldoc?Cache%3A%3AMemcached%3A%3AFast">Cache::Memcached::Fast</link> -при значении параметра <value>ketama_points</value> равным 160. -</para> - -</directive> - - -<directive name="ip_hash"> -<syntax/> -<default/> -<context>upstream</context> - -<para> -Задаёт для группы метод балансировки нагрузки, при котором запросы -распределяются по серверам на основе IP-адресов клиентов. -В качестве ключа для хэширования используются первые три -октета IPv4-адреса клиента или IPv6-адрес клиента целиком. -Метод гарантирует, что запросы одного и того же клиента -будут всегда передаваться на один и тот же сервер. -Если же этот сервер будет считаться недоступным, -то запросы этого клиента будут передаваться на другой сервер. -С большой долей вероятности это также будет один и тот же сервер. -<note> -IPv6-адреса поддерживаются начиная с версий 1.3.2 и 1.2.2. -</note> -</para> - -<para> -Если один из серверов нужно убрать на некоторое время, то для сохранения -текущего хэширования IP-адресов клиентов этот сервер нужно пометить -параметром <literal>down</literal>. -</para> - -<para> -Пример: -<example> -upstream backend { - ip_hash; - - server backend1.example.com; - server backend2.example.com; - server backend3.example.com <emphasis>down</emphasis>; - server backend4.example.com; -} -</example> -</para> - -<para> -<note> -До версий 1.3.1 и 1.2.2 для серверов, использующих метод балансировки нагрузки -<literal>ip_hash</literal>, нельзя было задать вес. -</note> -</para> - -</directive> - - -<directive name="keepalive"> -<syntax><value>соединения</value></syntax> -<default/> -<context>upstream</context> -<appeared-in>1.1.4</appeared-in> - -<para> -Задействует кэш соединений для группы серверов. -</para> - -<para> -Параметр <value>соединения</value> устанавливает максимальное число -неактивных постоянных соединений с серверами группы, которые будут -сохраняться в кэше каждого рабочего процесса. -При превышении этого числа наиболее давно не используемые соединения -закрываются. -<note> -Следует особо отметить, что директива <literal>keepalive</literal> -не ограничивает общее число соединений с серверами группы, которые -рабочие процессы nginx могут открыть. -Параметр <value>соединения</value> следует устанавливать достаточно -консервативно, чтобы серверы группы по-прежнему могли обрабатывать -новые входящие соединения. -</note> -</para> - -<para> -Пример конфигурации группы серверов memcached с постоянными соединениями: -<example> -upstream memcached_backend { - server 127.0.0.1:11211; - server 10.0.0.2:11211; - - keepalive 32; -} - -server { - ... - - location /memcached/ { - set $memcached_key $uri; - memcached_pass memcached_backend; - } - -} -</example> -</para> - -<para> -Для HTTP директиву -<link doc="ngx_http_proxy_module.xml" id="proxy_http_version"/> -следует установить в “<literal>1.1</literal>”, -а поле заголовка <header>Connection</header> — очистить: -<example> -upstream http_backend { - server 127.0.0.1:8080; - - keepalive 16; -} - -server { - ... - - location /http/ { - proxy_pass http://http_backend; - proxy_http_version 1.1; - proxy_set_header Connection ""; - ... - } -} -</example> -</para> - -<para> -<note> -Хоть это и не рекомендуется, но также возможно использование постоянных -соединений с HTTP/1.0, путём передачи поля заголовка -<header>Connection: Keep-Alive</header> серверу группы. -</note> -</para> - -<para> -Для работы постоянных соединений с FastCGI-серверами потребуется -включить директиву -<link doc="ngx_http_fastcgi_module.xml" id="fastcgi_keep_conn"/>: -<example> -upstream fastcgi_backend { - server 127.0.0.1:9000; - - keepalive 8; -} - -server { - ... - - location /fastcgi/ { - fastcgi_pass fastcgi_backend; - fastcgi_keep_conn on; - ... - } -} -</example> -</para> - -<para> -<note> -При использовании методов балансировки нагрузки, отличных -от стандартного round-robin, следует активировать их до -директивы <literal>keepalive</literal>. -</note> - -<note> -Протоколы SCGI и uwsgi не определяют семантику постоянных соединений. -</note> -</para> - -</directive> - - -<directive name="least_conn"> -<syntax/> -<default/> -<context>upstream</context> -<appeared-in>1.3.1</appeared-in> -<appeared-in>1.2.2</appeared-in> - -<para> -Задаёт для группы метод балансировки нагрузки, при котором запрос -передаётся серверу с наименьшим числом активных соединений, -с учётом весов серверов. -Если подходит сразу несколько серверов, они выбираются циклически -(в режиме round-robin) с учётом их весов. -</para> - -</directive> - - -<directive name="health_check"> -<syntax>[<value>параметры</value>]</syntax> -<default/> -<context>location</context> - -<para> -Активирует периодические проверки работоспособности серверов в -<link id="upstream">группе</link>, указанной в содержащем location. -</para> - -<para> -Могут быть заданы следующие необязательные параметры: -<list type="tag"> - -<tag-name id="interval"> -<literal>interval</literal>=<value>время</value> -</tag-name> -<tag-desc> -задаёт интервал между двумя последовательными проверками, -по умолчанию 5 секунд; -</tag-desc> - -<tag-name id="fails"> -<literal>fails</literal>=<value>число</value> -</tag-name> -<tag-desc> -задаёт число последовательных неуспешных проверок для определённого сервера, -после которых сервер будет считаться неработоспособным, -по умолчанию 1; -</tag-desc> - -<tag-name id="passes"> -<literal>passes</literal>=<value>число</value> -</tag-name> -<tag-desc> -задаёт число последовательных успешных проверок для определённого сервера, -после которых сервер будет считаться работоспособным, -по умолчанию 1; -</tag-desc> - -<tag-name id="uri"> -<literal>uri</literal>=<value>uri</value> -</tag-name> -<tag-desc> -задаёт URI, используемый в запросах, проверяющих работоспособность, -по умолчанию “<literal>/</literal>”; -</tag-desc> - -<tag-name id="hc_match"> -<literal>match</literal>=<value>имя</value> -</tag-name> -<tag-desc> -указывает на блок <literal>match</literal> с условиями, которым должен -удовлетворять ответ, чтобы результат проверки считался успешным; -по умолчанию код ответа должен быть 2xx или 3xx. -</tag-desc> - -</list> -</para> - -<para> -В примере -<example> -location / { - proxy_pass http://backend; - health_check; -} -</example> -каждому серверу группы <literal>backend</literal> -с интервалом в 5 секунд посылаются запросы “<literal>/</literal>”. -Если происходит ошибка или таймаут при работе с сервером, или -код ответа проксируемого сервера не равен -2xx или 3xx, проверка считается неуспешной и сервер -признаётся неработоспособным. -На неработоспособные серверы клиентские запросы передаваться не будут. -</para> - -<para> -Проверки работоспособности могут тестировать код ответа, -наличие или отсутствие определённых полей заголовка и их значений, -а также содержимое тела ответа. -Тесты настраиваются отдельно при помощи директивы <link id="match"/> -и указываются в параметре <literal>match</literal>. -Например: -<example> -http { - server { - ... - location / { - proxy_pass http://backend; - health_check match=welcome; - } - } - - match welcome { - status 200; - header Content-Type = text/html; - body ~ "Welcome to nginx!"; - } -} -</example> -В такой конфигурации успешный ответ на проверочный запрос -должен иметь код 200, тип содержимого “<literal>text/html</literal>” -и “<literal>Welcome to nginx!</literal>” в теле ответа. -</para> - -<para> -Группа должна находиться в <link id="zone">зоне разделяемой памяти</link>. -</para> - -<para> -Если для группы задано несколько проверок, -то при любой неуспешной проверке соответствующий сервер будет -считаться неработоспособным. -</para> - -<para> -<note> -Обратите внимание, что при использовании проверок -большинство переменных имеют пустые значения. -</note> -</para> - -<para> -<note> -Эта директива доступна как часть -<commercial_version>коммерческой подписки</commercial_version>. -</note> -</para> - -</directive> - - -<directive name="match"> -<syntax block="yes"><value>имя</value></syntax> -<default/> -<context>http</context> - -<para> -Задаёт именованный набор тестов для анализа ответов -на запросы проверки работоспособности. -</para> - -<para> -В ответе могут быть протестированы следующие объекты: -<list type="tag"> - -<tag-name><literal>status 200;</literal></tag-name> -<tag-desc>код ответа равен 200</tag-desc> - -<tag-name><literal>status ! 500;</literal></tag-name> -<tag-desc>код ответа не равен 500</tag-desc> - -<tag-name><literal>status 200 204;</literal></tag-name> -<tag-desc>код ответа равен 200 или 204</tag-desc> - -<tag-name><literal>status ! 301 302;</literal></tag-name> -<tag-desc>код ответа не равен ни 301, ни 302</tag-desc> - -<tag-name><literal>status 200-399;</literal></tag-name> -<tag-desc>код ответа находится в диапазоне от 200 до 399</tag-desc> - -<tag-name><literal>status ! 400-599;</literal></tag-name> -<tag-desc>код ответа находится вне диапазона от 400 до 599</tag-desc> - -<tag-name><literal>status 301-303 307;</literal></tag-name> -<tag-desc>код ответа равен 301, 302, 303 или 307</tag-desc> - -</list> - -<list type="tag"> - -<tag-name><literal>header Content-Type = text/html;</literal></tag-name> -<tag-desc> -заголовок содержит <header>Content-Type</header> -со значением <literal>text/html</literal> -</tag-desc> - -<tag-name><literal>header Content-Type != text/html;</literal></tag-name> -<tag-desc> -заголовок содержит <header>Content-Type</header> -со значением, отличным от <literal>text/html</literal> -</tag-desc> - -<tag-name><literal>header Connection ~ close;</literal></tag-name> -<tag-desc> -заголовок содержит <header>Connection</header> -со значением, совпадающим с регулярным выражением <literal>close</literal> -</tag-desc> - -<tag-name><literal>header Connection !~ close;</literal></tag-name> -<tag-desc> -заголовок содержит <header>Connection</header> -со значением, не совпадающим с регулярным выражением <literal>close</literal> -</tag-desc> - -<tag-name><literal>header Host;</literal></tag-name> -<tag-desc>заголовок содержит <header>Host</header></tag-desc> - -<tag-name><literal>header ! X-Accel-Redirect;</literal></tag-name> -<tag-desc>заголовок не содержит <header>X-Accel-Redirect</header></tag-desc> - -</list> - -<list type="tag"> - -<tag-name><literal>body ~ "Welcome to nginx!";</literal></tag-name> -<tag-desc> -тело ответа совпадает с регулярным выражением -“<literal>Welcome to nginx!</literal>” -</tag-desc> - -<tag-name><literal>body !~ "Welcome to nginx!";</literal></tag-name> -<tag-desc> -тело ответа не совпадает с регулярным выражением -“<literal>Welcome to nginx!</literal>” -</tag-desc> - -</list> -</para> - -<para> -Если задано несколько тестов, -то ответ должен удовлетворять всем тестам. -<note> -Проверяются только первые 256 Кбайт тела ответа. -</note> -</para> - -<para> -Примеры: -<example> -# код ответа 200, тип содержимого "text/html" -# и тело ответа содержит "Welcome to nginx!" -match welcome { - status 200; - header Content-Type = text/html; - body ~ "Welcome to nginx!"; -} -</example> - -<example> -# код ответа не равен 301, 302, 303 и 307 и заголовок не содержит "Refresh:" -match not_redirect { - status ! 301-303 307; - header ! Refresh; -} -</example> - -<example> -# код ответа успешный и сервер не в сервисном режиме -match server_ok { - status 200-399; - body !~ "maintenance mode"; -} -</example> - -</para> - -<para> -<note> -Эта директива доступна как часть -<commercial_version>коммерческой подписки</commercial_version>. -</note> -</para> - -</directive> - - -<directive name="queue"> -<syntax> -<value>число</value> -[<literal>timeout</literal>=<value>время</value>]</syntax> -<default/> -<context>upstream</context> -<appeared-in>1.5.12</appeared-in> - -<para> -Если при обработке запроса невозможно сразу выбрать сервер группы -и в группе есть серверы, у которых число соединений достигло -ограничения <link id="max_conns"/>, -запрос будет помещён в очередь. -Директива задаёт максимальное число запросов, которые могут одновременно -находиться в очереди. -Если очередь переполнена -или за время, задаваемое параметром <literal>timeout</literal>, -так и не удастся выбрать сервер для передачи ему запроса, -клиенту будет возвращена ошибка. -</para> - -<para> -По умолчанию параметр <literal>timeout</literal> равен 60 секундам. -</para> - -<para> -<note> -Эта директива доступна как часть -<commercial_version>коммерческой подписки</commercial_version>. -</note> -</para> - -</directive> - - -<directive name="sticky"> -<syntax> - <literal>cookie</literal> <value>имя</value> - [<literal>expires=</literal><value>время</value>] - [<literal>domain=</literal><value>домен</value>] - [<literal>path=</literal><value>путь</value>]</syntax> -<syntax> - <literal>route</literal> <value>переменная</value> ...</syntax> -<syntax> - <literal>learn</literal> - <literal>create=</literal><value>$переменная</value> - <literal>lookup=</literal><value>$переменная</value> - <literal>zone=</literal><value>имя</value>:<value>размер</value> - [<literal>timeout=</literal><value>время</value>]</syntax> -<default/> -<context>upstream</context> -<appeared-in>1.5.7</appeared-in> - -<para> -Включает режим привязки сеансов, в котором запросы клиента -будут передаваться на один и тот же сервер группы. -Доступны три метода: -<list type="tag"> -<tag-name id="sticky_cookie"><literal>cookie</literal></tag-name> -<tag-desc> - -<para> -При использовании метода <literal>cookie</literal> информация о -назначенном сервере передаётся в HTTP-куке: -<example> -upstream backend { - server backend1.example.com; - server backend2.example.com; - - sticky cookie srv_id expires=1h domain=.example.com path=/; -} -</example> -</para> - -<para> -Запрос от клиента, ещё не привязанного к определённому серверу, -передаётся на сервер, выбранный согласно настроенному методу балансировки. -Дальнейшие запросы от этого клиента передаются на тот же сервер. -Если назначенный сервер не может обработать запрос, выбирается новый -сервер как если бы клиент не имел привязки к серверу. -</para> - -<para> -Первый параметр задаёт имя куки, которую необходимо установить или проверить. -Дополнительные параметры могут быть следующими: -<list type="tag"> - -<tag-name><literal>expires</literal></tag-name> -<tag-desc> -Задаёт время, в течение которого браузеру необходимо хранить куку. -Специальное значение <literal>max</literal> устанавливает срок хранения куки до -31 декабря 2037 года 23:55:55 GMT. -Если параметр не указан, то время действия куки ограничивается сессией браузера. -</tag-desc> - -<tag-name><literal>domain</literal></tag-name> -<tag-desc> -Задаёт домен, для которого устанавливается кука. -</tag-desc> - -<tag-name><literal>path</literal></tag-name> -<tag-desc> -Задаёт путь, для которого устанавливается кука. -</tag-desc> - -</list> -Если пропущен тот или иной параметр, то соответствующего поля в куке не будет. -</para> -</tag-desc> - -<tag-name id="sticky_route"><literal>route</literal></tag-name> -<tag-desc> - -<para> -При использовании метода <literal>route</literal> проксируемый сервер назначает -клиенту маршрут по получении первого запроса. -Все последующие запросы от этого клиента будут содержать информацию о -маршруте в куке или URI. -Эта информация сравнивается с параметром “<literal>route</literal>” директивы -<link id="server"/> для идентификации сервера, на который -следует проксировать запрос. -Если назначенный сервер не может обработать запрос, выбирается новый сервер -согласно настроенному методу балансировки как если бы в запросе не было -информации о маршруте. -</para> - -<para> -Параметры метода <literal>route</literal> задают переменные, которые -могут содержать информацию о маршруте. -Первая непустая переменная используется для поиска соответствующего сервера. -</para> - -<para> -Пример: -<example> -map $cookie_jsessionid $route_cookie { - ~.+\.(?P<route>\w+)$ $route; -} - -map $request_uri $route_uri { - ~jsessionid=.+\.(?P<route>\w+)$ $route; -} - -upstream backend { - server backend1.example.com route=a; - server backend2.example.com route=b; - - sticky route $route_cookie $route_uri; -} -</example> -В этом примере маршрут берётся из куки “<literal>JSESSIONID</literal>”, -если она присутствует в запросе. -В противном случае используется маршрут из URI. -</para> - -</tag-desc> - -<tag-name id="sticky_learn"><literal>learn</literal></tag-name> -<tag-desc> -<para> -При использовании метода <literal>learn</literal> (1.7.1) nginx -анализирует ответы от вышестоящего сервера и запоминает -начатые им сессии, которые обычно передаются в HTTP-куке. -<example> -upstream backend { - server backend1.example.com:8080; - server backend2.example.com:8081; - - sticky learn - create=$upstream_cookie_sessionid - lookup=$cookie_sessionid - zone=client_sessions:1m; -} -</example> - -В примере выше сервер группы создаёт сессию путём установки -куки “<literal>SESSIONID</literal>” в своём ответе. -Последующие запросы с этой кукой будут передаваться на этот же сервер. -Если сервер не может обработать запрос, выбирается новый -сервер как если бы клиент не имел привязки к серверу. -</para> - -<para> -Параметры <literal>create</literal> и <literal>lookup</literal> -задают переменные, в которых соответственно указывается способ -создания новых и поиска существующих сессий. -Оба параметра могут быть указаны больше одного раза -(в этом случае используется первая непустая переменная). -</para> - -<para> -Сессии хранятся в зоне разделяемой памяти, <value>имя</value> и -<value>размер</value> которой задаются параметром <literal>zone</literal>. -Зоны размером в 1 мегабайт достаточно для хранения около 8 тысяч сессий -на 64-битной платформе. -Сессии, к которым не было обращений в течение времени, заданного параметром -<literal>timeout</literal>, удаляются из зоны. -По умолчанию <literal>timeout</literal> равен 10 минутам. -</para> - -</tag-desc> -</list> -</para> - -<para> -<note> -Эта директива доступна как часть -<commercial_version>коммерческой подписки</commercial_version>. -</note> -</para> - -</directive> - - -<directive name="sticky_cookie_insert"> -<syntax><value>имя</value> -[<literal>expires=</literal><value>время</value>] -[<literal>domain=</literal><value>домен</value>] -[<literal>path=</literal><value>путь</value>]</syntax> -<default/> -<context>upstream</context> - -<para> -Эта директива устарела начиная с версии 1.5.7. -Вместо неё следует использовать аналогичную директиву -<link id="sticky"/> с изменённым синтаксисом: -<note> -<literal>sticky cookie</literal> <value>имя</value> -[<literal>expires=</literal><value>время</value>] -[<literal>domain=</literal><value>домен</value>] -[<literal>path=</literal><value>путь</value>]; -</note> -</para> - -</directive> - - <directive name="upstream_conf"> <syntax/> <default/> @@ -1076,7 +89,7 @@ upstream backend { Команда настройки состоит из параметров, передаваемых в аргументах запроса, например: <example> -http://127.0.0.1/upstream_conf?upstream=dynamic +http://127.0.0.1/upstream_conf?upstream=backend </example> </para> @@ -1086,6 +99,15 @@ http://127.0.0.1/upstream_conf?upstream= <list type="tag" compact="no"> <tag-name> +<literal>stream=</literal></tag-name> +<tag-desc> +Выбирает группу серверов +<link doc="../stream/ngx_stream_upstream_module.xml">stream</link>. +Если параметр не задан, будет выбрана группа серверов +<link doc="ngx_http_upstream_module.xml">http</link>. +</tag-desc> + +<tag-name> <literal>upstream=</literal><value>имя</value></tag-name> <tag-desc> Выбирает группу серверов для работы. @@ -1123,88 +145,112 @@ http://127.0.0.1/upstream_conf?upstream= <tag-name> <literal>server=</literal><value>адрес</value></tag-name> <tag-desc> -То же, что и параметр “<literal>адрес</literal>” -директивы <link id="server"/>. +То же, что и параметр “<literal>адрес</literal>” сервера группы +<link doc="ngx_http_upstream_module.xml" id="server">http</link> +или +<link doc="../stream/ngx_stream_upstream_module.xml" id="server">stream</link>. <para> При добавлении сервер можно задать в виде доменного имени. В этом случае любые изменения IP-адресов, соответствующих доменному имени сервера, отслеживаются и автоматически применяются к конфигурации группы без необходимости перезапуска nginx (1.7.2). -Для этого в блоке <link doc="ngx_http_core_module.xml" id="http"/> должна -быть задана директива <link doc="ngx_http_core_module.xml" id="resolver"/>. -См. также параметр -<link id="resolve"/> директивы <link id="server"/>. +Для этого в блоке +<link doc="ngx_http_core_module.xml" id="resolver">http</link> +или +<link doc="../stream/ngx_stream_core_module.xml" id="resolver">stream</link> +должна быть задана директива “<literal>resolver</literal>”. +См. также параметр “<literal>resolve</literal>” сервера группы +<link doc="ngx_http_upstream_module.xml" id="resolve">http</link> +или +<link doc="../stream/ngx_stream_upstream_module.xml" id="resolve">stream</link>. </para> </tag-desc> <tag-name> <literal>weight=</literal><value>число</value></tag-name> <tag-desc> -То же, что и параметр “<literal>weight</literal>” -директивы <link id="server"/>. +То же, что и параметр “<literal>weight</literal>” сервера группы +<link doc="ngx_http_upstream_module.xml" id="weight">http</link> +или +<link doc="../stream/ngx_stream_upstream_module.xml" id="weight">stream</link>. </tag-desc> <tag-name> <literal>max_conns=</literal><value>число</value></tag-name> <tag-desc> -То же, что и параметр “<literal>max_conns</literal>” -директивы <link id="server"/>. +То же, что и параметр “<literal>max_conns</literal>” сервера группы +<link doc="ngx_http_upstream_module.xml" id="max_conns">http</link> +или +<link doc="../stream/ngx_stream_upstream_module.xml" id="max_conns">stream</link>. </tag-desc> <tag-name> <literal>max_fails=</literal><value>число</value></tag-name> <tag-desc> -То же, что и параметр “<literal>max_fails</literal>” -директивы <link id="server"/>. +То же, что и параметр “<literal>max_fails</literal>” сервера группы +<link doc="ngx_http_upstream_module.xml" id="max_fails">http</link> +или +<link doc="../stream/ngx_stream_upstream_module.xml" id="max_fails">stream</link>. </tag-desc> <tag-name> <literal>fail_timeout=</literal><value>время</value></tag-name> <tag-desc> -То же, что и параметр “<literal>fail_timeout</literal>” -директивы <link id="server"/>. +То же, что и параметр “<literal>fail_timeout</literal>” сервера группы +<link doc="ngx_http_upstream_module.xml" id="fail_timeout">http</link> +или +<link doc="../stream/ngx_stream_upstream_module.xml" id="fail_timeout">stream</link>. </tag-desc> <tag-name> <literal>slow_start=</literal><value>время</value></tag-name> <tag-desc> -То же, что и параметр “<literal>slow_start</literal>” -директивы <link id="server"/>. +То же, что и параметр “<literal>slow_start</literal>” сервера группы +<link doc="ngx_http_upstream_module.xml" id="slow_start">http</link> +или +<link doc="../stream/ngx_stream_upstream_module.xml" id="slow_start">stream</link>. </tag-desc> <tag-name> <literal>down=</literal></tag-name> <tag-desc> -То же, что и параметр “<literal>down</literal>” -директивы <link id="server"/>. +То же, что и параметр “<literal>down</literal>” сервера группы +<link doc="ngx_http_upstream_module.xml" id="down">http</link> +или +<link doc="../stream/ngx_stream_upstream_module.xml" id="down">stream</link>. </tag-desc> <tag-name id="drain"><literal>drain=</literal></tag-name> - <tag-desc> -Переводит сервер группы в режим “draining” (1.7.5). +Переводит сервер группы серверов +<link doc="ngx_http_upstream_module.xml">http</link> +в режим “draining” (1.7.5). В этом режиме на сервер будут проксироваться только -<link id="sticky">привязанные</link> к нему запросы. +<link doc="ngx_http_upstream_module.xml" id="sticky">привязанные</link> +к нему запросы. </tag-desc> <tag-name> <literal>up=</literal></tag-name> <tag-desc> -Параметр, обратный по значению параметру “<literal>down</literal>” -директивы <link id="server"/>. +Параметр, обратный по значению параметру “<literal>down</literal>” сервера группы +<link doc="ngx_http_upstream_module.xml" id="down">http</link> +или +<link doc="../stream/ngx_stream_upstream_module.xml" id="down">stream</link>. </tag-desc> <tag-name> <literal>route=</literal><value>строка</value></tag-name> <tag-desc> -То же, что и параметр “<literal>route</literal>” -директивы <link id="server"/>. +То же, что и параметр “<literal>route</literal>” сервера группы +<link doc="ngx_http_upstream_module.xml" id="route">http</link>. </tag-desc> </list> -Первые два параметра выбирают объект. -Объектом может быть либо группа серверов, либо отдельный сервер. +Первые три параметра выбирают объект. +Объектом может быть либо группа серверов http или stream, +либо отдельный сервер. Если остальные параметры не указаны, то показывается конфигурация выбранной группы или сервера. </para> @@ -1213,176 +259,75 @@ http://127.0.0.1/upstream_conf?upstream= Например, команда для просмотра конфигурации всей группы выглядит следующим образом: <example> -http://127.0.0.1/upstream_conf?upstream=dynamic +http://127.0.0.1/upstream_conf?upstream=backend </example> Для просмотра конфигурации отдельного сервера следует указать его идентификатор: <example> -http://127.0.0.1/upstream_conf?upstream=dynamic&id=42 +http://127.0.0.1/upstream_conf?upstream=backend&id=42 </example> - </para> <para> Для добавления нового сервера в группу следует указать его адрес в параметре “<literal>server=</literal>”. Если остальные параметры не указаны, то при добавлении сервера -их значения будут установлены по умолчанию (см. директиву <link id="server"/>). +их значения будут установлены по умолчанию (см. директиву +“<literal>server</literal>” для +<link doc="ngx_http_upstream_module.xml" id="server">http</link> +или +<link doc="../stream/ngx_stream_upstream_module.xml" id="server">stream</link>). </para> <para> Например, команда для добавления нового основного сервера в группу выглядит следующим образом: <example> -http://127.0.0.1/upstream_conf?add=&upstream=dynamic&server=127.0.0.1:8080 +http://127.0.0.1/upstream_conf?add=&upstream=backend&server=127.0.0.1:8080 </example> Добавление нового запасного сервера происходит следующим образом: <example> -http://127.0.0.1/upstream_conf?add=&upstream=dynamic&backup=&server=127.0.0.1:8080 +http://127.0.0.1/upstream_conf?add=&upstream=backend&backup=&server=127.0.0.1:8080 </example> Добавление нового основного сервера с нестандартными значениями параметров и с пометкой его как постоянно недоступного (“<literal>down</literal>”) происходит следующим образом: <example> -http://127.0.0.1/upstream_conf?add=&upstream=dynamic&server=127.0.0.1:8080&weight=2&down= +http://127.0.0.1/upstream_conf?add=&upstream=backend&server=127.0.0.1:8080&weight=2&down= </example> -</para> -<para> Для удаления сервера следует указать его идентификатор: <example> -http://127.0.0.1/upstream_conf?remove=&upstream=dynamic&id=42 +http://127.0.0.1/upstream_conf?remove=&upstream=backend&id=42 </example> -</para> -<para> Пометка существующего сервера как постоянно недоступного (“<literal>down</literal>”) происходит следующим образом: <example> -http://127.0.0.1/upstream_conf?upstream=dynamic&id=42&down= +http://127.0.0.1/upstream_conf?upstream=backend&id=42&down= </example> Изменение адреса существующего сервера происходит следующим образом: <example> -http://127.0.0.1/upstream_conf?upstream=dynamic&id=42&server=192.0.2.3:8123 +http://127.0.0.1/upstream_conf?upstream=backend&id=42&server=192.0.2.3:8123 </example> Изменение других параметров существующего сервера происходит следующим образом: <example> -http://127.0.0.1/upstream_conf?upstream=dynamic&id=42&max_fails=3&weight=4 +http://127.0.0.1/upstream_conf?upstream=backend&id=42&max_fails=3&weight=4 </example> -</para> - -<para> -<note> -Эта директива доступна как часть -<commercial_version>коммерческой подписки</commercial_version>. -</note> +Вышеприведённые примеры актуальны для группы серверов +<link doc="ngx_http_upstream_module.xml">http</link>. +Аналогичные примеры для группы серверов +<link doc="../stream/ngx_stream_upstream_module.xml">stream</link> +требуют указания параметра “<literal>stream=</literal>”. </para> </directive> </section> - -<section id="variables" name="Встроенные переменные"> - -<para> -Модуль <literal>ngx_http_upstream_module</literal> -поддерживает следующие встроенные переменные: -<list type="tag"> - -<tag-name id="var_upstream_addr"><var>$upstream_addr</var></tag-name> -<tag-desc> -хранит IP-адрес и порт или путь к UNIX-сокету сервера группы. -Если при обработке запроса были сделаны обращения к нескольким серверам, -то их адреса разделяются запятой, например, -“<literal>192.168.1.1:80, 192.168.1.2:80, unix:/tmp/sock</literal>”. -Если произошло внутреннее перенаправление от одной группы серверов на другую -с помощью -<header>X-Accel-Redirect</header> или -<link doc="ngx_http_core_module.xml" id="error_page"/>, -то адреса, соответствующие разным группам серверов, разделяются двоеточием, -например, -“<literal>192.168.1.1:80, 192.168.1.2:80, unix:/tmp/sock : 192.168.10.1:80, 192.168.10.2:80</literal>”. -</tag-desc> - -<tag-name id="var_upstream_cache_status"><var>$upstream_cache_status</var> -</tag-name> -<tag-desc> -хранит статус доступа к кэшу ответов (0.8.3). -Статус может быть одним из “<literal>MISS</literal>”, -“<literal>BYPASS</literal>”, “<literal>EXPIRED</literal>”, -“<literal>STALE</literal>”, “<literal>UPDATING</literal>”, -“<literal>REVALIDATED</literal>” или “<literal>HIT</literal>”. -</tag-desc> - -<tag-name id="var_upstream_cookie_"><var>$upstream_cookie_</var><value>имя</value> -</tag-name> -<tag-desc> -кука с указанным <value>именем</value>, переданная сервером группы -в поле <header>Set-Cookie</header> заголовка ответа (1.7.1). -Необходимо иметь в виду, что куки запоминаются только из ответа -последнего сервера. -</tag-desc> - -<tag-name id="var_upstream_header_time"><var>$upstream_header_time</var> -</tag-name> -<tag-desc> -хранит время, -затраченное на получение заголовка ответа от сервера группы (1.7.10); -время хранится в секундах с точностью до миллисекунд. -Времена нескольких ответов -разделяются запятыми и двоеточиями подобно адресам в переменной -<link id="var_upstream_addr">$upstream_addr</link>. -</tag-desc> - -<tag-name id="var_upstream_http_"><var>$upstream_http_</var><value>имя</value></tag-name> -<tag-desc> -хранят поля заголовка ответа сервера. -Например, поле заголовка ответа <header>Server</header> -доступно в переменной <var>$upstream_http_server</var>. -Правила преобразования имён полей заголовка ответа в имена переменных -такие же, как для переменных с префиксом -“<link doc="ngx_http_core_module.xml" id="var_http_">$http_</link>”. -Необходимо иметь в виду, что поля заголовка запоминаются только из ответа -последнего сервера. -</tag-desc> - -<tag-name id="var_upstream_response_length"><var>$upstream_response_length</var> -</tag-name> -<tag-desc> -хранит длину ответа, полученного от сервера группы (0.7.27); -длина хранится в байтах. -Длины нескольких ответов -разделяются запятыми и двоеточиями подобно адресам в переменной -<link id="var_upstream_addr">$upstream_addr</link>. -</tag-desc> - -<tag-name id="var_upstream_response_time"><var>$upstream_response_time</var> -</tag-name> -<tag-desc> -хранит время, затраченное на получение ответа от сервера группы; -время хранится в секундах с точностью до миллисекунд. -Времена нескольких ответов -разделяются запятыми и двоеточиями подобно адресам в переменной -<link id="var_upstream_addr">$upstream_addr</link>. -</tag-desc> - -<tag-name id="var_upstream_status"><var>$upstream_status</var></tag-name> -<tag-desc> -хранит статус ответа, полученного от сервера группы. -Статусы нескольких ответов -разделяются запятыми и двоеточиями подобно адресам в переменной -<link id="var_upstream_addr">$upstream_addr</link>. -</tag-desc> - -</list> -</para> - -</section> - </module>