Revision 80276b9e README

b/README
6 6
only Ganeti 2.0 is supported.
7 7

  
8 8

  
9
Cluster rebalancer
10
------------------
11

  
12
Compared to the N+1 solver, the rebalancer uses a very simple algorithm:
13
repeatedly try to move each instance one step, so that the cluster score
14
becomes better. We stop when no further move can improve the score.
15

  
16
For algorithm details and usage, see the man page hbal(1).
17

  
9 18
Cluster N+1 solver
10 19
------------------
11 20

  
......
14 23
needed to fix the cluster. Note this means we won't get a balanced cluster,
15 24
just one that passes N+1 checks.
16 25

  
17
For algorithm details and usage, see the man page hn1(1).
18

  
19
Cluster rebalancer
20
------------------
26
For algorithm details and usage, see the man page hn1(1). **Note**:
27
this program is deprecated, hbal should be used instead.
21 28

  
22
Compared to the N+1 solver, the rebalancer uses a very simple algorithm:
23
repeatedly try to move each instance one step, so that the cluster score
24
becomes better. We stop when no further move can improve the score.
29
IAllocator plugin
30
-----------------
25 31

  
26
For algorithm details and usage, see the man page hbal(1).
32
The ``hail`` iallocator plugin can be used for allocations of mirrored
33
and non-mirrored instances and for relocations of mirrored
34
instances. It needs to be installed in Ganeti's iallocator search
35
path—usually ``/usr/lib/ganeti/iallocators`` or
36
``/usr/local/lib/ganeti/iallocators``.
27 37

  
28 38
Integration with Ganeti
29 39
-----------------------
30 40

  
31
The programs can either get their input from text files, or online
32
from a cluster via RAPI. For online collection via RAPI, the "-m"
33
argument to both hn1 and hbal should specify the cluster or master
34
node name.
41
The ``hbal`` and ``hn1`` programs can either get their input from text
42
files, or online from a cluster via RAPI. For online collection via
43
RAPI, the "-m" argument to both hn1 and hbal should specify the
44
cluster or master node name. ``hail`` uses the standard iallocator API
45
and thus doesn't need any special setup (just needs to be installed in
46
the right directory).
35 47

  
36 48
For text files, a separate tool (hscan) is provided to automate their
37 49
gathering if RAPI is available, which is better since it can extract
......
43 55
    gnt-instance list -oname,admin_ram,sda_size,status,pnode,snodes \
44 56
      --separator '|' --no-head > instances
45 57

  
46
These two files should be saved under the names of *nodes* and *instances*.
58
These two files should be saved under the names of *nodes* and
59
*instances*.
47 60

  
48 61
Installation
49 62
------------
......
55 68
- json
56 69
- curl
57 70

  
58
One these are available, just typing *make* in the top-level directory
59
should be enough.
71
Once these are available, just typing *make* in the top-level
72
directory should be enough.
60 73

  
61 74
Internal (implementation) documentation is available in the ``apidoc``
62 75
directory.

Also available in: Unified diff