Statistics
| Branch: | Tag: | Revision:

root / INSTALL @ daa4dcc1

History | View | Annotate | Download (6.2 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
- `affinity Python module <http://pypi.python.org/pypi/affinity/0.1.0>`_,
43
  optional python package for supporting CPU pinning under KVM
44
- `ElementTree Python module <http://effbot.org/zone/element-index.htm>`_,
45
  if running python 2.4 (optional, used by ovfconverter tool)
46

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

    
53
  $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
54
                    ndisc6 python python-pyopenssl openssl \
55
                    python-pyparsing python-simplejson \
56
                    python-pyinotify python-pycurl socat \
57
		    python-elementtree
58

    
59
If you want to also enable the `htools` components, which is recommended
60
on bigger deployments (they give you automatic instance placement,
61
cluster balancing, etc.), then you need to have a Haskell compiler
62
installed. More specifically:
63

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

    
77
All of these are also available as package in Debian/Ubuntu::
78

    
79
  $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
80
                    libghc6-parallel-dev libghc6-curl-dev
81

    
82
Note that more recent version have switched to GHC 7.x and the packages
83
were renamed::
84

    
85
  $ apt-get install ghc libghc-json-dev libghc-network-dev \
86
                    libghc-parallel-dev libghc-curl-dev
87

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

    
93
If you want to build from source, please see doc/devnotes.rst for more
94
dependencies.
95

    
96
.. _socat-note:
97
.. note::
98
  Ganeti's import/export functionality uses ``socat`` with OpenSSL for
99
  transferring data between nodes. By default, OpenSSL 0.9.8 and above
100
  employ transparent compression of all data using zlib if supported by
101
  both sides of a connection. In cases where a lot of data is
102
  transferred, this can lead to an increased CPU usage. Additionally,
103
  Ganeti already compresses all data using ``gzip`` where it makes sense
104
  (for inter-cluster instance moves).
105

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

    
111
  Ganeti will use the option if it's detected by the ``configure``
112
  script; auto-detection can be disabled by explicitely passing
113
  ``--enable-socat-compress`` (use the option to disable compression) or
114
  ``--disable-socat-compress`` (don't use the option).
115

    
116
  The patches and more information can be found on
117
  http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
118

    
119

    
120
Installation of the software
121
----------------------------
122

    
123
To install, simply run the following command::
124

    
125
  ./configure --localstatedir=/var --sysconfdir=/etc && \
126
  make && \
127
  make install
128

    
129
This will install the software under ``/usr/local``. You then need to
130
copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
131
integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
132
etc.).
133

    
134

    
135
Cluster initialisation
136
----------------------
137

    
138
Before initialising the cluster, on each node you need to create the
139
following directories:
140

    
141
- ``/etc/ganeti``
142
- ``/var/lib/ganeti``
143
- ``/var/log/ganeti``
144
- ``/srv/ganeti``
145
- ``/srv/ganeti/os``
146
- ``/srv/ganeti/export``
147

    
148
After this, use ``gnt-cluster init``.
149

    
150
.. vim: set textwidth=72 syntax=rst :
151
.. Local Variables:
152
.. mode: rst
153
.. fill-column: 72
154
.. End: