README
1/==============================================================================\
2| The Wackamole Program. |
3| Copyright (c) 2000-2001 The Johns Hopkins University |
4| All rights reserved. |
5| |
6| Wackamole is developed at the Center for Networking and Distributed Systems, |
7| The Johns Hopkins University. |
8| |
9| The Wackamole package is licensed under the CNDS Open Source License |
10| You may only use this software in compliance with the License. |
11| A copy of the license can be found at |
12| http://www.backhand.org/wackamole/license |
13| |
14| Wackamole development was partially funded by a grant from the Defense |
15| Advanced Research Projects Agency (DARPA) to Johns Hopkins University. The |
16| U.S. Government retains certain rights in this software. |
17| |
18| This product uses the Spread toolkit, developed by Spread Concepts LLC. |
19| For more information about Spread see http://www.spread.org |
20| |
21| This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF |
22| ANY KIND, either express or implied. |
23| |
24| Creators: |
25| Yair Amir yairamir@cnds.jhu.edu |
26| Ryan Caudy wyvern@cnds.jhu.edu |
27| Aashima Munjal munjal@jhu.edu |
28| Theo Schlossnagle jesus@cnds.jhu.edu |
29| |
30| For a full list of contributors, see Readme.txt in the distribution. |
31| |
32| WWW: www.backhand.org www.cnds.jhu.edu bsdforge.com |
33| Contact: wackamole@backhand.org |
34| |
35| Version 2.1.5 Built 05/06/2014 |
36| |
37\==============================================================================/
38
39OVERVIEW
40
41Wackamole
42
43Wackamole is an application that helps with making a cluster highly available.
44It uses the membership notifications provided by the Spread toolkit to generate
45a consistent state that is agreed upon among all of the connected Wackamole
46instances. Wackamole uses this knowledge to ensure that all of the public IP
47addresses served by the cluster will be covered by exactly one Wackamole
48instance.
49
50Wackamole works towards achieving a balanced distribution of the clusters IP
51space between its instances. First, each instance immediately claims its
52preferred IP address. Then, if the number of virtual IP addresses acquired by
53any two machines does differ by more than one, Wackamole will work towards
54making the them differ by one or less. Wackamole has the ability to balance
55all the IP addresses at once or do it gradually.
56
57
58
59SOURCE INSTALL
60
61You will need The Spread Tookit to build wackamole
62
631) Download the Spread Toolkit from www.spread.org and install it.
64
652) Either add the spread header files (found in the include directory
66 in the spread download) and libsp.a for your architecture to the
67 wackamole directory, or pass CPPFLAGS and LDFLAGS to configure:
68
69 Assuming that your spread is installed somewhere odd like: /opt/spread
70
71 ./configure --with-cppflags=-I/opt/spread/include \
72 --with-ldflags=-L/opt/spread/lib
73
74 Assuming that your spread is installed is /usr/local
75
76 ./configure --with-cppflags=-I/usr/local/include \
77 --with-ldflags=-L/usr/local/lib
78
793) Run ./configure with the appropriate parameters.
80
814) Type "make all" and you should have a wackamole binary
82
835) Type "make install" and it will install the distribution.
84
85Configuration
86
87You will need to have a valid configuration file for wackamole. Read
88the sample wackamole.conf and create your own, or just modify it for
89your cluster. You can use --sysconfdir=<path to wackamole.conf> as a
90paramater for ./configure to specify the path to the configuration file.
91
92To run wackamole, you will need to have a Spread deamon running. If the
93Spread deamon is not at its default port 4803, you will need to say
94/path/to/wackamole -s <port number>
95
96
97Wackamole WILL ONLY run as "root" or superuser because it needs to aquire
98IP addresses.
99
100Number of virtual IPs that wackamole manages can be less than number of
101machines that wackamole manages if some machines have config vip 0.0.0.0
102