Improve references to htools in the documentation

Was not sure about the bit in admin.rst, hope it's fine.

Signed-off-by: Iustin Pop <iustin@google.com>
Reviewed-by: René Nussbaumer <rn@google.com>

diff --git a/INSTALL b/INSTALL
index 191015f..d611a36 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -74,6 +74,11 @@ All of these are also available as package in Debian/Ubuntu::
   $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
                     libghc6-parallel-dev libghc6-curl-dev
 
+The compilation of the htools components is automatically enabled when
+the compiler and the requisite libraries are found. You can use the
+``--enable-htools`` configure flag to force the selection (at which
+point ``./configure`` will fail if it doesn't find the prerequisites).
+
 If you want to build from source, please see doc/devnotes.rst for more
 dependencies.
 

diff --git a/doc/admin.rst b/doc/admin.rst
index ba4c73d..ad99e3b 100644 (file)
--- a/doc/admin.rst
+++ b/doc/admin.rst
@@ -1482,10 +1482,10 @@ See :doc:`separate documentation for move-instance <move-instance>`.
 Other Ganeti projects
 ---------------------
 
-There are two other Ganeti-related projects that can be useful in a
-Ganeti deployment. These can be downloaded from the project site
-(http://code.google.com/p/ganeti/) and the repositories are also on the
-project git site (http://git.ganeti.org).
+Below is a list (which might not be up-to-date) of additional projects
+that can be useful in a Ganeti deployment. They can be downloaded from
+the project site (http://code.google.com/p/ganeti/) and the repositories
+are also on the project git site (http://git.ganeti.org).
 
 NBMA tools
 ++++++++++
@@ -1499,14 +1499,11 @@ archive.
 ganeti-htools
 +++++++++++++
 
-The ``ganeti-htools`` software consists of a set of tools:
-
-- ``hail``: an advanced iallocator script compared to Ganeti's builtin
-  one
-- ``hbal``: a tool for rebalancing the cluster, i.e. moving instances
-  around in order to better use the resources on the nodes
-- ``hspace``: a tool for estimating the available capacity of a cluster,
-  so that capacity planning can be done efficiently
+Before Ganeti version 2.5, this was a standalone project; since that
+version it is integrated into the Ganeti codebase (see
+:doc:`install-quick` for instructions on how to enable it). If you run
+an older Ganeti version, you will have to download and build it
+separately.
 
 For more information and installation instructions, see the README file
 in the source archive.

diff --git a/doc/iallocator.rst b/doc/iallocator.rst
index dfdcd69..caceca8 100644 (file)
--- a/doc/iallocator.rst
+++ b/doc/iallocator.rst
@@ -539,10 +539,9 @@ Command line messages
 Reference implementation
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-Ganeti's default iallocator is "hail" which is part of the separate
-ganeti-htools project. In order to see its source code please clone
-``git://git.ganeti.org/htools.git``. Note that htools is implemented
-using the Haskell programming language.
+Ganeti's default iallocator is "hail" which is available when "htools"
+components have been enabled at build time (see :doc:`install-quick` for
+more details).
 
 .. vim: set textwidth=72 :
 .. Local Variables:

diff --git a/doc/walkthrough.rst b/doc/walkthrough.rst
index 06bdf6d..dd3fa23 100644 (file)
--- a/doc/walkthrough.rst
+++ b/doc/walkthrough.rst
@@ -592,8 +592,9 @@ And is now working again::
   node2   1.3T  1.3T  32.0G  1.0G 30.4G     1     3
   node3   1.3T  1.3T  32.0G  1.0G 30.4G     0     0
 
-.. note:: If you have the ganeti-htools package installed, you can
-   shuffle the instances around to have a better use of the nodes.
+.. note:: If you have the Ganeti has been built with the htools
+   component enabled, you can shuffle the instances around to have a
+   better use of the nodes.
 
 Disk failures
 +++++++++++++
@@ -916,9 +917,9 @@ solve this, you have a number of options:
   for any non-trivial cluster)
 - try to reduce memory of some instances to accommodate the available
   node memory
-- if you have the ganeti-htools package installed, you can run the
-  ``hbal`` tool which will try to compute an automated cluster solution
-  that complies with the N+1 rule
+- if Ganeti has been built with the htools package enabled, you can run
+  the ``hbal`` tool which will try to compute an automated cluster
+  solution that complies with the N+1 rule
 
 Network issues
 ++++++++++++++