Commit Graph

52 Commits

Author SHA1 Message Date
Doug Hellmann 1c7f556d4f rearrange existing documentation to follow the new layout standard
This change moves existing files, updates a few of the cross-references
and paths, and fixes some formatting. It is not meant to be the final
word on how the main page looks or how the other files are organized,
but it gets everything roughly into shape. If the glance team wants to
make changes, please do those as follow-up patches

This change depends on the spec and on a feature of pbr that allows us
to move where the auto-generated class reference documentation ends up
in the tree.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Depends-On: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb
Change-Id: I9dde267793a5913acb5b1ec028cfb66bc5189783
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-21 14:15:58 -04:00
Maxim Nestratov ab7152ea28 Add ploop to supported disk_formats
Lite-Spec-Id:Ib45de5ff2fe7fc4e1c2d6f8cb6772e017ef891c2
Change-Id: Ice74c4bf9ed2efae519930f33b2fa2b3c162e8c4
2016-12-22 21:14:14 +03:00
Brian Rosmaita 0a9bbd33c0 dev-docs: mark v1 as deprecated
This patch consists of changes to the Glance developer docs to
indicate that the Images API v1 has been deprecated in Newton.

Change-Id: Idf62cf86cd402b2f39a7233f7159ba81dad02bb9
Partial-bug: #1618495
2016-09-30 07:21:40 -04:00
Jenkins 9de8fc1eae Merge "Remove references of s3 store driver" 2016-08-19 19:11:05 +00:00
Nikhil Komawar 66335ba873 Remove references of s3 store driver
As we are removing the s3 driver from source tree per change
I032b0fc16400cbd2112687d38e010128be699221 , it seems right to remove the
references of the same in the glance tree.

Updated here are files that referenced s3; these files include:

    * documentation files
    * documentation of the glance architecture (source and png files)
    * config help text
    * stores associated with location strategy
    * tests

UpgradeImpact

Change-Id: I680ee2baf39b49156d173e2ae108ae5d0221eca7
Depends-On: I032b0fc16400cbd2112687d38e010128be699221
Depends-On: I5d2da0611365b838f41285b64cdcfef9adf50e85
2016-08-11 12:32:48 -04:00
Jin Li e736517c80 change the example URLs in dev-docs for Glance
Change all example urls in doc/source to
http://glance.openstack.example.org

Change-Id: If7a5ccd31f6892de441d2acb6213bf15d1be3e64
Closes-Bug: #1611489
Co-Authored-By: Jin Li <jl7351@att.com>
Co-Authored-By: Hemanth Makkapati <hemanth.makkapati@rackspace.com>
2016-08-10 16:33:22 +00:00
Jenkins 88aae3b867 Merge "Add 'vhdx' disk format." 2016-08-01 18:32:59 +00:00
Stuart McLaren fc0b47beb6 Add 'vhdx' disk format.
This patch adds the Hyper-V 'vhdx' disk format to the Glance
configuration. This allows users to upload 'vhdx' images by default.

'vhdx' disks can have much larger storage capacity than the older 'vhd'
format [1].  (Plus, anything with 'x' in the name is awesome.)

DocImpact: Docs will need to be updated to indicate that the 'vhdx'
disk_format is now one of the default disk formats supported by Glance.

UpgradeImpact: Adds 'vhdx' to the default list of disk_formats.  Operators
will no longer need to configure specifically to use 'vhdx' disks.

[1] https://technet.microsoft.com/en-us/library/hh831446(v=ws.11).aspx

Spec-Lite: https://review.openstack.org/#/c/347626
Change-Id: I4e172c78d7afeb8be5a0123238efe3d8e4b044c9
2016-07-28 16:34:00 +00:00
ke-kuroki 21c7981751 Add 'ova' as a container_format in dev-docs
Add 'ova' as a container_format in glanceapi.rst
because the format is missed.

Change-Id: Ifa52d6ca8a6f81fd8c07aa59c171ba47ad8f798c
Closes-Bug: #1606573
2016-07-27 18:27:04 +09:00
Nikhil Komawar f5c10879a0 Clarify language used in glanceapi future section
As per the comments and agreement on
Iede37e61784b6a8a974ce0ae29ccfab510d8cc53 , this patch proposes the
concerned changes. The former patch was merged as the consensus on the
idea of the Images API future section was converged. This is merely a
simplification to the grammatical tone on the respective sections.

Change-Id: Iefbdeadb78b2a7b866495d4a8f3e7a84cee46fe2
2016-05-13 00:33:07 +00:00
bria4010 96cece900b Images APIs: The Future
Adds a section to the Glance docs clarifying the relations between
Glance and the OpenStack Images APIs, as well as Glare and why there
is no current intention to create an Images v3 API.

Change-Id: Iede37e61784b6a8a974ce0ae29ccfab510d8cc53
2016-05-09 16:18:07 -04:00
Tom Cocozzello adfc7e5a3f fix docstring warnings and errors
There are many warnings and errors that occur when the docs are
generated.

Co-Author-By: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
Closes-Bug: 1556818
Change-Id: Ifebeb3904f136a56bd6fe6877220b279a1f98354
2016-03-14 18:40:15 +00:00
wangxiyuan 0d89611c1e Stop gridfs driver support
Gridfs was marked as deprecated some releases go and now it has
been removed from Glance_store. So Glance should not support this
driver anymore.

Change-Id: Ia81e109c3919ad8ee8336f9051fa7920780f5bbd
2016-02-18 11:17:47 +00:00
Dave McNally f666e5f5e6 Add the Docker container format
A Docker image is a tar archive typically containing a container
filesystem. In order to use the nova-docker compute driver nova and boot
docker instances glance support of the docker container format is
required.

This patch adds the Docker container format to the Glance configuration.

DocImpact: Docs will need to be updated to indicate that the docker
container_format is now one of the default container formats supported
by Glance.

UpgradeImpact: Adds 'docker' to the default list of container_formats.
Operators will no longer need to configure specifically to use docker
containers.

Closes-Bug: #1519402
Change-Id: Ifa206686086232a5599e7bc27a852bc5f3186ebc
2015-12-01 16:42:51 +00:00
bria4010 c2f2dab939 Add tasks info to glance documentation
Adds conceptual overview of tasks and documents the tasks API calls.
This is a partial fix (parts 1 & 2) for bug #1484566.

Change-Id: If295c35d3cfa2f39d9f6bac8f02947bce3552d0a
Partial-bug: #1484566
2015-11-05 10:44:09 +00:00
Olena Logvinova edd51e289a [Glance Developer Guide] Grammar edits
This patch:
- addresses grammar comments from commit
  https://review.openstack.org/207510
- fixes small grammar/syntax errors in Using Glance’s
  Image Public APIs section of the guide.

Change-Id: I6b5339a7680c3ccd3ce9bb156f10acad9f47daa3
2015-09-18 17:55:22 +03:00
Lakshmi N Sampath f97afca2ba Sync glance docs with metadefs api changes
- Rename resource_type to resource_type_
   associations in namespace API input/output
 - Add created_at/updated_at in resource_
   type_associations block of namespace API
   input/output.
 - Fix minor nits

Closes-bug: 1367908

Change-Id: Ie74bfb36a7023abb346852f5b863f19d0d7bc4ff
2014-09-10 10:48:38 -07:00
Christian Berendt 03a4d0aba1 fixed typos found by RETF rules in RST files
rules are avaialble at
https://en.wikipedia.org/wiki/Wikipedia:AutoWikiBrowser/Typos

Change-Id: I725d3892d915bf880e62b8b11b97dcfc0a804a41
2014-05-20 10:19:20 +02:00
Fei Long Wang efb8df7f2c Document for API message localization
This patch will add document about how to use the
API message localization.

Partially implements bp i18n-messages

Change-Id: I389103574fc52feed96c592cbafbb52faccda939
2014-03-04 13:29:30 +00:00
Arnaud Legendre f9589bd010 VMware Datastore storage backend
Customers using a VMware environment with OpenStack should be able to
store their Glance images in VMware datastores. This is a first step to solve
the problem where Nova needs to copy the bits over the network
from Glance to the datastore when spawning an instance.
Also, this give the ability to provide some optimizations for specific
image formats in the future (fast cloning for example).

This patch contains a 'glance/store/vmware/' folder with the code
to manage the connection with vCenter or an ESX(i) host.
This code will go away as soon as it is merged to Olso:
see review https://review.openstack.org/#/c/65075/

The current implementation give this ability to specify the vCenter or
ESX(i) IP. In case of a vCenter IP, there is no optimization to reduce
the datapath (no host selected).
Consequently, it is recommended to specify an ESX IP if the ESX host
API endpoint is accessible from Glance.

docImpact
Implements bp vmware-datastore-storage-backend

Change-Id: I3837912e0d1614b9c31a689f71c2e34d453e2dc3
2014-01-30 18:14:15 -08:00
Nassim Babaci 70d2c8c2d8 fix comments and docstrings misspelled words
Change-Id: I355b6fedf372b1273ceaebe22e8e890aa9c913c9
Closes-bug: #1267103
2014-01-08 17:03:44 +01:00
Jenkins 43748fd296 Merge "Corrected v2 image sharing documentation." 2013-10-01 08:13:09 +00:00
Brian Rosmaita 63fbdd9a5a Corrected v2 image sharing documentation.
corrected request body for POST to /v2/.../members
removed GET /v2/images/{imageId}/members/{memberId} (call not implemented)

Change-Id: Iafbba48c7d5e8b8b38e77b7ead216d0e7e235cb2
Closes-Bug: #1229351
2013-09-23 18:49:31 +00:00
Fei Long Wang 849eba3b2d Fixes typos of v1 meta data in glanceapi.rst
Fixes bug 1226701

Change-Id: Ie5547f5020d0dad3a2d9a9a96db0b5dd1d2dc34e
2013-09-18 00:41:39 +08:00
Kun Huang 485274433f Text formatting changes
These are some text fixes in document, scripts and functions,
including variable usage, text aligning, adding new store class in
document

Change-Id: I98e226969d86698972870a7b3a042cb00c2206e9
2013-08-07 13:15:27 +08:00
Paul Bourke 02fc5ba589 Add documentation on reserving a Glance image
This lets us refer to the fact that some optional headers are in fact
required unless reserving an image.

Fixes bug 1124224

Change-Id: I5646d4dc130efecf991573b363eb1a665012b7df
2013-05-28 13:38:09 +00:00
Stuart McLaren bba2f5c4d0 Add documentation for query parameters
Add documenation for 'marker', 'limit' and 'is_public' query
paramters.

Addresses bug 1177739.

Change-Id: I429ec7a54c132a6eee64846932ff72b35acfbfb2
2013-05-08 16:07:12 +00:00
Brian Rosmaita fb4cb999d0 Update documentation to reflect API v2 image sharing
Related to bp glance-api-v2-image-sharing

Change-Id: Ida2f530ef2c8474ec29f8870c2218c291a9e449c
2013-03-04 15:39:32 +00:00
annegentle a2b9bed75d Updates OpenStack LLC with OpenStack Foundation
Patchset addresses reviewer's comments, rebase against master,
and follows new guidance from Foundation:
http://wiki.openstack.org/Documentation/Copyright

Change-Id: I94367461505778973528eb8835d991f4fb796dab
2013-02-17 19:19:43 -08:00
Brian Waldon 34d6335672 Remove repeated image-sharing docs
* Drop image sharing blurb from authentication docs.
* Link to authentication page from api page

Related to bp glance-folsom-docs-cleanup

Change-Id: Idac46a78f79fac0c673f6a9b91c1f44df7b705b4
2012-08-29 08:53:54 -07:00
Brian Waldon 7a0d2eb6cd Tidy up API docs
* Add bit about images api vs glance
* Explain how to send auth token
* Prepend '/v1' to example URIs

Related to bp glance-folsom-docs-cleanup

Change-Id: I2c3b568e463f62033268573f50f2d8a74d053965
2012-08-29 08:44:09 -07:00
Brian Waldon 87033d04d5 Rename glance api docs to something more concise
Related to bp glance-folsom-docs-cleanup

Change-Id: Ic2206b9a3233d9b9d0617a253749d2021d14ac20
2012-08-22 19:21:03 -07:00
Hengqing Hu bbf46b45cd Remove trailing whitespaces in regular file
Change-Id: I0d015501492902ddf7fda20e0381fc21fbcaeb91
2012-03-03 12:10:46 +08:00
Eoghan Glynn 62c913c3ad Require container & disk formats on image create
Fixes lp 933702

For images created via the glance CLI, the container and disk formats
were previously defaulted if not explicitly set. However if created via
the python or REST APIs, these attributes were not defaulted if unset.

There is no real sensible default for these formats, so now an image
create fails with 400 "Bad Request" if the format metadata are missing.

Also we ensure unset image metadata are not reported in x-image-meta-*
headers in order to disambiguate None and empty string values.

Change-Id: I8189383f5f9adf42a8cdac7f8dc7e9327baf46da
2012-02-20 18:06:51 +00:00
Brian Waldon ceab6b3ed4 Convert image id value to a uuid
This just changes the value of image.id, leaving the key name alone. We also
enforce image ids provided on an image create be a uuid. Implements
blueprint uuid-image-identifiers

Change-Id: I22ba69550ccbc04a24d680748d60414d2d0f1a99
2011-10-26 21:16:12 -04:00
Alex Meade 20b7c69758 Added min_disk and min_ram properties to images
Fixes LP Bug#849368

Change-Id: I3e17370537144d117d99af5fa5a21df830b7c7ed
2011-09-20 14:43:35 -04:00
Jay Pipes e7ec4a1d02 Fixes LP Bug#755916 - Location field shows creds
Removes the Location field from the return of the
API server's GET /images/detail and GET /images/<ID>
calls. The Registry server API was unchanged, as the API
server needs to call the Registry server in order to
find location information...

Change-Id: I914456ad3879f19fa0b55c8a89b8217c193193d8
2011-09-19 14:42:11 -04:00
Kevin L. Mitchell 1e4be06cb2 Add support for shared images
Change-Id: I3822a3841e1c10717c180052f929688b9f21a841
2011-08-15 16:20:49 -05:00
Brian Waldon 3ebfff8ba8 updating docs 2011-06-20 23:52:25 -04:00
Donal Lafferty c54e7bf264 Sync with trunk. 2011-05-26 13:53:48 +01:00
jaypipes@gmail.com 37b1c2901e Documentation for new results filtering in the API and client. 2011-05-25 11:03:16 -04:00
Donal Lafferty 2ce002b38b Update documentation. 2011-05-19 10:20:54 +01:00
jaypipes@gmail.com 6703ba193e OK, fix docs to make it clear that only the string 'true' is allowed for boolean headers. Add False-hood unit tests as well. 2011-04-12 17:45:16 -04:00
jaypipes@gmail.com b2ec714d12 Make it clear that the checksum is an MD5 checksum in docs. 2011-03-08 11:40:35 -05:00
jaypipes@gmail.com af11621170 Adds checksumming to Glance.
When adding an image (or uploading an image during PUT operations),
you may now supply an optional X-Image-Meta-Checksum header. When
storing the uploaded image, the backend image stores now are required
to return a checksum of the data they just stored. The optional
X-Image-Meta-Checksum header is compared against this generated checksum
and returns a 409 Bad Request if there is a mismatch.

The ETag header is now properly set to the image's checksum now
for all GET /images/<ID>, HEAD /images/<ID>, POST /images and
PUT /images/<ID> operations.

Adds unit tests verifying the checksumming behaviour in the API, and
in the Swift and Filesystem backend stores.
2011-03-08 10:22:44 -05:00
jaypipes@gmail.com 4a8522d794 Final review fixes. Makes disk_format and container_format optional. Makes glance-upload --type put the type in properties 2011-03-05 12:04:43 -05:00
jaypipes@gmail.com 79ba479ada Adds lots of unit tests for verifying exceptions are raised
properly with invalid or mismatched disk and container formats.

Adds documentation on disk and container formats. Updates
existing documentation to remove references to the now-gone
type column and replaces these references with disk_format
and container_format.

Reworked the validates_image() method in the registry.db.api
to be like what Rick was describing in reviews.
2011-02-25 09:55:26 -05:00
Rick Harris 0236aea227 Adding some basic documentation 2011-02-02 06:53:05 +00:00
jaypipes@gmail.com 14cc5df1cc Cleanup of RST documentation and addition of docs on an image's status 2011-01-17 13:09:14 -05:00
Rick Harris 21cea9c5e6 Updating docs 2011-01-11 11:34:48 -06:00