System for quickly installing an OpenStack cloud from upstream git for testing and development.
Go to file
John L. Villalovos daa7a41e21 Export the 'short_source' function & don't keep PS4 in sudo
Export the 'short_source' function so that it will be present in the
environment for child shell scripts. Do this because we are passing PS4
to the child shell scripts and it is using 'short_source'

Don't do an 'env_keep' in the sudoers file for PS4, since it is
difficult to also pass along the 'short_source' function.

Change-Id: I9781010d6eb336d02939c7fd47f18bedeae5ccc6
Closes-Bug: #1563443
2016-05-06 10:50:58 -07:00
data Be a bit more explicit about the plugin generation 2016-04-11 11:45:02 +10:00
doc/source Updated from generate-devstack-plugins-list 2016-04-30 06:51:53 +00:00
exercises Remove EC2 API from devstack 2016-03-15 13:32:23 +11:00
extras.d make the alt_demo user during normal install 2016-02-02 05:51:14 -05:00
files Remove Ceilometer leftover 2016-03-30 12:45:30 +02:00
gate Mostly docs cleanups 2015-03-28 14:35:12 -05:00
inc Normalize path for upper-constraints 2016-03-22 21:23:23 +09:00
lib Merge "Handle common and seperate tempest tox venvs" 2016-05-04 21:54:17 +00:00
pkg Fix elastic search support for Fedora. 2016-01-06 08:22:39 +00:00
samples Change "secrete" to "secret" 2016-03-17 14:53:03 +11:00
tests Remove tempest-lib setup 2016-05-02 11:59:52 +02:00
tools Export the 'short_source' function & don't keep PS4 in sudo 2016-05-06 10:50:58 -07:00
.gitignore Merge "Ignore vmdk files as well as other image types" 2016-03-23 20:42:07 +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
clean.sh remove clouds.yaml in clean.sh 2016-04-15 02:27:35 +08: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 Export the 'short_source' function & don't keep PS4 in sudo 2016-05-06 10:50:58 -07:00
functions-common Update is_service_enabled 2016-04-27 12:13:16 -05:00
FUTURE.rst Document where we are going 2015-02-05 16:20:52 -05:00
HACKING.rst Updated Typos in devstack 2015-11-20 11:17:19 +05:30
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 remove wheel cache code 2015-11-04 12:31:39 -05:00
openrc Change "secrete" to "secret" 2016-03-17 14:53:03 +11:00
README.md Remove EC2 API from devstack 2016-03-15 13:32:23 +11:00
run_tests.sh Remove old comment in run_tests.sh 2015-04-17 13:23:25 +10:00
setup.cfg Replace the devstack.org with devstack docs url 2015-09-26 18:05:34 +05:30
setup.py Convert all HTML doc to RST 2014-10-22 12:27:00 -04:00
stack.sh Export the 'short_source' function & don't keep PS4 in sudo 2016-05-06 10:50:58 -07:00
stackrc Remove tempest-lib setup 2016-05-02 11:59:52 +02:00
tox.ini Add venv tox environment 2016-04-15 21:06:45 +02:00
unstack.sh Cleanup from zookeeper->dlm change 2016-03-31 09:54:46 -04:00

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 juno OpenStack cloud:

git checkout stable/juno
./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
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...

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.