r5198 - trunk/varnish-cache/doc/sphinx/reference

[perbu at varnish-cache.org]

Author: perbu
Date: 2010-09-13 16:14:40 +0200 (Mon, 13 Sep 2010)
New Revision: 5198

Modified:
   trunk/varnish-cache/doc/sphinx/reference/vcl.rst
Log:
fleshed out the directors a bit more. unsure about if the hash/client dir take the retries parameter

Modified: trunk/varnish-cache/doc/sphinx/reference/vcl.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/reference/vcl.rst	2010-09-13 10:51:45 UTC (rev 5197)
+++ trunk/varnish-cache/doc/sphinx/reference/vcl.rst	2010-09-13 14:14:40 UTC (rev 5198)
@@ -103,12 +103,16 @@
 Directors
 ---------
 
-Directors choose from different backends based on health status and a
-per-director algorithm.  There currently exists a round-robin and a
-random director.
+A director is a logical group of backend servers clustered together
+for redundancy. The basic role of the director is to let Varnish
+choose a backend server amongst several so if one is down another can
+be used.
 
-Directors are defined using:::
+There are several types of directors. The different director types
+use different algorithms to choose which backend to use.
 
+Configuring a director may look like this:::
+
   director b2 random {
     .retries = 5;
     {
@@ -152,8 +156,12 @@
 Note: in 2.1 *client.identity* isn't available and the director will
 use client.ip to distribute clients across backends.
 
-The client director takes no options.
+The client director takes one option - *retries* which set the number
+of retries the director should take in order to find a healthy
+backend.
 
+
+
 The hash director
 ~~~~~~~~~~~~~~~~~
 
@@ -164,7 +172,9 @@
 other Varnish caches or other web accelerators as objects won't be
 duplicated across caches.
 
-The hash director takes no options.
+The client director takes one option - *retries* which set the number
+of retries the director should take in order to find a healthy
+backend.
 
 The DNS director
 ~~~~~~~~~~~~~~~~