On Fri, Mar 25, 2011 at 16:43 +0100, Iustin Pop <[email protected]> wrote:
> On Thu, Mar 24, 2011 at 09:41:59PM +0000, Adeodato Simo wrote:
> > Hi,
> > This is the change I mentioned I'd be sending. I *think* it makes the
> > document more readable, and it makes it a bit less messy to add new
> > operation types. Please let me know what you think.
> Agreed. LGTM, with one tiny request: please keep the mention of the
> 'request' field in the common section, as all messages will have this
> field (just don't document its contents).
Good idea, thanks. Proposed interdiff:
--- doc/iallocator.rst
+++ doc/iallocator.rst
@@ -90,6 +90,11 @@ cluster_tags
enabled_hypervisors
the list of enabled hypervisors
+request
+ a dictionary containing the details of the request; the keys vary
+ depending on the type of operation that's being requested, as
+ explained in `Operation-specific input`_ below.
+
nodegroups
a dictionary with the data for the cluster's node groups; it is keyed
on the group UUID, and the values are a dictionary with the following
@@ -173,13 +178,13 @@ nodes
reserved_memory, free_memory, total_disk, free_disk, total_cpus,
i_pri_memory and i_pri_up memory will be absent
-Operation-specific input (request)
-++++++++++++++++++++++++++++++++++
+Operation-specific input
+++++++++++++++++++++++++
-All input dictionaries to the IAllocator carry one extra element,
-``request``, which is itself a dictionary. The required keys in this
-dictionary vary depending on the type of operation that's being
-requested.
+All input dictionaries to the IAllocator carry, in the ``request``
+dictionary, detailed information about the operation that's being
+requested. The required keys vary depending on the type of operation, as
+follows.
In all cases, it includes:
--
Adeodato Simo | [email protected]
Corp Computing Services SRE (Dublin)
