Commit Graph

5 Commits

Author SHA1 Message Date
Eric Fried e8406e6437 api-ref: Further clarify placement aggregates
Following up on the comments at [1], provide further disambiguation and
clarity on the difference between placement aggregates and nova host
aggregates, with some illustrative examples that include where the
former may be used to represent the latter (as is being proposed via
[2]).

[1] https://review.openstack.org/#/c/539033/1/placement-api-ref/source/aggregates.inc@14
[2] https://review.openstack.org/#/q/bp/placement-mirror-host-aggregates

Change-Id: I53588fca311992f885c4157591232a864b6a86b1
2018-02-16 08:52:30 -06:00
Zuul 0cf7a8a648 Merge "api-ref: provide more detail on what a provider aggregate is" 2018-02-16 11:15:12 +00:00
Takashi NATSUME de6e2b9948 [placement] Move body examples to an isolated directory
JSON body examples of Placement API reference
are in the same directroy where *.inc files exist.

This patch moves JSON body examples to an isolated directory
in order to make it easier to maintain the API reference.

Change-Id: I8fd587100d22bd10dd4b2b2f1b25c5ecc7fc8537
2018-02-08 21:59:19 +00:00
Matt Riedemann 03be4beb4c api-ref: provide more detail on what a provider aggregate is
The description of placement resource provider aggregates is mostly
discussing how they aren't nova's concept of host aggregates, but
doesn't give a very simple description of what they are.

This provides a simple description and the canonical example of a
shared storage pool.

Change-Id: I3b7c6404d364c045f19390e86fd1b747baf11f8c
2018-01-29 17:39:49 -05:00
Andrey Volkov 1f6bddd74d [placement] Add api-ref for aggregates
This provides simple documentation of the path, request and response
body parameters when listing and updating aggregates.

Change-Id: Ife94d22e87a73fc26c4dcbda9545a9f59680f44f
2017-06-08 15:32:33 +00:00