Skip to content

Commit a3efa45

Browse files
Alex-WelshAlex-Welsh
authored
Merge pull request #410 from stackhpc/upstream/master-2025-04-28
Synchronise master with upstream
2 parents 58640ee + 6567440 commit a3efa45

File tree

7 files changed

+131
-18
lines changed

7 files changed

+131
-18
lines changed

‎doc/source/contributor/release-notes.rst‎

Lines changed: 99 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Release notes
55
=============
66

7+
Introduction
8+
~~~~~~~~~~~~
9+
710
Kayobe (just like Kolla) uses the following release notes sections:
811

912
- ``features`` --- for new features or functionality; these should ideally
@@ -22,7 +25,7 @@ Other release note types may be applied per common sense.
2225
Each change should include a release note unless being a ``TrivialFix``
2326
change or affecting only docs or CI. Such changes should `not` include
2427
a release note to avoid confusion.
25-
Remember release notes are mostly for end users which, in case of Kolla,
28+
Remember release notes are mostly for end users which, in case of Kayobe,
2629
are OpenStack administrators/operators.
2730
In case of doubt, the core team will let you know what is required.
2831

@@ -33,13 +36,106 @@ To add a release note, run the following command:
3336
tox -e venv -- reno new <summary-line-with-dashes>
3437

3538
All release notes can be inspected by browsing ``releasenotes/notes``
36-
directory.
39+
directory. Further on this page we show reno templates, examples and how to
40+
make use of them.
41+
42+
.. note::
3743

38-
To generate release notes in HTML format in ``releasenotes/build``, run:
44+
The term `release note` is often abbreviated to `reno` as it is the name of
45+
the tool that is used to manage the release notes.
46+
47+
To generate renos in HTML format in ``releasenotes/build``, run:
3948

4049
.. code-block:: console
4150

4251
tox -e releasenotes
4352

4453
Note this requires the release note to be tracked by ``git`` so you
4554
have to at least add it to the ``git``'s staging area.
55+
56+
Templates and examples
57+
~~~~~~~~~~~~~~~~~~~~~~
58+
59+
All approved release notes end up being published on a dedicated site:
60+
61+
https://docs.openstack.org/releasenotes/kayobe/
62+
63+
When looking for examples, it is advised to consider browsing the page above
64+
for a similar type of change and then comparing with their source
65+
representation in ``releasenotes/notes``.
66+
67+
The sections below give further guidelines. Please try to follow them but note
68+
they are not set in stone and sometimes a different wording might be more
69+
appropriate. In case of doubt, the core team will be happy to help.
70+
71+
Features
72+
--------
73+
74+
Template
75+
++++++++
76+
77+
.. path releasenotes/templates/feature.yml
78+
.. code-block:: yaml
79+
80+
---
81+
features:
82+
- |
83+
Implements [some feature].
84+
[Can be described using multiple sentences if necessary.]
85+
86+
Example
87+
+++++++
88+
89+
Implementing feature with id `letsencrypt-https`, we use ``reno`` to generate
90+
the scaffolded file:
91+
92+
.. code-block:: console
93+
94+
tox -e venv -- reno new --from-template releasenotes/templates/feature.yml letsencrypt-https
95+
96+
And then fill it out with the following content (for example):
97+
98+
.. code-block:: yaml
99+
100+
---
101+
features:
102+
- |
103+
Implements support for hassle-free integration with Let's Encrypt.
104+
The support is limited to operators in the underworld.
105+
For more details check the TLS docs of Kayobe.
106+
107+
Fixes
108+
-----
109+
110+
Template
111+
++++++++
112+
113+
.. path releasenotes/templates/fix.yml
114+
.. code-block:: yaml
115+
116+
---
117+
fixes:
118+
- |
119+
Fixes [some bug].
120+
[Can be described using multiple sentences if necessary.]
121+
[Possibly also giving the previous behaviour description.]
122+
`LP#[bug number] <https://bugs.launchpad.net/kayobe/+bug/[bug number]>`__
123+
124+
Example
125+
+++++++
126+
127+
Fixing bug number `9999999`, we use ``reno`` to generate the scaffolded file:
128+
129+
.. code-block:: console
130+
131+
tox -e venv -- reno new --from-template releasenotes/templates/fix.yml bug-9999999
132+
133+
And then fill it out with the following content (for example):
134+
135+
.. code-block:: yaml
136+
137+
---
138+
fixes:
139+
- |
140+
Fixes ``deploy-containers`` action missing for the Masakari role.
141+
`LP#9999999 <https://bugs.launchpad.net/kayobe/+bug/9999999>`__

‎playbooks/kayobe-overcloud-upgrade-base/globals.yml.j2‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,3 @@ openstack_service_rpc_workers: "1"
1414

1515
# Reduce size of libvirt logs when OpenStack debug logging is enabled
1616
nova_libvirt_logging_debug: False
17-
18-
# Disable new RabbitMQ features until support is backported to 2024.1.
19-
# TODO(mattcrees): Remove these when we can properly perform the queue
20-
# migtations.
21-
om_enable_queue_manager: false
22-
om_enable_rabbitmq_transient_quorum_queue: false

‎playbooks/kayobe-overcloud-upgrade-base/run.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,17 @@
8282
chdir: "{{ previous_kayobe_src_dir }}"
8383
executable: /bin/bash
8484

85+
# Migrate RabbitMQ queues.
86+
87+
- name: Ensure RabbitMQ queues are migrated
88+
shell:
89+
cmd: dev/rabbitmq-migrate-queues.sh ironic,keystone,neutron,nova &> {{ logs_dir }}/ansible/rabbitmq-migrate-queues
90+
chdir: "{{ previous_kayobe_src_dir }}"
91+
executable: /bin/bash
92+
environment:
93+
KAYOBE_CONFIG_SOURCE_PATH: "{{ previous_kayobe_config_src_dir }}"
94+
KAYOBE_SOURCE_PATH: "{{ previous_kayobe_src_dir }}"
95+
8596
# Upgrade Kayobe, and use it to perform an upgrade of the control plane.
8697

8798
- name: Ensure overcloud is upgraded

‎releasenotes/templates/feature.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
features:
3+
- |
4+
Implements [some feature].
5+
[Can be described using multiple sentences if necessary.]

‎releasenotes/templates/fix.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
fixes:
3+
- |
4+
Fixes [some bug].
5+
[Can be described using multiple sentences if necessary.]
6+
[Possibly also giving the previous behaviour description.]
7+
`LP#[bug number] <https://bugs.launchpad.net/kayobe/+bug/[bug number]>`__

‎roles/kayobe-network-bootstrap/tasks/main.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
- name: Ensure all-in-one network bridge interface exists
1010
vars:
1111
bridge_cidr: "{{ bridge_ip }}/{{ bridge_prefix }}"
12-
bridge_broadcast: "{{ bridge_cidr | ipaddr('broadcast') }}"
12+
bridge_broadcast: "{{ bridge_cidr | ansible.utils.ipaddr('broadcast') }}"
1313
command: "{{ item }}"
1414
become: true
1515
with_items:

‎zuul.d/project.yaml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,10 @@
2121
- kayobe-overcloud-tls-rocky9
2222
- kayobe-overcloud-host-configure-rocky9
2323
- kayobe-overcloud-host-configure-ubuntu-noble
24-
# TODO(priteau): make this voting again when RabbitMQ migration issues
25-
# are resolved.
26-
- kayobe-overcloud-upgrade-rocky9:
27-
voting: false
28-
- kayobe-overcloud-upgrade-ubuntu-noble:
29-
voting: false
30-
- kayobe-overcloud-upgrade-slurp-rocky9:
31-
voting: false
24+
- kayobe-overcloud-upgrade-rocky9
25+
- kayobe-overcloud-upgrade-ubuntu-noble
26+
- kayobe-overcloud-upgrade-slurp-rocky9
27+
- kayobe-overcloud-upgrade-slurp-ubuntu-noble
3228
- kayobe-seed-rocky9
3329
- kayobe-seed-rocky9-podman
3430
- kayobe-seed-ubuntu-noble
@@ -59,6 +55,10 @@
5955
- kayobe-overcloud-tls-rocky9
6056
- kayobe-overcloud-host-configure-rocky9
6157
- kayobe-overcloud-host-configure-ubuntu-noble
58+
- kayobe-overcloud-upgrade-rocky9
59+
- kayobe-overcloud-upgrade-ubuntu-noble
60+
- kayobe-overcloud-upgrade-slurp-rocky9
61+
- kayobe-overcloud-upgrade-slurp-ubuntu-noble
6262
- kayobe-seed-rocky9
6363
- kayobe-seed-rocky9-podman
6464
- kayobe-seed-ubuntu-noble

0 commit comments

Comments
 (0)