System for quickly installing an OpenStack cloud from upstream git for testing and development.
Go to file
Ian Wienand 1e7f738f28 Ensure we install setuptools from requirements
Use pip_install_gr so we get the version pinned by requirements.  The
depends-on is an example of where we're trying to pin to workaround
issues.

Depends-On: I9c57c08a150571c5bb62235d502839394d53a4c1
Change-Id: I780cca681b12a3e9d228dbf2fd9fa6e8ab1a82e1
2017-02-27 11:35:43 +11:00
data Fix comment in plugin-registry header 2016-08-31 10:07:06 +10:00
doc/source Using sudo in the Quick start section 2017-02-13 15:14:41 +01: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 Placement service only using default HTTPd ports 2016-12-21 15:33:52 +00:00
gate Mostly docs cleanups 2015-03-28 14:35:12 -05:00
inc add install_devstack_tools 2017-01-18 15:42:53 -05:00
lib Merge "Fix file permissions for lib/neutron_plugins/linuxbridge_agent" 2017-02-26 06:26:01 +00:00
pkg Use java version independent package on Ubuntu 2016-12-15 08:48:02 -08:00
samples Update local.sh sample file to use OSC 2016-11-11 15:11:54 +01:00
tests Warn instead of die on undefined config names 2016-12-12 09:55:32 -05:00
tools Ensure we install setuptools from requirements 2017-02-27 11:35:43 +11:00
.gitignore Add files/*.deb and files/*.deb.* to gitignore 2016-08-25 23:36:12 +08: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 Use delete action for clean up *.pyc files 2017-01-13 09:16:42 -06: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 unify logging setup on all services 2017-01-20 10:48:29 -05:00
functions-common Merge "Remove distro support based on new libvirt minimum" 2017-02-25 16:02:50 +00:00
FUTURE.rst Document where we are going 2015-02-05 16:20:52 -05:00
HACKING.rst Fixes language: "following allowing" -> "allowing" 2016-08-23 10:08:03 +01: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 Remove OS_NO_CACHE from openrc 2017-01-31 11:59:09 -05:00
README.md Update stable branch example 2016-11-03 10:10:03 +00: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 Merge "Remove distro support based on new libvirt minimum" 2017-02-25 16:02:50 +00:00
stackrc Merge "Use the latest 0.3.5 version of CirrOS" 2017-02-15 17:38:24 +00:00
tox.ini Update to bashate 0.5.1 2016-04-26 17:53:45 +10:00
unstack.sh Merge "Load neutron-legacy only if enabled" 2017-01-03 19:53:37 +00: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 Newton OpenStack cloud:

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