Commit 877d0386 authored by Iustin Pop's avatar Iustin Pop
Browse files

Some documentation updates for the new parameters

parent 66d67ad4
......@@ -14,6 +14,8 @@ hbal \- Cluster balancer for Ganeti
.BI "[-m " cluster "]"
.BI "[-n " nodes-file " ]"
.BI "[-i " instances-file "]"
.BI "[--max-cpu " cpu-ratio "]"
.BI "[--min-disk " disk-ratio "]"
.B hbal
.B --version
......@@ -89,6 +91,10 @@ percentage of nodes failing N+1 check
\(em
percentage of instances living (either as primary or secondary) on
offline nodes
.TP
\(em
coefficent of variance of the ratio of virtual-to-physical cpus (for
primary instaces of the node)
.RE
The free memory and free disk values help ensure that all nodes are
......@@ -137,7 +143,7 @@ dynamically-computed metrics, such as:
.RS 4
.TP 3
\(em
CPU usage of instances, combined with VCPU versus PCPU count
CPU usage of instances
.TP
\(em
Disk IO usage
......@@ -194,6 +200,12 @@ total disk
.B f_dsk
free disk
.TP
.B pcpu
the number of physical cpus on the node
.TP
.B vcpu
the number of virtual cpus allocated to primary instances
.TP
.B pri
number of primary instances
.TP
......@@ -205,6 +217,9 @@ percent of free memory
.TP
.B p_fdsk
percent of free disk
.TP
.B r_cpu
ratio of virtual to physical cpus
.RE
.TP
......@@ -297,6 +312,21 @@ considered a fully-specified URL and is used as-is.
Restrict the solution to this length. This can be used for example to
automate the execution of the balancing.
.TP
.BI "--max-cpu " cpu-ratio
The maximum virtual-to-physical cpu ratio, as a floating point number
between zero and one. For example, specifying \fIcpu-ratio\fR as
\fB2.5\fR means that, for a 4-cpu machine, a maximum of 10 virtual
cpus should be allowed to be in use for primary instances. A value of
one doesn't make sense though, as that means no disk space can be used
on it.
.TP
.BI "--min-disk " disk-ratio
The minimum amount of free disk space remaining, as a floating point
number. For example, specifying \fIdisk-ratio\fR as \fB0.25\fR means
that at least one quarter of disk space should be left free on nodes.
.TP
.B -v, --verbose
Increase the output verbosity. Each usage of this option will increase
......
......@@ -139,7 +139,7 @@ options =
, Option [] ["max-cpu"]
(ReqArg (\ n opts -> opts { optMcpu = read n }) "RATIO")
"maximum virtual-to-physical cpu ratio for nodes"
, Option [] ["max-disk"]
, Option [] ["min-disk"]
(ReqArg (\ n opts -> opts { optMdsk = read n }) "RATIO")
"minimum free disk space for nodes (between 0 and 1)"
, Option ['V'] ["version"]
......
......@@ -203,6 +203,12 @@ total disk
.B f_dsk
free disk
.TP
.B pcpu
the number of physical cpus on the node
.TP
.B vcpu
the number of virtual cpus allocated to primary instances
.TP
.B pri
number of primary instances
.TP
......@@ -214,6 +220,9 @@ percent of free memory
.TP
.B p_fdsk
percent of free disk
.TP
.B r_cpu
ratio of virtual to physical cpus
.RE
.TP
......
......@@ -13,6 +13,8 @@ hspace \- Cluster space analyzer for Ganeti
.BI "[--memory " mem "]"
.BI "[--disk " disk "]"
.BI "[--req-nodes " req-nodes "]"
.BI "[--max-cpu " cpu-ratio "]"
.BI "[--min-disk " disk-ratio "]"
.B hspace
.B --version
......@@ -45,6 +47,21 @@ The disk size of the instances to be placed (defaults to 100GiB).
The number of nodes for the instances; the default of two means
mirrored instances, while passing one means plain type instances.
.TP
.BI "--max-cpu " cpu-ratio
The maximum virtual-to-physical cpu ratio, as a floating point number
between zero and one. For example, specifying \fIcpu-ratio\fR as
\fB2.5\fR means that, for a 4-cpu machine, a maximum of 10 virtual
cpus should be allowed to be in use for primary instances. A value of
one doesn't make sense though, as that means no disk space can be used
on it.
.TP
.BI "--min-disk " disk-ratio
The minimum amount of free disk space remaining, as a floating point
number. For example, specifying \fIdisk-ratio\fR as \fB0.25\fR means
that at least one quarter of disk space should be left free on nodes.
.TP
.B -p, --print-nodes
Prints the before and after node status, in a format designed to allow
......@@ -87,6 +104,12 @@ total disk
.B f_dsk
free disk
.TP
.B pcpu
the number of physical cpus on the node
.TP
.B vcpu
the number of virtual cpus allocated to primary instances
.TP
.B pri
number of primary instances
.TP
......@@ -98,6 +121,9 @@ percent of free memory
.TP
.B p_fdsk
percent of free disk
.TP
.B r_cpu
ratio of virtual to physical cpus
.RE
.TP
......
......@@ -136,7 +136,7 @@ options =
, Option [] ["max-cpu"]
(ReqArg (\ n opts -> opts { optMcpu = read n }) "RATIO")
"maximum virtual-to-physical cpu ratio for nodes"
, Option [] ["max-disk"]
, Option [] ["min-disk"]
(ReqArg (\ n opts -> opts { optMdsk = read n }) "RATIO")
"minimum free disk space for nodes (between 0 and 1)"
, Option ['V'] ["version"]
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment