System for quickly installing an OpenStack cloud from upstream git for testing and development.
Go to file
Clark Boylan f266a2dc81 Install test-requirements with main install
To reduce the total number of invocations necessary for pip which isn't
the quickest thing ever (due to needing to evaluate constraints and deps
lists and what is currently installed) combine the main installation of
software with its test-requirements.txt file which should roughly halve
our pip invocations.

Change-Id: Ibcc3264136e66d34a879ad1c90a62e1bb6a84243
2017-06-12 14:57:59 -07:00
data Fix comment in plugin-registry header 2016-08-31 10:07:06 +10:00
doc/source Updated from generate-devstack-plugins-list 2017-06-07 08:24:31 +00:00
exercises Neutron: use "OSC show -f value -c id" instead of "OSC list + grep" 2016-11-18 12:18:09 +01:00
extras.d Merge "Ensure testing configuration can run as late as possible" 2016-11-30 16:30:38 +00:00
files Make stack.sh work on SUSE 2017-05-28 09:58:51 -07:00
gate Mostly docs cleanups 2015-03-28 14:35:12 -05:00
inc Install test-requirements with main install 2017-06-12 14:57:59 -07:00
lib Don't treat service as enabled if in disabled list 2017-06-07 17:23:38 +00:00
pkg Use java version independent package on Ubuntu 2016-12-15 08:48:02 -08:00
samples Update local.sh sample file to use OSC 2016-11-11 15:11:54 +01:00
tests Merge "Change version of noVNC to stable" 2017-05-26 21:21:19 +00:00
tools Merge "Make use of Ubuntu Cloud Archive switchable" 2017-06-09 01:55:36 +00:00
.gitignore Add files/ironic-inspector* to .gitignore 2017-05-11 09:38:25 +00:00
.gitreview Add .gitreview config file for gerrit. 2011-11-16 11:24:49 -08:00
.mailmap Remove AUTHORS 2014-08-14 13:52:28 +10:00
clean.sh Always have ./clean.sh run ./unstack.sh 2017-05-04 16:05:19 -04:00
exercise.sh Remove EC2 API from devstack 2016-03-15 13:32:23 +11:00
exerciserc Remove EC2 API from devstack 2016-03-15 13:32:23 +11:00
functions Merge "Use correct argument order in truorfalse for USE_JOURNAL" 2017-06-06 13:24:32 +00:00
functions-common Merge "Use the proper keystone endpoints in clouds.yaml" 2017-05-26 19:24:51 +00:00
FUTURE.rst Document where we are going 2015-02-05 16:20:52 -05:00
HACKING.rst Document testing of new devstack features 2017-05-12 10:16:33 -07:00
LICENSE Add Apache 2 LICENSE file 2012-04-18 01:45:35 -05:00
MAINTAINERS.rst Move Sahara into in-tree plugin 2015-07-01 16:09:56 +00:00
Makefile Suppressed echoing of the line. 2016-04-30 14:11:52 +05:30
openrc Merge "Make openrc more robust for grenade scenarios" 2017-05-16 14:47:04 +00:00
README.rst Fix configuration link syntax error 2017-05-27 15:03:58 +08:00
run_tests.sh Remove old comment in run_tests.sh 2015-04-17 13:23:25 +10:00
setup.cfg update sphinx 2017-05-21 11:00:04 -04:00
setup.py Convert all HTML doc to RST 2014-10-22 12:27:00 -04:00
stack.sh Merge "Start placement before services that might like to use it" 2017-06-06 00:01:06 +00:00
stackrc Merge "Make use of Ubuntu Cloud Archive switchable" 2017-06-09 01:55:36 +00:00
tox.ini update sphinx 2017-05-21 11:00:04 -04:00
unstack.sh Get rid of zookeeper from devstack 2017-05-24 14:13:27 +00:00

DevStack is a set of scripts and utilities to quickly deploy an OpenStack cloud.

Goals

  • To quickly build dev OpenStack environments in a clean Ubuntu or Fedora environment
  • 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 provide an environment for the OpenStack CI testing on every commit to the projects

Read more at http://docs.openstack.org/developer/devstack

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 Newton OpenStack cloud:

git checkout stable/newton
./stack.sh

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=git://git.openstack.org/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 DevStack Execution Environment below for more on user accounts):

./stack.sh

When the script finishes executing, you should be able to access OpenStack endpoints, like so:

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 OpenStack CLI creds
. openrc
# list instances
openstack server list

DevStack Execution Environment

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 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.

DevStack will not automatically create the user, but provides a helper script in 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

DevStack can be extensively configured via the configuration file local.conf. It is likely that you will need to provide and modify this file if you want anything other than the most basic setup. Start by reading the configuration guide for details of the configuration file and the many available options.