Statistics
| Branch: | Tag: | Revision:

root / INSTALL @ 0b71067a

History | View | Annotate | Download (5.8 kB)

1 c27ba1cc Michael Hanselmann
Ganeti quick installation guide
2 c27ba1cc Michael Hanselmann
===============================
3 4096472d Iustin Pop
4 c27ba1cc Michael Hanselmann
Please note that a more detailed installation procedure is described in
5 c27ba1cc Michael Hanselmann
the :doc:`install`. A glossary of terms can be found in the
6 c27ba1cc Michael Hanselmann
:doc:`glossary`.
7 4096472d Iustin Pop
8 4096472d Iustin Pop
9 bd785ecd Michael Hanselmann
Software Requirements
10 c27ba1cc Michael Hanselmann
---------------------
11 a8083063 Iustin Pop
12 a8083063 Iustin Pop
Before installing, please verify that you have the following programs:
13 c27ba1cc Michael Hanselmann
14 c4b2b2e2 Guido Trotter
- `Xen Hypervisor <http://www.xen.org/>`_, version 3.0 or above, if
15 c4b2b2e2 Guido Trotter
  running on Xen
16 c4b2b2e2 Guido Trotter
- `KVM Hypervisor <http://www.linux-kvm.org>`_, version 72 or above, if
17 c4b2b2e2 Guido Trotter
  running on KVM. In order to use advanced features, such as live
18 c4b2b2e2 Guido Trotter
  migration, virtio, etc, an even newer version is recommended (qemu-kvm
19 c4b2b2e2 Guido Trotter
  versions 0.11.X or above have shown good behavior).
20 c27ba1cc Michael Hanselmann
- `DRBD <http://www.drbd.org/>`_, kernel module and userspace utils,
21 c27ba1cc Michael Hanselmann
  version 8.0.7 or above
22 c27ba1cc Michael Hanselmann
- `LVM2 <http://sourceware.org/lvm2/>`_
23 c27ba1cc Michael Hanselmann
- `OpenSSH <http://www.openssh.com/portable.html>`_
24 c27ba1cc Michael Hanselmann
- `bridge utilities <http://www.linuxfoundation.org/en/Net:Bridge>`_
25 c27ba1cc Michael Hanselmann
- `iproute2 <http://www.linuxfoundation.org/en/Net:Iproute2>`_
26 c27ba1cc Michael Hanselmann
- `arping <http://www.skbuff.net/iputils/>`_ (part of iputils)
27 69affe73 Manuel Franceschini
- `ndisc6 <http://www.remlab.net/ndisc6/>`_ (if using IPv6)
28 c27ba1cc Michael Hanselmann
- `Python <http://www.python.org/>`_, version 2.4 or above, not 3.0
29 c27ba1cc Michael Hanselmann
- `Python OpenSSL bindings <http://pyopenssl.sourceforge.net/>`_
30 c27ba1cc Michael Hanselmann
- `simplejson Python module <http://code.google.com/p/simplejson/>`_
31 7578ab0a Michael Hanselmann
- `pyparsing Python module <http://pyparsing.wikispaces.com/>`_, version
32 7578ab0a Michael Hanselmann
  1.4.6 or above
33 c27ba1cc Michael Hanselmann
- `pyinotify Python module <http://trac.dbzteam.org/pyinotify/>`_
34 2a7c3583 Michael Hanselmann
- `PycURL Python module <http://pycurl.sourceforge.net/>`_
35 b447ab51 Luca Bigliardi
- `ctypes Python module
36 b447ab51 Luca Bigliardi
  <http://starship.python.net/crew/theller/ctypes/>`_, if running on
37 b447ab51 Luca Bigliardi
  python 2.4 (optional, used for node daemon memory locking)
38 e90739d6 Michael Hanselmann
- `socat <http://www.dest-unreach.org/socat/>`_, see :ref:`note
39 e90739d6 Michael Hanselmann
  <socat-note>` below
40 a40b1fc4 René Nussbaumer
- `Paramiko <http://www.lag.net/paramiko/>`_, if you want automated SSH
41 a40b1fc4 René Nussbaumer
  setup; optional otherwise but manual setup of the nodes required
42 c27ba1cc Michael Hanselmann
43 c27ba1cc Michael Hanselmann
These programs are supplied as part of most Linux distributions, so
44 c27ba1cc Michael Hanselmann
usually they can be installed via the standard package manager. Also
45 c27ba1cc Michael Hanselmann
many of them will already be installed on a standard machine. On
46 c27ba1cc Michael Hanselmann
Debian/Ubuntu, you can use this command line to install all required
47 c27ba1cc Michael Hanselmann
packages, except for DRBD and Xen::
48 c27ba1cc Michael Hanselmann
49 c27ba1cc Michael Hanselmann
  $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
50 69affe73 Manuel Franceschini
                    ndisc6 python python-pyopenssl openssl \
51 69affe73 Manuel Franceschini
                    python-pyparsing python-simplejson \
52 69affe73 Manuel Franceschini
                    python-pyinotify python-pycurl socat
53 c27ba1cc Michael Hanselmann
54 77a180f6 Iustin Pop
If you want to also enable the `htools` components, which is recommended
55 77a180f6 Iustin Pop
on bigger deployments (they give you automatic instance placement,
56 77a180f6 Iustin Pop
cluster balancing, etc.), then you need to have a Haskell compiler
57 77a180f6 Iustin Pop
installed. More specifically:
58 77a180f6 Iustin Pop
59 77a180f6 Iustin Pop
- `GHC <http://www.haskell.org/ghc/>`_ version 6.10 or higher
60 77a180f6 Iustin Pop
- or even better, `The Haskell Platform
61 77a180f6 Iustin Pop
  <http://hackage.haskell.org/platform/>`_ which gives you a simple way
62 77a180f6 Iustin Pop
  to bootstrap Haskell
63 77a180f6 Iustin Pop
- `json <http://hackage.haskell.org/package/json>`_, a JSON library
64 77a180f6 Iustin Pop
- `network <http://hackage.haskell.org/package/network>`_, a basic
65 77a180f6 Iustin Pop
  network library
66 77a180f6 Iustin Pop
- `parallel <http://hackage.haskell.org/package/parallel>`_, version 1.x
67 77a180f6 Iustin Pop
  or 2.x, a parallel programming library (note: version 3.x is not yet
68 77a180f6 Iustin Pop
  supported)
69 77a180f6 Iustin Pop
- `curl <http://hackage.haskell.org/package/curl>`_, bindings for the
70 77a180f6 Iustin Pop
  curl library, only needed if you want these tools to connect to remote
71 77a180f6 Iustin Pop
  clusters (as opposed to the local one)
72 77a180f6 Iustin Pop
73 77a180f6 Iustin Pop
All of these are also available as package in Debian/Ubuntu::
74 77a180f6 Iustin Pop
75 77a180f6 Iustin Pop
  $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
76 77a180f6 Iustin Pop
                    libghc6-parallel-dev libghc6-curl-dev
