Revision c27ba1cc

b/INSTALL
1
Documentation
2
=============
1
Ganeti quick installation guide
2
===============================
3 3

  
4
Please note that a more detailed installation procedure is described in the
5
doc/install.html file. A glossary of terms can be found in the doc/admin.html
6
file.
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 7

  
8 8

  
9 9
Software Requirements
10
=====================
10
---------------------
11 11

  
12 12
Before installing, please verify that you have the following programs:
13
  - Xen virtualization (version 3.0.x or 3.1)
14
    http://xen.xensource.com/
15
  - DRBD (kernel module and userspace utils), version 8.0.7+
16
    http://www.drbd.org/
17
  - LVM2
18
    http://sourceware.org/lvm2/
19
  - OpenSSL
20
    http://www.openssl.org/
21
  - OpenSSH
22
    http://www.openssh.com/portable.html
23
  - bridge utilities
24
    http://bridge.sourceforge.net/
25
  - iproute2
26
    http://developer.osdl.org/dev/iproute2
27
  - arping (part of iputils package)
28
    ftp://ftp.inr.ac.ru/ip-routing/iputils-current.tar.gz
29
  - Python 2.4
30
    http://www.python.org
31
  - Python OpenSSL bindings
32
    http://pyopenssl.sourceforge.net/
33
  - simplejson Python module
34
    http://www.undefined.org/python/#simplejson
35
  - pyparsing Python module
36
    http://pyparsing.wikispaces.com/
37

  
38
For building from source, you also need tar, gzip or bzip2 and make.
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.
39 42

  
40 43

  
41 44
Installation of the software
42
============================
45
----------------------------
46

  
47
To install, simply run the following command::
43 48

  
44
To install, simply do ``./configure --localstatedir=/var --sysconfdir=/etc && \
45
make && make install``
49
  ./configure --localstatedir=/var --sysconfdir=/etc && \
50
  make && \
51
  make install
46 52

  
47
This will install the software under /usr/local. You then need to copy
48
ganeti.init to /etc/init.d/ganeti and integrate it into your boot sequence
49
(``chkconfig``, ``update-rc.d``, etc.).
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.).
50 57

  
51 58

  
52 59
Cluster initialisation
53
======================
60
----------------------
54 61

  
55
Before initialising the cluster, on each node you need to create the following
56
directories:
62
Before initialising the cluster, on each node you need to create the
63
following directories:
57 64

  
58
  - /etc/ganeti
59
  - /var/lib/ganeti, /var/log/ganeti
60
  - /srv/ganeti, /srv/ganeti/os, /srv/ganeti/export
65
- ``/etc/ganeti``
66
- ``/var/lib/ganeti``
67
- ``/var/log/ganeti``
68
- ``/srv/ganeti``
69
- ``/srv/ganeti/os``
70
- ``/srv/ganeti/export``
61 71

  
62 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:
b/doc/devnotes.rst
5 5
------------------
6 6

  
7 7
Most dependencies from INSTALL, plus:
8
 - docbook2html, docbook2man from Docbook tools
9
   http://sources.redhat.com/docbook-tools/
10
 - python-sphinx (tested with version 0.6.1) from
11
   http://sphinx.pocoo.org/
12
 - graphviz
13
   http://www.graphviz.org/
8
- `GNU make <http://www.gnu.org/software/make/>`_
9
- `GNU tar <http://www.gnu.org/software/tar/>`_
10
- `Gzip <http://www.gnu.org/software/gzip/>`_
11
- `Docbook tools <http://sources.redhat.com/docbook-tools/>`_
12
  (docbook2html and docbook2man)
13
- `python-sphinx <http://sphinx.pocoo.org/>`_
14
  (tested with version 0.6.1)
15
- `graphviz <http://www.graphviz.org/>`_
14 16

  
15 17

  
16 18
Configuring for development
17 19
---------------------------
18 20

  
21
.. highlight:: sh
22

  
19 23
Run the following command (only use ``PYTHON=...`` if you need to use a
20 24
different python version)::
21 25

  

Also available in: Unified diff