Update NEWS file for the 0.1.1 release

[ganeti-local] / hbal.1

diff --git a/hbal.1 b/hbal.1
index 767b4ef..c7a8e79 100644 (file)
--- a/hbal.1
+++ b/hbal.1
@@ -7,8 +7,10 @@ hbal \- Cluster balancer for Ganeti
 .B "[-C]"
 .B "[-p]"
 .B "[-o]"
 .B "[-C]"
 .B "[-p]"
 .B "[-o]"

+.B "[-v... | -q]"

 .BI "[-l" limit "]"
 .BI "[-O" name... "]"
 .BI "[-l" limit "]"
 .BI "[-O" name... "]"

+.BI "[-e" score "]"

 .BI "[-m " cluster "]"
 .BI "[-n " nodes-file " ]"
 .BI "[-i " instances-file "]"
 .BI "[-m " cluster "]"
 .BI "[-n " nodes-file " ]"
 .BI "[-i " instances-file "]"

@@ -245,6 +247,28 @@ node is offline, since this move requires a failover.
 these nodes will not be included in the score calculation (except for
 the percentage of instances on offline nodes)
 .RE
 these nodes will not be included in the score calculation (except for
 the percentage of instances on offline nodes)
 .RE

+Note that hbal will also mark as offline any nodes which are reported
+by RAPI as such, or that have "?" in file-based input in any numeric
+fields.
+.RE
+
+.TP
+.BI "-e" score ", --min-score=" score
+This parameter denotes the minimum score we are happy with and alters
+the computation in two ways:
+.RS
+.RS 4
+.TP 3
+\(em
+if the cluster has the initial score lower than this value, then we
+don't enter the algorithm at all, and exit with success
+.TP
+\(em
+during the iterative process, if we reach a score lower than this
+value, we exit the algorithm
+.RE
+The default value of the parameter is currently \fI1e-9\fR (chosen
+empirically).

 .RE
 
 .TP
 .RE
 
 .TP

@@ -263,8 +287,10 @@ how to customize the default value via the environment).
 .BI "-m" cluster
 Collect data not from files but directly from the
 .I cluster
 .BI "-m" cluster
 Collect data not from files but directly from the
 .I cluster

-given as an argument via RAPI. This work for both Ganeti 1.2 and
-Ganeti 2.0.
+given as an argument via RAPI. If the argument doesn't contain a colon
+(:), then it is converted into a fully-built URL via prepending
+https:// and appending the default RAPI port, otherwise it's
+considered a fully-specified URL and is used unchanged.

 
 .TP
 .BI "-l" N ", --max-length=" N
 
 .TP
 .BI "-l" N ", --max-length=" N

@@ -275,7 +301,13 @@ automate the execution of the balancing.
 .B -v, --verbose
 Increase the output verbosity. Each usage of this option will increase
 the verbosity (currently more than 2 doesn't make sense) from the
 .B -v, --verbose
 Increase the output verbosity. Each usage of this option will increase
 the verbosity (currently more than 2 doesn't make sense) from the

-default of zero.
+default of one.
+
+.TP
+.B -q, --quiet
+Decrease the output verbosity. Each usage of this option will decrease
+the verbosity (less than zero doesn't make sense) from the default of
+one.

 
 .TP
 .B -V, --version
 
 .TP
 .B -V, --version