Jump to: navigation, search


Revision as of 20:06, 21 March 2013 by Thingee (talk | contribs) (adding block storage api guide link)

OpenStack software documentation

Documentation is community-oriented and available for different audiences on several websites - this wiki is for project or release documentation, the developer documentation for the projects is on docs.openstack.org/developer for example. For official documentation, see docs.openstack.org. To log a bug against the documentation, go to http://bugs.launchpad.net/openstack-manuals or http://bugs.launchpad.net/openstack-api-site.

There's also an OpenStack documentation mailing list and IRC channel at #openstack-doc.

OpenStack Manuals

OpenStack APIs


  • OpenStack Compute Administration Manual html pdf
  • OpenStack Object Storage Administration Manual html pdf
  • OpenStack Network Administration Manual (Quantum) html pdf

Source Repositories

Doc source is on GitHub. Everyone can propose merge to docs. Here are the repositories that build to docs.openstack.org.


These guides are available and sourced in .rst files in /doc/source/ if you want to work on them:

Ideally the content on the above sites is geared towards developers, and docs.openstack.org is for developer consumers of the ReST API and OpenStack administrators.


Lists current development release and past releases, with links to downloads and release notes (what's new and what's changed in each release as well as known issues and potential workarounds)


How to find or ask for support.


  • Glossary - Contains terms that are our definitions for OpenStack, cloud computing, and open source.

Project documentation


How to contribute code to OpenStack or develop using the OpenStack projects.

Launchpad reference

How we use Launchpad to track features, bugs and releases.

Writing documentation