33 Commits

Author SHA1 Message Date
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
jaypipes@gmail.com
13ff5c8eaa bin/glance-admin => bin/glance, since it's really just the CLI tool to interact with Glance. Added lots of documentation and more logging statements in some critical areas (like the glance.registry calls... 2011-02-25 11:33:24 -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
jaypipes@gmail.com
5c03271048 Adds an admin tool to Glance (bin/glance-admin) that allows
a user to administer the Glance server:

* add images
* update image metadata
* delete images and metadata
* delete all images (clear)
* show an image
* list public images
* show detailed info on public images

Adds documentation for the tool and cleans up a few issues
that came up in initial testing.
2011-02-23 21:50:24 -05:00
jaypipes@gmail.com
66f4b78234 Adds bin/glance-control program server daemonization wrapper
program based on Swift's swift-init script.

Adds a crap-ton of documentation on installing Glance and
controlling Glance's server programs.

This was necessary since when glance.common.server was removed
from Glance and paste.deploy used, we lost the ability to control
server daemonization with CLI options. This adds back some of that
functionality while still using paste.deploy like Swift does.
2011-02-04 18:59:52 -05:00
jaypipes@gmail.com
5a74a85f94 Adds architecture docs and enables Graphviz sphinx extension. Also cleans up source code formatting in docs. 2011-01-24 13:03:20 -05:00
jaypipes@gmail.com
c967f9ace2 Adds man pages for glance-registry and glance-api. Adds Getting Started guide to Glance docs. 2011-01-19 16:38:39 -05: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
jaypipes@gmail.com
2406386809 Update sphinx conf to match other OpenStack projects 2010-12-22 12:52:15 -05:00
jaypipes@gmail.com
f32a2eadb0 Documentation cleanup. Splits out index.rst into multiple section docs. 2010-12-22 12:38:54 -05:00
jaypipes@gmail.com
c566d9b77d Update docs for adding image... 2010-12-20 12:12:46 -05:00
jaypipes@gmail.com
97e966f2db Fixes from review 2010-12-16 17:04:58 -05:00
jaypipes@gmail.com
4cc79106e7 Documentation updates and GlanceClient -> Client 2010-12-14 14:47:00 -05:00
jaypipes@gmail.com
fba60c3a58 Merges Glance API with the registry API:
* Makes HEAD /images/<ID> return metadata in headers
* Make GET /images/<ID> return image data with metadata
  in headers
Updates docs some (more needed)

Next steps:

* Update main GlanceClient class to encapsulate entire Glance API
  and hide RegistryClient from normal usage
* Refactor registry database API and schema
2010-12-13 22:22:13 -05:00
Monty Taylor
3d69f40135 Added setup.py and sphinx docs. 2010-09-26 00:25:34 -07:00