You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenDev Sysadmins c962b5b836 OpenDev Migration Patch 3 years ago
figures Reorganize layout 8 years ago
incubation/openstack-api-extensions Reorganize layout 8 years ago
tools Workflow documentation is now in infra-manual 8 years ago
v1.0 Fix directory structure to match openstack-manuals 8 years ago
v2 Merge "List servers compute API V2 server status cleanup." 8 years ago
.gitignore Properly ignore .DS_Store 8 years ago
.gitreview OpenDev Migration Patch 3 years ago
README.rst Indicates frozen nature in README 8 years ago
doc-test.conf Fix publishing 8 years ago
pom.xml Update to clouddocs-maven-plugin 2.1.3 8 years ago
test-requirements.txt Updated from global requirements 8 years ago
tox.ini Add new checklinks tox environment 8 years ago


Compute API

This repository is now frozen-in-time and will not accept new patches.

To update Compute API information, please submit patches to for a new API feature and to and for implemented v2.0 API information.

It was the original API information holder for the OpenStack Compute project, also known as Nova. The Nova project provides open source cloud management and orchestration services.


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


The manuals are in the incubation, openstack-compute-api-1.0 and openstack-compute-api-2 directories.

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-compute-api-2
mvn clean generate-sources

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.


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 Launchpad, the OpenStack wiki, or blogs. We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.


Refer to to learn more about installing an OpenStack Compute server that can respond to these API commands.