Commit Graph

120 Commits

Author SHA1 Message Date
Cyril Roelandt cddcb8e5ac api-ref: Fix RST formatting
The list is currently not displayed properly.

Change-Id: Ie7edcfb18d91ee6e68bdba019b153819235222df
2023-09-14 01:13:21 +02:00
Abhishek Kekane fd222f3128 Sort locations based on store weight
Related to blueprint store-weight

Change-Id: I2383a476cb7e79c7efecdf33203cff0b50ef3bbb
2023-08-01 14:16:08 +00:00
Zuul 85be85d4f9 Merge "Fixes the api-ref response" 2023-02-09 15:50:45 +00:00
yuqian 475193b11d vmware does't support VirtualSriovEthernetCard
Compute-driver: vmwareapi.VMwareVCDriver does not support
VirtualSriovEthernetCard

Change-Id: I1d4b0dee3c70454c0d595cb4a69606990b96b35a
Partial-Bug: #1779781
2022-11-21 21:57:17 +01:00
Mridula Joshi 2872130bb9 Fixes the api-ref response
The response returned from the Create Tags API
'/v2/metadefs/namespaces/{namespace_name}/tags' does not match
the response in api-ref.
This patch corrects the api-ref response.

Closes-Bug: #1939690
Change-Id: Icdafa6f55b434977d83148a0b0a958f35e99afac
2022-09-06 12:17:23 +00:00
Abhishek Kekane f09c338035 Add documentation for glance-download plugin
This patch adds documentation and API reference support for
glance download plugin.

Related blueprint glance-download-import
Co-Authored-By: Victor Coutellier <victor.coutellier@gmail.com>

Change-Id: Ie36232f3474d398a913025c8d408f08f879874d8
2022-08-26 05:46:12 +00:00
Zuul 5c675bddcf Merge "Extending stores-detail API" 2022-08-24 12:05:46 +00:00
Mridula Joshi b0d727d028 Extending stores-detail API
This patch extends the functionality of the API
``GET /v2/info/stores/detail`` to expose store details
of other stores. Currently the ``stores-detail`` API
exposes store details of RBD backend.

Implements: blueprint expanding-stores-detail
Change-Id: I0c7bbc315b56dc0e40397b4ed8a68d1668203c44
2022-08-23 14:42:53 +00:00
anguoming cb60c1d2fa remove expired notes for Multi Store feature
The Multi Store feature is stable for server versions, need delete the EXPERIMENTAL notes in api guide.

Change-Id: Ifff797387ec06e8a1c0da13ebd722df0b993d672
2022-08-10 15:17:47 +08:00
Zuul c66705069b Merge "Remove unicode literal strings" 2022-07-08 07:55:24 +00:00
Zuul 4335195535 Merge "Fix URLs in the form docs.openstack.org/developer/$project" 2022-07-07 15:42:28 +00:00
Cyril Roelandt 0cbdfdde40 Fix URLs in the form docs.openstack.org/developer/$project
These URLs are now in the form docs.openstack.org/$project/latest. Make
sure to use always use https for these URLs.

Change-Id: I4a75bb6097399efca373d2f9a0e8697eb92312a7
2022-07-05 19:23:33 +02:00
Gonéri Le Bouder d883e4fd5b doc: update the kvm kw_vif_model driver list
The kw_vif_model driver list has evolved a bit. This commit adds:
- e1000e: I12a5d28d75bc32a76a4f3765cb4db4cbc46c0c75
- vmxnet3 I95203af4ded9a4dbecfb7981b400f0fb988f2d47

Change-Id: I23fbd227274c89735547322cedda565c5987776d
2022-07-04 22:39:25 +02:00
xuanyandong be997b53ab Remove unicode literal strings
Co-Authored-By: Cyril Roelandt <cyril@redhat.com>
Change-Id: Id9e1a5fb9c732c207ee08f0dbf387436a1783174
2022-06-30 19:37:03 +02:00
chenwei 0934cf0305 Update api-ref: versions response for master branch
Closes bug: #1962480

Change-Id: Iba5a720fcd1408dc81f7da8a6b814fe952a5ddf9
2022-06-13 18:28:16 +08:00
Abhishek Kekane ecb040c177 [APIImpact] Correct API response code for PUT /v2/cache/{image_id}
PUT /v2/cache/{image_id} returns HTTP 200 response code to user but as per
proposal it should be HTTP 202. This change returns HTTP 202 response to
user.

Closes-Bug: #1971521
Change-Id: I6a875a38bef5beafe352ab3320f3fd199db89aa1
2022-05-06 14:07:42 +00:00
Brian Rosmaita 8271cde1e2 [api-ref] update cache manage API info
Change-Id: If95fcb6beb17fd4ca337da58bc8fb03bbde25b03
Closes-bug: #1971176
2022-05-02 12:20:59 -04:00
vinay_m 3949fc467c api-ref needs update about 'checksum' image prop
Modified the "Checksum" description as mentioned , it is not computed from
victoria release .
Closes-Bug: #1875629

Change-Id: Id4299c7e02298157ad88971a78fac72a9f0248d0
2022-04-11 22:24:27 +00:00
Zuul f5776e6c1c Merge "Fix overwriting of existing tags while creating new tags" 2022-02-17 16:01:16 +00:00
Mridula Joshi a34764ecac Added a new API to expose store info
This patch adds a new API to glance ``GET /v2/info/stores/detail``
to expose the stores specific details about the store like store
type and other specific store properties.This operation
will be admin only and validated by the new policy rule
``stores_info_detail`` which defaults to admin only

Implements: blueprint expose-store-specific-info
Change-Id: I6882fd2381e6ae245fd8c61bf9f4d52df2b216f5
2022-02-16 05:46:47 +00:00
Mridula Joshi 2a9a4c8e0e Fix overwriting of existing tags while creating new tags
It was observed that md-tag-create-multiple
(/v2/metadefs/namespaces/{namespace_name}/tags) API overwrites
existing tags for specified namespace rather than creating new one
in addition to the existing tags.
This patch resolves the issue by introducing a header 'X-Openstack-Append'
which on being True will append the new tags to existing ones and
if False will continue to overwrite the tags.

Implements: blueprint append-tags
Closes-Bug: #1939169
Change-Id: I29448746b14c542e5fbf0283011968ae1516642e
2022-02-16 05:45:06 +00:00
Erno Kuvaja 87eae327bf Cache management API endpoints
This change adds the new cache API endpoints and their related
new policies.

Implements-bp: https://blueprints.launchpad.net/glance/+spec/cache-api
Change-Id: I69162e19bf095ef11fbac56a1ea2159d1caefba7
2022-02-14 15:14:17 +00:00
Dan Smith f865b8cac7 [APIImpact] Quota usage API
This adds a /v2/info/usage API endpoint which exposes to the user
their current limits and usage.

The discovery API does not (appear to) have existing tests, so this
adds a module for that, although only usage tests are added currently.

Implements: blueprint quota-api
Change-Id: I50c98bac50f815bdb9baae024e77afd388f74554
2022-02-03 09:55:50 -08:00
Mridula Joshi ad755cbd2b Add doc support for delete-from-store API
It is observed that the api-ref has no doc support for
delete-from-store (/v2/stores/%(store)s/%(image)s) API.
This patch adds the doc support for delete-from-store in api-ref.

bp: delete-from-store

Closes-Bug: #1941038
Change-Id: I5e82ff9f979b80b5b1e06eebea84a1b2fb50c78e
2021-09-03 06:03:18 +00:00
Abhishek Kekane f8551de8c9 Make some metadef operations admin-only
This restricts all metadef resource manipulation to admin-only, but
still allow users to see everything. There are multiple low-grade
security issues with the metadef API, detailed in the related bug.
Restricting resource manipulation to admin-only solves most of these
concerns.

SecurityImpact
Depends-On: https://review.opendev.org/c/openstack/tempest/+/780108
Change-Id: I333c58e73c202c1f523030e54e03f2868459b595
Related-Bug: #1916926
2021-03-15 07:59:05 -07:00
Abhishek Kekane 03696299d2 Update API docs for new /v2/images/{image_id}/tasks API
Updated API reference documentation for new API.

Change-Id: Ie69d4180e09fe4c670faaa7d3c31742d1fc581e2
Related: blueprint messages-api
2021-02-24 05:57:16 +00:00
Cyril Roelandt 7839ab0925 Remove unused option "owner_is_tenant"
This option has been deprecated since Rocky.

Change-Id: I8edc957ad50ec28d80a06e76912f4226cea53562
2021-02-11 16:17:10 +01:00
Dan Smith 07951b095b Update docs and renos for os_glance reservation
This adds some words to the api-ref doc, as well as a release note
about the blanket reservation of os_glance* properties.

Change-Id: I0cd6f35296a647fdb1f2cb44a688b34c0382c556
Related-Bug: #1912001
2021-01-25 12:30:50 -08:00
Abhishek Kekane e16d5c9ba3 Corrections in default value of all_stores_must_succeed
Change-Id: I7b04f8ba86e0d6f42ef436e30ece9f019221e318
Closes-Bug: #1884996
2020-09-11 06:03:30 +00:00
Abhishek Kekane 52eaa56e40 [Doc] Policy support to copy unowned images
Change-Id: If0fd74d9f2eecb21153493457c58d767f12ffdeb
2020-07-27 16:54:01 +00:00
Rafael Weingärtner e2e050c0b1 Add 'all' visibility filter for listing images in docs
Since this commit cfa9b6e8e8,
the visibility all is supported in the listing of images. However,
the documentation does not present it. This can make it hard for operators
to be aware of this option when listing images. Therefore, we propose to add
it in the documentation.

Change-Id: Iaa0ce6e1fde5c4c546b2f4a53969287b05d295de
2020-07-08 17:36:58 -03:00
Andreas Jaeger 03cb88a437 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Ib1796ac0c786c16bade68668f0d978ee71d29307
2020-05-30 16:56:09 +02:00
Brian Rosmaita 0a29d31c13 Correct reference to 2 import methods
We now have 3.

Change-Id: I276cead53ef4315881fda3659874f33084cae7ab
2020-02-26 17:35:27 -05:00
Abhishek Kekane 1754c9e2b0 Copy existing image in multiple stores
Added new import method 'copy-image' which will copy existing image into
specified list of stores. Introduced additional task which will serve
as internal plugin which will allow copying existing image into staging
area and then this data will be uploaded to specified stores via regula
import flow.

NOTE: This new import method 'copy-image' is only supported if multiple
stores are enabled in deployment.

APIImpact
Implements: blueprint copy-existing-image
Change-Id: I13eaab7ab013f44ce18465bdbdbe8052942570ff
2020-02-12 05:32:46 +00:00
Grégoire Unbekandt 92492cf504 Add ability to import image into multi-stores
The import image api now supports a list of stores to import data into.
This list can be specified through a new "stores" field that has been
added to the request body.
During import stage, Glance iterates overs this list and send the data
to each store one by one.
If an invalid backend is requested by the user, an exception is raised.
If an errors occurs during verify, already pushed data is removed and
image state is unchanged.

Change-Id: Id3ac19488c0a693d7042be4a3c83f3b9f12313d0
Implements: blueprint import-multi-stores
2020-02-10 09:39:01 +01:00
Zuul 26c5c8dff6 Merge "Remove OS::Compute::Trust metadef" 2020-01-28 05:42:34 +00:00
Erno Kuvaja 515412b59f Set API version 2.9 CURRENT
This change removes experimental status from Api versions
>2.7 setting 2.8 (multi-store support) to SUPPORTED and
2.9 (caching) to CURRENT.

