The aggregate link has been added in resource provider APIs
since microversion 1.1.
But the note is missing in Placement API reference.
Add the note.
The allocations link is missing in the response example
of "Update resource provider" API.
Add it as well.
Change-Id: I325ff34c8b436429c2a2623cf1fb16b368807d29
Closes-Bug: #1733317
POST /placement/resource_classes with incorrect format body
of the resource class name lead to something like:
JSON does not validate: u'_FPGA' does not match '^CUSTOM\\_[A-Z0-9_]+$'
with return code 400
we should add this into doc
Change-Id: Iab264f6d731a5f757a992d9bd148e7eb30922b9d
In "Delete traits" API of Placement API reference,
the format of response codes description is wrong.
"409 Conflict if the name to delete has associations with any"
is bold, but "ResourceProvider." is not.
So fix it.
TrivialFix
Change-Id: I963c350bfc339d4db769b0bfd6bba1087fa065e0
In the review of I49f5680c15413bce27f2abba68b699f3ea95dcdc, a few
non-blocking nits were identified. This change addresses some of
those nits, fixing some typos, clarifying method names and what
microversion is in use at particular times.
Change-Id: Iff15340502ce43eba3b98db26aa0652b1da24504
This provides microversion 1.13 of the placement API, giving the
ability to POST to /allocations to set (or clear) allocations for
more than one consumer uuid.
It builds on the recent work to support a dict-based JSON format
when doing a PUT to /allocations/{consumer_uuid}.
Being able to set allocations for multiple consumers in one request
helps to address race conditions when cleaning up allocations during
move operations in nova.
Clearing allocations is done by setting the 'allocations' key for a
specific consumer to an empty dict.
Updates to placement-api-ref, rest version history and a reno are
included.
Change-Id: I239f33841bb9fcd92b406f979674ae8c5f8d57e3
Implements: bp post-allocations
In the following resource class APIs,
the name of a resource class must start with 'CUSTOM_'.
If not, the request returns a 'Bad Request (400)' response code.
It should be described in the API reference. So add it.
* POST /resource_classes
* PUT /resource_classes/{name}
Change-Id: I132c532678bb74a460515067187fbf1e30885335
Closes-Bug: #1733308
Optional parameters should be after required paramenters.
Parameters added in microversions should be after
original parameters.
So fix them.
Change-Id: I5e3f5df5601d3747debed273e09a8b9b18046a96
Closes-Bug: #1728557
In a new microversion, 1.12, include project_id and user_id in the
output of GET /allocations/{consumer_uuid} and add JSON schema
to enable PUT to /allocations/{consumer_uuid} using the same dict-based
format for request body that is used in the GET response. In later
commits a similar format will be used in POST /allocations. This
symmetry is general good form and also will make client code a little
easier.
Since GET /allocation_candiates includes objects which are capable
of being PUT to /allocations/{consumer_uuid}, its response body has
been updated as well, to change the 'allocation_requests' object
to use the dict-based format.
Internally to handlers/allocation.py the same method (_set_allocations)
is used for every microversion. Any previous data structure is
transformed into the dict-ish form. This means that pre-existing tests
(like allocation-bad-class.yaml) continue to exercise the problems it
was made for, but needs to be pinned to an older microversion, rather than
being latest.
Info about these changes is added to placement-api-ref,
rest_api_version_history and a reno.
Change-Id: I49f5680c15413bce27f2abba68b699f3ea95dcdc
Implements: bp symmetric-allocations
Closes-Bug: #1708204
Briefly document in the Placement API reference:
a) the use of Content-Type: application/json
b) how to use microversion headers, including a link to the main
Microversions reference.
Change-Id: I60d7b9dfe4f1c50fc50eaf07a04848c220ffcf62
Following on [1], this change updates the placement api-ref to include
the allocations link in the sample output for GET
/resource_providers[/uuid].
[1] https://review.openstack.org/499826
Depends-On: I6a1d320ce914926791d5f45e89bf4c601a6b10a0
Change-Id: I161da67258afaccd90df12364153f068ef55a3b1
DELETE /placement/resource_classes/VCPU
leads to something like:
Cannot delete standard resource class VCPU:
with return code 400, we should add this into doc
actually it returns 2 lines of
Cannot delete standard resource class VCPU:
now, another patch will fix it.
Partial implement blueprint placement-doc-enhancement-queens
Change-Id: I957325bc421033743472cdd4de17d260da942174
The member_of query parameter was new in 1.3.
The resources query parameter was new in 1.4.
As a result, the 'resources' parameter description used for
allocation_candidates has to be decoupled since the entire
allocation_candidates API was new in 1.10 and is not specified
per parameter.
Change-Id: I6e0688b4a12212ace98a6876132735094df84b77
Closes-Bug: #1716046
In the Placement API reference, the GET /traits [1] query parameter
'name' says it accepts a key called 'starts_with'. The actual API
accepts 'startswith' (no underscore).
[1] https://developer.openstack.org/api-ref/placement/#list-traits
Change-Id: I5a1fa51fc751f2492ae6aa2b38893a9e06a26ed1
Closes-Bug: #1714283
This provides simple documentation of the path and response
body parameters when listing resource provider allocations.
Co-Authored-by: Andrey Volkov <avolkov@gmail.com>
Change-Id: I40fcbc3077151227f33c6a021229b5c549889bbe
This provides simple documentation of the path, request and response
body parameters when listing, creating, updating and deleting allocations.
Change-Id: I58e9dfcb62a2f485addeab98dcd835568ba792cf
This provides simple documentation of the path, request and response
body parameters when managing the association between traits and
resource_providers.
Change-Id: I2ef25313db89a2fd58d11dc023d2d9755d0a86ed
This provides simple documentation of the path, request and response
body parameters when listing, creating, updating and deleting traits.
Change-Id: If377b725e0910de2e1768666184a0212c8c9fdbc
This provides simple documentation of the path, request and response
body parameters when listing and updating aggregates.
Change-Id: Ife94d22e87a73fc26c4dcbda9545a9f59680f44f
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Changing Popen to .check_output because of 3 reasons:
1. check_output() will raise CalledProcessError if
the called process returns a non-zero return code.
2. For consistency with keystone [1] and cinder [2]
3. It makes the code look much better.
[1] https://review.openstack.org/#/c/457142/
[2] https://review.openstack.org/#/c/433081
Change-Id: Ia3e792c512da46c2b92d3ad9ec1657849d379052
This provides simple documentation of the path, request and response
body parameters when listing, creating, updating and deleting a resource
class.
Change-Id: I4038d116d53b68344282ef59f9f01753766d2ef8
This provides simple documentation of the request and response body
parameters when setting or replacing a resource provider.
Change-Id: Ifa3c0bad0ec3f9d85f0f18bfd6f90e0bcb52773d
This provides simple documentation of the response body and path
parameters when listing a single resource provider.
Change-Id: I84d472067e4365d59cab4863f87df9d24718701f
This provides simple documentation of the path parameters when deleting
a single inventory record for a resource provider.
Change-Id: Ie7eeb426744bccf5e976ed304fa6f0a58b38ac01
This provides simple documentation of the response body and path
parameters when setting or replacing an inventory record for a resource
provider.
Change-Id: I77d99c174b50eef5d2b72e226ff31f03807e69aa
This provides simple documentation of the response body and path
parameters when showing a single class of inventory for a resource
provider.
Change-Id: Ic562baa3e74445c8f6dbeb416c1ec183cc2ad14d
This provides simple documentation of the path
parameters when deleting resource provider inventories.
Change-Id: Ia1f787fb9def8473a9698a9bf1ab1990a1c21f48
This provides simple documentation of the request and response body
parameters when setting or replacing all inventories for a resource provider.
Change-Id: I720f5b6792b9f4ced905aef31715a835b07be504
This provides simple documentation of the response body and path
parameters when listing resource provider inventories.
Change-Id: Id4ed2450ab70fc63d47dabb21c4a9b21f25d85b1
This provides simple documentation of the response body and query
parameters when listing resource providers.
Change-Id: Ic8db81b5f17d4c380b64b3da24e525297db18584
This consists of a duplicate of the [nova-]api-ref setup and
conf.py along with tooling to fail the tox -edocs target when
a route that is defined in
nova.api.openstack.placement.handler.ROUTE_DECLARATIONS is not
present in placement-api-ref/source/index.rst.
tools/placement_api_docs.py will report which routes are missing.
Though completely gameable (as demonstrated in the current lame
index.rst) it's better than nothing and provides some useful
structuring on what to do next. It's also the case that the 'docs'
target in tox is not part of gating.
The response for GET / is in place with the necessary
parameters.yaml for it to be correctly described. The 'get-root.json'
file provides the JSON of the expected response. The expectation is
that later commits will add information for other urls and their
JSON files will be named method-path-separated-by-dash.json with a
request/response qualifier as necessary.
Followup patches will add other routes.
A new parameters.yaml is used instead of reusing the one from
api-ref as there isn't a lot of expected overlap and having a
separate file will ease eventual extraction.
Running tox -eplacement-api-ref will generate the docs for review,
with output in placement-api-ref/build/html/index.html.
This will be hooked up with CI to deploy the generated docs,
eventually.
Change-Id: Ifb4d91d39db0e49b55952e37cdfc9f63dcd37aa3
