Fix capitalization.
[ganeti-local] / INSTALL
1 Documentation
2 =============
3
4 Please note that a more detailed installation procedure is described in the
5 docs/install.html file. A glossary of terms exists in the docs/admin.html file.
6
7
8 Software Requirements
9 =====================
10
11 Before installing, please verify that you have the following programs:
12   - Xen virtualization (version 3.0.x or 3.1)
13     http://xen.xensource.com/
14   - DRBD (kernel module and userspace utils)
15     http://www.drbd.org/
16   - LVM2
17     http://sourceware.org/lvm2/
18   - OpenSSL
19     http://www.openssl.org/
20   - OpenSSH
21     http://www.openssh.com/portable.html
22   - bridge utilities
23     http://bridge.sourceforge.net/
24   - fping
25     http://fping.sourceforge.net/
26   - iproute2
27     http://developer.osdl.org/dev/iproute2
28   - arping (part of iputils package)
29     ftp://ftp.inr.ac.ru/ip-routing/iputils-current.tar.gz
30   - mdadm (Linux Software Raid tools)
31     http://www.kernel.org/pub/linux/utils/raid/mdadm/
32   - Python 2.4
33     http://www.python.org
34   - Python Twisted library (the core is enough)
35     http://twistedmatrix.com/
36   - Python OpenSSL bindings
37     http://pyopenssl.sourceforge.net/
38
39 For testing, you also need the YAML module for Python (http://pyyaml.org/).
40
41 For building from source, you also need tar, gzip or bzip2 and make.
42
43
44 Installation of the software
45 ============================
46
47 To install, simply do ``./configure --localstatedir=/var && make && make install``
48
49 This will install the software under /usr/local. You then need to copy
50 ganeti.init to /etc/init.d/ganeti and integrate it into your boot sequence
51 (``chkconfig``, ``update-rc.d``, etc.).
52
53
54 Cluster initialisation
55 ======================
56
57 Before initialising the cluster, on each node you need to create the following
58 directories:
59
60   - /etc/ganeti
61   - /srv/ganeti, /srv/ganeti/os, /srv/ganeti/export
62
63 After this, use ``gnt-cluster init``.