Commit Graph

64 Commits

Author SHA1 Message Date
Brian Rosmaita bdb3c37142 doc: add link to release notes
We want people to pay attention to the release notes, so add a
link to the Glance docs landing page.

Change-Id: I8327dc56574ac96d77fbab6f70758c6c6d78811a
2019-08-08 22:15:51 -04:00
Andreas Jaeger 15609a11bd Update api-ref location
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: I17c97cb7655bdedc3927f4883b45ba4dcfc55516
2019-07-22 19:15:05 +02:00
Brian Rosmaita eceb4f54c6 Clarify the Glance/metadefs relationship
I've answered a few questions recently for people who assumed that
since the metadefs service lives on the Glance endpoint, metadefs
have some kind of special relationship to images.  I think the
metadefs section of the api-ref makes it clear that this is not the
case (though it's not mentioned at all on the Images part of the
api-ref).  So here's an attempt to clarify issue (without being too
intrusive) right at the top of the Glance docs landing page.

Change-Id: I3dfbb09862acedb265a5a4557749bf52f6add5f4
2019-03-05 15:50:14 +00:00
Brian Rosmaita b13987cd41 Update Glance landing pages
Currently https://docs.openstack.org/glance/latest/ is a long
unorganized list of documentation links.  This patch revises that
page and the 'Glance Contribution Guidelines' page to make it
easier to locate content.  Also updates the main heading on other
index pages.

Change-Id: Ieea44dd05f8d164ed4c27f1205fb29b6e66d9660
2018-03-20 16:04:49 -04:00
Doug Hellmann a792b5829a only show first heading from the glossary on home page
Change-Id: I81fea1c2e4d51994367c42d8f973a9503c366a09
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-29 16:14:46 -04:00
Doug Hellmann eed781b6cb move links to older install guides to the current install guide
Change-Id: I3226609ab90af0c5eaf55fe68c275a4235903352
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-29 16:14:46 -04:00
Doug Hellmann 80a7d0147d import the glossary from openstack-manuals
Change-Id: I01491fe7d24428d4f0ad470c5976feea7caaa157
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-29 14:00:35 +00:00
Doug Hellmann 2725850d5f fix repeated hyperlink target names
Change-Id: Iea87947ebd0c90dc19bff14c3f0bda3a2acb5780
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-21 14:15:58 -04:00
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
Matthew Treinish 623492cc21
Add docs and sample configs for running glance with apache
This commit adds docs and sample configs to glance for running glance
under apache. It also documents the limitations with the 2 common
methods of deploying wsgi scripts with apache, mod_wsgi and
mod_proxy_uwsgi, and why those don't work for the glance use case.

Change-Id: I856e7ada856128def48deda5b063d818f45af336
2017-06-18 04:00:48 -04:00
lijunbo 3ddd62f4bb Fix the mismatch of title and content
Update Ocata Image service install guide to Newton
Image service install guide, because the tile is intended
to describe Newton Image service.

Change-Id: Iaf6ccbf3660897d2872139d68aac306c69bfb47e
2017-04-26 09:40:48 +08:00
Hemanth Makkapati 15cc9a71c0 Dev Docs for Writing E-M-C Migrations
Add dev docs to describe how Glance database migrations must be
written for zero-downtime upgrades using Alembic.

Change-Id: Ic8b21d2cc1e42f3e1478973df0f80792e5098f90
2017-04-10 10:02:21 -05:00
Alexandra Settle 9627e7bb1a [docs] Removing docs from dev ref
1. Deletes man pages
2. Deletes indices section
3. Moves the contributor section up to the top

Change-Id: I6d67e7a40e16468bb7bf4ac742361fb44eec4e28
Implements: blueprint overhaul-glance-docs
2017-02-28 15:01:55 +00:00
Brian Rosmaita 5393599e0b Update developer docs for rolling upgrades
Add more detailed information about Alembic migrations and the
EXPERIMENTAL zero-downtime database upgrade process introduced
in Ocata plus initial rolling upgrade operator docs.