NOTE: 2.8 will show up in list only if the glance-api service
is configured with multi-store. The API versions list can be
used to determine if the multi-store functionality is availabe
in the endpoint.

Change-Id: I37350fc46191074d42edc73c2451eae73261957d
2019-10-01 17:45:26 +00:00
Matt Riedemann b78abdfa0e Remove OS::Compute::Trust metadef
The nova TrustedFilter scheduler filter was removed in the Queens
release [1] so the compute trust metadef is now just noise so we
should remove it.

[1] https://review.opendev.org/506864/

Change-Id: I71825cd5317d458fa30287b78cd1030cbc457dbd
2019-09-17 09:45:52 -04:00
Erno Kuvaja d9546dce75 Images API version bump and config sync
This change contains minor version bump to Images API to
indicate latest changes to the API.

Also has config file sync for for M3 release.

These two are combined for saving some gating time due to
busy infra at Train milestone 3 deadline.

Change-Id: I13133c32734751d43cc3afed9b68d015cebd5b6b
2019-09-16 13:25:45 +01:00
Brian Rosmaita 6537ff2136 Update v2/info/stores api-ref
Slight rewrite of the stores discovery section of the api-ref to
indicate which elements of the response are optional and to remove
mention of the store type from the descriptions.

Change-Id: I8261de878fcaff1e498f7a3e152df7d980d0560c
2019-06-04 09:02:52 -04:00
Abhishek Kekane f930288120 Mark http store read-only in discovery call
Made changes to discovery store to show 'http'
store as 'read-only' if it is configured under
'enabled_backends' cofiguration option.

Change-Id: If5d292bbb4cef1bd21a7e6cd4ef343a767eb91a4
2019-05-29 05:12:44 +00:00
ZhongShengping 8e16e3a857 Replace git.openstack.org URLs with opendev.org URLs
Thorough replacement of git.openstack.org URLs with their opendev.org
counterparts.

Change-Id: Ibe48a4ea537915bc6ce142812354b1d3b3ab1cf7
2019-04-28 09:26:48 +08:00
melissaml a08a88b0a7 fix a typo in docstring
Change-Id: I47544dee1e386aac27dc23321de3ed927db58a30
2018-10-05 17:29:32 +08:00
Brian Rosmaita d8221bf16f api-ref: "hidden" images update
Update the api-ref for the "Operator maintained images lifecycle"
spec implemented in Rocky.

Change-Id: I8fcfb84579b655fd44759164508ce4532e4dd205
2018-08-16 19:05:52 +00:00
Brian Rosmaita b6d5100de7 api-ref: update version history
Update version history to include the Rocky changes.

Change-Id: Ie673a52c72a5975ac059002c351782a1c6d8df90
2018-08-08 16:15:41 -04:00
Zuul 671cfed406 Merge "Add API version 2.8" 2018-08-08 20:03:56 +00:00
Erno Kuvaja 208935af96 Add API version 2.8
This change bumps the API to EXPERIMENTAL 2.8 when multi back-end
is enabled.

Change-Id: Ie0e1ed84db1b227eea1774138b2a83172ff85bec
2018-08-07 16:39:06 +01:00
Brian Rosmaita 6187728bec api-ref: make the discovery section more general
Move all the v2/info calls to the same section of the api-ref.

Change-Id: I05cd7d89585a71cc8f5448cc3c08905da1638638
2018-08-07 11:31:37 -04:00
Zuul cbdd1ab222 Merge "Doc:Multiple stores support" 2018-08-06 14:07:09 +00:00
Abhishek Kekane d6ac7460ca Doc:Multiple stores support
Added documentation and modified api-ref documents to
reflect multiple stores support changes.

Related to blueprint multi-store
Change-Id: I932297df8149968d31a5367a9ca71a5629045445
2018-08-03 11:17:59 +00:00