openstack-attic
/
image-api
Code Issues Proposed changes
92 Commits 1 Branch 3 Tags 548 KiB
Text 100%
Go to file
Andreas Jaeger 87f589d3ee Update to clouddocs-maven-plugin 2.1.3 
Change-Id: Id6b99efe8bfde89b560aeb992df0142bce381ff0
 		2014-09-22 19:58:32 +02:00
doc Update to clouddocs-maven-plugin 2.1.3 2014-09-22 19:58:32 +02: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
README.rst README change to trigger build 2014-02-21 15:34:06 -06:00
doc-test.conf Set up for publishing via openstack-doc-tools 2014-02-14 18:00:12 +01:00
test-requirements.txt Updated from global requirements 2014-09-11 00:25:29 +00:00
tox.ini Add new checklinks tox environment 2014-08-16 12:06:52 +02: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 provides 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 doc/image-api-v1
mvn clean generate-sources

The generated PDF documentation file is:

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

The root of the generated HTML documentation is:

doc/image-api-v1/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 meet up 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.