Add command to print ipolicy options

[ganeti-local] / man / htools.rst

diff --git a/man/htools.rst b/man/htools.rst
index a05039b..85e8f52 100644 (file)
--- a/man/htools.rst
+++ b/man/htools.rst
@@ -12,6 +12,9 @@ SYNOPSIS
 **hbal**
   cluster balancer
 
+**hcheck**
+  cluster checker
+
 **hspace**
   cluster capacity computation
 
@@ -21,11 +24,15 @@ SYNOPSIS
 **hscan**
   saves cluster state for later reuse
 
+**hinfo**
+  cluster information printer
+
+**hroller**
+  cluster rolling maintenance scheduler
 
 DESCRIPTION
 -----------
 
-
 ``htools`` is a suite of tools designed to help with allocation/movement
 of instances and balancing of Ganeti clusters. ``htools`` is also the
 generic binary that must be symlinked or hardlinked under each tool's
@@ -35,6 +42,9 @@ environment variable HTOOLS can be used to set the desired role.
 Installed as ``hbal``, it computes and optionally executes a suite of
 instance moves in order to balance the cluster.
 
+Installed as ``hcheck``, it preforms cluster checks and optionally
+simulates rebalancing with all the ``hbal`` options available.
+
 Installed as ``hspace``, it computes how many additional instances can
 be fit on a cluster, while maintaining N+1 status. It can run on models
 of existing clusters or of simulated clusters.
@@ -45,6 +55,12 @@ by Ganeti to compute new instance allocations and instance moves.
 Installed as ``hscan``, it scans the local or remote cluster state and
 saves it to files which can later be reused by the other roles.
 
+Installed as ``hinfo``, it prints information about the current cluster
+state.
+
+Installed as ``hroller``, it helps scheduling maintenances that require
+node reboots on a cluster.
+
 COMMON OPTIONS
 --------------
 
@@ -135,7 +151,7 @@ support all options. Some common options are:
   Backend specification: the name of the file holding node and instance
   information (if not collecting via RAPI or LUXI). This or one of the
   other backends must be selected. The option is described in the man
-  page **htools**(1).
+  page **htools**\(1).
 
   The file should contain text data, line-based, with two empty lines
   separating sections. The lines themselves are column-based, with the
@@ -165,7 +181,7 @@ support all options. Some common options are:
   - instance disk size
   - instance vcpus
   - instance status (in Ganeti's format, e.g. ``running`` or ``ERROR_down``)
-  - instance ``auto_balance`` flag (see man page **gnt-instance** (7))
+  - instance ``auto_balance`` flag (see man page **gnt-instance**\(8))
   - instance primary node
   - instance secondary node(s), if any
   - instance disk type (e.g. ``plain`` or ``drbd``)
@@ -184,7 +200,7 @@ support all options. Some common options are:
     - cpu count
     - disk size
     - disk count
-    - nic count
+    - NIC count
   - disk templates
   - vcpu ratio
   - spindle ratio
@@ -221,7 +237,7 @@ support all options. Some common options are:
   - the cpu core count for the nodes
   - the spindle count for the nodes
 
-  An example description would be **preferred,B20,100G,16g,4,2**
+  An example description would be **preferred,20,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.
@@ -256,7 +272,7 @@ their longer equivalents of *MB*, *GB*, *TB*, for which case doesn't
 matter).
 
 More details about the difference between the SI and binary systems can
-be read in the *units(7)* man page.
+be read in the **units**\(7) man page.
 
 ENVIRONMENT
 -----------