System for quickly installing an OpenStack cloud from upstream git for testing and development.
Go to file
Ghanshyam 4a6a717a15 Support TEMPEST_BRANCH with tag name & stable u-c
TEMPEST_BRANCH which is mostly set as master so
that Tempest master is run to test the env. With
stable branch going to EM state and Tempest master
might not work due to incompatibility of code or
requirements. In that case we pin the Tempest so that
older Tempest can be used for their testing.

Till now for ocata, pike and, queens we used the gerrit style
ref to pin the Tempest which is not preferred way. We should be
able to use the tag name on TEMPEST_BRANCH.

This commit explicitly checkout the tag set in TEMPEST_BRANCH
as git_clone does not checkout the tag directly until RECLONE
is true or tempest dir does not exist.

After this stable branch or job can set the tag directly with name.
For exmaple: TEMPEST_BRANCH=23.0.0.

Also use the stable/ocata upper constraint in Tempest venv.

Related--Bug: 1861308
[1] https://review.opendev.org/#/c/704840/

Change-Id: I15942917ec96e0f0e17639ea3296e356cdfeb832
2020-02-07 00:30:22 +00:00
data Fix comment in plugin-registry header 2016-08-31 10:07:06 +10:00
doc Replace openstack.org git:// URLs with https:// 2019-03-22 01:35:38 +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 fping requirement 2018-09-24 17:34:21 +00:00
gate Mostly docs cleanups 2015-03-28 14:35:12 -05:00
inc Properly get pip version 2018-04-15 11:50:39 +02:00
lib Support TEMPEST_BRANCH with tag name & stable u-c 2020-02-07 00:30:22 +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 Change version of noVNC to stable 2017-05-27 19:21:44 +02:00
tools Replace openstack.org git:// URLs with https:// 2019-03-22 01:35:38 +00:00
.gitignore Add files/*.deb and files/*.deb.* to gitignore 2016-08-25 23:36:12 +08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:43:14 +00:00
.mailmap Remove AUTHORS 2014-08-14 13:52:28 +10:00
.zuul.yaml Merge "Follow job renames" into stable/ocata 2018-09-13 06:25:27 +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
README.md Replace openstack.org git:// URLs with https:// 2019-03-22 01:35:38 +00: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 Wait for compute service to check in 2017-09-07 13:36:42 +00:00
functions-common Use the proper keystone endpoints in clouds.yaml 2017-04-27 19:37:02 -05:00
openrc Move default Keystone API version to v3 2016-11-02 20:28:41 +01: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 Fix rdo-release install 2019-09-17 07:01:25 +00:00
stackrc Support TEMPEST_BRANCH with tag name & stable u-c 2020-02-07 00:30:22 +00:00
tox.ini Add doc/requirements.txt file with doc requirements 2018-01-03 15:16:32 +00:00
unstack.sh Merge "Load neutron-legacy only if enabled" 2017-01-03 19:53:37 +00:00

README.md

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