In order to provide native SPICE console functionality in OpenStack, a series of patches against OpenStack are required. This repository maintains those patches.
The majority of the patches are against Nova, although there are a fair few against Kolla and Kolla-Ansible as my preferred deployment system too. Any other OpenStack deployment system wishing to include Kerbside would need to make similar modifications to their code.
The remainder of the patches are ancillary changes -- support for new Nova API microversions in clients, things which helped me debug along the way, and that sort of thing.
These patches last successfully applied via CI on 3 December 2024.
These patches were developed while building the Kerbside proof of concept.
Because these patches add a Nova API microversion which is not seen upstream they are not suitable for production use. Specifically, as upstream Nova adds API microversions themselves, they consume the version number used by these patches. This results in an unsafe upgrade path. Until these patches (or equivalent) are landed upstream, Kerbside should be considered unsafe for a production deployment.
The following microversions are used for Nova releases:
- 2023.1: v2.96
- 2023.2: v2.96
- 2024.1: v2.97
- master: v2.97 (subject to change)
The original proof of concept was developed against OpenStack 2023.1, and that is therefore the best tested version of these patches. Forward porting of patches to 2023.2 and 2024.1 has been done, but because Kolla / Kolla-Ansible only just started supporting 2024.1 they are not as well tested. Bug reports are welcomed.
Because RHEL 9 dropped support for SPICE in KVM / qemu, and the downstream redistributions such as Rocky Linux followed suit, the only tested container operating system for these patches is Debian. While it is technically feasible to add back SPICE into Rocky with custom packages, that work has not been attempted. Additionally, Kolla-Ansible does not support running a mix of container operating systems for your deployment. Therefore, you need to use Debian for all container images in a deployment using Kerbside, even though only the Nova / LibVirt containers are customized by these patches.
Given I am using Kolla-Ansible for testing, this respository also contains scripts to build container images suitable for use with Kolla-Ansible.
This process is automated for gitlab users using the included .gitlab-ci.yml
configuration file, and for github users with the included github workflows
under .github/workflow.
On Debian, you can build patched container images like this:
# Basic build configuration
sudo apt-get update
sudo apt-get dist-upgrade -y
sudo apt-get install -y moreutils python3-venv pkg-config \
libmariadb-dev-compat build-essential python3-dev python3-lxml \
libxml2-dev libxslt1-dev jq ca-certificates curl git libpq-dev
sudo pip3 uninstall virtualenv
sudo apt purge -y python3-virtualenv
sudo pip3 install virtualenv tox yq occystrap
# These build scripts require a more recent version of Docker than that packaged
# by Debian, so we use the Docker repositories instead.
for pkg in docker.io docker-doc docker-compose podman-docker containerd runc; do
sudo apt-get remove -y $pkg
done
if [ ! -e /etc/apt/keyrings/docker.asc ]; then
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
fi
sudo apt-get install -y docker-ce docker-ce-cli containerd.io \
docker-buildx-plugin
# Allow the current user to access docker
sudo usermod -a -G docker $(whoami)
# Note that you might need to logout / in to pick up the group change
Now continue to the shared steps below.
On Rocky, you can build patched container images like this:
# Basic build configuration
sudo dnf update -y
sudo dnf install -y epel-release
sudo dnf config-manager --set-enabled crb
sudo dnf install -y moreutils pkg-config python3-lxml libxml2-devel libxslt jq
sudo dnf remove python3-virtualenv
sudo pip3 install tox yq occystrap virtualenv
# Install a recent Docker
sudo dnf config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
sudo dnf install docker-ce docker-ce-cli containerd.io
sudo systemctl start docker
# Allow the current user to access docker
sudo usermod -a -G docker $(whoami)
# Note that you might need to logout / in to pick up the group change
Now continue to the shared steps below.
Now run these commands, regardless of host OS:
# Clone the Kerbside patches respository
git clone https://github.com/shakenfist/kerbside-patches
cd kerbside-patches
# Make a place to store the source for kerbside and patched OpenStack components
mkdir src
cd src
# Clone the kerbside source, needed for container image build later
git clone https://github.com/shakenfist/kerbside
tar cvf kerbside.tgz kerbside
cd ..
# Apply patches to upstream projects for your chosen release. Note that this
# example skips running the tests against each patch, but then does run a single
# test at the end for each repository. This should be sufficient for building
# images, but not for patch development. To skip the tests entirely because
# they're quite slow and fail on machines running OpenStack, use --skip-tests
# instead of --defer-tests.
#
# Note that we use the most recent release here because Kolla-Ansible does not
# always have support for master.
for item in *-2024.1; do
./testapply.sh --defer-tests $item || break
done
# At the end you should see this:
#
# ==================================================
# All patches applied correctly.
# ==================================================
# Now we can build images. Note that you can use --build-targets and
# --build-images to override the default behaviour. So for example this
# would build _all_ container images for 2024.1, but not for any other release:
# ./buildall.sh --build-targets "2024.1" --build-images "all"
./buildall.sh --build-targets "2024.1"
At the end you should see output like this:
Export patched source code to archive/src
→...kerbside-e1632d4.tgz
→...kolla-ansible-e1632d4.tgz
→...nova-e1632d4.tgz
→...openstacksdk-e1632d4.tgz
→...oslo.config-e1632d4.tgz
→...python-novaclient-e1632d4.tgz
→...python-openstackclient-e1632d4.tgz
→...kolla-e1632d4.tgz
==================================================
Archival complete.
Total archive size: 67G archive
==================================================
In order to deploy Kolla-Ansible with our newly built images, we need to import those images into our local docker registry so that Kolla-Ansible can use them for a deploy. Note that the SHA variable below is set to match the value at the end of the filename in the output above. Note that my docker registry in this example is running on the same host I did the build on, and is on port 4000. Now we can do a tag and push:
sha="e1632d4"
release="2024.1"
debian_codename="bookworm"
for name in $(docker image list | grep ${sha} | cut -f 1 -d " " | cut -f 2 -d "/"); do
sudo docker image tag kolla/${name}:${release}-${sha} \
127.0.0.1:4000/openstack.kolla/${name}:${release}-debian-${debian_codename}
sudo docker image push \
127.0.0.1:4000/openstack.kolla/${name}:${release}-debian-${debian_codename}
done
Now we need to have a patched version of Kolla-Ansible installed somewhere so we can do the deployment. I do it this way, although you might want to use a venv for this:
cd src/kolla-ansible
sudo python3 setup.py develop
You'll need a globals.yml in /etc/kolla, but that's site specific so I don't
want to include much detail here. Refer to the Kolla-Ansible documentation for
more details. Then I deploy like this:
sudo kolla-ansible -i /etc/kolla/all-in-one deploy