gnt-instance info: sort the hv parameters
[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.x or 3.1
15 - `DRBD <http://www.drbd.org/>`_, kernel module and userspace utils,
16   version 8.0.7 or above
17 - `LVM2 <http://sourceware.org/lvm2/>`_
18 - `OpenSSL <http://www.openssl.org/>`_
19 - `OpenSSH <http://www.openssh.com/portable.html>`_
20 - `bridge utilities <http://www.linuxfoundation.org/en/Net:Bridge>`_
21 - `iproute2 <http://www.linuxfoundation.org/en/Net:Iproute2>`_
22 - `arping <http://www.skbuff.net/iputils/>`_ (part of iputils)
23 - `Python <http://www.python.org/>`_, version 2.4 or above, not 3.0
24 - `Python OpenSSL bindings <http://pyopenssl.sourceforge.net/>`_
25 - `simplejson Python module <http://code.google.com/p/simplejson/>`_
26 - `pyparsing Python module <http://pyparsing.wikispaces.com/>`_
27 - `pyinotify Python module <http://trac.dbzteam.org/pyinotify/>`_
28 - `socat <http://www.dest-unreach.org/socat/>`_
29
30 These programs are supplied as part of most Linux distributions, so
31 usually they can be installed via the standard package manager. Also
32 many of them will already be installed on a standard machine. On
33 Debian/Ubuntu, you can use this command line to install all required
34 packages, except for DRBD and Xen::
35
36   $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
37                     python python-pyopenssl openssl python-pyparsing \
38                     python-simplejson python-pyinotify socat
39
40 If you want to build from source, please see doc/devnotes.rst for more
41 dependencies.
42
43
44 Installation of the software
45 ----------------------------
46
47 To install, simply run the following command::
48
49   ./configure --localstatedir=/var --sysconfdir=/etc && \
50   make && \
51   make install
52
53 This will install the software under ``/usr/local``. You then need to
54 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
55 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
56 etc.).
57
58
59 Cluster initialisation
60 ----------------------
61
62 Before initialising the cluster, on each node you need to create the
63 following directories:
64
65 - ``/etc/ganeti``
66 - ``/var/lib/ganeti``
67 - ``/var/log/ganeti``
68 - ``/srv/ganeti``
69 - ``/srv/ganeti/os``
70 - ``/srv/ganeti/export``
71
72 After this, use ``gnt-cluster init``.
73
74 .. vim: set textwidth=72 syntax=rst :
75 .. Local Variables:
76 .. mode: rst
77 .. fill-column: 72
78 .. End: