glance/doc/source/index.rst
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

4.1 KiB

Welcome to Glance's documentation!

About Glance

The Image service (glance) project provides a service where users can upload and discover data assets that are meant to be used with other services. This currently includes images and metadata definitions.

Images

Glance image services include discovering, registering, and retrieving virtual machine (VM) images. Glance has a RESTful API that allows querying of VM image metadata as well as retrieval of the actual image.

VM images made available through Glance can be stored in a variety of locations from simple filesystems to object-storage systems like the OpenStack Swift project.

Metadata Definitions

Glance hosts a metadefs catalog. This provides the OpenStack community with a way to programmatically determine various metadata key names and valid values that can be applied to OpenStack resources.

Note that what we're talking about here is simply a catalog; the keys and values don't actually do anything unless they are applied to individual OpenStack resources using the APIs or client tools provided by the services responsible for those resources.

It's also worth noting that there is no special relationship between the Image Service and the Metadefs Service. If you want to apply the keys and values defined in the Metadefs Service to images, you must use the Image Service API or client tools just as you would for any other OpenStack service.

Design Principles

Glance, as with all OpenStack projects, is written with the following design guidelines in mind:

  • Component based architecture: Quickly add new behaviors
  • Highly available: Scale to very serious workloads
  • Fault tolerant: Isolated processes avoid cascading failures
  • Recoverable: Failures should be easy to diagnose, debug, and rectify
  • Open standards: Be a reference implementation for a community-driven api

Glance Documentation

The Glance Project Team has put together the following documentation for you. Pick the documents that best match your user profile.

User Profile Links
Contributor
You want to contribute code, documentation, reviews, or ideas to the Glance Project.
  • contributor/index
Administrator
You want to administer and maintain a Glance installation, including being aware of changes in Glance from release to release.
Operator
You want to install and configure Glance for your cloud.
  • install/index
  • configuration/index
End User or Third-party Developer
You want to use the Image Service APIs provided by Glance.
Everyone Here's a handy glossary of terms related to Glance

contributor/index admin/index cli/index install/index configuration/index user/index glossary