Document OpNodeMigrate's result for RAPI

[ganeti-local] / doc / iallocator.rst

diff --git a/doc/iallocator.rst b/doc/iallocator.rst
index e8c3716..26cc808 100644 (file)
--- a/doc/iallocator.rst
+++ b/doc/iallocator.rst
@@ -1,7 +1,7 @@
 Ganeti automatic instance allocation
 ====================================
 
-Documents Ganeti version 2.4
+Documents Ganeti version 2.5
 
 .. contents::
 
@@ -190,15 +190,16 @@ In all cases, it includes:
 
   type
     the request type; this can be either ``allocate``, ``relocate``,
-    ``multi-relocate`` or ``multi-evacuate``. The ``allocate`` request
-    is used when a new instance needs to be placed on the cluster. The
-    ``relocate`` request is used when an existing instance needs to be
-    moved within its node group.
+    ``change-group`` or ``node-evacuate``. The
+    ``allocate`` request is used when a new instance needs to be placed
+    on the cluster. The ``relocate`` request is used when an existing
+    instance needs to be moved within its node group.
 
     The ``multi-evacuate`` protocol used to request that the script
     computes the optimal relocate solution for all secondary instances
-    of the given nodes. It is now deprecated and should no longer be
-    used.
+    of the given nodes. It is now deprecated and needs only be
+    implemented if backwards compatibility with Ganeti 2.4 and lower is
+    needed.
 
     The ``change-group`` request is used to relocate multiple instances
     across multiple node groups. ``node-evacuate`` evacuates instances
@@ -291,7 +292,6 @@ As for ``node-evacuate``, it needs the following request arguments:
     specify which instances to evacuate; one of ``primary-only``,
     ``secondary-only``, ``all``, type *string*
 
-
 ``change-group`` needs the following request arguments:
 
   instances
@@ -303,12 +303,6 @@ As for ``node-evacuate``, it needs the following request arguments:
     should be considered for relocating instances to; type
     *list of strings*
 
-Finally, in the case of multi-evacuate, there's one single request
-argument (in addition to ``type``):
-
-  evac_nodes
-    the names of the nodes to be evacuated; type *list of strings*
-
 Response message
 ~~~~~~~~~~~~~~~~
 
@@ -331,12 +325,10 @@ result
   entry in the input message, otherwise Ganeti will consider the result
   as failed
 
-  for multi-relocate mode, this is a list of lists of serialized
-  opcodes. See the :ref:`design document <multi-reloc-result>` for a
-  detailed dscription.
-
-  for multi-evacuation mode, this is a list of lists; each element of
-  the list is a list of instance name and the new secondary node
+  for the ``node-evacuate`` and ``change-group`` modes, this is a
+  dictionary containing, among other information, a list of lists of
+  serialized opcodes; see the :ref:`design document
+  <multi-reloc-result>` for a detailed description
 
 .. note:: Current Ganeti version accepts either ``result`` or ``nodes``
    as a backwards-compatibility measure (older versions only supported
@@ -505,19 +497,6 @@ Input message, reallocation::
     }
   }
 
-Input message, node evacuation::
-
-  {
-    "version": 2,
-    ...
-    "request": {
-      "type": "multi-evacuate",
-      "evac_nodes": [
-        "node2"
-      ],
-    }
-  }
-
 
 Response messages
 ~~~~~~~~~~~~~~~~~