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.
 
 
 
 
Brian Haley c9f3e5bdd7 Fix stackrc os-resource-classes typo 5 days ago
data Fix comment in plugin-registry header 5 years ago
doc Updated from generate-devstack-plugins-list 2 weeks ago
extras.d Async task support 7 months ago
files Fix stackrc os-resource-classes typo 5 days ago
gate Mostly docs cleanups 7 years ago
inc Revert "Workaround for new pip 20.3 behavior" 1 month ago
lib Merge "Glance remote worker should use own cache directory" 1 week ago
playbooks Decrease MTU to account for IPv6 header 11 months ago
roles Move verify-ipv6-only-deployments 4 months ago
samples Fix default security group in samples/local.sh 2 years ago
tests Allow to install os-resource-classes from git repo 3 months ago
tools Simplify pip install 1 month ago
.gitignore Ignore local.conf in root of repo 3 years ago
.gitreview OpenDev Migration Patch 2 years ago
.mailmap Remove AUTHORS 7 years ago
.zuul.yaml Merge "Set swap size to 4G for c8 jobs" 4 weeks ago
CONTRIBUTING.rst [ussuri][goal] Update contributor documentation 1 year ago
FUTURE.rst Document where we are going 7 years ago
HACKING.rst Remove MAINTAINERS.rst 7 months ago
LICENSE Add Apache 2 LICENSE file 10 years ago
Makefile Suppressed echoing of the line. 5 years ago
README.rst Update (git|review).openstack.org links to opendev 2 years ago
clean.sh Async task support 7 months ago
functions Remove references to XenAPI driver 7 months ago
functions-common nova ironic-hypevisor - support scoped auth config 3 months ago
openrc Prepare for dropping keystone admin endpoint 1 year ago
run_tests.sh Remove old comment in run_tests.sh 7 years ago
setup.cfg setup.cfg: Replace dashes with underscores 4 months ago
setup.py Convert all HTML doc to RST 7 years ago
stack.sh Merge "Simplify pip install" 1 month ago
stackrc Fix stackrc os-resource-classes typo 5 days ago
tox.ini Changed minversion in tox to 3.18.0 4 months ago
unstack.sh Async task support 7 months ago

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=https://opendev.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.