openstack-attic/compute-api
Code Issues Proposed changes
169 Commits 1 Branch 3 Tags 2.6 MiB
StringTemplate 58.1%
JavaScript 17.9%
HTML 9.3%
XSLT 8.7%
CSS 5.6%
Other 0.4%
master
Go to file
OpenDev Sysadmins c962b5b836 OpenDev Migration Patch 
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
2019-04-19 19:26:12 +00:00
figures Reorganize layout 2014-05-20 16:07:36 -05:00
incubation/openstack-api-extensions Reorganize layout 2014-05-20 16:07:36 -05:00
tools Workflow documentation is now in infra-manual 2014-12-05 03:30:36 +00:00
v1.0 Fix directory structure to match openstack-manuals 2014-05-28 20:13:15 +02:00
v2 Merge "List servers compute API V2 server status cleanup." 2014-09-25 03:54:34 +00:00
.gitignore Properly ignore .DS_Store 2014-05-26 22:07:48 +02:00
.gitreview OpenDev Migration Patch 2019-04-19 19:26:12 +00:00
doc-test.conf Fix publishing 2014-07-30 21:39:17 +02:00
pom.xml Update to clouddocs-maven-plugin 2.1.3 2014-09-22 19:57:07 +02:00
README.rst Indicates frozen nature in README 2014-12-12 14:17:47 -06:00
test-requirements.txt Updated from global requirements 2014-10-13 23:05:14 +00:00
tox.ini Add new checklinks tox environment 2014-08-16 12:06:00 +02:00

README.rst

Compute API

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

To update Compute API information, please submit patches to http://git.openstack.org/cgit/openstack/nova-specs for a new API feature and to http://git.openstack.org/cgit/openstack/api-site and http://git.openstack.org/cgit/openstack/nova 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.

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 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.

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 Launchpad, 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 to learn more about installing an OpenStack Compute server that can respond to these API commands.