Document the default instance allocator in gnt-cluster.sgml
[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
38 These programs are supplied as part of most Linux distributions, so
39 usually they can be installed via the standard package manager. Also
40 many of them will already be installed on a standard machine. On
41 Debian/Ubuntu, you can use this command line to install all required
42 packages, except for DRBD and Xen::
43
44   $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
45                     python python-pyopenssl openssl python-pyparsing \
46                     python-simplejson python-pyinotify python-pycurl \
47                     socat
48
49 If you want to build from source, please see doc/devnotes.rst for more
50 dependencies.
51
52
53 Installation of the software
54 ----------------------------
55
56 To install, simply run the following command::
57
58   ./configure --localstatedir=/var --sysconfdir=/etc && \
59   make && \
60   make install
61
62 This will install the software under ``/usr/local``. You then need to
63 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
64 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
65 etc.).
66
67
68 Cluster initialisation
69 ----------------------
70
71 Before initialising the cluster, on each node you need to create the
72 following directories:
73
74 - ``/etc/ganeti``
75 - ``/var/lib/ganeti``
76 - ``/var/log/ganeti``
77 - ``/srv/ganeti``
78 - ``/srv/ganeti/os``
79 - ``/srv/ganeti/export``
80
81 After this, use ``gnt-cluster init``.
82
83 .. vim: set textwidth=72 syntax=rst :
84 .. Local Variables:
85 .. mode: rst
86 .. fill-column: 72
87 .. End: