Revision 25ee7fd8 doc/iallocator.rst

b/doc/iallocator.rst
1 1
Ganeti automatic instance allocation
2 2
====================================
3 3

  
4
Documents Ganeti version 2.1
4
Documents Ganeti version 2.4
5 5

  
6 6
.. contents::
7 7

  
......
193 193
    ``multi-relocate`` or ``multi-evacuate``. The ``allocate`` request
194 194
    is used when a new instance needs to be placed on the cluster. The
195 195
    ``relocate`` request is used when an existing instance needs to be
196
    moved within its node group, while the ``multi-relocate`` one is
197
    able to relocate multiple instances across multiple node groups. The
198
    ``multi-evacuate`` protocol requests that the script computes the
199
    optimal relocate solution for all secondary instances of the given
200
    nodes.
196
    moved within its node group.
197

  
198
    The ``multi-evacuate`` protocol used to request that the script
199
    computes the optimal relocate solution for all secondary instances
200
    of the given nodes. It is now deprecated and should no longer be
201
    used.
202

  
203
    The ``change-group`` request is used to relocate multiple instances
204
    across multiple node groups. ``node-evacuate`` evacuates instances
205
    off their node(s). These are described in a separate :ref:`design
206
    document <multi-reloc-detailed-design>`.
201 207

  
202 208
For both allocate and relocate mode, the following extra keys are needed
203 209
in the ``request`` dictionary:
......
276 282
     Ganeti 2.0, this list will always contain a single node, the
277 283
     current secondary of the instance); type *list of strings*
278 284

  
279
As for ``multi-relocate``, it needs the three following request
280
arguments:
285
As for ``node-evacuate``, it needs the following request arguments:
281 286

  
282 287
  instances
283
    a list of instance names to relocate; type *list of strings*
288
    a list of instance names to evacuate; type *list of strings*
289

  
290
  evac_mode
291
    specify which instances to evacuate; one of ``primary-only``,
292
    ``secondary-only``, ``all``, type *string*
284 293

  
285
  reloc_mode
286
    a string indicating the relocation mode; there are three possible
287
    values for this string: *keep_group*, *change_group*, and
288
    *any_group*, the semantics or which are explained in :ref:`the
289
    design document <multi-reloc-detailed-design>`
294

  
295
``change-group`` needs the following request arguments:
296

  
297
  instances
298
    a list of instance names whose group to change; type
299
    *list of strings*
290 300

  
291 301
  target_groups
292
    this argument is only accepted when ``reloc_mode``, as explained
293
    above, is *change_group*; if present, it must either be the empty
294
    list, or contain a list of group UUIDs that should be considered for
295
    relocating instances to; type *list of strings*
302
    must either be the empty list, or contain a list of group UUIDs that
303
    should be considered for relocating instances to; type
304
    *list of strings*
296 305

  
297 306
Finally, in the case of multi-evacuate, there's one single request
298 307
argument (in addition to ``type``):

Also available in: Unified diff