Skip to content

Commit 7017ed1

Browse files
Update epoxy upgrade doc (#1857)
Add section about Python 3.12 prerequisite From Epoxy, Python 3.12 is required for Ansible control host. * Remove Let's Encrypt section from known issues The issue was resolved [1] [1] https://review.opendev.org/c/openstack/kolla-ansible/+/957321 * Refer to beokay for creating kaybe env Co-authored-by: Alex Welsh <[email protected]>
1 parent cfe92da commit 7017ed1

File tree

2 files changed

+51
-12
lines changed

2 files changed

+51
-12
lines changed

doc/source/operations/upgrading-openstack.rst

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -152,15 +152,6 @@ if using environments) to 3.43.1,
152152
or pulling all custom built images before destroying pulp then push them again
153153
after pulp upgrade is done.
154154

155-
Let's Encrypt
156-
-------------
157-
158-
`Let's Encrypt TLS settings fix <https://review.opendev.org/c/openstack/kolla-ansible/+/925971>`__
159-
brought a breaking change to Let’s Encrypt ansible role. Now users have to explicitly set the target
160-
Let’s Encrypt ACME server as a kolla ansible variable ``letsencrypt_external_cert_server``/
161-
``letsencrypt_internal_cert_server`` if they were using Let’s Encrypt as a CA of their
162-
external/internal TLS certificates.
163-
164155
Cinder
165156
------
166157

@@ -353,6 +344,34 @@ After the queue migration is finished, upgrade RabbitMQ to 4.1.
353344
354345
kayobe kolla ansible run "rabbitmq-upgrade 4.1"
355346
347+
.. _python-3-12:
348+
349+
Python 3.12
350+
-----------
351+
352+
From OpenStack 2025.1, Kayobe and Kolla-Ansible require Python 3.12.
353+
354+
Ubuntu 24.04 has a default Python of version 3.12.
355+
You can find the upgrade procedure from :ref:`upgrading-to-ubuntu-noble`
356+
357+
For Rocky Linux 9, install Python 3.12 manually.
358+
359+
.. code-block:: bash
360+
361+
dnf install python3.12
362+
363+
For both Operating Systems, Kayobe and Kolla-Ansible Python virtual environments
364+
created with older Python versions will not work with OpenStack 2025.1.
365+
366+
Create a new Kayobe environment and bootstrap the Ansible control host with Python 3.12.
367+
Beokay is recommended when creating and managing the local Kayobe environment.
368+
You can find more information from the :ref:`beokay` documentation.
369+
370+
.. note::
371+
372+
For Rocky Linux 9, ``beokay create`` must be used with the ``--python python3.12``
373+
option to specify Beokay to use Python 3.12 as it is not the default.
374+
356375
Preparation
357376
===========
358377

@@ -470,12 +489,19 @@ configuration. The output of the command may be restricted using the
470489
Upgrading local Kayobe environment
471490
----------------------------------
472491

492+
.. warning::
493+
494+
Python 3.12 is required for OpenStack 2025.1 Kayobe environments.
495+
The environment cannot be upgraded for this release, it must be rebuilt.
496+
You can find more information at :ref:`python-3-12`
497+
473498
The local Kayobe environment should be either recreated or upgraded to use the
474499
new release. It may be beneficial to keep a Kayobe environment for the old
475-
release in case it is necessary before the uprade begins.
500+
release in case it is necessary before the upgrade begins.
476501

477-
In general it is safer to rebuild an environment than upgrade, but for
478-
completeness the following shows how to upgrade an existing local Kayobe
502+
In general it is safer to rebuild an environment than upgrade. You can follow
503+
instructions from the :ref:`beokay` documentation.
504+
But for completeness the following shows how to upgrade an existing local Kayobe
479505
environment.
480506

481507
Change to the Kayobe configuration directory:

doc/source/usage.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ The intention is to avoid merge conflicts where possible, but there may be
5858
cases where this is difficult. We are open to discussion on how best to
5959
approach this on both sides.
6060

61+
.. _beokay:
62+
6163
Beokay
6264
------
6365

@@ -88,6 +90,17 @@ Kayobe environments can also be specified, for example, to create an AIO environ
8890
--vault-password-file ~/vault-pw \
8991
--kayobe-in-requirements
9092
93+
Python executable can also be specified, for example, to use Python 3.12:
94+
95+
.. code-block:: console
96+
97+
beokay.py create \
98+
--base-path skc-environment \
99+
--kayobe-config-repo https://github.com/stackhpc/stackhpc-kayobe-config.git \
100+
--kayobe-config-branch |current_release_git_branch_name| \
101+
--kayobe-in-requirements
102+
--python python3.12
103+
91104
When Beokay environments are no longer required, they can be deleted by running:
92105

93106
.. code-block:: console

0 commit comments

Comments
 (0)