Sean M. Collins 09e550c370 Convert all HTML doc to RST

The motivation for this conversion is to have DevStack's docs be
generated using a more familair workflow for OpenStack projects, using
Sphinx.

Changing from raw HTML to RST will also make it easier to contribute
more documentation, as well as making edits less of a hassle.

The majority of the work was done by using Pandoc to convert from HTML
to RST, with minor edits to the output to remove errors in Sphinx.

Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd

2014-10-22 12:27:00 -04:00

2.6 KiB

Raw Blame History

DevStack

stackrc DevStack settings

stackrc is the primary configuration file for DevStack. It contains all of the settings that control the services started and the repositories used to download the source for those services. stackrc sources the localrc section of local.conf to perform the default overrides.

DATABASE_TYPE

Select the database backend to use. The default is mysql, postgresql is also available.

ENABLED_SERVICES

Specify which services to launch. These generally correspond to screen tabs. The default includes: Glance (API and Registry), Keystone, Nova (API, Certificate, Object Store, Compute, Network, Scheduler, VNC proxies, Certificate Authentication), Cinder (Scheduler, API, Volume), Horizon, MySQL, RabbitMQ, Tempest.

ENABLED_SERVICES=g-api,g-reg,key,n-api,n-crt,n-obj,n-cpu,n-net,n-cond,cinder,c-sch,c-api,c-vol,n-sch,n-novnc,n-xvnc,n-cauth,horizon,rabbit,tempest,$DATABASE_TYPE

Other services that are not enabled by default can be enabled in localrc. For example, to add Swift, use the following service names:

enable_service s-proxy s-object s-container s-account

A service can similarly be disabled:

disable_service horizon

Service Repos

The Git repositories used to check out the source for each service are controlled by a pair of variables set for each service. *_REPO points to the repository and *_BRANCH selects which branch to check out. These may be overridden in local.conf to pull source from a different repo for testing, such as a Gerrit branch proposal. GIT_BASE points to the primary repository server.

NOVA_REPO=$GIT_BASE/openstack/nova.git
NOVA_BRANCH=master

To pull a branch directly from Gerrit, get the repo and branch from the Gerrit review page:

git fetch https://review.openstack.org/p/openstack/nova refs/changes/50/5050/1 && git checkout FETCH_HEAD

The repo is the stanza following fetch and the branch is the stanza following that:

NOVA_REPO=https://review.openstack.org/p/openstack/nova
NOVA_BRANCH=refs/changes/50/5050/1

2.6 KiB Raw Blame History

stackrc DevStack settings

2.6 KiB

Raw Blame History