openstack/glance
Code Issues Proposed changes

Adding some basic documentation

Browse Source
This commit is contained in:
Rick Harris 2011-02-02 06:53:05 +00:00
parent 511b109794
commit 0236aea227
5 changed files with 65 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/conf.py
View File

@ -129,6 +129,8 @@ man_pages = [
('man/glanceapi', 'glance-api', u'Glance API Server',
[u'OpenStack'], 1),
('man/glanceregistry', 'glance-registry', u'Glance Registry Server',
[u'OpenStack'], 1),
('man/glancemanage', 'glance-manage', u'Glance Management Utility',
[u'OpenStack'], 1)
]

12
doc/source/glanceapi.rst
View File

@ -24,7 +24,7 @@ A host that runs the ``bin/glance-api`` service is said to be a *Glance API
Server*.
Assume there is a Glance API server running at the URL
``http://glance.example.com``.
``http://glance.example.com``.
Let's walk through how a user might request information from this server.
@ -116,7 +116,7 @@ following shows an example of the HTTP headers returned from the above
x-image-meta-store swift
x-image-meta-created_at 2010-02-03 09:34:01
x-image-meta-updated_at 2010-02-03 09:34:01
x-image-meta-deleted_at
x-image-meta-deleted_at
x-image-meta-status available
x-image-meta-is_public True
x-image-meta-property-distro Ubuntu 10.04 LTS
@ -126,7 +126,7 @@ following shows an example of the HTTP headers returned from the above
All timestamps returned are in UTC
The `x-image-meta-updated_at` timestamp is the timestamp when an
image's metadata was last updated, not its image data, as all
image's metadata was last updated, not its image data, as all
image data is immutable once stored in Glance
There may be multiple headers that begin with the prefix
@ -165,7 +165,7 @@ returned from the above ``GET`` request::
x-image-meta-store swift
x-image-meta-created_at 2010-02-03 09:34:01
x-image-meta-updated_at 2010-02-03 09:34:01
x-image-meta-deleted_at
x-image-meta-deleted_at
x-image-meta-status available
x-image-meta-is_public True
x-image-meta-property-distro Ubuntu 10.04 LTS
@ -175,7 +175,7 @@ returned from the above ``GET`` request::
All timestamps returned are in UTC
The `x-image-meta-updated_at` timestamp is the timestamp when an
image's metadata was last updated, not its image data, as all
image's metadata was last updated, not its image data, as all
image data is immutable once stored in Glance
There may be multiple headers that begin with the prefix
@ -232,7 +232,7 @@ The list of metadata headers that Glance accepts are listed below.
* ``x-image-meta-id``
This header is optional.
This header is optional.
When present, Glance will use the supplied identifier for the image.
If the identifier already exists in that Glance node, then a

2
doc/source/man/glanceapi.rst
View File

@ -48,7 +48,7 @@ OPTIONS
running ``glance-api``
FILES
========
=====
None

55
doc/source/man/glancemanage.py Normal file
View File

@ -0,0 +1,55 @@
=============
glance-manage
=============
-------------------------
Glance Management Utility
-------------------------
:Author: glance@lists.launchpad.net
:Date: 2010-11-16
:Copyright: OpenStack LLC
:Version: 0.1.2
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
glance-manage [options]
DESCRIPTION
===========
glance-manage is a utility for managing and configuring a Glance installation.
One important use of glance-manage is to setup the database. To do this run::
glance-manage version_control
glance-manage upgrade
OPTIONS
=======
**General options**
**-v, --verbose**
Print more verbose output
**--sql_connection=CONN_STRING**
A proper SQLAlchemy connection string as described
`here <http://www.sqlalchemy.org/docs/05/reference/sqlalchemy/connections.html?highlight=engine#sqlalchemy.create_engine>`_
FILES
=====
None
SEE ALSO
========
* `OpenStack Glance <http://glance.openstack.org>`__
BUGS
====
* Glance is sourced in Launchpad so you can view current bugs at `OpenStack Glance <http://glance.openstack.org>`__

2
doc/source/man/glanceregistry.rst
View File

@ -43,7 +43,7 @@ OPTIONS
`here <http://www.sqlalchemy.org/docs/05/reference/sqlalchemy/connections.html?highlight=engine#sqlalchemy.create_engine>`_
FILES
========
=====
None