diff options
| author | Dan Smith <dansmith@redhat.com> | 2019-10-14 08:11:27 -0700 |
|---|---|---|
| committer | Matt Riedemann <mriedem.os@gmail.com> | 2019-10-15 21:22:31 -0400 |
| commit | 339129870692467b703220dbc3905fd8bffe6a83 (patch) | |
| tree | 9d033985e9e5d3d44310d1581ac409567347768d /api-ref | |
| parent | 11d909c2cbf80ce899b7a68ce72897dfb2945fed (diff) | |
| download | nova-339129870692467b703220dbc3905fd8bffe6a83.tar.gz | |
Add image caching API for aggregates
This adds a new microversion and support for requesting image pre-caching
on an aggregate.
Related to blueprint image-precache-support
Change-Id: I4ab96095106b38737ed355fcad07e758f8b5a9b0
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/os-aggregates.inc | 33 | ||||
| -rw-r--r-- | api-ref/source/parameters.yaml | 5 |
2 files changed, 38 insertions, 0 deletions
diff --git a/api-ref/source/os-aggregates.inc b/api-ref/source/os-aggregates.inc index 9e612ad06d..6021c8e860 100644 --- a/api-ref/source/os-aggregates.inc +++ b/api-ref/source/os-aggregates.inc @@ -354,3 +354,36 @@ Response .. literalinclude:: ../../doc/api_samples/os-aggregates/v2.41/aggregates-metadata-post-resp.json :language: javascript + +Request Image Pre-caching for Aggregate +======================================= + +.. rest_method:: POST /os-aggregates/{aggregate_id}/images + +Requests that a set of images be pre-cached on compute nodes within the referenced aggregate. + +This API is available starting with microversion 2.81. + +Normal response codes: 202 + +Error response codes: badRequest(400), unauthorized(401), forbidden(403), +itemNotFound(404) + +Request +------- + +.. rest_parameters:: parameters.yaml + + - aggregate_id: aggregate_id + - cache: cache + - cache.id: image_id_body + +**Example Request Image pre-caching for Aggregate (v2.81): JSON request** + +.. literalinclude:: ../../doc/api_samples/os-aggregates/v2.81/aggregate-images-post-req.json + :language: javascript + +Response +-------- + +The response body is always empty. diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 2f22b0eda3..8401601740 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -1997,6 +1997,11 @@ boot_index: in: body required: true type: integer +cache: + description: A list of image objects to cache. + in: body + required: true + type: array certificate: description: | The certificate object. |