Adding a user document for the use of cluster-merge
[ganeti-local] / doc / cluster-merge.rst
1 ================
2 Merging clusters
3 ================
4
5 With ``cluster-merge`` from the ``tools`` directory it is possible to
6 merge two or more clusters into one single cluster.
7
8 If anything goes wrong at any point the script suggests you rollback
9 steps you've to perform *manually* if there are any. The point of no
10 return is when the master daemon is started the first time after merging
11 the configuration files. A rollback at this point would involve a lot of
12 manual work.
13
14 For the internal design of this tool have a look at the `Automated
15 Ganeti Cluster Merger <design-2.1.rst>` document.
16
17
18 Merge Clusters
19 ==============
20
21 The tool has to be invoked on the cluster you like to merge the other
22 clusters into.
23
24 The usage of ``cluster-merge`` is as follows::
25
26   cluster-merge [--debug|--verbose] [--watcher-pause-period SECONDS] <cluster> \
27   <cluster...>
28
29 You can provide multiple clusters. The tool will then go over every
30 cluster in serial and perform the steps to merge it into the invoking
31 cluster.
32
33 These options can be used to control the behaviour of the tool:
34
35 ``--debug``/``--verbose``
36   These options are mutually exclusive and increase the level of output
37   to either debug output or just more verbose output like action
38   performed right now.
39 ``--watcher-pause-period``
40   Define the period of time in seconds the watcher shall be disabled,
41   default is 1800 seconds (30 minutes).
42
43
44 Rollback
45 ========
46
47 If for any reason something in the merge doesn't work the way it should
48 ``cluster-merge`` will abort, provide an error message and optionally
49 rollback steps. Please be aware that after a certain point there's no
50 easy way to rollback the cluster to its previous state. If you've
51 reached that point the tool will not provide any rollback steps.
52
53 If you end up with rollback steps, please perform them before invoking
54 the tool again. It doesn't keep state over invokations.
55
56
57 .. vim: set textwidth=72 :
58 .. Local Variables:
59 .. mode: rst
60 .. fill-column: 72
61 .. End: