Move ganeti-noded to ganeti.server.noded
[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 - `ndisc6 <http://www.remlab.net/ndisc6/>`_ (if using IPv6)
28 - `Python <http://www.python.org/>`_, version 2.4 or above, not 3.0
29 - `Python OpenSSL bindings <http://pyopenssl.sourceforge.net/>`_
30 - `simplejson Python module <http://code.google.com/p/simplejson/>`_
31 - `pyparsing Python module <http://pyparsing.wikispaces.com/>`_
32 - `pyinotify Python module <http://trac.dbzteam.org/pyinotify/>`_
33 - `PycURL Python module <http://pycurl.sourceforge.net/>`_
34 - `ctypes Python module
35   <http://starship.python.net/crew/theller/ctypes/>`_, if running on
36   python 2.4 (optional, used for node daemon memory locking)
37 - `socat <http://www.dest-unreach.org/socat/>`_
38 - `Paramiko <http://www.lag.net/paramiko/>`_, if you want automated SSH
39   setup; optional otherwise but manual setup of the nodes required
40
41 These programs are supplied as part of most Linux distributions, so
42 usually they can be installed via the standard package manager. Also
43 many of them will already be installed on a standard machine. On
44 Debian/Ubuntu, you can use this command line to install all required
45 packages, except for DRBD and Xen::
46
47   $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
48                     ndisc6 python python-pyopenssl openssl \
49                     python-pyparsing python-simplejson \
50                     python-pyinotify python-pycurl socat
51
52 If you want to build from source, please see doc/devnotes.rst for more
53 dependencies.
54
55
56 Installation of the software
57 ----------------------------
58
59 To install, simply run the following command::
60
61   ./configure --localstatedir=/var --sysconfdir=/etc && \
62   make && \
63   make install
64
65 This will install the software under ``/usr/local``. You then need to
66 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
67 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
68 etc.).
69
70
71 Cluster initialisation
72 ----------------------
73
74 Before initialising the cluster, on each node you need to create the
75 following directories:
76
77 - ``/etc/ganeti``
78 - ``/var/lib/ganeti``
79 - ``/var/log/ganeti``
80 - ``/srv/ganeti``
81 - ``/srv/ganeti/os``
82 - ``/srv/ganeti/export``
83
84 After this, use ``gnt-cluster init``.
85
86 .. vim: set textwidth=72 syntax=rst :
87 .. Local Variables:
88 .. mode: rst
89 .. fill-column: 72
90 .. End: