We want people to pay attention to the release notes, so add a
link to the Glance docs landing page.
Change-Id: I8327dc56574ac96d77fbab6f70758c6c6d78811a
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
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
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
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>
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
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
Add dev docs to describe how Glance database migrations must be
written for zero-downtime upgrades using Alembic.
Change-Id: Ic8b21d2cc1e42f3e1478973df0f80792e5098f90
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
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
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
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
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>
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
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
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>
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
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>
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
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
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>
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>
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>
Patchset addresses reviewer's comments, rebase against master,
and follows new guidance from Foundation:
http://wiki.openstack.org/Documentation/Copyright
Change-Id: I94367461505778973528eb8835d991f4fb796dab
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
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
* 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
Adds documentation on managing the image cache
Adds a simple CLI program to queue an image for
caching.
Change-Id: I2b4c9708c521fdcfaf1c6b8f07505e130923c4b7