Merge "Add ODL_NAME variable for OpenDaylight configuration"
diff --git a/doc/source/changes.rst b/doc/source/changes.rst
index ccd96e8..f4a326d 100644
--- a/doc/source/changes.rst
+++ b/doc/source/changes.rst
@@ -1,10 +1,6 @@
-`DevStack </>`__
-
-- `Overview <overview.html>`__
-- `Changes <changes.html>`__
-- `FAQ <faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
+=======
+Changes
+=======
Recent Changes What's been happening?
-------------------------------------
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index 9befc90..eba2956 100644
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -1,13 +1,6 @@
-`DevStack </>`__
-
-- `Overview <overview.html>`__
-- `Changes <changes.html>`__
-- `FAQ <faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-Configuration Making it go my way
----------------------------------
+=============
+Configuration
+=============
DevStack has always tried to be mostly-functional with a minimal amount
of configuration. The number of options has ballooned as projects add
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
index 73069e7..b4f9f37 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributing.rst
@@ -1,13 +1,6 @@
-`DevStack </>`__
-
-- `Overview <overview.html>`__
-- `Changes <changes.html>`__
-- `FAQ <faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-Contributing Help us help you
------------------------------
+============
+Contributing
+============
DevStack uses the standard OpenStack contribution process as outlined in
`the OpenStack wiki 'How To
diff --git a/doc/source/eucarc.rst b/doc/source/eucarc.rst
index c91d341..1284b88 100644
--- a/doc/source/eucarc.rst
+++ b/doc/source/eucarc.rst
@@ -1,13 +1,6 @@
-`DevStack </>`__
-
-- `Overview <overview.html>`__
-- `Changes <changes.html>`__
-- `FAQ <faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-eucarc EC2 settings
--------------------
+=====================
+eucarc - EC2 Settings
+=====================
``eucarc`` creates EC2 credentials for the current user as defined by
``OS_TENANT_NAME:OS_USERNAME``. ``eucarc`` sources ``openrc`` at the
diff --git a/doc/source/exerciserc.rst b/doc/source/exerciserc.rst
index ed3f2e8..f3780c3 100644
--- a/doc/source/exerciserc.rst
+++ b/doc/source/exerciserc.rst
@@ -1,13 +1,6 @@
-`DevStack </>`__
-
-- `Overview <overview.html>`__
-- `Changes <changes.html>`__
-- `FAQ <faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-exerciserc Exercise settings
-----------------------------
+==============================
+exerciserc - Exercise Settings
+==============================
``exerciserc`` is used to configure settings for the exercise scripts.
The values shown below are the default values. Thse can all be
diff --git a/doc/source/faq.rst b/doc/source/faq.rst
index 36b25b3..7b33b41 100644
--- a/doc/source/faq.rst
+++ b/doc/source/faq.rst
@@ -1,13 +1,6 @@
-`DevStack </>`__
-
-- `Overview <overview.html>`__
-- `Changes <changes.html>`__
-- `FAQ <faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-FAQ: Using DevStack Making to behave
-------------------------------------
+===
+FAQ
+===
- `General Questions <#general>`__
- `Operation and Configuration <#ops_conf>`__
diff --git a/doc/source/guides/multinode-lab.rst b/doc/source/guides/multinode-lab.rst
index 0b1ebb9..1c53227 100644
--- a/doc/source/guides/multinode-lab.rst
+++ b/doc/source/guides/multinode-lab.rst
@@ -1,13 +1,6 @@
-`DevStack </>`__
-
-- `Overview <../overview.html>`__
-- `Changes <../changes.html>`__
-- `FAQ <../faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-Multi-Node Lab: Serious Stuff
-=============================
+==============
+Multi-Node Lab
+==============
Here is OpenStack in a realistic test configuration with multiple
physical servers.
diff --git a/doc/source/guides/single-machine.rst b/doc/source/guides/single-machine.rst
index 3e0a39c..6059511 100644
--- a/doc/source/guides/single-machine.rst
+++ b/doc/source/guides/single-machine.rst
@@ -1,13 +1,6 @@
-`DevStack </>`__
-
-- `Overview <../overview.html>`__
-- `Changes <../changes.html>`__
-- `FAQ <../faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-All-In-One: Dedicated Hardware
-==============================
+==========
+All-In-One
+==========
Things are about to get real! Using OpenStack in containers or VMs is
nice for kicking the tires, but doesn't compare to the feeling you get
diff --git a/doc/source/guides/single-vm.rst b/doc/source/guides/single-vm.rst
index 35efb14..d296db6 100644
--- a/doc/source/guides/single-vm.rst
+++ b/doc/source/guides/single-vm.rst
@@ -1,13 +1,6 @@
-`DevStack </>`__
-
-- `Overview <../overview.html>`__
-- `Changes <../changes.html>`__
-- `FAQ <../faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-Running a Cloud in a VM
-=======================
+=============
+Cloud in a VM
+=============
Use the cloud to build the cloud! Use your cloud to launch new versions
of OpenStack in about 5 minutes. When you break it, start over! The VMs
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 37b365d..6c38216 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,40 +1,19 @@
-`DevStack </>`__
-
-- `Overview <overview.rst>`__
-- `Changes <changes.rst>`__
-- `FAQ <faq.rst>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-.. toctree::
- :glob:
- :maxdepth: 2
-
- *
- guides/*
-
-
-
DevStack - an OpenStack Community Production
============================================
-| A documented shell script to build complete OpenStack development environments.
-| An OpenStack program maintained by the developer community.
+.. toctree::
+ :glob:
+ :maxdepth: 1
-#. Setup a fresh supported Linux installation.
-#. Clone devstack from git.openstack.org.
+ overview
+ configuration
+ plugins
+ faq
+ changes
+ contributing
- ::
+ guides/*
- git clone https://git.openstack.org/openstack-dev/devstack
-
-#. Deploy your OpenStack Cloud
-
- ::
-
- cd devstack && ./stack.sh
-
-
Quick Start This ain't your first rodeo
---------------------------------------
@@ -75,68 +54,45 @@
It takes a few minutes, we recommend `reading the
script <stack.sh.html>`__ while it is building.
-Guides Walk through various setups used by stackers
----------------------------------------------------
+Guides
+======
+
+Walk through various setups used by stackers
OpenStack on VMs
----------------
-Title
-
-Description
-
-Link
-
-Virtual Machine
-
-Run OpenStack in a VM. The VMs launched in your cloud will be slow as
-they are running in QEMU (emulation), but it is useful if you don't have
-spare hardware laying around.
-
-`Read » <guides/single-vm.html>`__
-
-1 Guide
-
-What is this?
-^^^^^^^^^^^^^
-
These guides tell you how to virtualize your OpenStack cloud in virtual
machines. This means that you can get started without having to purchase
any hardware.
+Virtual Machine
+~~~~~~~~~~~~~~~
+
+`Run OpenStack in a VM <guides/single-vm.html>`__. The VMs launched in your cloud will be slow as
+they are running in QEMU (emulation), but it is useful if you don't have
+spare hardware laying around. `[Read] <guides/single-vm.html>`__
+
OpenStack on Hardware
---------------------
-Title
-
-Description
-
-Link
-
-All-In-One
-
-Run OpenStack on dedicated hardware to get real performance in your VMs.
-This can include a server-class machine or a laptop at home.
-
-`Read » <guides/single-machine.html>`__
-
-Multi-Node + VLANs
-
-Setup a multi-node cluster with dedicated VLANs for VMs & Management.
-
-`Read » <guides/multinode-lab.html>`__
-
-2 Guides
-
-What is this?
-^^^^^^^^^^^^^
-
These guides tell you how to deploy a development environment on real
hardware. Guides range from running OpenStack on a single laptop to
running a multi-node deployment on datacenter hardware.
-Documentation Help yourself to stack
-------------------------------------
+All-In-One
+~~~~~~~~~~
+
+`Run OpenStack on dedicated hardware <guides/single-machine.html>`__ to get real performance in your VMs.
+This can include a server-class machine or a laptop at home. `[Read] <guides/single-machine.html>`__
+
+Multi-Node + VLANs
+~~~~~~~~~~~~~~~~~~
+
+`Setup a multi-node cluster <guides/multinode-lab.html>`__ with dedicated VLANs for VMs & Management. `[Read] <guides/multinode-lab.html>`__
+
+Documentation
+=============
Overview
--------
@@ -168,11 +124,15 @@
`Pitching in to make DevStack a better place <contributing.html>`__
-Code A look at the bits that make it all go
--------------------------------------------
+Code
+====
-Scripts Generated documentation of DevStack scripts.
-----------------------------------------------------
+A look at the bits that make it all go
+
+Scripts
+-------
+
+Generated documentation of DevStack scripts.
+-------------------------------+----------------------------------------------+
| Filename | Link |
@@ -254,8 +214,8 @@
| extras.d/80-tempest.sh | `Read » <extras.d/80-tempest.html>`__ |
+-------------------------------+----------------------------------------------+
-Configuration Setting the table
--------------------------------
+Configuration
+-------------
+--------------+--------------------------------+
| Filename | Link |
@@ -271,8 +231,8 @@
| eucarc | `Read » <eucarc.html>`__ |
+--------------+--------------------------------+
-Tools Support scripts
----------------------
+Tools
+-----
+-----------------------------+----------------------------------------------+
| Filename | Link |
@@ -292,8 +252,10 @@
| tools/upload\_image.sh | `Read » <tools/upload_image.sh.html>`__ |
+-----------------------------+----------------------------------------------+
-Samples Generated documentation of DevStack sample files.
----------------------------------------------------------
+Samples
+-------
+
+Generated documentation of DevStack sample files.
+------------+--------------------------------------+
| Filename | Link |
@@ -303,8 +265,8 @@
| localrc | `Read » <samples/localrc.html>`__ |
+------------+--------------------------------------+
-Exercises Generated documentation of DevStack scripts.
-------------------------------------------------------
+Exercises
+---------
+---------------------------------+-------------------------------------------------+
| Filename | Link |
@@ -343,3 +305,9 @@
+---------------------------------+-------------------------------------------------+
| exercises/zaqar.sh | `Read » <exercises/zaqar.sh.html>`__ |
+---------------------------------+-------------------------------------------------+
+
+.. toctree::
+ :glob:
+ :maxdepth: 1
+
+ *
diff --git a/doc/source/local.conf.rst b/doc/source/local.conf.rst
index e1de44c..a9dfcb0 100644
--- a/doc/source/local.conf.rst
+++ b/doc/source/local.conf.rst
@@ -1,13 +1,6 @@
-`DevStack </>`__
-
-- `Overview <overview.html>`__
-- `Changes <changes.html>`__
-- `FAQ <faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-local.conf User settings
-------------------------
+==========================
+local.conf - User Settings
+==========================
``local.conf`` is a user-maintained setings file that is sourced in
``stackrc``. It contains a section that replaces the historical
diff --git a/doc/source/localrc.rst b/doc/source/localrc.rst
index 487280b..98f3083 100644
--- a/doc/source/localrc.rst
+++ b/doc/source/localrc.rst
@@ -1,13 +1,6 @@
-`DevStack </>`__
-
-- `Overview <overview.html>`__
-- `Changes <changes.html>`__
-- `FAQ <faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-localrc User settings
----------------------
+=====================
+localrc - The Old Way
+=====================
``localrc`` is the old file used to configure DevStack. It is deprecated
and has been replaced by ```local.conf`` <local.conf.html>`__. DevStack
diff --git a/doc/source/openrc.rst b/doc/source/openrc.rst
index ce5765a..dc12f76 100644
--- a/doc/source/openrc.rst
+++ b/doc/source/openrc.rst
@@ -1,13 +1,6 @@
-`DevStack </>`__
-
-- `Overview <overview.html>`__
-- `Changes <changes.html>`__
-- `FAQ <faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-openrc User authentication settings
------------------------------------
+=====================================
+openrc - User Authentication Settings
+=====================================
``openrc`` configures login credentials suitable for use with the
OpenStack command-line tools. ``openrc`` sources ``stackrc`` at the
diff --git a/doc/source/overview.rst b/doc/source/overview.rst
index cedf941..e3cf75d 100644
--- a/doc/source/overview.rst
+++ b/doc/source/overview.rst
@@ -1,13 +1,6 @@
-`DevStack </>`__
-
-- `Overview <overview.html>`__
-- `Changes <changes.html>`__
-- `FAQ <faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-Overview DevStack from a cloud-height view
-------------------------------------------
+========
+Overview
+========
DevStack has evolved to support a large number of configuration options
and alternative platforms and support services. That evolution has grown
diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst
index 0747b59..282c1a4 100644
--- a/doc/source/plugins.rst
+++ b/doc/source/plugins.rst
@@ -1,13 +1,6 @@
-`DevStack </>`__
-
-- `Overview <overview.html>`__
-- `Changes <changes.html>`__
-- `FAQ <faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-Plugins Add stuff
------------------
+=======
+Plugins
+=======
DevStack has a couple of plugin mechanisms to allow easily adding
support for additional projects and features.
diff --git a/doc/source/stackrc.rst b/doc/source/stackrc.rst
index 5d9d221..0faab45 100644
--- a/doc/source/stackrc.rst
+++ b/doc/source/stackrc.rst
@@ -1,13 +1,6 @@
-`DevStack </>`__
-
-- `Overview <overview.html>`__
-- `Changes <changes.html>`__
-- `FAQ <faq.html>`__
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__
-
-stackrc DevStack settings
--------------------------
+===========================
+stackrc - DevStack Settings
+===========================
``stackrc`` is the primary configuration file for DevStack. It contains
all of the settings that control the services started and the