Merge "Move platform check after localrc"
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/pxe-boot.rst b/doc/source/guides/pxe-boot.rst
deleted file mode 100644
index f745abb..0000000
--- a/doc/source/guides/pxe-boot.rst
+++ /dev/null
@@ -1,140 +0,0 @@
-`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>`__
-
-PXE Boot Server Guide: Magic Dust for Network Boot
-==================================================
-
-Boot DevStack from a PXE server to a RAM disk.
-
-Prerequisites Hardware & OpenWRT
---------------------------------
-
-Hardware
-~~~~~~~~
-
-The whole point of this exercise is to have a highly portable boot
-server, so using a small router with a USB port is the desired platform.
-This guide uses a Buffalo WZR-HP-G300NH as an example, but it is easily
-generalized for other supported platforms. See openwrt.org for more.
-
-OpenWRT
-~~~~~~~
-
-Any recent 'Backfire' build of OpenWRT will work for the boot server
-project. We build from trunk and have made the images available at
-`http://openwrt.xr7.org/openwrt <http://openwrt.xr7.org/openwrt>`__.
-
-Installation bit blasting
--------------------------
-
-Install the Image
-~~~~~~~~~~~~~~~~~
-
-This process follows `the OpenWRT doc OEM
-Install <http://wiki.openwrt.org/toh/buffalo/wzr-hp-g300h>`__ to tftp
-the new image onto the router. You need a computer to set up the router,
-we assume it is a recent Linux or OS/X installation.
-
-- Get openwrt-ar71xx-wzr-hp-g300nh-squashfs-tftp.bin
-
- ::
-
- wget http://openwrt.xr7.org/openwrt/ar71xx/openwrt-ar71xx-wzr-hp-g300nh-squashfs-tftp.bin
-
-- Connect computer to LAN port 4 (closest to WAN port)
-- Set computer interface to IP address in the 192.168.11.2
-- Add static arp entry for router
-
- ::
-
- arp -s 192.168.11.1 <mac-address>
-
-- Start TFTP transfer attempt
-
- ::
-
- tftp 192.168.11.1
- binary
- rexmt 1
- timeout 60
- put openwrt-ar71xx-wzr-hp-g300nh-squashfs-tftp.bin
-
-- Power on router. Router will reboot and initialize on 192.168.1.1.
-- Delete static arp entry for router
-
- ::
-
- arp -d 192.168.11.1
-
-- Set computer to DHCP, connect and telnet to router and set root
- password.
-
-Configure the Router
-~~~~~~~~~~~~~~~~~~~~
-
-- Update ``/etc/opkg.conf`` to point to our repo:
-
- ::
-
- src/gz packages http://192.168.5.13/openwrt/build/ar71xx/packages
-
-- Configure anon mounts:
-
- ::
-
- uci delete fstab.@mount[0]
- uci commit fstab
- /etc/init.d/fstab restart
-
-- Reset the DHCP address range. DevStack will claim the upper /25 of
- the router's LAN address space for floating IPs so the default DHCP
- address range needs to be moved:
-
- ::
-
- uci set dhcp.lan.start=65
- uci set dhcp.lan.limit=60
- uci commit dhcp
-
-- Enable TFTP:
-
- ::
-
- uci set dhcp.@dnsmasq[0].enable_tftp=1
- uci set dhcp.@dnsmasq[0].tftp_root=/mnt/sda1/tftpboot
- uci set dhcp.@dnsmasq[0].dhcp_boot=pxelinux.0
- uci commit dhcp
- /etc/init.d/dnsmasq restart
-
-Set Up tftpboot
-~~~~~~~~~~~~~~~
-
-- Create the ``/tmp/tftpboot`` structure and populate it:
-
- ::
-
- cd ~/devstack
- tools/build_pxe_boot.sh /tmp
-
- This calls ``tools/build_ramdisk.sh`` to create a 2GB ramdisk
- containing a complete development Oneiric OS plus the OpenStack code
- checkouts.
-
-- Copy ``tftpboot`` to a USB drive:
-
- ::
-
- mount /dev/sdb1 /mnt/tmp
- rsync -a /tmp/tftpboot/ /mnt/tmp/tftpboot/
- umount /mnt/tmp
-
-- Plug USB drive into router. It will be automounted and is ready to
- serve content.
-
-Now `return <ramdisk.html>`__ to the RAM disk Guide to kick off your
-DevStack experience.
diff --git a/doc/source/guides/ramdisk.rst b/doc/source/guides/ramdisk.rst
deleted file mode 100644
index 1ba74f2..0000000
--- a/doc/source/guides/ramdisk.rst
+++ /dev/null
@@ -1,86 +0,0 @@
-`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>`__
-
-Stack-in-a-Box: Try before you mkfs
-===================================
-
-Run DevStack from a RAM disk to give it a whirl before making the
-commitment to install it. We'll cover booting from a USB drive or over
-the network via PXE. We'll even thow in configuring a home router to
-handle the PXE boot. You will need a minimum of 3GB for both of these
-configurations as the RAM disk itself is 2GB.
-
-Prerequisites Hardware
-----------------------
-
-USB Boot
-~~~~~~~~
-
-`This guide <usb-boot.html>`__ covers the creation of a bootable USB
-drive. Your computer BIOS must support booting from USB.
-
-PXE Boot
-~~~~~~~~
-
-`This guide <pxe-boot.html>`__ covers the installation of OpenWRT on a
-home router and configuring it as a PXE server, plus the creation of the
-boot images and PXE support files.
-
-Installation bit blasting
--------------------------
-
-Install DevStack
-~~~~~~~~~~~~~~~~
-
-Grab the latest version of DevStack via https:
-
-::
-
- sudo apt-get install git -y
- git clone https://git.openstack.org/openstack-dev/devstack
- cd devstack
-
-Prepare the Boot RAMdisk
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-Pick your boot method and follow the guide to prepare to build the RAM
-disk and set up the boot process:
-
-- `USB boot <usb-boot.html>`__
-- `PXE boot <pxe-boot.html>`__
-
-Fire It Up
-~~~~~~~~~~
-
-- Boot the computer into the RAM disk. The details will vary from
- machine to machine but most BIOSes have a method to select the boot
- device, often by pressing F12 during POST.
-- Select 'DevStack' from the Boot Menu.
-- Log in with the 'stack' user and 'pass' password.
-- Create ``devstack/localrc`` if you wish to change any of the
- configuration variables. You will probably want to at least set the
- admin login password to something memorable rather than the default
- 20 random characters:
-
- ::
-
- ADMIN_PASSWORD=openstack
-
-- Fire up OpenStack!
-
- ::
-
- ./run.sh
-
-- See the processes running in screen:
-
- ::
-
- screen -x
-
-- Connect to the dashboard at ``http://<ip-address>/``
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/guides/usb-boot.rst b/doc/source/guides/usb-boot.rst
deleted file mode 100644
index 4f7a494..0000000
--- a/doc/source/guides/usb-boot.rst
+++ /dev/null
@@ -1,57 +0,0 @@
-`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>`__
-
-USB Boot: Undoable Stack Boot
-=============================
-
-Boot DevStack from a USB disk into a RAM disk.
-
-Prerequisites
--------------
-
-Hardware
-~~~~~~~~
-
-This guide covers the creation of a bootable USB drive. Your computer
-BIOS must support booting from USB and You will want at least 3GB of
-RAM. You also will need a USB drive of at least 2GB.
-
-Software
-~~~~~~~~
-
-Ubuntu 11.10 (Oneiric Ocelot) is required on host to create images.
-
-Installation bit blasting
--------------------------
-
-Set Up USB Drive
-~~~~~~~~~~~~~~~~
-
-- Insert the USB drive into the computer. Make a note of the device
- name, such as ``sdb``. Do not mount the device.
-- Install the boot system:
-
- ::
-
- tools/build_usb_boot.sh /dev/sdb1
-
- This calls tools/build\_ramdisk.sh to create a 2GB ramdisk containing
- a complete development Oneiric OS plus the OpenStack code checkouts.
- It then writes a syslinux boot sector to the specified device and
- creates ``/syslinux``.
-
-- If desired, you may now mount the device:
-
- ::
-
- mount /dev/sdb1 /mnt/tmp
- # foo
- umount /mnt/tmp
-
-Now `return <ramdisk.html>`__ to the RAM disk Guide to kick off your
-DevStack experience.
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 37b365d..2128620 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
---------------------------------------
@@ -63,8 +42,8 @@
#. Configure
- We recommend at least a `minimal
- configuration <configuration.html>`__ be set up.
+ We recommend at least a :doc:`minimal
+ configuration <configuration>` be set up.
#. Start the install
@@ -75,104 +54,85 @@
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
+~~~~~~~~~~~~~~~
+
+:doc:`Run OpenStack in a VM <guides/single-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. :doc:`[Read] <guides/single-vm>`
+
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
+~~~~~~~~~~
+
+:doc:`Run OpenStack on dedicated hardware <guides/single-machine>` to get real performance in your VMs.
+This can include a server-class machine or a laptop at home. :doc:`[Read] <guides/single-machine>`
+
+Multi-Node + VLANs
+~~~~~~~~~~~~~~~~~~
+
+:doc:`Setup a multi-node cluster <guides/multinode-lab>` with dedicated VLANs for VMs & Management. :doc:`[Read] <guides/multinode-lab>`
+
+Documentation
+=============
Overview
--------
-`An overview of DevStack goals and priorities <overview.html>`__
+:doc:`An overview of DevStack goals and priorities <overview>`
Configuration
-------------
-`Configuring and customizing the stack <configuration.html>`__
+:doc:`Configuring and customizing the stack <configuration>`
Plugins
-------
-`Extending DevStack with new features <plugins.html>`__
+:doc:`Extending DevStack with new features <plugins>`
Recent Changes
--------------
-`An incomplete summary of recent changes <changes.html>`__
+:doc:`An incomplete summary of recent changes <changes>`
FAQ
---
-`The DevStack FAQ <faq.html>`__
+:doc:`The DevStack FAQ <faq>`
Contributing
------------
-`Pitching in to make DevStack a better place <contributing.html>`__
+:doc:`Pitching in to make DevStack a better place <contributing>`
-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
diff --git a/lib/opendaylight b/lib/opendaylight
index 374de95..bdebe58 100644
--- a/lib/opendaylight
+++ b/lib/opendaylight
@@ -44,6 +44,9 @@
# The ODL password
ODL_PASSWORD=${ODL_PASSWORD:-admin}
+# Short name of ODL package
+ODL_NAME=${ODL_NAME:-distribution-karaf-0.2.0-Helium}
+
# <define global variables here that belong to this project>
ODL_DIR=$DEST/opendaylight
@@ -87,23 +90,23 @@
# configure_opendaylight() - Set config files, create data dirs, etc
function configure_opendaylight {
# Add odl-ovsdb-openstack if it's not already there
- local ODLOVSDB=$(cat $ODL_DIR/distribution-karaf-0.2.0-Helium/etc/org.apache.karaf.features.cfg | grep featuresBoot= | grep odl)
+ local ODLOVSDB=$(cat $ODL_DIR/$ODL_NAME/etc/org.apache.karaf.features.cfg | grep featuresBoot= | grep odl)
if [ "$ODLOVSDB" == "" ]; then
- sed -i '/^featuresBoot=/ s/$/,odl-ovsdb-openstack/' $ODL_DIR/distribution-karaf-0.2.0-Helium/etc/org.apache.karaf.features.cfg
+ sed -i '/^featuresBoot=/ s/$/,odl-ovsdb-openstack/' $ODL_DIR/$ODL_NAME/etc/org.apache.karaf.features.cfg
fi
# Configure OpenFlow 1.3 if it's not there
- local OFLOW13=$(cat $ODL_DIR/distribution-karaf-0.2.0-Helium/etc/custom.properties | grep ^of.version)
+ local OFLOW13=$(cat $ODL_DIR/$ODL_NAME/etc/custom.properties | grep ^of.version)
if [ "$OFLOW13" == "" ]; then
- echo "ovsdb.of.version=1.3" >> $ODL_DIR/distribution-karaf-0.2.0-Helium/etc/custom.properties
+ echo "ovsdb.of.version=1.3" >> $ODL_DIR/$ODL_NAME/etc/custom.properties
fi
# Configure L3 if the user wants it
if [ "${ODL_L3}" == "True" ]; then
# Configure L3 FWD if it's not there
- local L3FWD=$(cat $ODL_DIR/distribution-karaf-0.2.0-Helium/etc/custom.properties | grep ^ovsdb.l3.fwd.enabled)
+ local L3FWD=$(cat $ODL_DIR/$ODL_NAME/etc/custom.properties | grep ^ovsdb.l3.fwd.enabled)
if [ "$L3FWD" == "" ]; then
- echo "ovsdb.l3.fwd.enabled=yes" >> $ODL_DIR/distribution-karaf-0.2.0-Helium/etc/custom.properties
+ echo "ovsdb.l3.fwd.enabled=yes" >> $ODL_DIR/$ODL_NAME/etc/custom.properties
fi
fi
}
@@ -156,7 +159,7 @@
# -of13: runs ODL using OpenFlow 1.3 protocol support.
# -virt ovsdb: Runs ODL in "virtualization" mode with OVSDB support
- run_process odl-server "cd $ODL_DIR/distribution-karaf-0.2.0-Helium && JAVA_HOME=$JHOME bin/karaf"
+ run_process odl-server "cd $ODL_DIR/$ODL_NAME && JAVA_HOME=$JHOME bin/karaf"
# Sleep a bit to let OpenDaylight finish starting up
sleep $ODL_BOOT_WAIT