Update epoxy upgrade doc #1857
Update epoxy upgrade doc #1857
Conversation
seunghun1ee
commented
Aug 27, 2025
seunghun1ee
commented
- Added Prerequisite section about using Python 3.12
- Removed Known issue section of Let's Encrypt because the issue was resolved
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @seunghun1ee, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request updates the upgrading-openstack.rst documentation to reflect current requirements and resolved issues. It introduces a new prerequisite section for Python 3.12, outlining its necessity for OpenStack 2025.1 and providing clear instructions for environment setup. Concurrently, an outdated 'Let's Encrypt' known issue section has been removed, streamlining the documentation and ensuring its accuracy.
Highlights
- Python 3.12 Prerequisite: A new section has been added to the upgrade documentation detailing the requirement for Python 3.12 for OpenStack 2025.1. This includes instructions for installing Python 3.12 on Ubuntu 24.04 and Rocky Linux 9, and guidance on creating new Python virtual environments for Kayobe and Kolla-Ansible.
- Resolved Let's Encrypt Issue: The 'Let's Encrypt' known issue section has been removed from the documentation. This issue, which previously described a breaking change related to TLS settings, has been resolved, making the documentation obsolete.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request updates the Epoxy upgrade documentation. It correctly removes the 'Let's Encrypt' known issue, which is now resolved. It also adds a new prerequisite section for Python 3.12, which is a necessary change for the OpenStack 2025.1 release. I've found a couple of minor issues in the new section, including a typo and a small grammar suggestion to improve clarity. Overall, the changes are good and improve the documentation.
|
Should we think about documenting to use beokay? I'd guess majority of us and our clients use that. |
|
|
||
| .. code-block:: bash | ||
|
|
||
| dnf install python3.12 |
There was a problem hiding this comment.
Don't we need python3.12-devel?
There was a problem hiding this comment.
I can't find aio or multinode setup script/playbooks installing python3.12-devel for RL9. So probably not?
seunghun1ee
force-pushed
the
update-epoxy-upgrade-doc
branch
from
88dc5a2 to
1c09e6b
Compare
There was a problem hiding this comment.
Could you also add a note to the Upgrading local Kayobe environment section please? It should also mention something about python 3.12, even if that's just a link back to this new section.
While you're there, i noticed a typo in the last line of the first paragraph of that section (uprade), would you mind fixing that?
|
We have https://stackhpc-kayobe-config.readthedocs.io/en/stackhpc-2025.1/usage.html#beokay but not utilised well I guess. |
That would be good. We should try to normalise as many sites as possible on beokay |
From Epoxy, Python 3.12 is required for Ansible control host.
The issue was resolved [1] [1] https://review.opendev.org/c/openstack/kolla-ansible/+/957321
seunghun1ee
force-pushed
the
update-epoxy-upgrade-doc
branch
from
1c09e6b to
6a81ea9
Compare
Co-authored-by: Alex Welsh <[email protected]>
|
|
||
| From OpenStack 2025.1, Kayobe and Kolla-Ansible require Python 3.12. | ||
|
|
||
| Ubuntu 24.04 has default Python of version 3.12. |
There was a problem hiding this comment.
| Ubuntu 24.04 has default Python of version 3.12. | |
| Ubuntu 24.04 has a default Python of version 3.12. |
| dnf install python3.12 | ||
|
|
||
| For both Operating Systems, Kayobe and Kolla-Ansible Python virtual environments | ||
| created with older Python version will not work with OpenStack 2025.1. |
There was a problem hiding this comment.
| created with older Python version will not work with OpenStack 2025.1. | |
| created with older Python versions will not work with OpenStack 2025.1. |
| Create new Kayobe environment and bootstrap Ansible control host with Python 3.12. | ||
| Beokay is recommended when creating and managing local Kayobe environment. | ||
| You can find more information from :ref:`beokay` documentation. |
There was a problem hiding this comment.
| Create new Kayobe environment and bootstrap Ansible control host with Python 3.12. | |
| Beokay is recommended when creating and managing local Kayobe environment. | |
| You can find more information from :ref:`beokay` documentation. | |
| 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. | |
| You can find more information from the :ref:`beokay` documentation. |
|
|
||
| .. note:: | ||
|
|
||
| For Rocky Linux 9, ``beokay create`` need ``--python python3.12`` option |
There was a problem hiding this comment.
| For Rocky Linux 9, ``beokay create`` need ``--python python3.12`` option | |
| For Rocky Linux 9, ``beokay create`` must be used with the ``--python python3.12`` option |
| In general it is safer to rebuild an environment than upgrade, but for | ||
| completeness the following shows how to upgrade an existing local Kayobe | ||
| In general it is safer to rebuild an environment than upgrade. You can follow | ||
| instructions from :ref:`beokay` documentation. |
There was a problem hiding this comment.
| instructions from :ref:`beokay` documentation. | |
| instructions from the :ref:`beokay` documentation. |
