OpenStack Manuals
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.
Joe Savak 12d9dde5ff bug 944097 adding apache license to openstack-manuals repo 11 years ago
doc bug 923273 edited the url 11 years ago
tools Add to help with gerrit workflow. 11 years ago
www Use 3 columns instead of 2 + wall of text 11 years ago
.gitignore standardize capitalization: ReST -> REST 11 years ago
.gitreview Add .gitreview config file for gerrit. 11 years ago
LICENSE bug 944097 adding apache license to openstack-manuals repo 11 years ago
README.rst Update the formatting of README 11 years ago


Openstack Manuals

This repository contains the cloud administrator documentation for the OpenStack project. It includes documentation for:

  • OpenStack Compute
  • OpenStack Identity Service
  • OpenStack Image Service
  • OpenStack Object Storage
  • OpenStack Dashboard

For more details, see the OpenStack Documentation HowTo wiki page.

In addtion to the guides, this repository contains:

  • doc/src/docbkx/openstack-api-site
  • www


Apache Maven must be installed to build the documentation.

To install Maven for Ubuntu:

apt-get install maven2


To build the Compute Admin Manual, Object Storage Admin Manual, and Image Service Manual:

cd openstack-manuals/doc
mvn clean generate-sources

The different manuals are in subdirectories of the openstack-manuals/doc/src/docbkx directory.

For example, the root directory of the OpenStack Compute Administration Guide is openstack-manuals/doc/src/docbkx/openstack-compute-admin.

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-manuals/doc/src/docbkx/openstack-compute-admin
mvn clean generate-sources

The generated PDF documentation file is:


The root of the generated HTML documentation is:



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, blogs, or on IRC at #openstack on

We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.


Refer to to see where these documents are published and to learn more about the OpenStack project.