Skip to content

Add 2026.1 documentation #2391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
priteau wants to merge 1 commit into
base: stackhpc/2026.1
Choose a base branch
from
Open

Add 2026.1 documentation #2391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ build:
python: "3.12"
jobs:
post_checkout:
- git remote set-branches origin master stackhpc/master stackhpc/2025.1 stackhpc/2024.1 stackhpc/2023.1 stackhpc/zed stackhpc/yoga stackhpc/xena stackhpc/wallaby
- git remote set-branches origin master stackhpc/master stackhpc/2026.1 stackhpc/2025.1 stackhpc/2024.1 stackhpc/2023.1 stackhpc/zed stackhpc/yoga stackhpc/xena stackhpc/wallaby
- git fetch --unshallow

# Build documentation in the doc/source/ directory with Sphinx
Expand Down
4 changes: 2 additions & 2 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
# -- StackHPC Kayobe configuration --------------------------------------
# Variables to override

current_series = "2025.1"
previous_series = "2024.1"
current_series = "2026.1"
previous_series = "2025.1"
branch = f"stackhpc/{current_series}"
ceph_series = "squid"

Expand Down
2 changes: 1 addition & 1 deletion doc/source/contributor/environments/aufn-ceph.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This environment creates a Universe-from-nothing_-style deployment of Kayobe con
.. warning::

This guide was written for the Yoga release and has not been validated for
2025.1. Proceed with caution.
2026.1. Proceed with caution.

Prerequisites
=============
Expand Down
6 changes: 3 additions & 3 deletions doc/source/contributor/environments/ci-aio.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Download the setup script:

.. parsed-literal::

curl -LO https://raw.githubusercontent.com/stackhpc/stackhpc-kayobe-config/stackhpc/2025.1/etc/kayobe/environments/ci-aio/automated-setup.sh
curl -LO https://raw.githubusercontent.com/stackhpc/stackhpc-kayobe-config/stackhpc/2026.1/etc/kayobe/environments/ci-aio/automated-setup.sh

Change the permissions on the script:

Expand All @@ -52,9 +52,9 @@ following options:

* ``BASE_PATH`` (default: ``~``) - Directory to deploy from. The directory must
exist before running the script.
* ``KAYOBE_BRANCH`` (default: ``stackhpc/2025.1``) - The branch of Kayobe
* ``KAYOBE_BRANCH`` (default: ``stackhpc/2026.1``) - The branch of Kayobe
source code to use.
* ``KAYOBE_CONFIG_BRANCH`` (default: ``stackhpc/2025.1``) - The branch of
* ``KAYOBE_CONFIG_BRANCH`` (default: ``stackhpc/2026.1``) - The branch of
``stackhpc-kayobe-config`` to use.
* ``KAYOBE_AIO_LVM`` (default: ``true``) - Whether the image uses LVM.
* ``KAYOBE_CONFIG_EDIT_PAUSE`` (default: ``false``) - Option to pause
Expand Down
2 changes: 1 addition & 1 deletion doc/source/contributor/environments/ci-multinode.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Multinode Test Environment
.. warning::

This guide was written for the Yoga release and has not been validated for
2025.1. Proceed with caution.
2026.1. Proceed with caution.

The ``ci-multinode`` environment provides a Kayobe configuration for multi-node
clouds to be used for test and development purposes. It is designed to be used
Expand Down
2 changes: 1 addition & 1 deletion doc/source/contributor/environments/ci-tenks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Download the setup script:

.. parsed-literal::
curl -LO https://raw.githubusercontent.com/stackhpc/stackhpc-kayobe-config/stackhpc/2025.1/etc/kayobe/environments/ci-tenks/automated-deployment.sh
curl -LO https://raw.githubusercontent.com/stackhpc/stackhpc-kayobe-config/stackhpc/2026.1/etc/kayobe/environments/ci-tenks/automated-deployment.sh
Change the permissions on the script:

