Mercurial > hg > nginx-site

comparison xml/ru/docs/http/ngx_http_upstream_conf_module.xml @ 1450:f5b5eefc43cb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
1449:c79501e16e26 1450:f5b5eefc43cb
1 <?xml version="1.0"?>
2
3 <!--
4 Copyright (C) Nginx, Inc.
5 -->
6
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8
9 <module name="Модуль ngx_http_upstream_conf_module"
10 link="/ru/docs/http/ngx_http_upstream_conf_module.html"
11 lang="ru"
12 rev="1">
13
14 <section id="summary">
15
16 <para>
17 Модуль <literal>ngx_http_upstream_conf_module</literal>
18 позволяет оперативно настраивать группы серверов
19 при помощи простого HTTP-интерфейса без необходимости перезапуска nginx.
20 Группа серверов
21 <link doc="ngx_http_upstream_module.xml" id="zone">http</link>
22 или
23 <link doc="../stream/ngx_stream_upstream_module.xml" id="zone">stream</link>
24 должна находиться в разделяемой памяти.
25 </para>
26
27 </section>
28
29
30 <section id="example" name="Пример конфигурации">
31
32 <para>
33 <example>
34 upstream backend {
35 zone upstream_backend 64k;
36
37 ...
38 }
39
40 server {
41 location /upstream_conf {
42 <emphasis>upstream_conf</emphasis>;
43 allow 127.0.0.1;
44 deny all;
45 }
46 }
47 </example>
48 </para>
49
50 </section>
51
52
53 <section id="directives" name="Директивы">
54
55 <directive name="upstream_conf">
56 <syntax/>
57 <default/>
58 <context>location</context>
59
60 <para>
61 Активирует HTTP-интерфейс для настройки групп серверов в содержащем location.
62 Доступ в location следует
63 <link doc="ngx_http_core_module.xml" id="satisfy">ограничить</link>.
64 </para>
65
66 <para>
67 С помощью команд настройки можно:
68 <list type="bullet">
69
70 <listitem>просматривать конфигурацию группы;</listitem>
71
72 <listitem>
73 просматривать или изменять конфигурацию, а также
74 удалять серверы;
75 </listitem>
76
77 <listitem>добавлять новые серверы.</listitem>
78
79 </list>
80 <note>
81 Поскольку адреса в группе не обязаны быть уникальными,
82 обращение к отдельным серверам в группе осуществляется по их идентификаторам.
83 Идентификаторы назначаются автоматически и показываются при добавлении сервера
84 или просмотре конфигурации группы.
85 </note>
86 </para>
87
88 <para>
89 Команда настройки состоит из параметров, передаваемых в аргументах запроса,
90 например:
91 <example>
92 http://127.0.0.1/upstream_conf?upstream=backend
93 </example>
94 </para>
95
96 <para>
97 Поддерживаются следующие параметры:
98
99 <list type="tag" compact="no">
100
101 <tag-name>
102 <literal>stream=</literal></tag-name>
103 <tag-desc>
104 Выбирает группу серверов
105 <link doc="../stream/ngx_stream_upstream_module.xml">stream</link>.
106 Если параметр не задан, будет выбрана группа серверов
107 <link doc="ngx_http_upstream_module.xml">http</link>.
108 </tag-desc>
109
110 <tag-name>
111 <literal>upstream=</literal><value>имя</value></tag-name>
112 <tag-desc>
113 Выбирает группу серверов для работы.
114 Параметр является обязательным.
115 </tag-desc>
116
117 <tag-name>
118 <literal>id=</literal><value>число</value></tag-name>
119 <tag-desc>
120 Выбирает сервер для просмотра, изменения или удаления.
121 </tag-desc>
122
123 <tag-name>
124 <literal>remove=</literal></tag-name>
125 <tag-desc>
126 Удаляет сервер из группы.
127 </tag-desc>
128
129 <tag-name>
130 <literal>add=</literal></tag-name>
131 <tag-desc>
132 Добавляет новый сервер в группу.
133 </tag-desc>
134
135 <tag-name>
136 <literal>backup=</literal></tag-name>
137 <tag-desc>
138 Необходим для добавления запасного сервера.
139 <note>
140 До версии 1.7.2 параметр <literal>backup=</literal> требовался
141 также для просмотра, изменения или удаления существующих запасных серверов.
142 </note>
143 </tag-desc>
144
145 <tag-name>
146 <literal>server=</literal><value>адрес</value></tag-name>
147 <tag-desc>
148 То же, что и параметр “<literal>адрес</literal>” сервера группы
149 <link doc="ngx_http_upstream_module.xml" id="server">http</link>
150 или
151 <link doc="../stream/ngx_stream_upstream_module.xml" id="server">stream</link>.
152 <para>
153 При добавлении сервер можно задать в виде доменного имени.
154 В этом случае любые изменения IP-адресов, соответствующих доменному имени
155 сервера, отслеживаются и автоматически применяются к конфигурации группы
156 без необходимости перезапуска nginx (1.7.2).
157 Для этого в блоке
158 <link doc="ngx_http_core_module.xml" id="resolver">http</link>
159 или
160 <link doc="../stream/ngx_stream_core_module.xml" id="resolver">stream</link>
161 должна быть задана директива “<literal>resolver</literal>”.
162 См. также параметр “<literal>resolve</literal>” сервера группы
163 <link doc="ngx_http_upstream_module.xml" id="resolve">http</link>
164 или
165 <link doc="../stream/ngx_stream_upstream_module.xml" id="resolve">stream</link>.
166 </para>
167 </tag-desc>
168
169 <tag-name>
170 <literal>weight=</literal><value>число</value></tag-name>
171 <tag-desc>
172 То же, что и параметр “<literal>weight</literal>” сервера группы
173 <link doc="ngx_http_upstream_module.xml" id="weight">http</link>
174 или
175 <link doc="../stream/ngx_stream_upstream_module.xml" id="weight">stream</link>.
176 </tag-desc>
177
178 <tag-name>
179 <literal>max_conns=</literal><value>число</value></tag-name>
180 <tag-desc>
181 То же, что и параметр “<literal>max_conns</literal>” сервера группы
182 <link doc="ngx_http_upstream_module.xml" id="max_conns">http</link>
183 или
184 <link doc="../stream/ngx_stream_upstream_module.xml" id="max_conns">stream</link>.
185 </tag-desc>
186
187 <tag-name>
188 <literal>max_fails=</literal><value>число</value></tag-name>
189 <tag-desc>
190 То же, что и параметр “<literal>max_fails</literal>” сервера группы
191 <link doc="ngx_http_upstream_module.xml" id="max_fails">http</link>
192 или
193 <link doc="../stream/ngx_stream_upstream_module.xml" id="max_fails">stream</link>.
194 </tag-desc>
195
196 <tag-name>
197 <literal>fail_timeout=</literal><value>время</value></tag-name>
198 <tag-desc>
199 То же, что и параметр “<literal>fail_timeout</literal>” сервера группы
200 <link doc="ngx_http_upstream_module.xml" id="fail_timeout">http</link>
201 или
202 <link doc="../stream/ngx_stream_upstream_module.xml" id="fail_timeout">stream</link>.
203 </tag-desc>
204
205 <tag-name>
206 <literal>slow_start=</literal><value>время</value></tag-name>
207 <tag-desc>
208 То же, что и параметр “<literal>slow_start</literal>” сервера группы
209 <link doc="ngx_http_upstream_module.xml" id="slow_start">http</link>
210 или
211 <link doc="../stream/ngx_stream_upstream_module.xml" id="slow_start">stream</link>.
212 </tag-desc>
213
214 <tag-name>
215 <literal>down=</literal></tag-name>
216 <tag-desc>
217 То же, что и параметр “<literal>down</literal>” сервера группы
218 <link doc="ngx_http_upstream_module.xml" id="down">http</link>
219 или
220 <link doc="../stream/ngx_stream_upstream_module.xml" id="down">stream</link>.
221 </tag-desc>
222
223 <tag-name id="drain"><literal>drain=</literal></tag-name>
224 <tag-desc>
225 Переводит сервер группы серверов
226 <link doc="ngx_http_upstream_module.xml">http</link>
227 в режим “draining” (1.7.5).
228 В этом режиме на сервер будут проксироваться только
229 <link doc="ngx_http_upstream_module.xml" id="sticky">привязанные</link>
230 к нему запросы.
231 </tag-desc>
232
233 <tag-name>
234 <literal>up=</literal></tag-name>
235 <tag-desc>
236 Параметр, обратный по значению параметру “<literal>down</literal>” сервера группы
237 <link doc="ngx_http_upstream_module.xml" id="down">http</link>
238 или
239 <link doc="../stream/ngx_stream_upstream_module.xml" id="down">stream</link>.
240 </tag-desc>
241
242 <tag-name>
243 <literal>route=</literal><value>строка</value></tag-name>
244 <tag-desc>
245 То же, что и параметр “<literal>route</literal>” сервера группы
246 <link doc="ngx_http_upstream_module.xml" id="route">http</link>.
247 </tag-desc>
248
249 </list>
250
251 Первые три параметра выбирают объект.
252 Объектом может быть либо группа серверов http или stream,
253 либо отдельный сервер.
254 Если остальные параметры не указаны, то показывается конфигурация выбранной
255 группы или сервера.
256 </para>
257
258 <para>
259 Например, команда для просмотра конфигурации всей группы
260 выглядит следующим образом:
261 <example>
262 http://127.0.0.1/upstream_conf?upstream=backend
263 </example>
264
265 Для просмотра конфигурации отдельного сервера следует указать его идентификатор:
266 <example>
267 http://127.0.0.1/upstream_conf?upstream=backend&amp;id=42
268 </example>
269 </para>
270
271 <para>
272 Для добавления нового сервера в группу
273 следует указать его адрес в параметре “<literal>server=</literal>”.
274 Если остальные параметры не указаны, то при добавлении сервера
275 их значения будут установлены по умолчанию (см. директиву
276 “<literal>server</literal>” для
277 <link doc="ngx_http_upstream_module.xml" id="server">http</link>
278 или
279 <link doc="../stream/ngx_stream_upstream_module.xml" id="server">stream</link>).
280 </para>
281
282 <para>
283 Например, команда для добавления нового основного сервера в группу
284 выглядит следующим образом:
285 <example>
286 http://127.0.0.1/upstream_conf?add=&amp;upstream=backend&amp;server=127.0.0.1:8080
287 </example>
288
289 Добавление нового запасного сервера происходит следующим образом:
290 <example>
291 http://127.0.0.1/upstream_conf?add=&amp;upstream=backend&amp;backup=&amp;server=127.0.0.1:8080
292 </example>
293
294 Добавление нового основного сервера с нестандартными
295 значениями параметров и с пометкой его как постоянно недоступного
296 (“<literal>down</literal>”) происходит следующим образом:
297 <example>
298 http://127.0.0.1/upstream_conf?add=&amp;upstream=backend&amp;server=127.0.0.1:8080&amp;weight=2&amp;down=
299 </example>
300
301 Для удаления сервера следует указать его идентификатор:
302 <example>
303 http://127.0.0.1/upstream_conf?remove=&amp;upstream=backend&amp;id=42
304 </example>
305
306 Пометка существующего сервера как постоянно недоступного
307 (“<literal>down</literal>”) происходит следующим образом:
308 <example>
309 http://127.0.0.1/upstream_conf?upstream=backend&amp;id=42&amp;down=
310 </example>
311
312 Изменение адреса существующего сервера происходит следующим образом:
313 <example>
314 http://127.0.0.1/upstream_conf?upstream=backend&amp;id=42&amp;server=192.0.2.3:8123
315 </example>
316
317 Изменение других параметров существующего сервера происходит следующим образом:
318 <example>
319 http://127.0.0.1/upstream_conf?upstream=backend&amp;id=42&amp;max_fails=3&amp;weight=4
320 </example>
321
322 Вышеприведённые примеры актуальны для группы серверов
323 <link doc="ngx_http_upstream_module.xml">http</link>.
324 Аналогичные примеры для группы серверов
325 <link doc="../stream/ngx_stream_upstream_module.xml">stream</link>
326 требуют указания параметра “<literal>stream=</literal>”.
327 </para>
328
329 </directive>
330
331 </section>
332
333 </module>