77 77a180f6 Iustin Pop
78 1ebe6dbd Iustin Pop
The compilation of the htools components is automatically enabled when
79 1ebe6dbd Iustin Pop
the compiler and the requisite libraries are found. You can use the
80 1ebe6dbd Iustin Pop
``--enable-htools`` configure flag to force the selection (at which
81 1ebe6dbd Iustin Pop
point ``./configure`` will fail if it doesn't find the prerequisites).
82 1ebe6dbd Iustin Pop
83 c27ba1cc Michael Hanselmann
If you want to build from source, please see doc/devnotes.rst for more
84 c27ba1cc Michael Hanselmann
dependencies.
85 5cd0d9c0 Iustin Pop
86 e90739d6 Michael Hanselmann
.. _socat-note:
87 e90739d6 Michael Hanselmann
.. note::
88 e90739d6 Michael Hanselmann
  Ganeti's import/export functionality uses ``socat`` with OpenSSL for
89 e90739d6 Michael Hanselmann
  transferring data between nodes. By default, OpenSSL 0.9.8 and above
90 e90739d6 Michael Hanselmann
  employ transparent compression of all data using zlib if supported by
91 e90739d6 Michael Hanselmann
  both sides of a connection. In cases where a lot of data is
92 e90739d6 Michael Hanselmann
  transferred, this can lead to an increased CPU usage. Additionally,
93 e90739d6 Michael Hanselmann
  Ganeti already compresses all data using ``gzip`` where it makes sense
94 e90739d6 Michael Hanselmann
  (for inter-cluster instance moves).
95 e90739d6 Michael Hanselmann
96 e90739d6 Michael Hanselmann
  To remedey this situation, patches implementing a new ``socat`` option
97 e90739d6 Michael Hanselmann
  for disabling OpenSSL compression have been contributed and will
98 e90739d6 Michael Hanselmann
  likely be included in the next feature release. Until then, users or
99 e90739d6 Michael Hanselmann
  distributions need to apply the patches on their own.
100 e90739d6 Michael Hanselmann
101 e90739d6 Michael Hanselmann
  Ganeti will use the option if it's detected by the ``configure``
102 e90739d6 Michael Hanselmann
  script; auto-detection can be disabled by explicitely passing
103 e90739d6 Michael Hanselmann
  ``--enable-socat-compress`` (use the option to disable compression) or
104 e90739d6 Michael Hanselmann
  ``--disable-socat-compress`` (don't use the option).
105 e90739d6 Michael Hanselmann
106 e90739d6 Michael Hanselmann
  The patches and more information can be found on
107 e90739d6 Michael Hanselmann
  http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
108 e90739d6 Michael Hanselmann
109 bd785ecd Michael Hanselmann
110 bd785ecd Michael Hanselmann
Installation of the software
111 c27ba1cc Michael Hanselmann
----------------------------
112 c27ba1cc Michael Hanselmann
113 c27ba1cc Michael Hanselmann
To install, simply run the following command::
114 a8083063 Iustin Pop
115 c27ba1cc Michael Hanselmann
  ./configure --localstatedir=/var --sysconfdir=/etc && \
116 c27ba1cc Michael Hanselmann
  make && \
117 c27ba1cc Michael Hanselmann
  make install
118 a8083063 Iustin Pop
119 c27ba1cc Michael Hanselmann
This will install the software under ``/usr/local``. You then need to
120 c27ba1cc Michael Hanselmann
copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
121 c27ba1cc Michael Hanselmann
integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
122 c27ba1cc Michael Hanselmann
etc.).
123 a8083063 Iustin Pop
124 bd785ecd Michael Hanselmann
125 a8083063 Iustin Pop
Cluster initialisation
126 c27ba1cc Michael Hanselmann
----------------------
127 a8083063 Iustin Pop
128 c27ba1cc Michael Hanselmann
Before initialising the cluster, on each node you need to create the
129 c27ba1cc Michael Hanselmann
following directories:
130 a8083063 Iustin Pop
131 c27ba1cc Michael Hanselmann
- ``/etc/ganeti``
132 c27ba1cc Michael Hanselmann
- ``/var/lib/ganeti``
133 c27ba1cc Michael Hanselmann
- ``/var/log/ganeti``
134 c27ba1cc Michael Hanselmann
- ``/srv/ganeti``
135 c27ba1cc Michael Hanselmann
- ``/srv/ganeti/os``
136 c27ba1cc Michael Hanselmann
- ``/srv/ganeti/export``
137 a8083063 Iustin Pop
138 a8083063 Iustin Pop
After this, use ``gnt-cluster init``.
139 c27ba1cc Michael Hanselmann
140 c27ba1cc Michael Hanselmann
.. vim: set textwidth=72 syntax=rst :
141 c27ba1cc Michael Hanselmann
.. Local Variables:
142 c27ba1cc Michael Hanselmann
.. mode: rst
143 c27ba1cc Michael Hanselmann
.. fill-column: 72
144 c27ba1cc Michael Hanselmann
.. End: