code.grnet.gr Git - ganeti-local/blob - 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] \
  27   [--groups [merge|rename]] <cluster> [<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 ``--groups``
  43   This option controls how ``cluster-merge`` handles duplicate node
  44   group names on the merging clusters. If ``merge`` is specified then
  45   all node groups with the same name will be merged into one. If
  46   ``rename`` is specified, then conflicting node groups on the remove
  47   clusters will have their cluster name appended to the group name. If
  48   this option is not speicifed, then ``cluster-merge`` will refuse to
  49   continue if it finds conflicting group names, otherwise it will
  50   proceed as normal.
  51
  52
  53 Rollback
  54 ========
  55
  56 If for any reason something in the merge doesn't work the way it should
  57 ``cluster-merge`` will abort, provide an error message and optionally
  58 rollback steps. Please be aware that after a certain point there's no
  59 easy way to rollback the cluster to its previous state. If you've
  60 reached that point the tool will not provide any rollback steps.
  61
  62 If you end up with rollback steps, please perform them before invoking
  63 the tool again. It doesn't keep state over invokations.
  64
  65
  66 .. vim: set textwidth=72 :
  67 .. Local Variables:
  68 .. mode: rst
  69 .. fill-column: 72
  70 .. End: