System for quickly installing an OpenStack cloud from upstream git for testing and development.
Go to file
Clark Boylan 50e3c06ec2 Fix dbcounter installation on Jammy
There are two problems with dbcounter installation on Jammy. The first
is straightforward. We have to use `py_modules` instead of `modules` to
specify the source file. I don't know how this works on other distros
but the docs [0] seem to clearly indicate py_modules does this.

The second issue is quite an issue and requires story time. When
pip/setuptools insteall editable installs (as is done for many of the
openstack projects) it creates an easy-install.pth file that tells the
python interpreter to add the source dirs of those repos to the python
path. Normally these paths are appended to your sys.path. Pip's isolated
build env relies on the assumption that these paths are appeneded to the
path when it santizes sys.path to create the isolated environemnt.

However, when SETUPTOOLS_SYS_PATH_TECHNIQUE is set to rewrite the paths
are not appended and are inserted in the middle. This breaks pip's
isolated build env which broke dbcounter installations. We fix this by
not setting SETUPTOOLS_SYS_PATH_TECHNIQUE to rewrite. Upstream indicates
the reason we set this half a decade ago has since been fixed properly.

The reason Jammy and nothing else breaks is that python3.10 is the first
python version to use pip's isolated build envs by default.

I've locally fiddled with a patch to pip [1] to try and fix this
behavior even when rewrite is set. I don't plan to push this upstream
but it helps to illustrate where the problem lies. If someone else would
like to upstream this feel free.

Finally this change makes the jammy platform job voting again and adds
it to the gate to ensure we don't regress again.

[0] https://docs.python.org/3/distutils/sourcedist.html#specifying-the-files-to-distribute
[1] https://paste.opendev.org/show/bqVAuhgMtVtfYupZK5J6/

Change-Id: I237f5663b0f8b060f6df130de04e17e2b1695f8a
2022-05-20 10:35:18 -07:00
data Fix comment in plugin-registry header 2016-08-31 10:07:06 +10:00
doc modify the sample value of LOGDAYS 2022-04-21 15:00:41 +08:00
extras.d Async task support 2021-02-09 15:57:04 -08:00
files install mod_ssl on centos 9 stream by default 2022-04-21 20:40:44 +01:00
gate Mostly docs cleanups 2015-03-28 14:35:12 -05:00
inc Fix dbcounter installation on Jammy 2022-05-20 10:35:18 -07:00
lib Merge "Configure placement section in neutron conf" 2022-05-19 17:23:50 +00:00
playbooks Gather performance data after tempest 2022-04-20 13:07:22 -07:00
roles Collect status of all services 2022-04-29 16:40:32 +00:00
samples modify the sample value of LOGDAYS 2022-04-21 15:00:41 +08:00
tests Enable oslo.limit to be installed from git repo 2021-10-01 17:30:52 +00:00
tools Fix dbcounter installation on Jammy 2022-05-20 10:35:18 -07: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 Fix dbcounter installation on Jammy 2022-05-20 10:35:18 -07: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 Remove references to XenAPI driver 2021-03-05 15:10:19 +00:00
functions-common Merge "Global option for enforcing scope (ENFORCE_SCOPE)" 2022-05-07 10:51:35 +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
openrc Cleanup keystone library 2021-11-10 06:24:15 +01: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
stack.sh Merge "Add Ubuntu 22.04 LTS (jammy) platform job" 2022-05-19 08:16:18 +00:00
stackrc Merge "Global option for enforcing scope (ENFORCE_SCOPE)" 2022-05-07 10:51:35 +00:00
tox.ini Changed minversion in tox to 3.18.0 2021-05-12 17:01:05 +05:30
unstack.sh Use proper sed separator for paths 2022-04-25 15:26:28 +02: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.