-Installation of the software
-============================
+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:
- - lvm 2
- - ssh
- - fping
- - python twisted library (the core is enough)
- - python openssl bindings
+ - Xen virtualization (version 3.0.x or 3.1)
+ http://xen.xensource.com/
+ - DRBD (kernel module and userspace utils), version 0.7.x or 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
+ - mdadm (Linux Software Raid tools) (needed only with drbd 0.7.x)
+ http://www.kernel.org/pub/linux/utils/raid/mdadm/
+ - Python 2.4
+ http://www.python.org
+ - Python Twisted library (the core is enough)
+ http://twistedmatrix.com/
+ - Python OpenSSL bindings
+ http://pyopenssl.sourceforge.net/
+ - simplejson Python module
+ http://www.undefined.org/python/#simplejson
+ - pyparsing Python module
+ http://pyparsing.wikispaces.com/
+
+For testing, you also need the YAML module for Python (http://pyyaml.org/).
-To install, simply do ./configure && make && make install
+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 and integrate it into your boot sequence
+ganeti.init to /etc/init.d/ganeti and integrate it into your boot sequence
(``chkconfig``, ``update-rc.d``, etc.).
+
Cluster initialisation
======================
directories:
- /etc/ganeti
- - /var/log/ganeti
- - /var/lib/ganeti
- - /srv/ganeti and /srv/ganeti/os
+ - /srv/ganeti, /srv/ganeti/os, /srv/ganeti/export
After this, use ``gnt-cluster init``.