From 055752ea995d271dcb0ab9365c55fcf34db6c2c5 Mon Sep 17 00:00:00 2001 From: Pierre Riteau Date: Mon, 29 Jun 2026 09:24:13 +0200 Subject: [PATCH] Add 2026.1 documentation The OpenStack upgrade page still needs a full review. --- .readthedocs.yaml | 2 +- doc/source/conf.py | 4 ++-- .../contributor/environments/aufn-ceph.rst | 2 +- .../contributor/environments/ci-aio.rst | 6 +++--- .../contributor/environments/ci-multinode.rst | 2 +- .../contributor/environments/ci-tenks.rst | 2 +- doc/source/contributor/package-updates.rst | 10 +++++----- .../contributor/testing-ci-automation.rst | 2 +- doc/source/operations/customising-horizon.rst | 2 +- doc/source/operations/ubuntu-noble.rst | 10 ---------- doc/source/operations/upgrading-openstack.rst | 19 +++++-------------- doc/source/release-notes.rst | 8 ++++---- doc/source/usage.rst | 3 +-- 13 files changed, 26 insertions(+), 46 deletions(-) delete mode 100644 doc/source/operations/ubuntu-noble.rst diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 6cbc9d3e27..f7878668c4 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -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 diff --git a/doc/source/conf.py b/doc/source/conf.py index a6376d3018..ff2841f57a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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" diff --git a/doc/source/contributor/environments/aufn-ceph.rst b/doc/source/contributor/environments/aufn-ceph.rst index 537dd66310..130ee69708 100644 --- a/doc/source/contributor/environments/aufn-ceph.rst +++ b/doc/source/contributor/environments/aufn-ceph.rst @@ -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 ============= diff --git a/doc/source/contributor/environments/ci-aio.rst b/doc/source/contributor/environments/ci-aio.rst index 2a45c667a5..74a19aeb50 100644 --- a/doc/source/contributor/environments/ci-aio.rst +++ b/doc/source/contributor/environments/ci-aio.rst @@ -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: @@ -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 diff --git a/doc/source/contributor/environments/ci-multinode.rst b/doc/source/contributor/environments/ci-multinode.rst index 06509ce86e..3c5274ffa4 100644 --- a/doc/source/contributor/environments/ci-multinode.rst +++ b/doc/source/contributor/environments/ci-multinode.rst @@ -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 diff --git a/doc/source/contributor/environments/ci-tenks.rst b/doc/source/contributor/environments/ci-tenks.rst index 9146d631af..983a6222f7 100644 --- a/doc/source/contributor/environments/ci-tenks.rst +++ b/doc/source/contributor/environments/ci-tenks.rst @@ -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: diff --git a/doc/source/contributor/package-updates.rst b/doc/source/contributor/package-updates.rst index cb4450eff3..b2e1cccdf4 100644 --- a/doc/source/contributor/package-updates.rst +++ b/doc/source/contributor/package-updates.rst @@ -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. @@ -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: diff --git a/doc/source/contributor/testing-ci-automation.rst b/doc/source/contributor/testing-ci-automation.rst index 4601c74dbd..e46460f7c0 100644 --- a/doc/source/contributor/testing-ci-automation.rst +++ b/doc/source/contributor/testing-ci-automation.rst @@ -113,7 +113,7 @@ job. The workflow performs the following high-level steps: #. Deploy a VM on an OpenStack cloud using the `aio - `_ + `_ Terraform configuration. #. Deploy OpenStack in the VM using Kayobe and the :doc:`ci-aio ` environment. If this is an upgrade job, the previous diff --git a/doc/source/operations/customising-horizon.rst b/doc/source/operations/customising-horizon.rst index 97c6a84901..d6fe29d4ba 100644 --- a/doc/source/operations/customising-horizon.rst +++ b/doc/source/operations/customising-horizon.rst @@ -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 -`__ +`__ one. A theme contains at least two files: ``static/_styles.scss``, which can be empty, and diff --git a/doc/source/operations/ubuntu-noble.rst b/doc/source/operations/ubuntu-noble.rst deleted file mode 100644 index 6e7435894c..0000000000 --- a/doc/source/operations/ubuntu-noble.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _upgrading-to-ubuntu-noble: - -============ -Ubuntu Noble -============ - -.. warning:: - - Before upgrading to the 2025.1 release of OpenStack, all Ubuntu hosts must first be upgraded to Ubuntu Noble (24.04). - Please follow the upgrade instructions provided in the 2024.1 release documentation, available `here `__. diff --git a/doc/source/operations/upgrading-openstack.rst b/doc/source/operations/upgrading-openstack.rst index 6b414eb65f..98b268830e 100644 --- a/doc/source/operations/upgrading-openstack.rst +++ b/doc/source/operations/upgrading-openstack.rst @@ -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 baseline of StackHPC OpenStack deployments. If any of the following have not been done, they should be completed before the upgrade begins. @@ -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 ---------------------- @@ -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. Ubuntu 24.04 has a default Python of version 3.12. You can find the upgrade procedure from :ref:`upgrading-to-ubuntu-noble` @@ -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. @@ -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` @@ -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: diff --git a/doc/source/release-notes.rst b/doc/source/release-notes.rst index cec010e00e..898600ea07 100644 --- a/doc/source/release-notes.rst +++ b/doc/source/release-notes.rst @@ -1,6 +1,6 @@ -================================= -2025.1 Epoxy Series Release Notes -================================= +===================================== +2026.1 Gazapacho Series Release Notes +===================================== .. release-notes:: - :branch: stackhpc/2025.1 + :branch: stackhpc/2026.1 diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 0b503e7641..b5fbc1b192 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -16,8 +16,7 @@ when used with Kayobe's :kayobe-doc:`multiple environments ` feature. This configuration should be consumed using the `StackHPC Kayobe fork -`__, which includes -backported support for Ansible collections. +`__. New deployments ---------------