-
Iustin Pop authored
This big patch converts the documentation build system to sphinx (http://sphinx.pocoo.org/ ). Since that uses reStructuredText sources too, there is no change (yet) in the documents themselves, just in the build system. As before, the docs are pre built by the maintainer, and the end-user doesn't need sphinx or other rst tools to build the docs. Note that we are not distributing PDFs, so building that will require the tools. The docs will be stored under doc/html and the build system also need an extra directory doc/build. These are considered (by automake) maintainer-related objects and are removed at maintainer-clean time. The patch also fixes some small issues: add a docpng variable, add doc/api (also generated by maintainer) in maintainer-clean-local, etc. Signed-off-by:
Iustin Pop <iustin@google.com> Reviewed-by:
Guido Trotter <ultrotter@google.com>
d17e74b4
INSTALL 1.72 KiB
Documentation
=============
Please note that a more detailed installation procedure is described in the
doc/install.html file. A glossary of terms can be found in the doc/admin.html
file.
Software Requirements
=====================
Before installing, please verify that you have the following programs:
- Xen virtualization (version 3.0.x or 3.1)
http://xen.xensource.com/
- DRBD (kernel module and userspace utils), version 8.0.7+
http://www.drbd.org/
- LVM2
http://sourceware.org/lvm2/
- OpenSSL
http://www.openssl.org/
- OpenSSH
http://www.openssh.com/portable.html
- bridge utilities
http://bridge.sourceforge.net/
- iproute2
http://developer.osdl.org/dev/iproute2
- arping (part of iputils package)
ftp://ftp.inr.ac.ru/ip-routing/iputils-current.tar.gz
- Python 2.4
http://www.python.org
- Python OpenSSL bindings
http://pyopenssl.sourceforge.net/
- simplejson Python module
http://www.undefined.org/python/#simplejson
- pyparsing Python module
http://pyparsing.wikispaces.com/
For building from source, you also need tar, gzip or bzip2 and make.
Installation of the software
============================
To install, simply do ``./configure --localstatedir=/var --sysconfdir=/etc && \
make && make install``
This will install the software under /usr/local. You then need to copy
ganeti.init to /etc/init.d/ganeti and integrate it into your boot sequence
(``chkconfig``, ``update-rc.d``, etc.).
Cluster initialisation
======================
Before initialising the cluster, on each node you need to create the following
directories:
- /etc/ganeti
- /var/lib/ganeti, /var/log/ganeti
- /srv/ganeti, /srv/ganeti/os, /srv/ganeti/export
After this, use ``gnt-cluster init``.