The new configuration file is local.conf and resides in the root DevStack directory like the old localrc file. It is a modified INI format file that introduces a meta-section header to carry additional information regarding the configuration files to be changed.
The new header is similar to a normal INI section header but with two '[[ ]]' chars and two internal fields separated by a pipe ('|'):
+The new header is similar to a normal INI section header but with double brackets ([[ ... ]]) and two internal fields separated by a pipe (|):
[[ <phase> | <config-file-name> ]]@@ -67,6 +67,8 @@
The defined phases are:
localrc from local.conf before stackrc is sourcedextra.d are executed
[[post-config|/$Q_PLUGIN_CONF_FILE]]-
The existing ``EXTRAS_OPTS`` and similar variables are now deprecated. If used a warning will be printed at the end of the stack.sh run.
Also note that the localrc section is sourced as a shell script fragment amd = (equals).
localrc):
-EXTRA_OPTS=api_rate_limit=False -- to (
local.conf):
-[[post-config|$NOVA_CONF]] -[DEFAULT] -api_rate_limit = False -
CINDER_PERIODIC_INTERVAL):
[[post-config|$CINDER_CONF]]
[DEFAULT]
diff --git a/docs/source/contributing.html b/docs/source/contributing.html
index 8dbd179314..f3d4b5a4dc 100644
--- a/docs/source/contributing.html
+++ b/docs/source/contributing.html
@@ -59,20 +59,21 @@
HACKING.rst
Like most OpenStack projects, DevStack includes a HACKING.rst file that describes the layout, style and conventions of the project. Because HACKING.rst is in the main DevStack repo it is considered authoritative. Much of the content on this page is taken from there.
-
bash8 Formatting
- Around the time of the OpenStack Havana release we added a tool to do style checking in DevStack similar to what pep8/flake8 do for Python projects. It is still _very_ simplistic, focusing mostly on stray whitespace to help prevent -1 on reviews that are otherwise acceptable. Oddly enough it is called bash8. It will be expanded to enforce some of the documentation rules in comments that are used in formatting the script pages for devstack.org and possibly even simple code formatting. Run it on the entire project with ./run_tests.sh.
+
bashate Formatting
+ Around the time of the OpenStack Havana release we added a tool to do style checking in DevStack similar to what pep8/flake8 do for Python projects. It is still _very_ simplistic, focusing mostly on stray whitespace to help prevent -1 on reviews that are otherwise acceptable. Oddly enough it is called bashate. It will be expanded to enforce some of the documentation rules in comments that are used in formatting the script pages for devstack.org and possibly even simple code formatting. Run it on the entire project with ./run_tests.sh.
Code
Repo Layout
The DevStack repo generally keeps all of the primary scripts at the root level.
- exercises - contains the test scripts used to validate and demonstrate some OpenStack functions. These scripts know how to exit early or skip services that are not enabled.
- extras.d - contains the dispatch scripts called by the hooks in stack.sh, unstack.sh and clean.sh. See the plugins docs for more information.
- files - contains a variety of otherwise lost files used in configuring and operating DevStack. This includes templates for configuration files and the system dependency information. This is also where image files are downloaded and expanded if necessary.
- lib - contains the sub-scripts specific to each project. This is where the work of managing a project's services is located. Each top-level project (Keystone, Nova, etc) has a file here. Additionally there are some for system services and project plugins.
- samples - contains a sample of the local files not included in the DevStack repo.
+ docs - Contains the source for this website. It is built using tools/build_docs.sh.
+ exercises - Contains the test scripts used to validate and demonstrate some OpenStack functions. These scripts know how to exit early or skip services that are not enabled.
+ extras.d - Contains the dispatch scripts called by the hooks in stack.sh, unstack.sh and clean.sh. See the plugins docs for more information.
+ files - Contains a variety of otherwise lost files used in configuring and operating DevStack. This includes templates for configuration files and the system dependency information. This is also where image files are downloaded and expanded if necessary.
+ lib - Contains the sub-scripts specific to each project. This is where the work of managing a project's services is located. Each top-level project (Keystone, Nova, etc) has a file here. Additionally there are some for system services and project plugins.
+ samples - Contains a sample of the local files not included in the DevStack repo.
tests - the DevStack test suite is rather sparse, mostly consisting of test of specific fragile functions in the functions file.
- tools - contains a collection of stand-alone scripts, some of which have aged a bit (does anyone still do pamdisk installs?). While these may reference the top-level DevStack configuration they can generally be run alone. There are also some sub-directories to support specific environments such as XenServer and Docker.
+ tools - Contains a collection of stand-alone scripts, some of which have aged a bit (does anyone still do ramdisk installs?). While these may reference the top-level DevStack configuration they can generally be run alone. There are also some sub-directories to support specific environments such as XenServer.
diff --git a/docs/source/guides/multinode-lab.html b/docs/source/guides/multinode-lab.html
index 28a6585382..2e52379204 100644
--- a/docs/source/guides/multinode-lab.html
+++ b/docs/source/guides/multinode-lab.html
@@ -54,7 +54,7 @@
Minimal Install
- You need to have a fresh install of Linux on all of your nodes. You can download the Minimal CD for Ubuntu 12.04 (only 27MB) since DevStack will download & install all the additional dependencies. The netinstall ISO is available for Fedora and CentOS/RHEL.
+ You need to have a system with a fresh install of Linux. You can download the Minimal CD for Ubuntu releases since DevStack will download & install all the additional dependencies. The netinstall ISO is available for Fedora and CentOS/RHEL.
Install a couple of packages to bootstrap configuration:
apt-get install -y git sudo || yum install -y git sudo
diff --git a/docs/source/guides/single-machine.html b/docs/source/guides/single-machine.html
index 22807932f6..ca9cafac4e 100644
--- a/docs/source/guides/single-machine.html
+++ b/docs/source/guides/single-machine.html
@@ -53,7 +53,7 @@
Minimal Install
- You need to have a system with a fresh install of Linux. You can download the Minimal CD for Ubuntu 12.04 (only 27MB) since DevStack will download & install all the additional dependencies. The netinstall ISO is available for Fedora and CentOS/RHEL. You may be tempted to use a desktop distro on a laptop, it will probably work but you may need to tell Network Manager to keep its fingers off the interface(s) that OpenStack uses for bridging.
+ You need to have a system with a fresh install of Linux. You can download the Minimal CD for Ubuntu releases since DevStack will download & install all the additional dependencies. The netinstall ISO is available for Fedora and CentOS/RHEL. You may be tempted to use a desktop distro on a laptop, it will probably work but you may need to tell Network Manager to keep its fingers off the interface(s) that OpenStack uses for bridging.
Network Configuration
Determine the network configuration on the interface used to integrate your
diff --git a/docs/source/index.html b/docs/source/index.html
index 71c8c98cee..1a31df1ef0 100644
--- a/docs/source/index.html
+++ b/docs/source/index.html
@@ -76,7 +76,7 @@
-
Select a Linux Distribution
- Only Ubuntu 12.04 (Precise), Fedora 20 and CentOS/RHEL 6.5 are documented here. OpenStack also runs and is packaged on other flavors of Linux such as OpenSUSE and Debian.
+ Only Ubuntu 14.04 (Trusty), Fedora 20 and CentOS/RHEL 6.5 are documented here. OpenStack also runs and is packaged on other flavors of Linux such as OpenSUSE and Debian.
-
Install Selected OS
@@ -89,7 +89,7 @@
-
Configure
- While optional, we recommend a minimal configuration be set up as you may not want our default values for everything.
+ We recommend at least a minimal configuration be set up.
-
Start the install
@@ -230,6 +230,10 @@
functions
Read »
+
+ functions-common
+ Read »
+
lib/apache
Read »
@@ -303,12 +307,12 @@
Read »
- lib/savanna
- Read »
+ lib/sahara
+ Read »
- lib/savanna-dashboard
- Read »
+ lib/savanna
+ Read »
lib/stackforge
@@ -342,50 +346,35 @@
run_tests.sh
Read »
+
+ extras.d/50-ironic.sh
+ Read »
+
extras.d/70-marconi.sh
Read »
+
+ extras.d/70-sahara.sh
+ Read »
+
extras.d/70-savanna.sh
Read »
+
+ extras.d/70-trove.sh
+ Read »
+
+
+ extras.d/80-opendaylight.sh
+ Read »
+
extras.d/80-tempest.sh
Read »
-
- tools/info.sh
- Read »
-
-
- tools/build_docs.sh
- Read »
-
-
- tools/create_userrc.sh
- Read »
-
-
- tools/fixup_stuff.sh
- Read »
-
-
- tools/install_prereqs.sh
- Read »
-
-
- tools/install_pip.sh
- Read »
-
-
- tools/upload_image.sh
- Read »
-
-
- 40 bash scripts
-
@@ -420,9 +409,46 @@
Read »
-
- 5 configuration files
-
+
+
+ Tools Support scripts
+
+
+
+ Filename
+ Link
+
+
+
+
+ tools/info.sh
+ Read »
+
+
+ tools/build_docs.sh
+ Read »
+
+
+ tools/create_userrc.sh
+ Read »
+
+
+ tools/fixup_stuff.sh
+ Read »
+
+
+ tools/install_prereqs.sh
+ Read »
+
+
+ tools/install_pip.sh
+ Read »
+
+
+ tools/upload_image.sh
+ Read »
+
+
Samples Generated documentation of DevStack sample files.
@@ -443,9 +469,6 @@
Read »
-
- 2 sample files
-
@@ -493,10 +516,19 @@
exercises/horizon.sh
Read »
+
+ exercises/marconi.sh
+ Read »
exercises/neutron-adv-test.sh
Read »
+
+ exercises/sahara.sh
+ Read »
+
+ exercises/savanna.sh
+ Read »
exercises/sec_groups.sh
@@ -505,15 +537,15 @@
exercises/swift.sh
Read »
+
+ exercises/trove.sh
+ Read »
exercises/volumes.sh
Read »
-
- 13 exercise scripts
-
diff --git a/docs/source/overview.html b/docs/source/overview.html
index c0b6ea2f7c..baee400806 100644
--- a/docs/source/overview.html
+++ b/docs/source/overview.html
@@ -47,8 +47,8 @@
Overview DevStack from a cloud-height view
- DevStack is not and has never been intended to be a general OpenStack installer. It has evolved to support a large number of configuration options and alternative platforms and support services. However, that evolution has grown well beyond what was originally intended and the majority of configuration combinations are rarely, if ever, tested. DevStack was never meant to be everything to everyone and can not continue in that direction.
- Below is a list of what is specifically is supported (read that as "tested and assumed to work") going forward.
+ DevStack has evolved to support a large number of configuration options and alternative platforms and support services. That evolution has grown well beyond what was originally intended and the majority of configuration combinations are rarely, if ever, tested. DevStack is not a general OpenStack installer and was never meant to be everything to everyone..
+ Below is a list of what is specifically is supported (read that as "tested") going forward.
Supported Components
@@ -93,7 +93,7 @@
Services
- The default services configured by DevStack are Identity (Keystone), Object Storage (Swift), Image Storage (Glance), Block Storage (Cinder), Compute (Nova), Network (Nova), Dashboard (Horizon)
+ The default services configured by DevStack are Identity (Keystone), Object Storage (Swift), Image Storage (Glance), Block Storage (Cinder), Compute (Nova), Network (Nova), Dashboard (Horizon), Orchestration (Heat)
Additional services not included directly in DevStack can be tied in to stack.sh using the plugin mechanism to call scripts that perform the configuration and startup of the service.
Node Configurations
@@ -103,7 +103,7 @@
Exercises
- The DevStack exercise scripts have been replaced as integration and gating test with Tempest. They will continue to be maintained as they are valuable as demonstrations of using OpenStack from the command line and for quick operational testing.
+ The DevStack exercise scripts are no longer used as integration and gate testing as that job has transitioned to Tempest. They are still maintained as a demonstrations of using OpenStack from the command line and for quick operational testing.
diff --git a/docs/source/plugins.html b/docs/source/plugins.html
index 85cf8e4a8c..3327128dff 100644
--- a/docs/source/plugins.html
+++ b/docs/source/plugins.html
@@ -67,7 +67,12 @@ if is_service_enabled template; then
source $TOP_DIR/lib/template
fi
- if [[ "$1" == "stack" && "$2" == "install" ]]; then
+ if [[ "$1" == "stack" && "$2" == "pre-install" ]]; then
+ # Set up system services
+ echo_summary "Configuring system services Template"
+ install_package cowsay
+
+ elif [[ "$1" == "stack" && "$2" == "install" ]]; then
# Perform installation of service source
echo_summary "Installing Template"
install_template
@@ -103,6 +108,7 @@ fi
- source - Called by each script that utilizes
extras.d hooks; this replaces directly sourcing the lib/* script.
- stack - Called by
stack.sh three times for different phases of its run:
+ - pre-install - Called after system (OS) setup is complete and before project source is installed.
- install - Called after the layer 1 and 2 projects source and their dependencies have been installed.
- post-config - Called after the layer 1 and 2 services have been configured. All configuration files for enabled services should exist at this point.
- extra - Called near the end after layer 1 and 2 services have been started. This is the existing hook and has not otherwise changed.