Skip to content

Commit f4e0b3a

Browse files
committed
Improve docs for upgrading to Caracal
1 parent 3381a58 commit f4e0b3a

File tree

3 files changed

+68
-179
lines changed

3 files changed

+68
-179
lines changed

doc/source/operations/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ This guide is for operators of the StackHPC Kayobe configuration project.
1010
hotfix-playbook
1111
nova-compute-ironic
1212
octavia
13-
rabbitmq
1413
secret-rotation
1514
tempest
1615
upgrading-openstack

doc/source/operations/rabbitmq.rst

Lines changed: 0 additions & 177 deletions
This file was deleted.

doc/source/operations/upgrading-openstack.rst

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,64 @@ Notable changes in the |current_release| Release
3535
There are many changes in the OpenStack |current_release| release described in
3636
the release notes for each project. Here are some notable ones.
3737

38+
RabbitMQ SLURP upgrade
39+
----------------------
40+
41+
Because this is a SLURP upgrade, RabbitMQ must be upgraded manually from 3.11,
42+
to 3.12, then to 3.13 on Antelope before the Caracal upgrade. This upgrade
43+
should not cause an API outage (though it should still be considered "at
44+
risk").
45+
46+
There are two prerequisites:
47+
48+
1. Kolla-Ansible should be upgraded to the latest version. Assuming a typical
49+
production layout, execute the following from the kolla-ansible source
50+
directory:
51+
52+
.. code-block:: bash
53+
54+
git fetch && git pull && ../../venvs/kolla-ansible/bin/pip install .
55+
56+
2. The RabbitMQ container image tag must be equal to or newer than
57+
``20240823T101942``. Check the timestamps in
58+
``etc/kayobe/kolla-image-tags.yml``.
59+
60+
Once complete, upgrade RabbitMQ:
61+
62+
.. code-block:: bash
63+
64+
kayobe overcloud service configuration generate --node-config-dir /tmp/ignore -kt none
65+
kayobe kolla ansibe run "rabbitmq-upgrade 3.12"
66+
kayobe kolla ansibe run "rabbitmq-upgrade 3.13"
67+
68+
RabbitMQ quorum queues
69+
----------------------
70+
71+
In Caracal, quorum queues are enabled by default for RabbitMQ. This is
72+
different to Antelope which used HA queues. Before upgrading to Caracal, it is
73+
strongly recommended that you migrate from HA to quorum queues. The migration
74+
is automated using a script.
75+
76+
.. warning::
77+
This migration will stop all services using RabbitMQ and cause an
78+
extended API outage while queues are migrated. It should only be
79+
performed in a pre-agreed maintenance window.
80+
81+
Set the following variables in your kolla globals file (i.e.
82+
``$KAYOBE_CONFIG_PATH/kolla/globals.yml`` or
83+
``$KAYOBE_CONFIG_PATH/environments/$KAYOBE_ENVIRONMENT/kolla/globals.yml``):
84+
85+
.. code-block:: yaml
86+
87+
om_enable_rabbitmq_high_availability: false
88+
om_enable_rabbitmq_quorum_queues: true
89+
90+
Then execute the migration script:
91+
92+
.. code-block:: bash
93+
94+
$KAYOBE_CONFIG_PATH/../../tools/rabbitmq-quorum-migration.sh
95+
3896
Heat disabled by default
3997
------------------------
4098

@@ -85,7 +143,16 @@ configuration must change the names of those files in
85143
Known issues
86144
============
87145

88-
* None!
146+
* OVN breaks on Rocky 9 deployments where hostnames are FQDNs.
147+
Before upgrading, you must make sure no compute or controller nodes have any
148+
``.`` characters in their hostnames. Run the command below to check:
149+
150+
.. code-block:: bash
151+
152+
kayobe overcloud host command run --command "grep -v \'\.\' /etc/hostname" --show-output
153+
154+
There is currently no known fix for this issue aside from reprovisioning. A
155+
patch will be developed soon.
89156

90157
Security baseline
91158
=================

0 commit comments

Comments
 (0)