htools: Make it possible to load an IAlloc request

[ganeti-local] / man / htools.rst

diff --git a/man/htools.rst b/man/htools.rst
index 3449b4e..a05039b 100644 (file)
--- a/man/htools.rst
+++ b/man/htools.rst
@@ -156,6 +156,7 @@ support all options. Some common options are:
   - node physical cores
   - offline field (as ``Y`` or ``N``)
   - group UUID
+  - node spindle count
 
   The third section contains instance data, with the fields:
 
@@ -170,8 +171,23 @@ support all options. Some common options are:
   - instance disk type (e.g. ``plain`` or ``drbd``)
   - instance tags
 
-  The fourth and last section contains the cluster tags, with one tag
-  per line (no columns/no column processing).
+  The fourth section contains the cluster tags, with one tag per line
+  (no columns/no column processing).
+
+  The fifth section contains the ipolicies of the cluster and the node
+  groups, in the following format (separated by ``|``):
+
+  - owner (empty if cluster, group name otherwise)
+  - standard, min, max instance specs, containing the following values
+    separated by commas:
+    - memory size
+    - cpu count
+    - disk size
+    - disk count
+    - nic count
+  - disk templates
+  - vcpu ratio
+  - spindle ratio
 
 -m *cluster*
   Backend specification: collect data directly from the *cluster* given
@@ -187,6 +203,11 @@ support all options. Some common options are:
   on which the master daemon listens; otherwise, the default path used
   by Ganeti (configured at build time) is used.
 
+-I|\--ialloc-src *path*
+  Backend specification: load data directly from an iallocator request
+  (as produced by Ganeti when doing an iallocator call).  The iallocator
+  request is read from specified path.
+
 \--simulate *description*
   Backend specification: instead of using actual data, build an empty
   cluster given a node description. The *description* parameter must be
@@ -198,11 +219,12 @@ support all options. Some common options are:
   - the disk size of the nodes (default in mebibytes, units can be used)
   - the memory size of the nodes (default in mebibytes, units can be used)
   - the cpu core count for the nodes
+  - the spindle count for the nodes
 
-  An example description would be **preferred,B20,100G,16g,4**
-  describing a 20-node cluster where each node has 100GB of disk
-  space, 16GiB of memory and 4 CPU cores. Note that all nodes must
-  have the same specs currently.
+  An example description would be **preferred,B20,100G,16g,4,2**
+  describing a 20-node cluster where each node has 100GB of disk space,
+  16GiB of memory, 4 CPU cores and 2 disk spindles. Note that all nodes
+  must have the same specs currently.
 
   This option can be given multiple times, and each new use defines a
   new node group. Hence different node groups can have different