System for quickly installing an OpenStack cloud from upstream git for testing and development.
Go to file
Clark Boylan 81fac768b5 Remove unneed devstack early log file
In the run devstack role we specify a path to devstack_early_log then
hand it to stack.sh as a parameter which stack.sh does nothing with.
While looking at a fix for this it was pointed out that these early logs
make it into the job's output log now so we don't need a special file
for them. Rather than handle this as a special case just let the
job-output.txt log file pick up the logs for us which allows us to
remove this unneeded feature.

Change-Id: I9bedbe91c60257d94173b1c70676dd6c2b49dc91
2018-02-06 10:10:05 +11:00
data Fix comment in plugin-registry header 2016-08-31 10:07:06 +10:00
doc Updated from generate-devstack-plugins-list 2018-02-01 06:18:22 +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 Remove libpcre3-dev&pcre-devel from horizon prerequisite 2018-01-31 02:57:19 +00:00
gate Mostly docs cleanups 2015-03-28 14:35:12 -05:00
inc Fix Python3 get_python_exec_prefix on Fedora 27 2018-01-09 11:22:39 +01:00
lib Merge "tempest: set compute-feature-enabled.volume_multiattach" 2018-02-02 03:41:17 +00:00
pkg Use java version independent package on Ubuntu 2016-12-15 08:48:02 -08:00
playbooks Move zuul_copy_output to be a job variable 2018-01-31 14:40:39 -06:00
roles Remove unneed devstack early log file 2018-02-06 10:10:05 +11:00
samples Update URLs 2017-07-22 09:12:59 +09:00
tests Merge "Remove screen support from devstack completely" 2017-09-07 13:38:03 +00:00
tools tempest: set compute-feature-enabled.volume_multiattach 2018-01-18 18:00:04 +01:00
.gitignore Ignore etcd files downloaded to files/ dir 2017-06-21 09:18:46 +00: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 Merge "Zuul: Remove project name" 2018-02-02 16:28:30 +00:00
clean.sh Fix Cleanups for keystone/placement/nova 2017-08-17 10:40:38 -04: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 use openstack command instead of nova command 2018-01-24 23:52:56 +09:00
functions-common Merge "Allow plugins to express dependency info" 2017-12-07 11:00:29 +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 Modify some spelling mistakes 2017-08-10 03:03:47 -07: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 Add Fedora 27 support 2018-01-11 16:19:36 +01:00
stackrc Merge "tempest: set compute-feature-enabled.volume_multiattach" 2018-02-02 03:41:17 +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.