Adding new (optional) dependency to configure.ac
[ganeti-local] / INSTALL
1 Ganeti quick installation guide
2 ===============================
3
4 Please note that a more detailed installation procedure is described in
5 the :doc:`install`. A glossary of terms can be found in the
6 :doc:`glossary`.
7
8
9 Software Requirements
10 ---------------------
11
12 Before installing, please verify that you have the following programs:
13
14 - `Xen Hypervisor <http://www.xen.org/>`_, version 3.0 or above, if
15   running on Xen
16 - `KVM Hypervisor <http://www.linux-kvm.org>`_, version 72 or above, if
17   running on KVM. In order to use advanced features, such as live
18   migration, virtio, etc, an even newer version is recommended (qemu-kvm
19   versions 0.11.X or above have shown good behavior).
20 - `DRBD <http://www.drbd.org/>`_, kernel module and userspace utils,
21   version 8.0.7 or above
22 - `LVM2 <http://sourceware.org/lvm2/>`_
23 - `OpenSSH <http://www.openssh.com/portable.html>`_
24 - `bridge utilities <http://www.linuxfoundation.org/en/Net:Bridge>`_
25 - `iproute2 <http://www.linuxfoundation.org/en/Net:Iproute2>`_
26 - `arping <http://www.skbuff.net/iputils/>`_ (part of iputils)
27 - `Python <http://www.python.org/>`_, version 2.4 or above, not 3.0
28 - `Python OpenSSL bindings <http://pyopenssl.sourceforge.net/>`_
29 - `simplejson Python module <http://code.google.com/p/simplejson/>`_
30 - `pyparsing Python module <http://pyparsing.wikispaces.com/>`_
31 - `pyinotify Python module <http://trac.dbzteam.org/pyinotify/>`_
32 - `PycURL Python module <http://pycurl.sourceforge.net/>`_
33 - `ctypes Python module
34   <http://starship.python.net/crew/theller/ctypes/>`_, if running on
35   python 2.4 (optional, used for node daemon memory locking)
36 - `socat <http://www.dest-unreach.org/socat/>`_
37 - `Paramiko <http://www.lag.net/paramiko/>`_, if you want automated SSH
38   setup; optional otherwise but manual setup of the nodes required
39
40 These programs are supplied as part of most Linux distributions, so
41 usually they can be installed via the standard package manager. Also
42 many of them will already be installed on a standard machine. On
43 Debian/Ubuntu, you can use this command line to install all required
44 packages, except for DRBD and Xen::
45
46   $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
47                     python python-pyopenssl openssl python-pyparsing \
48                     python-simplejson python-pyinotify python-pycurl \
49                     socat
50
51 If you want to build from source, please see doc/devnotes.rst for more
52 dependencies.
53
54
55 Installation of the software
56 ----------------------------
57
58 To install, simply run the following command::
59
60   ./configure --localstatedir=/var --sysconfdir=/etc && \
61   make && \
62   make install
63
64 This will install the software under ``/usr/local``. You then need to
65 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
66 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
67 etc.).
68
69
70 Cluster initialisation
71 ----------------------
72
73 Before initialising the cluster, on each node you need to create the
74 following directories:
75
76 - ``/etc/ganeti``
77 - ``/var/lib/ganeti``
78 - ``/var/log/ganeti``
79 - ``/srv/ganeti``
80 - ``/srv/ganeti/os``
81 - ``/srv/ganeti/export``
82
83 After this, use ``gnt-cluster init``.
84
85 .. vim: set textwidth=72 syntax=rst :
86 .. Local Variables:
87 .. mode: rst
88 .. fill-column: 72
89 .. End: