placement/releasenotes/notes/alloc-candidates-in-tree-f69b0de5ba33096b.yaml
Tetsuro Nakamura ce10de2a29 in_tree[N] alloc_cands with microversion 1.31
This patch adds microversion 1.31 supporting the `in_tree`/`in_tree<N>`
query parameters to the `GET /allocation_candidates` API. It accepts a
UUID for a resource provider. If this parameter is provided, the only
resource providers returned will be those with the same tree with the
given resource provider.

Change-Id: I24d333d1437168f27aaaac6d894a18271cb6ab91
Blueprint: alloc-candidates-in-tree
2019-02-25 13:00:30 -06:00

21 lines
1.0 KiB
YAML

---
features:
- |
Add support for the ``in_tree`` query parameter to the ``GET
/allocation_candidates`` API. It accepts a UUID for a resource provider.
If this parameter is provided, the only resource providers returned will
be those in the same tree with the given resource provider. The numbered
syntax ``in_tree<N>`` is also supported. This restricts providers
satisfying the Nth granular request group to the tree of the specified
provider. This may be redundant with other ``in_tree<N>`` values specified
in other groups (including the unnumbered group). However, it can be
useful in cases where a specific resource (e.g. DISK_GB) needs to come
from a specific sharing provider (e.g. shared storage).
For example, a request for ``VCPU`` and ``VGPU`` resources from ``myhost``
and ``DISK_GB`` resources from ``sharing1`` might look like::
?resources=VCPU:1&in_tree=<myhost_uuid>
&resources1=VGPU:1&in_tree1=<myhost_uuid>
&resources2=DISK_GB:100&in_tree2=<sharing1_uuid>