Statistics
| Branch: | Tag: | Revision:

root / INSTALL @ 96a12113

History | View | Annotate | Download (5.8 kB)

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/>`_, version
32
  1.4.6 or above
33
- `pyinotify Python module <http://trac.dbzteam.org/pyinotify/>`_
34
- `PycURL Python module <http://pycurl.sourceforge.net/>`_
35
- `ctypes Python module
36
  <http://starship.python.net/crew/theller/ctypes/>`_, if running on
37
  python 2.4 (optional, used for node daemon memory locking)
38
- `socat <http://www.dest-unreach.org/socat/>`_, see :ref:`note
39
  <socat-note>` below
40
- `Paramiko <http://www.lag.net/paramiko/>`_, if you want automated SSH
41
  setup; optional otherwise but manual setup of the nodes required
42

    
43
These programs are supplied as part of most Linux distributions, so
44
usually they can be installed via the standard package manager. Also
45
many of them will already be installed on a standard machine. On
46
Debian/Ubuntu, you can use this command line to install all required
47
packages, except for DRBD and Xen::
48

    
49
  $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
50
                    ndisc6 python python-pyopenssl openssl \
51
                    python-pyparsing python-simplejson \
52
                    python-pyinotify python-pycurl socat
53

    
54
If you want to also enable the `htools` components, which is recommended
55
on bigger deployments (they give you automatic instance placement,
56
cluster balancing, etc.), then you need to have a Haskell compiler
57
installed. More specifically:
58

    
59
- `GHC <http://www.haskell.org/ghc/>`_ version 6.10 or higher
60
- or even better, `The Haskell Platform
61
  <http://hackage.haskell.org/platform/>`_ which gives you a simple way
62
  to bootstrap Haskell
63
- `json <http://hackage.haskell.org/package/json>`_, a JSON library
64
- `network <http://hackage.haskell.org/package/network>`_, a basic
65
  network library
66
- `parallel <http://hackage.haskell.org/package/parallel>`_, version 1.x
67
  or 2.x, a parallel programming library (note: version 3.x is not yet
68
  supported)
69
- `curl <http://hackage.haskell.org/package/curl>`_, bindings for the
70
  curl library, only needed if you want these tools to connect to remote
71
  clusters (as opposed to the local one)
72

    
73
All of these are also available as package in Debian/Ubuntu::
74

    
75
  $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
76
                    libghc6-parallel-dev libghc6-curl-dev
77

    
78
The compilation of the htools components is automatically enabled when
79
the compiler and the requisite libraries are found. You can use the
80
``--enable-htools`` configure flag to force the selection (at which
81
point ``./configure`` will fail if it doesn't find the prerequisites).
82

    
83
If you want to build from source, please see doc/devnotes.rst for more
84
dependencies.
85

    
86
.. _socat-note:
87
.. note::
88
  Ganeti's import/export functionality uses ``socat`` with OpenSSL for
89
  transferring data between nodes. By default, OpenSSL 0.9.8 and above
90
  employ transparent compression of all data using zlib if supported by
91
  both sides of a connection. In cases where a lot of data is
92
  transferred, this can lead to an increased CPU usage. Additionally,
93
  Ganeti already compresses all data using ``gzip`` where it makes sense
94
  (for inter-cluster instance moves).
95

    
96
  To remedey this situation, patches implementing a new ``socat`` option
97
  for disabling OpenSSL compression have been contributed and will
98
  likely be included in the next feature release. Until then, users or
99
  distributions need to apply the patches on their own.
100

    
101
  Ganeti will use the option if it's detected by the ``configure``
102
  script; auto-detection can be disabled by explicitely passing
103
  ``--enable-socat-compress`` (use the option to disable compression) or
104
  ``--disable-socat-compress`` (don't use the option).
105

    
106
  The patches and more information can be found on
107
  http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
108

    
109

    
110
Installation of the software
111
----------------------------
112

    
113
To install, simply run the following command::
114

    
115
  ./configure --localstatedir=/var --sysconfdir=/etc && \
116
  make && \
117
  make install
118

    
119
This will install the software under ``/usr/local``. You then need to
120
copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
121
integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
122
etc.).
123

    
124

    
125
Cluster initialisation
126
----------------------
127

    
128
Before initialising the cluster, on each node you need to create the
129
following directories:
130

    
131
- ``/etc/ganeti``
132
- ``/var/lib/ganeti``
133
- ``/var/log/ganeti``
134
- ``/srv/ganeti``
135
- ``/srv/ganeti/os``
136
- ``/srv/ganeti/export``
137

    
138
After this, use ``gnt-cluster init``.
139

    
140
.. vim: set textwidth=72 syntax=rst :
141
.. Local Variables:
142
.. mode: rst
143
.. fill-column: 72
144
.. End: