Add Ganeti 2.9 design document
[ganeti-local] / INSTALL
diff --git a/INSTALL b/INSTALL
index d65af86..236105e 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -2,8 +2,9 @@ Ganeti quick installation guide
 ===============================
 
 Please note that a more detailed installation procedure is described in
-the :doc:`install`. A glossary of terms can be found in the
-:doc:`glossary`.
+the :doc:`install`. Refer to it if you are setting up Ganeti the first time.
+This quick installation guide is mainly meant as reference for experienced
+users. A glossary of terms can be found in the :doc:`glossary`.
 
 
 Software Requirements
@@ -56,9 +57,19 @@ packages, except for RBD, DRBD and Xen::
 
   $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
                     ndisc6 python python-pyopenssl openssl \
-                    python-pyparsing python-simplejson \
-                    python-pyinotify python-pycurl socat fping \
-                    python-ipaddr python-bitarray
+                    python-pyparsing python-simplejson python-bitarray \
+                    python-pyinotify python-pycurl python-ipaddr socat fping
+
+If bitarray is missing it can be installed from easy-install::
+
+  $ easy_install bitarray
+
+Or on newer distributions (eg. Debian Wheezy) the above becomes::
+
+  $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
+                    ndisc6 python python-openssl openssl \
+                    python-pyparsing python-simplejson python-bitarray \
+                    python-pyinotify python-pycurl python-ipaddr socat fping
 
 Note that this does not install optional packages::
 
@@ -72,7 +83,7 @@ For example::
   $ cd / && sudo easy_install \
             affinity \
             bitarray \
-            ipaddr \
+            ipaddr
 
 
 On Fedora to install all required packages except RBD, DRBD and Xen::
@@ -155,9 +166,10 @@ If using a distribution which does not provide them, first install
 the Haskell platform. You can also install ``cabal`` manually::
 
   $ apt-get install cabal-install
+  $ cabal update
 
-Then install the additional libraries via
-``cabal``::
+Then install the additional libraries (only the ones not available in your
+distribution packages) via ``cabal``::
 
   $ cabal install json network parallel utf8-string curl
 
@@ -165,8 +177,8 @@ Haskell optional features
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Optionally, more functionality can be enabled if your build machine has
-a few more Haskell libraries enabled: the ``ganeti-confd`` daemon
-(``--enable-confd``) and the monitoring daemon
+a few more Haskell libraries enabled: the ``ganeti-confd`` and
+``ganeti-luxid`` daemon (``--enable-confd``) and the monitoring daemon
 (``--enable-mond``). The list of extra dependencies for these is:
 
 - `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
@@ -182,6 +194,8 @@ a few more Haskell libraries enabled: the ``ganeti-confd`` daemon
 - `vector <http://hackage.haskell.org/package/vector>`_
 - `snap-server` <http://hackage.haskell.org/package/snap-server>`_, version
   0.8.1 and above.
+- `process <http://hackage.haskell.org/package/process>`_, version 1.0.1.1 and
+  above
 
 These libraries are available in Debian Wheezy (but not in Squeeze), so you
 can use either apt::
@@ -194,7 +208,7 @@ can use either apt::
 or ``cabal``, after installing a required non-Haskell dependency::
 
   $ apt-get install libpcre3-dev
-  $ cabal install hslogger Crypto text hinotify regex-pcre \
+  $ cabal install hslogger Crypto text hinotify==0.3.2 regex-pcre \
                   attoparsec vector snap-server
 
 to install them.