Change-Id: Ic30cd5872962df0fdfa9064391d1f7d04104bc49
2017-02-15 15:30:37 -05: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
Nikhil Komawar 215ec1e835 Add a requirements guidelines to docs
In some cases, we ask the operators to make the dependencies optional.
This documentation page adds information for this guideline. It also adds
information to include the requirement as a part of the requirements.txt
file.

Change-Id: I3a55de9b51e5e4e46e8e48321a0847b85a921552
2016-08-04 16:22:13 +00:00
Nikhil Komawar 4016d11e91 Generate and include sample config as part of docs
Use oslo.config sphinx extension "sphinxconfiggen" to generate sample
configuration files at the beginning of each sphinx build. Include the
generated sample configuration files as part of the developer docs so
that they can be removed from the code tree eventually.

Change-Id: I42934a437272b3822efd84bfe16392341804baed
Co-Authored-By: Nikhil Komawar <nik.komawar@gmail.com>
Co-Authored-By: Hemanth Makkapati <hemanth.makkapati@rackspace.com>
2016-08-02 11:16:17 -05:00
Niall Bunting 7533f1c70d Add signed images documentation
This adds some documentation for creating and uploading signed images. The
only other documentation that exists seems to require the use of python
for parts of the image creation process, which may not be totally user
friendly.

Change-Id: I5e4c92c865edd6429986565fe46fbb60756e0d68
2016-06-30 09:49:07 +00:00
Tom Cocozzello b2b0599d51 no module docs generated
It looks like in the docs config.py there
needs to be some modifications so the module
docs can be generated through sphinx

Change-Id: I41a2d62a2300100d9fb412698360bb1238cf7406
Closes-Bug: #1552830
2016-03-07 20:00:22 +00:00
Doug Hellmann d7006d662f clean up auto-generated docs for configuration options
Split each config file out to its own page to avoid the SEVERE errors
from duplicate targets on a given page.

Use the new ability of oslo.config.sphinxext to read the existing
configuration files for the config generator to load the set of
namespaces for a given file to show all options for the service.

Change-Id: I844f43049b2b6def01541a8d761cebd0c2b0b324
Depends-On: I0ec46cc7aa820ae592d8e4e7b56ee98f0c5cbfb4
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2016-02-05 17:01:10 -05:00
Jenkins b2644d443c Merge "Generate page of all config options in docs" 2016-01-26 02:20:09 +00:00
Ronald Bradford 9526e05b96 Generate page of all config options in docs
Use oslo_config.sphinxext to automatically document the available
configuration options in the sphinx documentation.

See https://etherpad.openstack.org/p/automating-oslo-config-documentation
for work to implement this to each project.  Glance is one of the first
six projects for a consolidated operators configuration reference.

Change-Id: If701f7dfa240075457e6e149bcb12ff713a8c79b
2016-01-23 13:31:37 -05:00
Olena Logvinova 3342a09ba7 [docs] Add Domain model implementation sub-section
This patch adds a new Glance domain model implementation
sub-section to the Glance Background Concepts section.

Change-Id: I74a4923f2ba1a52cfd2d9ac42a8571619ef0882a
Co-Authored-By: Darja Shakhray <dshakhray@mirantis.com>
Co-Authored-By: Olena Logvinova <ologvinova@mirantis.com>
2016-01-20 17:04:15 +02:00
Flavio Percoco 87fed81ed5 Document contribution guidelines
We currently don't have any in-tree docs documenting what the
contribution guidelines for Glance are. I believe this is super useful,
it's easier to contribute to, and it's also versioned and managed by the
team. Therefore, I've started documenting these guidelines in this
patch.

Change-Id: I483eef9103e6241cb0b60da803484cbe1b866c19
2015-11-26 15:23:58 -03: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
Doug Hellmann b6acb87c9b add the man pages to the toctree
Change-Id: I96e22ebaae6a7381c9cad49edbc6895f85becceb
2015-10-01 15:46:19 +00:00
Doug Hellmann 533747c669 add missing document to toctree
Change-Id: Idc9ffdd6d3d9bbdfd18702dd2fb1302ec7dc70b1
2015-10-01 15:46:19 +00:00
Jenkins c4ef8f979a Merge "Domain model section" 2015-09-16 14:37:50 +00:00
Olena Logvinova 18b82868f9 Domain model section
Adds a domain model description section
to the Glance Developer guide.

Change-Id: I87a0cc4e97f2bbd44dd33917dbf74c93e580e43b
Co-Authored-By: Mike Fedosin <mfedosin@mirantis.com>
Co-Authored-By: Olena Logvinova <ologvinova@mirantis.com>
2015-09-10 21:58:15 +03:00
Cory Benfield b45bd50265 Use stevedore directive to document plugins.
Add directives to the documentation to bring in docstrings from the
plugins used by glance.

Change-Id: I06df808446c749588b719001e172721db6d43660
2015-08-27 13:48:32 +01:00
Olena Logvinova 351e5f1ad7 Glance database architecture section
Adds a database architecture description section
to the Glance Developer guide.

Change-Id: Ice951ecc344a1172d5bffc4f5d0dc329b75e9483
Co-Authored-By: Mike Fedosin <mfedosin@mirantis.com>
Co-Authored-By: Olena Logvinova <ologvinova@mirantis.com>
2015-04-17 19:39:10 +03:00
Olena Logvinova 1eb3f584dc Glance basic architecture section
Adds a basic architecture description section
to the Glance Developer guide.

Change-Id: I782490bb8757cd67d83057176f8e3eeffa007b84
Co-Authored-By: Mike Fedosin <mfedosin@mirantis.com>
Co-Authored-By: Olena Logvinova <ologvinova@mirantis.com>
Co-Authored-By: Alexander Adamov <aadamov@mirantis.com>
2015-03-11 19:46:14 +02:00
Travis Tripp 0aab5e2716 Include Metadata Defs Concepts in Dev Docs
The http://docs.openstack.org/developer/glance/
site currently doesn't include the Juno Metadata
Definitions concepts.  This patch adds
an overview of the concepts to this site.

This provides a synopis of the concepts in:
https://github.com/openstack/glance-specs/blob/master/specs/juno/metadata-schema-catalog.rst

DocImpact
Closes-Bug: 1367432
Related-Bug: 1367908
Related-Bug: 1363615
Related-Bug: 1366286
Related-Bug: 1363383
Change-Id: Iad4d388cbbf2f63fa243d04d35032de0cb0bc1b4
2014-09-29 15:49:41 -06:00
Wayne Okuma 2e7de07c5a Glance Metadata Definitions Catalog - API
Implements: blueprint metadata-schema-catalog

A common API hosted by the Glance service for vendors, admins,
services, and users to meaningfully define available key / value
pair and tag metadata. The intent is to enable better metadata
collaboration across artifacts, services, and projects for
OpenStack users.

This is about the definition of the available metadata that can
be used on different types of resources (images, artifacts,
volumes, flavors, aggregates, etc). A definition includes the
properties type, its key, it's description, and it's constraints.
This catalogue will not store the values for specific instance
properties.

 - REST API for CRUD on metadef namespace
 - REST API for CRUD on metadef objects
 - REST API for CRUD on metadef properites
 - REST API for CRUD on metadef resource types
 - REST API for JSON schemas on metadef API's

Change-Id: I8e6d88ffee9a9337bf82b1da85648ba638a154ab
DocImpact
Co-Authored-By: Lakshmi N Sampath <lakshmi.sampath@hp.com>
Co-Authored-By: Wayne Okuma <wayne.okuma@hp.com>
Co-Authored-By: Travis Tripp <travis.tripp@hp.com>
Co-Authored-By: Pawel Koniszewski <pawel.koniszewski@intel.com>
Co-Authored-By: Michal Jastrzebski <michal.jastrzebski@intel.com>
Co-Authored-By: Michal Dulko <michal.dulko@intel.com>
2014-08-30 15:48:33 +02:00
Brian Rosmaita d706143781 Adding new common image properties
Revised schema and glance sphinx docs, renamed 'os_arch' to
'architecture' for backwards compatibility, renamed 'os_shortid'
to 'os_libosinfo_shortid'.

Partially implements blueprint glance-common-image-properties

Change-Id: I23d8ba82015f1f53bff65b4fa08463d905eeadd8
2013-02-20 17:36:34 +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 991e4bd8de Tweak doc page titles
Related to bp glance-folsom-docs-cleanup

Change-Id: Ifc4d8371c0752997258e19e7b149ae88ec3413b0
2012-08-29 08:54:40 -07:00
Brian Waldon 17ae9b2846 Drop architecture doc page
Related to bp glance-folsom-docs-cleanup

Change-Id: If4d187e5c96e337f0df0134a101ad1bac061dc80
2012-08-29 08:54:40 -07:00
Brian Waldon cfa2915f95 Add link to notifications docs on index
Related to bp glance-folsom-docs-cleanup

Change-Id: Ib0c65fe2bf724199e13107325175541be85bfb29
2012-08-29 08:54:40 -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
Brian Waldon 37dc071dcd Drop deprecated client docs
Link out to the necessary python-glanceclient resources rather than
maintain docs on legacy usage.

Related to bp glance-folsom-docs-cleanup

Change-Id: I769cd21b900df353e7eee3d675989b1ad32f8edf
2012-08-22 19:17:46 -07:00
Brian Waldon 6089423427 Add DB Management docs
Fixes bug 909064

Change-Id: Ifd477b345dfb03efe8e8e5befa03a0cb2a3c3ce8
2012-08-17 12:12:16 -04:00
jakedahn 030e8b4b07 Removing 'Indices and tables' heading from docs.
* Bug 955475

Change-Id: Ibcd2d2ed535a548d76c8afad54673135c20c8232
2012-07-11 15:03:51 -07:00
Jenkins 6be4e3fdcd Merge "Remove 'community' doc page" 2012-03-14 21:52:48 +00:00
Brian Waldon f1bc67c24b Remove todolist from docs
* Fixes bug 954543

Change-Id: Ib6ca8bbed18f1967108825b8b219a7d46336d11d
2012-03-14 14:02:16 -07:00
Brian Waldon 691deeb4a3 Remove 'community' doc page
This page is duplicated several times over on the wiki, let's get rid of
it rather than worry about keeping it up to date.

Change-Id: I09a9c093b708526d6c73eb270b05131bfb715af0
2012-03-13 18:23:00 -07:00
Brian Waldon 6e2f39d69b Removing registry spec from docs
* Rewords how we refer to to our 'reference' implementation of the registry
  API. glance-registry is an implementation detail of the main glance API, not
  an example of a community-driven API spec
* Remove duplicate 'gettingstarted' information
* Fixes bug 954554

Change-Id: I889f61a399c398897f2146b756b2c3c310847718
2012-03-13 16:26:19 -07:00
Jay Pipes 180ae8964d Adds documentation for policy files.
Implements interim-glance-authz-service

Change-Id: Ifefa4174aa45a29fd58ab40c74b5eaf6fecb4f83
2012-01-24 21:19:26 -05:00
Jay Pipes 2a5a0e9a35 Fixes LP Bug#878411 - No docs for image cache
Adds documentation on managing the image cache

Adds a simple CLI program to queue an image for
caching.

Change-Id: I2b4c9708c521fdcfaf1c6b8f07505e130923c4b7
2011-11-09 13:40:49 -05:00
Kevin L. Mitchell 1e4be06cb2 Add support for shared images
Change-Id: I3822a3841e1c10717c180052f929688b9f21a841
2011-08-15 16:20:49 -05:00