Set of scripts and utilities to quickly deploy an OpenStack cloud
Shell Other
Latest commit 41f61ad Jun 22, 2017 Jenkins committed with openstack-gerrit Merge "Revert "Use uwsgi for glance-api""
Permalink
Failed to load latest commit information.
data Fix comment in plugin-registry header Aug 31, 2016
doc/source Merge "docs: add "kvm on s390x" specific configuration in `local.conf`" Jun 19, 2017
exercises Neutron: use "OSC show -f value -c id" instead of "OSC list + grep" Nov 18, 2016
extras.d Merge "Ensure testing configuration can run as late as possible" Nov 30, 2016
files Make stack.sh work on SUSE May 28, 2017
gate Mostly docs cleanups Mar 28, 2015
inc Install test-requirements with main install Jun 12, 2017
lib Merge "Revert "Use uwsgi for glance-api"" Jun 22, 2017
pkg Use java version independent package on Ubuntu Dec 15, 2016
samples Update local.sh sample file to use OSC Nov 11, 2016
tests Support installing os-traits from git Jun 5, 2017
tools Merge "Remove temporary openSUSE-42.2 workaround" Jun 14, 2017
.gitignore Add files/ironic-inspector* to .gitignore May 11, 2017
.gitreview Add .gitreview config file for gerrit. Nov 16, 2011
.mailmap Remove AUTHORS Aug 14, 2014
FUTURE.rst Document where we are going Feb 5, 2015
HACKING.rst Document testing of new devstack features May 12, 2017
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 configuration link syntax error May 27, 2017
clean.sh systemd: Always create the systemd unit files Jun 14, 2017
exercise.sh Remove EC2 API from devstack Mar 15, 2016
exerciserc Remove EC2 API from devstack Mar 15, 2016
functions Merge "Add a function to get an available random port" Jun 20, 2017
functions-common Merge "Provide timings for OSC during devstack run" Jun 15, 2017
openrc Merge "Make openrc more robust for grenade scenarios" May 16, 2017
run_tests.sh Remove old comment in run_tests.sh Apr 17, 2015
setup.cfg update sphinx May 21, 2017
setup.py Convert all HTML doc to RST Oct 22, 2014
stack.sh remove lib/os_brick Jun 21, 2017
stackrc Merge "Support installing os-traits from git" Jun 14, 2017
tox.ini update sphinx May 21, 2017
unstack.sh Get rid of zookeeper from devstack May 24, 2017

README.rst

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.