System for quickly installing an OpenStack cloud from upstream git for testing and development.
Go to file
Zuul 85b8d2ccab Merge "lib/apache: Reshuffle lines" 2024-05-16 14:26:12 +00:00
data Fix comment in plugin-registry header 2016-08-31 10:07:06 +10:00
doc Updated from generate-devstack-plugins-list 2024-05-16 02:37:02 +00:00
extras.d Async task support 2021-02-09 15:57:04 -08:00
files Use OSCaaS to speed up devstack runs 2024-05-14 07:30:55 -07:00
gate Mostly docs cleanups 2015-03-28 14:35:12 -05:00
inc Add support for the pyproject.toml file in setup with constraints 2024-02-09 15:50:16 +01:00
lib lib/apache: Reshuffle lines 2024-05-14 14:14:26 +01:00
playbooks Pin tox<4.0.0 for <=stable/zed branch testing 2022-12-09 02:55:08 +00:00
roles Fix performance stats gathering for global VENV 2023-10-23 11:21:24 -07:00
samples Use OS_CLOUD in sample local.sh 2023-09-20 11:32:33 +00:00
tests Remove support for opensuse 2023-02-16 12:01:39 +01:00
tools Fix datetime.utcnow() deprecation warning 2024-04-23 15:37:37 -04:00
.gitignore ignore dbcounter sub dirs 2023-10-27 02:38:19 +01: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 Make rocky 9 job non-voting 2024-05-09 10:47:49 -07:00
CONTRIBUTING.rst [ussuri][goal] Update contributor documentation 2020-04-23 02:56:13 +00:00
FUTURE.rst Document where we are going 2015-02-05 16:20:52 -05:00
HACKING.rst Remove MAINTAINERS.rst 2021-03-05 15:10:19 +00:00
LICENSE Add Apache 2 LICENSE file 2012-04-18 01:45:35 -05:00
Makefile Suppressed echoing of the line. 2016-04-30 14:11:52 +05:30
README.rst Drop Fedora support 2023-06-07 15:19:37 +02:00
clean.sh Drop lib/neutron module 2022-12-16 09:59:11 +01:00
functions Upload images with --file instead of stdin 2024-05-09 10:47:50 -07:00
functions-common Use OSCaaS to speed up devstack runs 2024-05-14 07:30:55 -07:00
openrc Cleanup keystone library 2021-11-10 06:24:15 +01:00
run_tests.sh Remove old comment in run_tests.sh 2015-04-17 13:23:25 +10:00
stack.sh Use OSCaaS to speed up devstack runs 2024-05-14 07:30:55 -07:00
stackrc Update DEVSTACK_SERIES to 2024.2 2024-03-28 23:38:19 +01:00
tox.ini Uncap bashate 2024-01-29 11:42:32 +09:00
unstack.sh Use OSCaaS to speed up devstack runs 2024-05-14 07:30:55 -07:00

README.rst

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 RockyLinux 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 Zed OpenStack cloud:

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