From 5ac3214f1a83ba151396c7631557b14b7a182d29 Mon Sep 17 00:00:00 2001
From: Iustin Pop <iustin@google.com>
Date: Mon, 1 Jun 2009 22:15:34 +0200
Subject: [PATCH] Update the README file with hspace informations

---
 README | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README b/README
index 1011a5c43..5e7fc939a 100644
--- a/README
+++ b/README
@@ -8,6 +8,13 @@ Note that these tools are most useful for bigger cluster sizes
 (e.g. more than five or ten machines); at lower sizes, the
 computations they do can also be done manually.
 
+Most of the tools revolve around the concept of keeping the cluster
+N+1 compliant: this means that in case of failure of any node, the
+instances affected can be failed over (via ``gnt-node failover`` or
+``gnt-instance failover``) to their secondary node, and there is
+enough memory reserved for this operation without needing to shutdown
+other instances or rebalance the cluster.
+
 Available tools
 ---------------
 
@@ -42,6 +49,15 @@ instances. It needs to be installed in Ganeti's iallocator search
 pathβ€”usually ``/usr/lib/ganeti/iallocators`` or
 ``/usr/local/lib/ganeti/iallocators``. See the man page hail(1).
 
+Cluster capacity estimator
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``hspace`` program will, given an input instance specification,
+estimate how many instances of those type can be place on the cluster
+before it will become full (as in any new allocation would fail N+1
+checks). For more details, see the man page hspace(1).
+
+
 Integration with Ganeti
 -----------------------
 
-- 
GitLab