Expand Down
10 changes: 5 additions & 5 deletions doc/source/contributor/package-updates.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ This section describes the Release Train process of creating new package reposit
Preparations
============

1. Before building images, you should check for any outstanding PRs into the earliest supported release. Below are the links for the 2025.1 branches.
1. Before building images, you should check for any outstanding PRs into the earliest supported release. Below are the links for the 2026.1 branches.

kayobe-config: https://github.com/stackhpc/stackhpc-kayobe-config/pulls?q=is%3Apr+is%3Aopen+base%3Astackhpc%2F2025.1+
kayobe-config: https://github.com/stackhpc/stackhpc-kayobe-config/pulls?q=is%3Apr+is%3Aopen+base%3Astackhpc%2F2026.1+

kolla: https://github.com/stackhpc/kolla/pulls?q=is%3Apr+is%3Aopen+base%3Astackhpc%2F2025.1+
kolla: https://github.com/stackhpc/kolla/pulls?q=is%3Apr+is%3Aopen+base%3Astackhpc%2F2026.1+

kolla-ansible: https://github.com/stackhpc/kolla-ansible/pulls?q=is%3Apr+is%3Aopen+base%3Astackhpc%2F2025.1+
kolla-ansible: https://github.com/stackhpc/kolla-ansible/pulls?q=is%3Apr+is%3Aopen+base%3Astackhpc%2F2026.1+

You should also check any referenced source trees in etc/kayobe/kolla.yml.

Expand Down Expand Up @@ -165,7 +165,7 @@ Upgrading OpenStack to the next release in a multinode environment
.. warning::

This guide was written for the Wallaby release and has not been validated
for 2025.1. Proceed with caution.
for 2026.1. Proceed with caution.

As this is not a full production system, only a reduced number of steps need to be followed to upgrade to a new release. Below describes these steps, with ``stackhpc/wallaby`` as the starting branch:

Expand Down
2 changes: 1 addition & 1 deletion doc/source/contributor/testing-ci-automation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ job.
The workflow performs the following high-level steps:

#. Deploy a VM on an OpenStack cloud using the `aio
<https://github.com/stackhpc/stackhpc-kayobe-config/tree/stackhpc/2025.1/terraform/aio>`_
<https://github.com/stackhpc/stackhpc-kayobe-config/tree/stackhpc/2026.1/terraform/aio>`_
Terraform configuration.
#. Deploy OpenStack in the VM using Kayobe and the :doc:`ci-aio
<environments/ci-aio>` environment. If this is an upgrade job, the previous
Expand Down
2 changes: 1 addition & 1 deletion doc/source/operations/customising-horizon.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Creating a custom Horizon theme

A simple custom theme for Horizon can be implemented as small modifications of
an existing theme, such as the `Default
<https://opendev.org/openstack/horizon/src/branch/2025.1/openstack_dashboard/themes/default>`__
<https://opendev.org/openstack/horizon/src/branch/2026.1/openstack_dashboard/themes/default>`__
one.

A theme contains at least two files: ``static/_styles.scss``, which can be empty, and
Expand Down
10 changes: 0 additions & 10 deletions doc/source/operations/ubuntu-noble.rst
View file
Open in desktop

This file was deleted.

19 changes: 5 additions & 14 deletions doc/source/operations/upgrading-openstack.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ A proper fix is still WIP, in the meantime these errors can be resolved with thi
Security baseline
=================

As part of the 2025.1 Epoxy release we are looking to improve the security
As part of the 2026.1 Epoxy release we are looking to improve the security

@gemini-code-assist gemini-code-assist Bot Jun 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The 2026.1 release series is named Gazpacho, not Epoxy (which was the name for 2025.1). Please update this reference to reflect the correct release name.

Suggested change
As part of the 2026.1 Epoxy release we are looking to improve the security
As part of the 2026.1 Gazpacho release we are looking to improve the security
References
  1. In upgrade documentation, avoid using generic release placeholders for information that is specific to a single release. Instead, hardcode the specific version number.

