Fix typos and thinkos in docs
Updates for the new major features and some clarification
Partial-Bug: #1235626
Change-Id: If2da63e62a14894e498b4163b5052d9b2b2069ed
diff --git a/HACKING.rst b/HACKING.rst
index 5f33d77..3c08e67 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -5,10 +5,10 @@
General
-------
-DevStack is written in POSIX shell script. This choice was made because
-it best illustrates the configuration steps that this implementation takes
-on setting up and interacting with OpenStack components. DevStack specifically
-uses Bash and is compatible with Bash 3.
+DevStack is written in UNIX shell script. It uses a number of bash-isms
+and so is limited to Bash (version 3 and up) and compatible shells.
+Shell script was chosen because it best illustrates the steps used to
+set up and interact with OpenStack components.
DevStack's official repository is located on GitHub at
https://github.com/openstack-dev/devstack.git. Besides the master branch that
@@ -54,14 +54,14 @@
``TOP_DIR`` should always point there, even if the script itself is located in
a subdirectory::
- # Keep track of the current devstack directory.
+ # Keep track of the current DevStack directory.
TOP_DIR=$(cd $(dirname "$0") && pwd)
Many scripts will utilize shared functions from the ``functions`` file. There are
also rc files (``stackrc`` and ``openrc``) that are often included to set the primary
configuration of the user environment::
- # Keep track of the current devstack directory.
+ # Keep track of the current DevStack directory.
TOP_DIR=$(cd $(dirname "$0") && pwd)
# Import common functions
@@ -100,13 +100,14 @@
-------
``stackrc`` is the global configuration file for DevStack. It is responsible for
-calling ``localrc`` if it exists so configuration can be overridden by the user.
+calling ``local.conf`` (or ``localrc`` if it exists) so local user configuration
+is recognized.
The criteria for what belongs in ``stackrc`` can be vaguely summarized as
follows:
-* All project respositories and branches (for historical reasons)
-* Global configuration that may be referenced in ``localrc``, i.e. ``DEST``, ``DATA_DIR``
+* All project repositories and branches handled directly in ``stack.sh``
+* Global configuration that may be referenced in ``local.conf``, i.e. ``DEST``, ``DATA_DIR``
* Global service configuration like ``ENABLED_SERVICES``
* Variables used by multiple services that do not have a clear owner, i.e.
``VOLUME_BACKING_FILE_SIZE`` (nova-volumes and cinder) or ``PUBLIC_NETWORK_NAME``
@@ -116,8 +117,9 @@
not be changed for other reasons but the earlier file needs to dereference a
variable set in the later file. This should be rare.
-Also, variable declarations in ``stackrc`` do NOT allow overriding (the form
-``FOO=${FOO:-baz}``); if they did then they can already be changed in ``localrc``
+Also, variable declarations in ``stackrc`` before ``local.conf`` is sourced
+do NOT allow overriding (the form
+``FOO=${FOO:-baz}``); if they did then they can already be changed in ``local.conf``
and can stay in the project file.
@@ -139,7 +141,9 @@
Markdown formatting in the comments; use it sparingly. Specifically, ``stack.sh``
uses Markdown headers to divide the script into logical sections.
-.. _shocco: http://rtomayko.github.com/shocco/
+.. _shocco: https://github.com/dtroyer/shocco/tree/rst_support
+
+The script used to drive <code>shocco</code> is <code>tools/build_docs.sh</code>.
Exercises
diff --git a/README.md b/README.md
index 514786c..640fab6 100644
--- a/README.md
+++ b/README.md
@@ -6,35 +6,39 @@
* To describe working configurations of OpenStack (which code branches work together? what do config files look like for those branches?)
* To make it easier for developers to dive into OpenStack so that they can productively contribute without having to understand every part of the system at once
* To make it easy to prototype cross-project features
-* To sanity-check OpenStack builds (used in gating commits to the primary repos)
+* To provide an environment for the OpenStack CI testing on every commit to the projects
-Read more at http://devstack.org (built from the gh-pages branch)
+Read more at http://devstack.org.
-IMPORTANT: Be sure to carefully read `stack.sh` and any other scripts you execute before you run them, as they install software and may alter your networking configuration. We strongly recommend that you run `stack.sh` in a clean and disposable vm when you are first getting started.
-
-# DevStack on Xenserver
-
-If you would like to use Xenserver as the hypervisor, please refer to the instructions in `./tools/xen/README.md`.
-
-# DevStack on Docker
-
-If you would like to use Docker as the hypervisor, please refer to the instructions in `./tools/docker/README.md`.
+IMPORTANT: Be sure to carefully read `stack.sh` and any other scripts you
+execute before you run them, as they install software and will alter your
+networking configuration. We strongly recommend that you run `stack.sh`
+in a clean and disposable vm when you are first getting started.
# Versions
-The devstack master branch generally points to trunk versions of OpenStack components. For older, stable versions, look for branches named stable/[release] in the DevStack repo. For example, you can do the following to create a diablo OpenStack cloud:
+The DevStack master branch generally points to trunk versions of OpenStack
+components. For older, stable versions, look for branches named
+stable/[release] in the DevStack repo. For example, you can do the
+following to create a grizzly OpenStack cloud:
- git checkout stable/diablo
+ git checkout stable/grizzly
./stack.sh
-You can also pick specific OpenStack project releases by setting the appropriate `*_BRANCH` variables in `localrc` (look in `stackrc` for the default set). Usually just before a release there will be milestone-proposed branches that need to be tested::
+You can also pick specific OpenStack project releases by setting the appropriate
+`*_BRANCH` variables in the ``localrc`` section of `local.conf` (look in
+`stackrc` for the default set). Usually just before a release there will be
+milestone-proposed branches that need to be tested::
GLANCE_REPO=https://github.com/openstack/glance.git
GLANCE_BRANCH=milestone-proposed
# Start A Dev Cloud
-Installing in a dedicated disposable vm is safer than installing on your dev machine! Plus you can pick one of the supported Linux distros for your VM. To start a dev cloud run the following NOT AS ROOT (see below for more):
+Installing in a dedicated disposable VM is safer than installing on your
+dev machine! Plus you can pick one of the supported Linux distros for
+your VM. To start a dev cloud run the following NOT AS ROOT (see
+**DevStack Execution Environment** below for more on user accounts):
./stack.sh
@@ -45,7 +49,7 @@
We also provide an environment file that you can use to interact with your cloud via CLI:
- # source openrc file to load your environment with osapi and ec2 creds
+ # source openrc file to load your environment with OpenStack CLI creds
. openrc
# list instances
nova list
@@ -61,16 +65,37 @@
DevStack runs rampant over the system it runs on, installing things and uninstalling other things. Running this on a system you care about is a recipe for disappointment, or worse. Alas, we're all in the virtualization business here, so run it in a VM. And take advantage of the snapshot capabilities of your hypervisor of choice to reduce testing cycle times. You might even save enough time to write one more feature before the next feature freeze...
-``stack.sh`` needs to have root access for a lot of tasks, but it also needs to have not-root permissions for most of its work and for all of the OpenStack services. So ``stack.sh`` specifically does not run if you are root. This is a recent change (Oct 2013) from the previous behaviour of automatically creating a ``stack`` user. Automatically creating a user account is not always the right response to running as root, so that bit is now an explicit step using ``tools/create-stack-user.sh``. Run that (as root!) if you do not want to just use your normal login here, which works perfectly fine.
+``stack.sh`` needs to have root access for a lot of tasks, but uses ``sudo``
+for all of those tasks. However, it needs to be not-root for most of its
+work and for all of the OpenStack services. ``stack.sh`` specifically
+does not run if started as root.
+
+This is a recent change (Oct 2013) from the previous behaviour of
+automatically creating a ``stack`` user. Automatically creating
+user accounts is not the right response to running as root, so
+that bit is now an explicit step using ``tools/create-stack-user.sh``.
+Run that (as root!) or just check it out to see what DevStack's
+expectations are for the account it runs under. Many people simply
+use their usual login (the default 'ubuntu' login on a UEC image
+for example).
# Customizing
-You can override environment variables used in `stack.sh` by creating file name `localrc`. It is likely that you will need to do this to tweak your networking configuration should you need to access your cloud from a different host.
+You can override environment variables used in `stack.sh` by creating file
+name `local.conf` with a ``locarc`` section as shown below. It is likely
+that you will need to do this to tweak your networking configuration should
+you need to access your cloud from a different host.
+
+ [[local|localrc]]
+ VARIABLE=value
+
+See the **Local Configuration** section below for more details.
# Database Backend
Multiple database backends are available. The available databases are defined in the lib/databases directory.
-`mysql` is the default database, choose a different one by putting the following in `localrc`:
+`mysql` is the default database, choose a different one by putting the
+following in the `localrc` section:
disable_service mysql
enable_service postgresql
@@ -81,7 +106,7 @@
Multiple RPC backends are available. Currently, this
includes RabbitMQ (default), Qpid, and ZeroMQ. Your backend of
-choice may be selected via the `localrc`.
+choice may be selected via the `localrc` section.
Note that selecting more than one RPC backend will result in a failure.
@@ -95,9 +120,10 @@
# Apache Frontend
-Apache web server is enabled for wsgi services by setting `APACHE_ENABLED_SERVICES` in your localrc. But remember to enable these services at first as above.
+Apache web server is enabled for wsgi services by setting
+`APACHE_ENABLED_SERVICES` in your ``localrc`` section. Remember to
+enable these services at first as above.
-Example:
APACHE_ENABLED_SERVICES+=keystone,swift
# Swift
@@ -108,23 +134,23 @@
object services will run directly in screen. The others services like
replicator, updaters or auditor runs in background.
-If you would like to enable Swift you can add this to your `localrc` :
+If you would like to enable Swift you can add this to your `localrc` section:
enable_service s-proxy s-object s-container s-account
If you want a minimal Swift install with only Swift and Keystone you
-can have this instead in your `localrc`:
+can have this instead in your `localrc` section:
disable_all_services
enable_service key mysql s-proxy s-object s-container s-account
If you only want to do some testing of a real normal swift cluster
with multiple replicas you can do so by customizing the variable
-`SWIFT_REPLICAS` in your `localrc` (usually to 3).
+`SWIFT_REPLICAS` in your `localrc` section (usually to 3).
# Swift S3
-If you are enabling `swift3` in `ENABLED_SERVICES` devstack will
+If you are enabling `swift3` in `ENABLED_SERVICES` DevStack will
install the swift3 middleware emulation. Swift will be configured to
act as a S3 endpoint for Keystone so effectively replacing the
`nova-objectstore`.
@@ -137,7 +163,7 @@
Basic Setup
In order to enable Neutron a single node setup, you'll need the
-following settings in your `localrc` :
+following settings in your `localrc` section:
disable_service n-net
enable_service q-svc
@@ -146,12 +172,15 @@
enable_service q-l3
enable_service q-meta
enable_service neutron
- # Optional, to enable tempest configuration as part of devstack
+ # Optional, to enable tempest configuration as part of DevStack
enable_service tempest
Then run `stack.sh` as normal.
-devstack supports adding specific Neutron configuration flags to the service, Open vSwitch plugin and LinuxBridge plugin configuration files. To make use of this feature, the following variables are defined and can be configured in your `localrc` file:
+DevStack supports setting specific Neutron configuration flags to the
+service, Open vSwitch plugin and LinuxBridge plugin configuration files.
+To make use of this feature, the following variables are defined and can
+be configured in your `localrc` section:
Variable Name Config File Section Modified
-------------------------------------------------------------------------------------
@@ -160,12 +189,14 @@
Q_AGENT_EXTRA_SRV_OPTS Plugin `OVS` (for Open Vswitch) or `LINUX_BRIDGE` (for LinuxBridge)
Q_SRV_EXTRA_DEFAULT_OPTS Service DEFAULT
-An example of using the variables in your `localrc` is below:
+An example of using the variables in your `localrc` section is below:
Q_AGENT_EXTRA_AGENT_OPTS=(tunnel_type=vxlan vxlan_udp_port=8472)
Q_SRV_EXTRA_OPTS=(tenant_network_type=vxlan)
-devstack also supports configuring the Neutron ML2 plugin. The ML2 plugin can run with the OVS, LinuxBridge, or Hyper-V agents on compute hosts. A simple way to configure the ml2 plugin is shown below:
+DevStack also supports configuring the Neutron ML2 plugin. The ML2 plugin
+can run with the OVS, LinuxBridge, or Hyper-V agents on compute hosts. A
+simple way to configure the ml2 plugin is shown below:
# VLAN configuration
Q_PLUGIN=ml2
@@ -179,7 +210,9 @@
Q_PLUGIN=ml2
Q_ML2_TENANT_NETWORK_TYPE=vxlan
-The above will default in devstack to using the OVS on each compute host. To change this, set the `Q_AGENT` variable to the agent you want to run (e.g. linuxbridge).
+The above will default in DevStack to using the OVS on each compute host.
+To change this, set the `Q_AGENT` variable to the agent you want to run
+(e.g. linuxbridge).
Variable Name Notes
-------------------------------------------------------------------------------------
@@ -194,13 +227,13 @@
# Heat
Heat is disabled by default. To enable it you'll need the following settings
-in your `localrc` :
+in your `localrc` section:
enable_service heat h-api h-api-cfn h-api-cw h-eng
Heat can also run in standalone mode, and be configured to orchestrate
on an external OpenStack cloud. To launch only Heat in standalone mode
-you'll need the following settings in your `localrc` :
+you'll need the following settings in your `localrc` section:
disable_all_services
enable_service rabbit mysql heat h-api h-api-cfn h-api-cw h-eng
@@ -215,9 +248,23 @@
$ cd /opt/stack/tempest
$ nosetests tempest/scenario/test_network_basic_ops.py
+# DevStack on Xenserver
+
+If you would like to use Xenserver as the hypervisor, please refer to the instructions in `./tools/xen/README.md`.
+
+# DevStack on Docker
+
+If you would like to use Docker as the hypervisor, please refer to the instructions in `./tools/docker/README.md`.
+
# Additional Projects
-DevStack has a hook mechanism to call out to a dispatch script at specific points in the execution if `stack.sh`, `unstack.sh` and `clean.sh`. This allows higher-level projects, especially those that the lower level projects have no dependency on, to be added to DevStack without modifying the scripts. Tempest is built this way as an example of how to structure the dispatch script, see `extras.d/80-tempest.sh`. See `extras.d/README.md` for more information.
+DevStack has a hook mechanism to call out to a dispatch script at specific
+points in the execution of `stack.sh`, `unstack.sh` and `clean.sh`. This
+allows upper-layer projects, especially those that the lower layer projects
+have no dependency on, to be added to DevStack without modifying the core
+scripts. Tempest is built this way as an example of how to structure the
+dispatch script, see `extras.d/80-tempest.sh`. See `extras.d/README.md`
+for more information.
# Multi-Node Setup
@@ -232,7 +279,8 @@
enable_service q-meta
enable_service neutron
-You likely want to change your `localrc` to run a scheduler that will balance VMs across hosts:
+You likely want to change your `localrc` section to run a scheduler that
+will balance VMs across hosts:
SCHEDULER=nova.scheduler.simple.SimpleScheduler
@@ -249,7 +297,7 @@
Cells is a new scaling option with a full spec at http://wiki.openstack.org/blueprint-nova-compute-cells.
-To setup a cells environment add the following to your `localrc`:
+To setup a cells environment add the following to your `localrc` section:
enable_service n-cell
@@ -264,32 +312,41 @@
The new config file ``local.conf`` is an extended-INI format that introduces a new meta-section header that provides some additional information such as a phase name and destination config filename:
- [[ <phase> | <filename> ]]
+ [[ <phase> | <config-file-name> ]]
-where <phase> is one of a set of phase names defined by ``stack.sh`` and <filename> is the project config filename. The filename is eval'ed in the stack.sh context so all environment variables are available and may be used. Using the project config file variables in the header is strongly suggested (see example of NOVA_CONF below). If the path of the config file does not exist it is skipped.
+where ``<phase>`` is one of a set of phase names defined by ``stack.sh``
+and ``<config-file-name>`` is the configuration filename. The filename is
+eval'ed in the ``stack.sh`` context so all environment variables are
+available and may be used. Using the project config file variables in
+the header is strongly suggested (see the ``NOVA_CONF`` example below).
+If the path of the config file does not exist it is skipped.
The defined phases are:
-* local - extracts ``localrc`` from ``local.conf`` before ``stackrc`` is sourced
-* post-config - runs after the layer 2 services are configured and before they are started
-* extra - runs after services are started and before any files in ``extra.d`` are executes
+* **local** - extracts ``localrc`` from ``local.conf`` before ``stackrc`` is sourced
+* **post-config** - runs after the layer 2 services are configured and before they are started
+* **extra** - runs after services are started and before any files in ``extra.d`` are executed
The file is processed strictly in sequence; meta-sections may be specified more than once but if any settings are duplicated the last to appear in the file will be used.
- [[post-config|$NOVA_CONF]]
- [DEFAULT]
- use_syslog = True
+ [[post-config|$NOVA_CONF]]
+ [DEFAULT]
+ use_syslog = True
- [osapi_v3]
- enabled = False
+ [osapi_v3]
+ enabled = False
-A specific meta-section ``local:localrc`` is used to provide a default localrc file. This allows all custom settings for DevStack to be contained in a single file. ``localrc`` is not overwritten if it exists to preserve compatability.
+A specific meta-section ``local|localrc`` is used to provide a default
+``localrc`` file (actually ``.localrc.auto``). This allows all custom
+settings for DevStack to be contained in a single file. If ``localrc``
+exists it will be used instead to preserve backward-compatibility.
- [[local|localrc]]
- FIXED_RANGE=10.254.1.0/24
- ADMIN_PASSWORD=speciale
- LOGFILE=$DEST/logs/stack.sh.log
+ [[local|localrc]]
+ FIXED_RANGE=10.254.1.0/24
+ ADMIN_PASSWORD=speciale
+ LOGFILE=$DEST/logs/stack.sh.log
-Note that ``Q_PLUGIN_CONF_FILE`` is unique in that it is assumed to _NOT_ start with a ``/`` (slash) character. A slash will need to be added:
+Note that ``Q_PLUGIN_CONF_FILE`` is unique in that it is assumed to *NOT*
+start with a ``/`` (slash) character. A slash will need to be added:
- [[post-config|/$Q_PLUGIN_CONF_FILE]]
+ [[post-config|/$Q_PLUGIN_CONF_FILE]]
diff --git a/extras.d/README.md b/extras.d/README.md
index 591e438..88e4265 100644
--- a/extras.d/README.md
+++ b/extras.d/README.md
@@ -10,12 +10,11 @@
names start with a two digit sequence number. DevStack reserves the sequence
numbers 00 through 09 and 90 through 99 for its own use.
-The scripts are sourced at each hook point so they should not declare anything
-at the top level that would cause a problem, specifically, functions. This does
-allow the entire `stack.sh` variable space to be available. The scripts are
+The scripts are sourced at the beginning of each script that calls them. The
+entire `stack.sh` variable space is available. The scripts are
sourced with one or more arguments, the first of which defines the hook phase:
-arg 1: source | stack | unstack | clean
+ source | stack | unstack | clean
source: always called first in any of the scripts, used to set the
initial defaults in a lib/* script or similar
diff --git a/stack.sh b/stack.sh
index aa0efea..b3380a8 100755
--- a/stack.sh
+++ b/stack.sh
@@ -53,7 +53,7 @@
if [[ -r $TOP_DIR/localrc ]]; then
warn $LINENO "localrc and local.conf:[[local]] both exist, using localrc"
else
- echo "# Generated file, do not exit" >$TOP_DIR/.localrc.auto
+ echo "# Generated file, do not edit" >$TOP_DIR/.localrc.auto
get_meta_section $TOP_DIR/local.conf local $lfile >>$TOP_DIR/.localrc.auto
fi
fi