Go to file
Stephen Finucane 24345ce579 [Stable-Only] Pin setuptools
setuptools 81.0.0 dropped support for the legacy 'pkg_resources'
library. While most users of this (including the all important pbr
library) have been updated to remove references to 'pkg_resources' on
current master, this is not true for historical releases. Pin the
setuptools version used on these historic branches to work around this.

Conflicts:
    inc/python

NOTE(stephenfin): Conflicts are due to the absence of
I74b0f93457f91e7d53d54737d52f67075088faca which we don't want to
backport

Change-Id: Icf07fa246b3532f939d20e3cbea32cc0b7b439ed
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
(cherry picked from commit 94e1ba49e9)
(cherry picked from commit 84c7dd2354)
2026-02-09 11:48:46 +00:00
2024-07-23 11:37:05 +01:00
2021-02-09 15:57:04 -08:00
2015-03-28 14:35:12 -05:00
2026-02-09 11:48:46 +00:00
2026-02-09 11:48:46 +00:00
2023-09-20 11:32:33 +00:00
2024-09-25 12:01:22 -07:00
2023-10-27 02:38:19 +01:00
2024-09-25 10:09:28 +00:00
2014-08-14 13:52:28 +10:00
2022-12-16 09:59:11 +01:00
2015-02-05 16:20:52 -05:00
2021-03-05 15:10:19 +00:00
2012-04-18 01:45:35 -05:00
2016-04-30 14:11:52 +05:30
2023-06-07 15:19:37 +02:00
2024-09-25 12:01:22 -07: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 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.

Description
System for quickly installing an OpenStack cloud from upstream git for testing and development.
Readme 129 MiB
Languages
Shell 92.8%
Python 6.8%
Makefile 0.3%
Jinja 0.1%