changeset 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 d4fb95e6067c
children 488a3f738db0
files xml/en/docs/http/ngx_http_upstream_module.xml
diffstat 1 files changed, 22 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_upstream_module.xml	Fri Aug 02 08:07:40 2013 +0000
+++ b/xml/en/docs/http/ngx_http_upstream_module.xml	Fri Aug 02 13:01:50 2013 +0400
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_upstream_module"
         link="/en/docs/http/ngx_http_upstream_module.html"
         lang="en"
-        rev="5">
+        rev="6">
 
 <section id="summary">
 
@@ -54,7 +54,7 @@
     zone appservers 64k;
 
     server appserv1.example.com      weight=5;
-    server appserv2.example.com:8080 fail_timeout=5s;
+    server appserv2.example.com:8080 fail_timeout=5s slow_start=30s;
     server 192.0.2.1                 max_fails=3;
 
     server reserve1.example.com:8080 backup;
@@ -179,6 +179,19 @@
 By default, timeout is set to 10 seconds.
 </tag-desc>
 
+<tag-name><literal>slow_start</literal>=<value>time</value></tag-name>
+<tag-desc>
+sets the <value>time</value> during which the server will recover its weight
+from zero to a nominal value, when unhealthy server becomes
+<link id="health_check">healthy</link>,
+or when the server becomes available after a period of time
+it was considered down.
+Default value is zero, i.e. slow start is disabled.
+<note>
+This functionality is available as part of our <commercial_version/> only.
+</note>
+</tag-desc>
+
 <tag-name><literal>backup</literal></tag-name>
 <tag-desc>
 marks the server as a backup server.
@@ -935,6 +948,13 @@
 </tag-desc>
 
 <tag-name>
+<literal>slow_start=</literal><value>time</value></tag-name>
+<tag-desc>
+Same as the “<literal>slow_start</literal>” parameter
+of the <link id="server"/> directive.
+</tag-desc>
+
+<tag-name>
 <literal>down=</literal></tag-name>
 <tag-desc>
 Same as the “<literal>down</literal>” parameter