comparison xml/en/docs/http/ngx_http_upstream_module.xml @ 955:28d580f1eb63

Documented the "slow_start" parameter of the upstream "server" directive.
author Vladimir Homutov <vl@nginx.com>
date Fri, 02 Aug 2013 13:01:50 +0400
parents aded7086e84f
children 488a3f738db0
comparison
equal deleted inserted replaced
954:d4fb95e6067c 955:28d580f1eb63
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_upstream_module" 10 <module name="Module ngx_http_upstream_module"
11 link="/en/docs/http/ngx_http_upstream_module.html" 11 link="/en/docs/http/ngx_http_upstream_module.html"
12 lang="en" 12 lang="en"
13 rev="5"> 13 rev="6">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_upstream_module</literal> module 18 The <literal>ngx_http_upstream_module</literal> module
52 <example> 52 <example>
53 upstream <emphasis>appservers</emphasis> { 53 upstream <emphasis>appservers</emphasis> {
54 zone appservers 64k; 54 zone appservers 64k;
55 55
56 server appserv1.example.com weight=5; 56 server appserv1.example.com weight=5;
57 server appserv2.example.com:8080 fail_timeout=5s; 57 server appserv2.example.com:8080 fail_timeout=5s slow_start=30s;
58 server 192.0.2.1 max_fails=3; 58 server 192.0.2.1 max_fails=3;
59 59
60 server reserve1.example.com:8080 backup; 60 server reserve1.example.com:8080 backup;
61 server reserve2.example.com:8080 backup; 61 server reserve2.example.com:8080 backup;
62 } 62 }
177 177
178 </list> 178 </list>
179 By default, timeout is set to 10 seconds. 179 By default, timeout is set to 10 seconds.
180 </tag-desc> 180 </tag-desc>
181 181
182 <tag-name><literal>slow_start</literal>=<value>time</value></tag-name>
183 <tag-desc>
184 sets the <value>time</value> during which the server will recover its weight
185 from zero to a nominal value, when unhealthy server becomes
186 <link id="health_check">healthy</link>,
187 or when the server becomes available after a period of time
188 it was considered down.
189 Default value is zero, i.e. slow start is disabled.
190 <note>
191 This functionality is available as part of our <commercial_version/> only.
192 </note>
193 </tag-desc>
194
182 <tag-name><literal>backup</literal></tag-name> 195 <tag-name><literal>backup</literal></tag-name>
183 <tag-desc> 196 <tag-desc>
184 marks the server as a backup server. 197 marks the server as a backup server.
185 It will be passed requests when the primary servers are down. 198 It will be passed requests when the primary servers are down.
186 </tag-desc> 199 </tag-desc>
929 942
930 <tag-name> 943 <tag-name>
931 <literal>fail_timeout=</literal><value>time</value></tag-name> 944 <literal>fail_timeout=</literal><value>time</value></tag-name>
932 <tag-desc> 945 <tag-desc>
933 Same as the “<literal>fail_timeout</literal>” parameter 946 Same as the “<literal>fail_timeout</literal>” parameter
947 of the <link id="server"/> directive.
948 </tag-desc>
949
950 <tag-name>
951 <literal>slow_start=</literal><value>time</value></tag-name>
952 <tag-desc>
953 Same as the “<literal>slow_start</literal>” parameter
934 of the <link id="server"/> directive. 954 of the <link id="server"/> directive.
935 </tag-desc> 955 </tag-desc>
936 956
937 <tag-name> 957 <tag-name>
938 <literal>down=</literal></tag-name> 958 <literal>down=</literal></tag-name>