baseline of StackHPC OpenStack deployments. If any of the following have not
been done, they should be completed before the upgrade begins.

Expand Down Expand Up @@ -261,15 +261,6 @@ suggestions:
generally be found in the documentation of each project. For example, Nova
policy: https://docs.openstack.org/nova/latest/configuration/policy.html

Ubuntu Noble migration
----------------------

Ubuntu Jammy support has been removed from the 2025.1 release onwards. Hosts
must be migrated to Ubuntu 24.04 before upgrading OpenStack services.
You can find the upgrade procedure from :ref:`upgrading-to-ubuntu-noble`
documentation.


RabbitMQ Prerequisites
----------------------

Expand Down Expand Up @@ -346,7 +337,7 @@ After the queue migration is finished, upgrade RabbitMQ to 4.1.
Python 3.12
-----------

From OpenStack 2025.1, Kayobe and Kolla-Ansible require Python 3.12.
From OpenStack 2026.1, Kayobe and Kolla-Ansible require Python 3.12.

@gemini-code-assist gemini-code-assist Bot Jun 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The file doc/source/operations/ubuntu-noble.rst has been removed in this pull request, which breaks the reference :ref:upgrading-to-ubuntu-noble`` on line 343. Please remove or update this reference to avoid documentation build errors.


Ubuntu 24.04 has a default Python of version 3.12.
You can find the upgrade procedure from :ref:`upgrading-to-ubuntu-noble`
Expand All @@ -358,7 +349,7 @@ For Rocky Linux 9, install Python 3.12 manually.
dnf install python3.12

For both Operating Systems, Kayobe and Kolla-Ansible Python virtual environments
created with older Python versions will not work with OpenStack 2025.1.
created with older Python versions will not work with OpenStack 2026.1.

Create a new Kayobe environment and bootstrap the Ansible control host with Python 3.12.
Beokay is recommended when creating and managing the local Kayobe environment.
Expand Down Expand Up @@ -496,7 +487,7 @@ Upgrading local Kayobe environment

.. warning::

Python 3.12 is required for OpenStack 2025.1 Kayobe environments.
Python 3.12 is required for OpenStack 2026.1 Kayobe environments.
The environment cannot be upgraded for this release, it must be rebuilt.
You can find more information at :ref:`python-3-12`

Expand Down Expand Up @@ -569,7 +560,7 @@ To upgrade the Ansible control host:
Upgrading Pulp
--------------

The local Pulp server needs to be upgraded before synchronising 2025.1
The local Pulp server needs to be upgraded before synchronising 2026.1
container images. The following command will deploy the latest Pulp container
without upgrading Bifrost:

Expand Down
8 changes: 4 additions & 4 deletions doc/source/release-notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=================================
2025.1 Epoxy Series Release Notes
=================================
=====================================
2026.1 Gazapacho Series Release Notes
=====================================
Comment on lines +1 to +3

@gemini-code-assist gemini-code-assist Bot Jun 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There is a typo in the release name: Gazapacho should be Gazpacho. Additionally, the title underline should be adjusted to match the new title length (36 characters).

Suggested change
=====================================
2026.1 Gazapacho Series Release Notes
=====================================
====================================
2026.1 Gazpacho Series Release Notes
====================================


.. release-notes::
:branch: stackhpc/2025.1
:branch: stackhpc/2026.1
3 changes: 1 addition & 2 deletions doc/source/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ when used with Kayobe's :kayobe-doc:`multiple environments
<multiple-environments>` feature.

This configuration should be consumed using the `StackHPC Kayobe fork
<https://github.com/stackhpc/kayobe/tree/stackhpc/2025.1>`__, which includes
backported support for Ansible collections.
<https://github.com/stackhpc/kayobe/tree/stackhpc/2026.1>`__.

New deployments
---------------
Expand Down
Loading