Go to file

Jeremy Stanley ae3fde3b70 Remove tox locale overrides

* tox.ini: The LANG, LANGUAGE and LC_ALL environment overrides were
introduced originally during the testr migration in an attempt to be
conservative about the possibility that locale settings in the
calling environment could cause consistency problems for test runs.
In actuality, this should be unnecessary and any place where it does
cause issues ought to be considered an actual bug. Also, having
these in the configuration actively causes older pip to have
problems with non-ASCII content in some package metadata files under
Python 3, so drop it now.

Change-Id: Ie556d04f4b8cd1549dca11344fc95abc6f70e746
Closes-Bug: #1277495

2014-02-10 03:01:22 +00:00

openstack-image-service-api

Update to clouddocs-maven-plugin 1.13.0

2014-01-25 11:15:10 +01:00

.gitignore

doc-tools: Ignore build-.log.gz

2014-02-08 22:06:05 +01:00

.gitreview

Add .gitreview config file for gerrit.

2011-10-24 11:02:49 -04:00

doc-test.conf

Fix doc-test.conf reponame

2014-02-08 20:22:09 +01:00

README.rst

Fix bullet list format in README.rst

2014-02-02 12:18:00 +01:00

test-requirements.txt

Updated from global requirements

2014-01-25 03:30:35 +00:00

tox.ini

Remove tox locale overrides

2014-02-10 03:01:22 +00:00

README.rst

Image Service API

This repository contains the RESTful API information for the OpenStack Image Service, also known as Glance. The Glance project provides services for discovering, registering, and retrieving virtual machine images. The Image Service 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.

Prerequisites

Apache Maven must be installed to build the documentation.

To install Maven 3 for Ubuntu 12.04 and later,and Debian wheezy and later:

apt-get install maven

On Fedora 15 and later:

yum install maven3

Building

The API is in the openstack-image-service-api directory.

To build a specific guide, look for a pom.xml file within a subdirectory, then run the mvn command in that directory. For example:

cd openstack-image-service-api
mvn clean generate-sources

The generated PDF documentation file is:

openstack-image-service-api/target/docbkx/webhelp/api/openstack-image-service/1.1/os-image-service-devguide-1.1.pdf

The root of the generated HTML documentation is:

openstack-image-service-api//target/docbkx/webhelp/api/openstack-image-service/1.1/content/index.html

Testing of changes and building of the manual

Install the python tox package and run tox from the top-level directory to use the same tests that are done as part of our Jenkins gating jobs.

If you like to run individual tests, run:

tox -e checkniceness - to run the niceness tests

tox -e checksyntax - to run syntax checks

tox -e checkdeletions - to check that no deleted files are referenced

tox -e checkbuild - to actually build the manual

tox will use the openstack-doc-tools package for execution of these tests. openstack-doc-tools has a requirement on maven for the build check.

Contributing

Our community welcomes all people interested in open source cloud computing, and there are no formal membership requirements. The best way to join the community is to talk with others online or at a meetup and offer contributions through the code review process, the OpenStack wiki, or blogs. We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.

Installing

Refer to http://docs.openstack.org/developer/glance/ to learn more about installing an OpenStack Image Service server that can respond to these API commands.