Commit c27ba1cc authored by Michael Hanselmann's avatar Michael Hanselmann
Browse files

Convert INSTALL to RST



This is in preparation to including it into the large
documentation.
Signed-off-by: default avatarMichael Hanselmann <hansmi@google.com>
Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
parent 90b704a1
Documentation Ganeti quick installation guide
============= ===============================
Please note that a more detailed installation procedure is described in the Please note that a more detailed installation procedure is described in
doc/install.html file. A glossary of terms can be found in the doc/admin.html the :doc:`install`. A glossary of terms can be found in the
file. :doc:`glossary`.
Software Requirements Software Requirements
===================== ---------------------
Before installing, please verify that you have the following programs: Before installing, please verify that you have the following programs:
- Xen virtualization (version 3.0.x or 3.1)
http://xen.xensource.com/ - `Xen Hypervisor <http://www.xen.org/>`_, version 3.0.x or 3.1
- DRBD (kernel module and userspace utils), version 8.0.7+ - `DRBD <http://www.drbd.org/>`_, kernel module and userspace utils,
http://www.drbd.org/ version 8.0.7 or above
- LVM2 - `LVM2 <http://sourceware.org/lvm2/>`_
http://sourceware.org/lvm2/ - `OpenSSL <http://www.openssl.org/>`_
- OpenSSL - `OpenSSH <http://www.openssh.com/portable.html>`_
http://www.openssl.org/ - `bridge utilities <http://www.linuxfoundation.org/en/Net:Bridge>`_
- OpenSSH - `iproute2 <http://www.linuxfoundation.org/en/Net:Iproute2>`_
http://www.openssh.com/portable.html - `arping <http://www.skbuff.net/iputils/>`_ (part of iputils)
- bridge utilities - `Python <http://www.python.org/>`_, version 2.4 or above, not 3.0
http://bridge.sourceforge.net/ - `Python OpenSSL bindings <http://pyopenssl.sourceforge.net/>`_
- iproute2 - `simplejson Python module <http://code.google.com/p/simplejson/>`_
http://developer.osdl.org/dev/iproute2 - `pyparsing Python module <http://pyparsing.wikispaces.com/>`_
- arping (part of iputils package) - `pyinotify Python module <http://trac.dbzteam.org/pyinotify/>`_
ftp://ftp.inr.ac.ru/ip-routing/iputils-current.tar.gz - `socat <http://www.dest-unreach.org/socat/>`_
- Python 2.4
http://www.python.org These programs are supplied as part of most Linux distributions, so
- Python OpenSSL bindings usually they can be installed via the standard package manager. Also
http://pyopenssl.sourceforge.net/ many of them will already be installed on a standard machine. On
- simplejson Python module Debian/Ubuntu, you can use this command line to install all required
http://www.undefined.org/python/#simplejson packages, except for DRBD and Xen::
- pyparsing Python module
http://pyparsing.wikispaces.com/ $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
python python-pyopenssl openssl python-pyparsing \
For building from source, you also need tar, gzip or bzip2 and make. python-simplejson python-pyinotify socat
If you want to build from source, please see doc/devnotes.rst for more
dependencies.
Installation of the software Installation of the software
============================ ----------------------------
To install, simply run the following command::
To install, simply do ``./configure --localstatedir=/var --sysconfdir=/etc && \ ./configure --localstatedir=/var --sysconfdir=/etc && \
make && make install`` make && \
make install
This will install the software under /usr/local. You then need to copy This will install the software under ``/usr/local``. You then need to
ganeti.init to /etc/init.d/ganeti and integrate it into your boot sequence copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
(``chkconfig``, ``update-rc.d``, etc.). integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
etc.).
Cluster initialisation Cluster initialisation
====================== ----------------------
Before initialising the cluster, on each node you need to create the following Before initialising the cluster, on each node you need to create the
directories: following directories:
- /etc/ganeti - ``/etc/ganeti``
- /var/lib/ganeti, /var/log/ganeti - ``/var/lib/ganeti``
- /srv/ganeti, /srv/ganeti/os, /srv/ganeti/export - ``/var/log/ganeti``
- ``/srv/ganeti``
- ``/srv/ganeti/os``
- ``/srv/ganeti/export``
After this, use ``gnt-cluster init``. After this, use ``gnt-cluster init``.
.. vim: set textwidth=72 syntax=rst :
.. Local Variables:
.. mode: rst
.. fill-column: 72
.. End:
...@@ -5,17 +5,21 @@ Build dependencies ...@@ -5,17 +5,21 @@ Build dependencies
------------------ ------------------
Most dependencies from INSTALL, plus: Most dependencies from INSTALL, plus:
- docbook2html, docbook2man from Docbook tools - `GNU make <http://www.gnu.org/software/make/>`_
http://sources.redhat.com/docbook-tools/ - `GNU tar <http://www.gnu.org/software/tar/>`_
- python-sphinx (tested with version 0.6.1) from - `Gzip <http://www.gnu.org/software/gzip/>`_
http://sphinx.pocoo.org/ - `Docbook tools <http://sources.redhat.com/docbook-tools/>`_
- graphviz (docbook2html and docbook2man)
http://www.graphviz.org/ - `python-sphinx <http://sphinx.pocoo.org/>`_
(tested with version 0.6.1)
- `graphviz <http://www.graphviz.org/>`_
Configuring for development Configuring for development
--------------------------- ---------------------------
.. highlight:: sh
Run the following command (only use ``PYTHON=...`` if you need to use a Run the following command (only use ``PYTHON=...`` if you need to use a
different python version):: different python version)::
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment