System for quickly installing an OpenStack cloud from upstream git for testing and development.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Ghanshyam 4a6a717a15 Support TEMPEST_BRANCH with tag name & stable u-c 8 months ago
data Fix comment in plugin-registry header 4 years ago
doc Replace git:// URLs with https:// 1 year ago
exercises Neutron: use "OSC show -f value -c id" instead of "OSC list + grep" 4 years ago
extras.d Merge "Ensure testing configuration can run as late as possible" 3 years ago
files Remove fping requirement 2 years ago
gate Mostly docs cleanups 5 years ago
inc Properly get pip version 2 years ago
lib Support TEMPEST_BRANCH with tag name & stable u-c 8 months ago
pkg Use java version independent package on Ubuntu 3 years ago
samples Update sample file to use OSC 4 years ago
tests Change version of noVNC to stable 3 years ago
tools Replace git:// URLs with https:// 1 year ago
.gitignore Add files/*.deb and files/*.deb.* to gitignore 4 years ago
.gitreview OpenDev Migration Patch 1 year ago
.mailmap Remove AUTHORS 6 years ago
.zuul.yaml Merge "Follow job renames" into stable/ocata 2 years ago
FUTURE.rst Document where we are going 5 years ago
HACKING.rst Fixes language: "following allowing" -> "allowing" 4 years ago
LICENSE Add Apache 2 LICENSE file 8 years ago
MAINTAINERS.rst Move Sahara into in-tree plugin 5 years ago
Makefile Suppressed echoing of the line. 4 years ago Replace git:// URLs with https:// 1 year ago Use delete action for clean up *.pyc files 3 years ago Remove EC2 API from devstack 4 years ago
exerciserc Remove EC2 API from devstack 4 years ago
functions Wait for compute service to check in 3 years ago
functions-common Use the proper keystone endpoints in clouds.yaml 3 years ago
openrc Move default Keystone API version to v3 4 years ago Remove old comment in 5 years ago
setup.cfg Replace the with devstack docs url 5 years ago Convert all HTML doc to RST 6 years ago Fix rdo-release install 1 year ago
stackrc Support TEMPEST_BRANCH with tag name & stable u-c 8 months ago
tox.ini Add doc/requirements.txt file with doc requirements 2 years ago Merge "Load neutron-legacy only if enabled" 3 years ago

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


  • 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


IMPORTANT: Be sure to carefully read 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 in a clean and disposable vm when you are first getting started.


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

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


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):


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
nova 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... 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. specifically does not run if started as root.

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


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.