System for quickly installing an OpenStack cloud from upstream git for testing and development.
Go to file
Akihiro Motoki f548ce4816 Allow to install os-ken from git repo
os-ken is used by neutron ML2/OVS agent.
We need to install os-ken from source to test os-ken changes
against neutron. We already have tempest-integrated-networking job
in os-ken repo but it turns out it consumes os-ken from PyPI :-(

Change-Id: Ibcff212591e9fed25f1316403627269d81455b09
2021-03-04 10:31:30 +09:00
data Fix comment in plugin-registry header 2016-08-31 10:07:06 +10:00
doc Install systemd-python from distribution package 2020-12-23 14:22:27 +00:00
extras.d Async task support 2021-02-09 15:57:04 -08:00
files Install systemd-python from distribution package 2020-12-23 14:22:27 +00:00
gate Mostly docs cleanups 2015-03-28 14:35:12 -05:00
inc Async task support 2021-02-09 15:57:04 -08:00
lib Allow to install os-ken from git repo 2021-03-04 10:31:30 +09:00
playbooks Decrease MTU to account for IPv6 header 2020-11-06 17:34:53 -05:00
roles orchestrate-devstack: Copy controller ceph.conf and keyrings to subnode 2021-02-10 16:01:04 +00:00
samples Fix default security group in samples/local.sh 2019-09-05 14:30:41 +00:00
tests Allow to install os-ken from git repo 2021-03-04 10:31:30 +09:00
tools Add debug helper script 2021-01-12 17:41:19 -08:00
.gitignore Ignore local.conf in root of repo 2018-12-18 09:04:49 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:43:10 +00:00
.mailmap Remove AUTHORS 2014-08-14 13:52:28 +10:00
.zuul.yaml Merge "Async task support" 2021-02-11 22:33:01 +00:00
clean.sh Async task support 2021-02-09 15:57:04 -08:00
CONTRIBUTING.rst [ussuri][goal] Update contributor documentation 2020-04-23 02:56:13 +00:00
functions Async task support 2021-02-09 15:57:04 -08:00
functions-common fix is_fedora for centos 8 stream 2020-12-15 19:58:37 +00:00
FUTURE.rst Document where we are going 2015-02-05 16:20:52 -05:00
HACKING.rst Merge "Update HACKING doc" 2020-09-16 06:24:39 +00: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 Revert "Drop keystone dedicated ports" 2020-07-06 14:01:08 -05:00
README.rst Update (git|review).openstack.org links to opendev 2019-06-21 14:35:16 +10:00
run_tests.sh Remove old comment in run_tests.sh 2015-04-17 13:23:25 +10:00
setup.cfg Cleanup py27 support 2020-05-09 13:35:01 +02:00
setup.py Convert all HTML doc to RST 2014-10-22 12:27:00 -04:00
stack.sh Fix DevStack setup on CentOS 8.3 2021-02-17 17:43:13 +01:00
stackrc Allow to install os-ken from git repo 2021-03-04 10:31:30 +09:00
tox.ini Cleanup py27 support 2020-05-09 13:35:01 +02:00
unstack.sh Async task support 2021-02-09 15:57:04 -08: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=https://opendev.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.