87fed81ed5
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
2.8 KiB
Welcome to Glance's documentation!
The 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.
Glance image services include discovering, registering, and retrieving virtual machine 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.
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
This documentation is generated by the Sphinx toolkit and lives in the source tree. Additional documentation on Glance and other components of OpenStack can be found on the OpenStack wiki.
Glance Background Concepts
architecture database_architecture domain_model identifiers statuses tasks formats common-image-properties metadefs-concepts
Installing/Configuring Glance
installing configuring authentication policies image-location-strategy-modules artifact-types flows property-protections
Operating Glance
controllingservers db cache notifications
Using Glance
glanceapi glanceclient glancemetadefcatalogapi
Glance Manual Pages
man/*
Contributing to Glance
contributing/index