Revision f0edfcf6 doc/iallocator.rst

b/doc/iallocator.rst
190 190

  
191 191
  type
192 192
    the request type; this can be either ``allocate``, ``relocate``,
193
    ``change-group``, ``node-evacuate`` or ``multi-evacuate``. The
193
    ``change-group`` or ``node-evacuate``. The
194 194
    ``allocate`` request is used when a new instance needs to be placed
195 195
    on the cluster. The ``relocate`` request is used when an existing
196 196
    instance needs to be moved within its node group.
197 197

  
198 198
    The ``multi-evacuate`` protocol used to request that the script
199 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.
200
    of the given nodes. It is now deprecated and needs only be
201
    implemented if backwards compatibility with Ganeti 2.4 and lower is
202
    needed.
202 203

  
203 204
    The ``change-group`` request is used to relocate multiple instances
204 205
    across multiple node groups. ``node-evacuate`` evacuates instances
......
302 303
    should be considered for relocating instances to; type
303 304
    *list of strings*
304 305

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

  
308
  evac_nodes
309
    the names of the nodes to be evacuated; type *list of strings*
310

  
311 306
Response message
312 307
~~~~~~~~~~~~~~~~
313 308

  
......
335 330
  serialized opcodes; see the :ref:`design document
336 331
  <multi-reloc-result>` for a detailed description
337 332

  
338
  for multi-evacuation mode, this is a list of lists; each element of
339
  the list is a list of instance name and the new secondary node
340

  
341 333
.. note:: Current Ganeti version accepts either ``result`` or ``nodes``
342 334
   as a backwards-compatibility measure (older versions only supported
343 335
   ``nodes``)
......
505 497
    }
506 498
  }
507 499

  
508
Input message, node evacuation::
509

  
510
  {
511
    "version": 2,
512
    ...
513
    "request": {
514
      "type": "multi-evacuate",
515
      "evac_nodes": [
516
        "node2"
517
      ],
518
    }
519
  }
520

  
521 500

  
522 501
Response messages
523 502
~~~~~~~~~~~~~~~~~

Also available in: Unified diff