System for quickly installing an OpenStack cloud from upstream git for testing and development.
Clone or download
derekhiggins Revert "remove external_network_bridge option"
This reverts commit faaf96b.

Ironic jobs were still using this option, it needs to be
switched to an alternative first.

Change-Id: I1683d7cfa81f5fe2497cc7045e87f8b20fed4968
Latest commit e3e9ea2 Nov 9, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
data Fix comment in plugin-registry header Aug 31, 2016
doc Updated from generate-devstack-plugins-list Oct 25, 2018
extras.d Merge "Ensure testing configuration can run as late as possible" Nov 30, 2016
files Update horizon wsgi wrapper to the recommended one Sep 8, 2018
gate Mostly docs cleanups Mar 28, 2015
inc Use bash-style test for Fedora version Oct 4, 2018
lib Revert "remove external_network_bridge option" Nov 9, 2018
pkg Increase the Elasticsearch service timeout Jul 4, 2018
playbooks Enforce linear strategy for orchestrate-devstack Mar 11, 2018
roles Add the project under test to LIBS_FROM_GIT Jun 15, 2018
samples Update URLs Jul 22, 2017
tests Revert "Update branches for stable/rocky" Aug 27, 2018
tools Disable apparmor for openSUSE distros Oct 8, 2018
.gitignore gitignore: Ignore all log files Aug 9, 2018
.gitreview Add .gitreview config file for gerrit. Nov 16, 2011
.mailmap Remove AUTHORS Aug 14, 2014
.zuul.yaml Merge "Add devstack ipv6 jobs" Oct 25, 2018
FUTURE.rst Document where we are going Feb 5, 2015
HACKING.rst Merge "Remove devstack exercises" Aug 27, 2018
LICENSE Add Apache 2 LICENSE file Apr 18, 2012
MAINTAINERS.rst Move Sahara into in-tree plugin Jul 1, 2015
Makefile Suppressed echoing of the line. Apr 30, 2016
README.rst Fix up main readme Sep 7, 2017
clean.sh Remove remnants of SCREEN_LOGDIR Mar 12, 2018
functions Fix Virtuozzo CI Jul 4, 2018
functions-common Merge "Quote error messages" Oct 10, 2018
openrc Merge "Export OS_CACERT after sourcing .stackenv file" Jun 11, 2018
run_tests.sh Remove old comment in run_tests.sh Apr 17, 2015
setup.cfg Update URLs Jul 22, 2017
setup.py Convert all HTML doc to RST Oct 22, 2014
stack.sh Convert to openSUSE Leap 15.0 platform testing Oct 8, 2018
stackrc Update DEVSTACK_SERIES to stein Aug 24, 2018
tox.ini fix tox python3 overrides Jun 12, 2018
unstack.sh Fix that DISTRO is not set in unstack.sh Dec 25, 2017

README.rst

DevStack is a set of scripts and utilities to quickly deploy an OpenStack cloud from git source trees.

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 https://docs.openstack.org/devstack/latest

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

git checkout stable/pike
./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.