Better text
[freeradius.git] / doc / load-balance.txt
1   As of version 1.1.0, FreeRADIUS supports load balancing in module
2 sections.  Please see the "configurable_failover" file in this
3 directory for a more complete description of module sections.
4
5   The short summary is that you can use a "load-balance" section in
6 any place where a module name may be used.  The semantics of the
7 "load-balance" section are that one of the modules in the section will
8 be chosen at random, evenly spread over the modules in the list.
9
10   An example is below:
11
12 accounting {
13         load-balance {
14                 sql1
15                 sql2
16                 sql2
17         }
18 }
19
20   In this case, 1/3 of the RADIUS requests will be processed by
21 "sql1", one third by "sql2", and 1/3 by "sql3".
22
23   The "load-balance" section can be nested in a "redundant" section,
24 or vice-versa:
25
26 accounting {
27         load-balance {          # between two redundant sections below
28                 redundant {
29                         sql1
30                         sql2
31                 }
32                 redundant {
33                         sql2
34                         sql1
35                 }
36         }
37 }
38
39   This says "load balance between sql1 and sql2, but if sql1 is down,
40 use sql2, and if sql2 is down, use sql1".  That way, you can guarantee
41 both that load balancing occurs, and that the requests are *always*
42 logged to one of the databases.
43
44 accounting {
45         redundant {
46                 load-balance {
47                         sql1
48                         sql2
49                 }
50                 detail
51         }
52 }
53
54   This says "load balance between sql1 and sql2, but if the one being
55 used is down, then log to detail".
56
57   And finally,
58
59 accounting {
60         redundant {                     # between load-balance & detail
61                 load-balance {          # between two redundant sections
62                         redundant {
63                                 sql1
64                                 sql2
65                         }
66                         redundant {
67                                 sql2
68                                 sql1
69                         }
70                 }
71                 detail
72         }
73 }
74
75 This says "try to load balance between sql1 and sql2; if sql1 is down,
76 use sql2; if sql2 is down use sql1; if both sql1 and sql2 are down,
77 then log to the detail file"
78
79
80 ----------------------------------------------------------------------
81 $Id$