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