System for quickly installing an OpenStack cloud from upstream git for testing and development.
Go to file
Lance Bragstad ed6e1d0996 Set transport_url in proper keystone config section
The RPC transport_url for keystone was being set in the DEFAULT
section, even though keystone doesn't do anything with it. Instead,
keystone leans on the [oslo_messaging_notification] section from
oslo.messaging to register the transport_url option.

This change sets the transport_url in the proper section instead of
using the DEFAULT section.

Change-Id: I11590d0175da7ea310d5529f2d7c0bf8d7fb25b3
2018-08-01 18:05:54 +00:00
data Fix comment in plugin-registry header 2016-08-31 10:07:06 +10:00
doc Updated from generate-devstack-plugins-list 2018-07-12 06:17:32 +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 Merge "Remove old packages from rpms/horizon" 2018-07-03 15:36:50 +00:00
gate Mostly docs cleanups 2015-03-28 14:35:12 -05:00
inc iniset: fix handling of keys with spaces 2018-06-04 11:00:08 +02:00
lib Set transport_url in proper keystone config section 2018-08-01 18:05:54 +00:00
pkg install and start elasticsearch on openSUSE 2018-06-22 09:03:36 +02:00
playbooks Enforce linear strategy for orchestrate-devstack 2018-03-11 11:17:42 +00:00
roles Add the project under test to LIBS_FROM_GIT 2018-06-15 16:11:29 -04:00
samples Update URLs 2017-07-22 09:12:59 +09:00
tests iniset: fix handling of keys with spaces 2018-06-04 11:00:08 +02:00
tools Do not use pip 10 or higher 2018-04-14 20:58:31 +00:00
.gitignore Zuul: support plugin dependencies 2018-03-22 11:50:49 -07: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
.zuul.yaml use fqdn for zuul projects 2018-07-10 18:36:03 -04:00
clean.sh Remove remnants of SCREEN_LOGDIR 2018-03-12 15:21:13 +00: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 Fix wait_for_compute to work for modified compute host name 2018-07-02 05:49:52 +00:00
functions-common Merge "Fix running with SERVICE_IP_VERSION=6" 2018-07-10 06:10:28 +00:00
FUTURE.rst Document where we are going 2015-02-05 16:20:52 -05:00
HACKING.rst Replace http with https for doc links in devstack's document 2017-09-01 19:48:04 -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 "Export OS_CACERT after sourcing .stackenv file" 2018-06-11 18:49:10 +00:00
README.rst Fix up main readme 2017-09-07 11:16:48 -04:00
run_tests.sh Remove old comment in run_tests.sh 2015-04-17 13:23:25 +10:00
setup.cfg Update URLs 2017-07-22 09:12:59 +09:00
setup.py Convert all HTML doc to RST 2014-10-22 12:27:00 -04:00
stack.sh Merge "Init placement before nova" 2018-06-14 12:20:41 +00:00
stackrc Merge "Fix running with SERVICE_IP_VERSION=6" 2018-07-10 06:10:28 +00:00
tox.ini Add doc/requirements.txt file with doc requirements 2017-12-18 11:12:42 -06:00
unstack.sh Fix that DISTRO is not set in unstack.sh 2017-12-25 09:08:42 +00:00

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.