From d930fca08c735b848ca92ac0d553eeebf3eaa028 Mon Sep 17 00:00:00 2001 From: Michal Nasiadka Date: Mon, 22 Apr 2024 16:35:04 +0200 Subject: [PATCH] CI: Add reno linting Change-Id: I799d6bf7a381c377dee565c13b1732f7313520f4 --- .../notes/add-designate-c789e47f8ced394d.yaml | 3 ++- ...ironic-prometheus-exporter-c793478ee5938bee.yaml | 4 ++-- .../add-monasca-grafana-app-ea24f8ca43fa9c7d.yaml | 3 ++- .../add-networking-ansible-b27128f544f300e6.yaml | 7 ++++--- ...se-dumb-init-config-option-26b47f6d97d7585c.yaml | 5 +++-- .../notes/bug-1814552-a037354969dcf7e5.yaml | 4 ++-- .../notes/bug-1859047-d41762357da8ae0b.yaml | 4 ++-- .../notes/bug-1946801-5f3af3c44e567fcf.yaml | 4 ++-- .../notes/bug-2062572-c55c71e1045a863f.yaml | 5 ++++- .../deprecate-kubernetes-dbabf9f86c15a0ee.yaml | 4 ++-- .../deprecate-opendaylight-58b3e9dbdc359688.yaml | 4 ++-- .../drop-pyhton-3-6-and-3-7-6cc88979aad423e8.yaml | 4 ++-- ...fana-opensearch-datasource-96dc8061d9721af3.yaml | 4 ++-- ...ync_rpm_swift_base_missing-9d106d94b52d0bad.yaml | 3 ++- .../generic-customisation-b2d431caa2fc5c10.yaml | 4 ++-- .../notes/ironic_syslinux-70eac225d227dc2e.yaml | 3 ++- .../octavia-driver-agent-83ee17b82c577e95.yaml | 4 ++-- .../prometheus-containers-1599a6417cc6a264.yaml | 6 +++--- .../remove-fwaas-deployment-8381b454528bdae9.yaml | 4 ++-- .../remove-glance-registry-4a5c3d54440f7c28.yaml | 3 ++- ...emove-neutron-vpnaas-agent-216810affb495ad0.yaml | 13 +++++++------ ...rometheus-haproxy-exporter-22d5af88af7e4a9d.yaml | 8 ++++---- .../notes/remove-zaqar-image-de36960a88f132c8.yaml | 3 ++- .../notes/summary-json-file-96441e67076fc480.yaml | 4 ++-- ...upport-image-cross-compile-3b1dc348d742e96d.yaml | 4 ++-- .../notes/upgrade-pip-44352805d60bbf7f.yaml | 4 ++-- .../notes/vitrage-containers-3bfb360357aa628b.yaml | 8 ++++---- tox.ini | 2 ++ 28 files changed, 71 insertions(+), 57 deletions(-) diff --git a/releasenotes/notes/add-designate-c789e47f8ced394d.yaml b/releasenotes/notes/add-designate-c789e47f8ced394d.yaml index 6528dcf2f1..0a4be74d8b 100644 --- a/releasenotes/notes/add-designate-c789e47f8ced394d.yaml +++ b/releasenotes/notes/add-designate-c789e47f8ced394d.yaml @@ -2,4 +2,5 @@ features: - Add deployment and management of Designate OpenStack services. issues: - - Customer facing DNS servers for use with Designate still required to be set up manually. + - Customer facing DNS servers for use with Designate still required + to be set up manually. diff --git a/releasenotes/notes/add-ironic-prometheus-exporter-c793478ee5938bee.yaml b/releasenotes/notes/add-ironic-prometheus-exporter-c793478ee5938bee.yaml index d3eeacf31c..9c62c42852 100644 --- a/releasenotes/notes/add-ironic-prometheus-exporter-c793478ee5938bee.yaml +++ b/releasenotes/notes/add-ironic-prometheus-exporter-c793478ee5938bee.yaml @@ -2,7 +2,7 @@ features: - | Adds an image and further support for the ironic-prometheus-exporter, 'a - Tool to expose hardware sensor data in the Prometheus format through an HTTP - endpoint'. + Tool to expose hardware sensor data in the Prometheus format through an + HTTP endpoint'. See https://opendev.org/openstack/ironic-prometheus-exporter for more details about the exporter. diff --git a/releasenotes/notes/add-monasca-grafana-app-ea24f8ca43fa9c7d.yaml b/releasenotes/notes/add-monasca-grafana-app-ea24f8ca43fa9c7d.yaml index 5b45516b8e..6cba408622 100644 --- a/releasenotes/notes/add-monasca-grafana-app-ea24f8ca43fa9c7d.yaml +++ b/releasenotes/notes/add-monasca-grafana-app-ea24f8ca43fa9c7d.yaml @@ -2,4 +2,5 @@ features: - | Add a Monasca app plugin for the Monasca fork of Grafana. Plugin provides - screens for viewing or configuring: Alarm Definitions, Alarms and Notifications + screens for viewing or configuring: Alarm Definitions, Alarms and + Notifications. diff --git a/releasenotes/notes/add-networking-ansible-b27128f544f300e6.yaml b/releasenotes/notes/add-networking-ansible-b27128f544f300e6.yaml index 7708a8781a..1350b8d4a7 100644 --- a/releasenotes/notes/add-networking-ansible-b27128f544f300e6.yaml +++ b/releasenotes/notes/add-networking-ansible-b27128f544f300e6.yaml @@ -1,5 +1,6 @@ --- features: - - Add support for networking-ansible. Installs networking-ansible ML2 driver in the neutron - base image when building from source. Binary users can use ``neutron_server_packages_append`` - to include ``python-networking-ansible`` when building neutron-server image. + - Add support for networking-ansible. Installs networking-ansible ML2 driver + in the neutron base image when building from source. Binary users can use + ``neutron_server_packages_append`` to include ``python-networking-ansible`` + when building neutron-server image. diff --git a/releasenotes/notes/add-use-dumb-init-config-option-26b47f6d97d7585c.yaml b/releasenotes/notes/add-use-dumb-init-config-option-26b47f6d97d7585c.yaml index cd60b26b6d..ab815c70f7 100644 --- a/releasenotes/notes/add-use-dumb-init-config-option-26b47f6d97d7585c.yaml +++ b/releasenotes/notes/add-use-dumb-init-config-option-26b47f6d97d7585c.yaml @@ -1,8 +1,9 @@ --- features: - | - Adds configuration option ``use_dumb_init``, with default value of ``True``. - This can be use to avoid the of ``dumb-init`` as the container entrypoint, + Adds configuration option ``use_dumb_init``, with default value of + ``True``. This can be use to avoid the of ``dumb-init`` as the + container entrypoint, using ``kolla_start`` directly instead. This option can also be disabled via the ``kolla-build --nouse-dumb-init`` CLI argument. upgrade: diff --git a/releasenotes/notes/bug-1814552-a037354969dcf7e5.yaml b/releasenotes/notes/bug-1814552-a037354969dcf7e5.yaml index fbff1f038c..7f544a1271 100644 --- a/releasenotes/notes/bug-1814552-a037354969dcf7e5.yaml +++ b/releasenotes/notes/bug-1814552-a037354969dcf7e5.yaml @@ -1,6 +1,6 @@ --- fixes: - | - Fix inability to run UEFI-based images/instances by installing UEFI packages - also in nova-libvirt image which is not based on nova-base. + Fix inability to run UEFI-based images/instances by installing UEFI + packages also in nova-libvirt image which is not based on nova-base. `LP#1814552 `__ diff --git a/releasenotes/notes/bug-1859047-d41762357da8ae0b.yaml b/releasenotes/notes/bug-1859047-d41762357da8ae0b.yaml index 68e8d5f4fa..6124d80a06 100644 --- a/releasenotes/notes/bug-1859047-d41762357da8ae0b.yaml +++ b/releasenotes/notes/bug-1859047-d41762357da8ae0b.yaml @@ -1,6 +1,6 @@ --- fixes: - | - Fix bug which caused Keystone Fernet key distribution to fail on Python 3 systems, - by adapting fetch-fernet-keys.py script to work on Python 3. + Fix bug which caused Keystone Fernet key distribution to fail on Python 3 + systems, by adapting fetch-fernet-keys.py script to work on Python 3. `LP#1859047 `__ diff --git a/releasenotes/notes/bug-1946801-5f3af3c44e567fcf.yaml b/releasenotes/notes/bug-1946801-5f3af3c44e567fcf.yaml index b67c9751fd..8bfc71172f 100644 --- a/releasenotes/notes/bug-1946801-5f3af3c44e567fcf.yaml +++ b/releasenotes/notes/bug-1946801-5f3af3c44e567fcf.yaml @@ -1,6 +1,6 @@ --- fixes: - | - CentOS ``nova-compute`` image has ``linux-firmware`` package removed to save - image size by ~500MB. + CentOS ``nova-compute`` image has ``linux-firmware`` package removed to + save image size by ~500MB. `LP#1926801 `__ diff --git a/releasenotes/notes/bug-2062572-c55c71e1045a863f.yaml b/releasenotes/notes/bug-2062572-c55c71e1045a863f.yaml index 81ba6b793b..a2a3693a1f 100644 --- a/releasenotes/notes/bug-2062572-c55c71e1045a863f.yaml +++ b/releasenotes/notes/bug-2062572-c55c71e1045a863f.yaml @@ -1,5 +1,8 @@ --- fixes: - | - Fixes a bug where swtpm and swtpm-tools deb packages are missing in 'nova-compute' and 'nova-libvirt' containers which keeps 'nova-compute' container from starting when operator enables TPM support in Nova. + Fixes a bug where swtpm and swtpm-tools deb packages are missing in + 'nova-compute' and 'nova-libvirt' containers which keeps + 'nova-compute' container from starting when operator enables TPM + support in Nova. `LP#2062572 `__ diff --git a/releasenotes/notes/deprecate-kubernetes-dbabf9f86c15a0ee.yaml b/releasenotes/notes/deprecate-kubernetes-dbabf9f86c15a0ee.yaml index 92e08bd6d7..73df7408b5 100644 --- a/releasenotes/notes/deprecate-kubernetes-dbabf9f86c15a0ee.yaml +++ b/releasenotes/notes/deprecate-kubernetes-dbabf9f86c15a0ee.yaml @@ -14,7 +14,7 @@ deprecations: The deprecated images include: ``helm-repository``, ``kube-*``, ``kubernetes-entrypoint`` and ``kubetoolbox``. The ``install_kubectl`` macro is deprecated as well and, along with it, - the ``magnum-conductor`` image's ``kubectl`` command because it is of limited - usefulness being pinned to an old version. Magnum end-users use + the ``magnum-conductor`` image's ``kubectl`` command because it is of + limited usefulness being pinned to an old version. Magnum end-users use an externally-provided ``kubectl``. Please note this deprecation does not affect Magnum nor Qinling support. diff --git a/releasenotes/notes/deprecate-opendaylight-58b3e9dbdc359688.yaml b/releasenotes/notes/deprecate-opendaylight-58b3e9dbdc359688.yaml index 0634e97a76..0120b9fb90 100644 --- a/releasenotes/notes/deprecate-opendaylight-58b3e9dbdc359688.yaml +++ b/releasenotes/notes/deprecate-opendaylight-58b3e9dbdc359688.yaml @@ -1,5 +1,5 @@ --- deprecations: - | - The OpenDaylight (``opendaylight``) image is deprecated and will be removed. - It is not used by any Kolla downstream projects. + The OpenDaylight (``opendaylight``) image is deprecated and will be + removed. It is not used by any Kolla downstream projects. diff --git a/releasenotes/notes/drop-pyhton-3-6-and-3-7-6cc88979aad423e8.yaml b/releasenotes/notes/drop-pyhton-3-6-and-3-7-6cc88979aad423e8.yaml index db420d7390..be968d94bc 100644 --- a/releasenotes/notes/drop-pyhton-3-6-and-3-7-6cc88979aad423e8.yaml +++ b/releasenotes/notes/drop-pyhton-3-6-and-3-7-6cc88979aad423e8.yaml @@ -1,5 +1,5 @@ --- upgrade: - | - Python 3.6 & 3.7 support has been dropped. The minimum version of Python now - supported is Python 3.8. + Python 3.6 & 3.7 support has been dropped. The minimum version of Python + now supported is Python 3.8. diff --git a/releasenotes/notes/fix-grafana-opensearch-datasource-96dc8061d9721af3.yaml b/releasenotes/notes/fix-grafana-opensearch-datasource-96dc8061d9721af3.yaml index 5bba49ec72..61c8ce111f 100644 --- a/releasenotes/notes/fix-grafana-opensearch-datasource-96dc8061d9721af3.yaml +++ b/releasenotes/notes/fix-grafana-opensearch-datasource-96dc8061d9721af3.yaml @@ -1,5 +1,5 @@ --- fixes: - | - Adds missing ``grafana-opensearch-datasource`` plugin to the list of plugins - in the docker image. + Adds missing ``grafana-opensearch-datasource`` plugin to the list of + plugins in the docker image. diff --git a/releasenotes/notes/fix_rsync_rpm_swift_base_missing-9d106d94b52d0bad.yaml b/releasenotes/notes/fix_rsync_rpm_swift_base_missing-9d106d94b52d0bad.yaml index 127907e3bf..b6a8600db2 100644 --- a/releasenotes/notes/fix_rsync_rpm_swift_base_missing-9d106d94b52d0bad.yaml +++ b/releasenotes/notes/fix_rsync_rpm_swift_base_missing-9d106d94b52d0bad.yaml @@ -1,5 +1,6 @@ --- fixes: - | - Fixes a bug where the ``rsync`` RPM package was missing in the ``swift-base`` container. + Fixes a bug where the ``rsync`` RPM package was missing in the + ``swift-base`` container. See `bug 2062072 `__ for details. diff --git a/releasenotes/notes/generic-customisation-b2d431caa2fc5c10.yaml b/releasenotes/notes/generic-customisation-b2d431caa2fc5c10.yaml index 2c8557b03d..e19195487f 100644 --- a/releasenotes/notes/generic-customisation-b2d431caa2fc5c10.yaml +++ b/releasenotes/notes/generic-customisation-b2d431caa2fc5c10.yaml @@ -10,7 +10,7 @@ features: ``PIP_EXTRA_INDEX_URL``, and ``PIP_TRUSTED_HOST`` variables. upgrade: - | - All Dockerfile files which uses curl to download any external files from the - Internet now have a corresponding version templating block which can + All Dockerfile files which uses curl to download any external files from + the Internet now have a corresponding version templating block which can be used to override them. Also all the ENV instructions inside these blocks converted to the ARG instructions to minimize the unneeded variables. diff --git a/releasenotes/notes/ironic_syslinux-70eac225d227dc2e.yaml b/releasenotes/notes/ironic_syslinux-70eac225d227dc2e.yaml index 400c88b814..18aa4ce672 100644 --- a/releasenotes/notes/ironic_syslinux-70eac225d227dc2e.yaml +++ b/releasenotes/notes/ironic_syslinux-70eac225d227dc2e.yaml @@ -1,4 +1,5 @@ --- fixes: - | - The syslinux package is only built for x86_64 and not for ppc64le or aarch64. + The syslinux package is only built for x86_64 and not for + ppc64le or aarch64. diff --git a/releasenotes/notes/octavia-driver-agent-83ee17b82c577e95.yaml b/releasenotes/notes/octavia-driver-agent-83ee17b82c577e95.yaml index 3e89cf38a4..6e91004a95 100644 --- a/releasenotes/notes/octavia-driver-agent-83ee17b82c577e95.yaml +++ b/releasenotes/notes/octavia-driver-agent-83ee17b82c577e95.yaml @@ -1,5 +1,5 @@ --- features: - | - ``octavia-driver-agent`` image was added to support other Octavia providers than - ``amphora``. + ``octavia-driver-agent`` image was added to support other Octavia providers + than ``amphora``. diff --git a/releasenotes/notes/prometheus-containers-1599a6417cc6a264.yaml b/releasenotes/notes/prometheus-containers-1599a6417cc6a264.yaml index 17bbeef030..9f95de419a 100644 --- a/releasenotes/notes/prometheus-containers-1599a6417cc6a264.yaml +++ b/releasenotes/notes/prometheus-containers-1599a6417cc6a264.yaml @@ -1,5 +1,5 @@ --- features: - - Container image for prometheus timeseries database - - Container images for the prometheus exporters node_exporter, mysqld_exporter - and haproxy_exporter + - Container image for prometheus timeseries database. + - Container images for the prometheus exporters node_exporter, + mysqld_exporter and haproxy_exporter. diff --git a/releasenotes/notes/remove-fwaas-deployment-8381b454528bdae9.yaml b/releasenotes/notes/remove-fwaas-deployment-8381b454528bdae9.yaml index 02647ed638..99f83f4477 100644 --- a/releasenotes/notes/remove-fwaas-deployment-8381b454528bdae9.yaml +++ b/releasenotes/notes/remove-fwaas-deployment-8381b454528bdae9.yaml @@ -1,5 +1,5 @@ --- upgrade: - | - FWaaS project has been removed in Victoria cycle and it's no longer included - in Kolla container images and deployment. + FWaaS project has been removed in Victoria cycle and it's no longer + included in Kolla container images and deployment. diff --git a/releasenotes/notes/remove-glance-registry-4a5c3d54440f7c28.yaml b/releasenotes/notes/remove-glance-registry-4a5c3d54440f7c28.yaml index 2ee39b02b7..99b02c48ac 100644 --- a/releasenotes/notes/remove-glance-registry-4a5c3d54440f7c28.yaml +++ b/releasenotes/notes/remove-glance-registry-4a5c3d54440f7c28.yaml @@ -1,5 +1,6 @@ --- upgrade: - | - Glance Registry service was deprecated in the Queens release and has been removed in Victoria. + Glance Registry service was deprecated in the Queens release and has been + removed in Victoria. Accordingly, container image glance-registry has been removed from Kolla. diff --git a/releasenotes/notes/remove-neutron-vpnaas-agent-216810affb495ad0.yaml b/releasenotes/notes/remove-neutron-vpnaas-agent-216810affb495ad0.yaml index c09f4ab8ce..179ec2da65 100644 --- a/releasenotes/notes/remove-neutron-vpnaas-agent-216810affb495ad0.yaml +++ b/releasenotes/notes/remove-neutron-vpnaas-agent-216810affb495ad0.yaml @@ -1,11 +1,12 @@ --- upgrade: - | - The neutron-vpnaas-agent has been loaded just inside of the existing l3 agent - rather than requiring operators to run a completely different binary with a - subclass of the existing L3 agent. + The neutron-vpnaas-agent has been loaded just inside of the existing + l3 agent rather than requiring operators to run a completely different + binary with a subclass of the existing L3 agent. -deprecation: +deprecations: - | - As neutron-vpnaas-agent can be loaded by the neutron l3 agent, neutron-vpnaas - standalone mode is not supported. It's time to remove this container. + As neutron-vpnaas-agent can be loaded by the neutron l3 agent, + neutron-vpnaas standalone mode is not supported. It's time to + remove this container. diff --git a/releasenotes/notes/remove-prometheus-haproxy-exporter-22d5af88af7e4a9d.yaml b/releasenotes/notes/remove-prometheus-haproxy-exporter-22d5af88af7e4a9d.yaml index c4da5635c2..5d1739357f 100644 --- a/releasenotes/notes/remove-prometheus-haproxy-exporter-22d5af88af7e4a9d.yaml +++ b/releasenotes/notes/remove-prometheus-haproxy-exporter-22d5af88af7e4a9d.yaml @@ -1,8 +1,8 @@ --- upgrade: - | - HAProxy Prometheus metrics are now available directly from HAProxy. Consequently, - the standalone Prometheus HAProxy exporter, which was archived in March 2023, is - no longer supported, and the Docker image has been removed from Kolla. For further - details, see `here + HAProxy Prometheus metrics are now available directly from HAProxy. + Consequently, the standalone Prometheus HAProxy exporter, which was + archived in March 2023, is no longer supported, and the Docker image + has been removed from Kolla. For further details, see `here `__. diff --git a/releasenotes/notes/remove-zaqar-image-de36960a88f132c8.yaml b/releasenotes/notes/remove-zaqar-image-de36960a88f132c8.yaml index 1d0a21076e..06662bf1c6 100644 --- a/releasenotes/notes/remove-zaqar-image-de36960a88f132c8.yaml +++ b/releasenotes/notes/remove-zaqar-image-de36960a88f132c8.yaml @@ -1,3 +1,4 @@ --- upgrade: - - The ``zaqar`` image and related plugins are removed per the deprecation cycle. + - The ``zaqar`` image and related plugins are removed + per the deprecation cycle. diff --git a/releasenotes/notes/summary-json-file-96441e67076fc480.yaml b/releasenotes/notes/summary-json-file-96441e67076fc480.yaml index 8584a36362..fbacbb4c25 100644 --- a/releasenotes/notes/summary-json-file-96441e67076fc480.yaml +++ b/releasenotes/notes/summary-json-file-96441e67076fc480.yaml @@ -1,5 +1,5 @@ --- features: - | - Added support for writing the build summary to a JSON file specified via the - ``[DEFAULT] summary_json_file`` option. + Added support for writing the build summary to a JSON file specified via + the ``[DEFAULT] summary_json_file`` option. diff --git a/releasenotes/notes/support-image-cross-compile-3b1dc348d742e96d.yaml b/releasenotes/notes/support-image-cross-compile-3b1dc348d742e96d.yaml index 50b0b9488e..789ccbb0f3 100644 --- a/releasenotes/notes/support-image-cross-compile-3b1dc348d742e96d.yaml +++ b/releasenotes/notes/support-image-cross-compile-3b1dc348d742e96d.yaml @@ -1,5 +1,5 @@ --- features: - | - Added support for cross-compilation. Enabled the creation of container images - on emulated architectures. + Added support for cross-compilation. Enabled the creation of container + images on emulated architectures. diff --git a/releasenotes/notes/upgrade-pip-44352805d60bbf7f.yaml b/releasenotes/notes/upgrade-pip-44352805d60bbf7f.yaml index 6c5e3f8e6e..b6f0bc7717 100644 --- a/releasenotes/notes/upgrade-pip-44352805d60bbf7f.yaml +++ b/releasenotes/notes/upgrade-pip-44352805d60bbf7f.yaml @@ -2,5 +2,5 @@ other: - | ``kolla-toolbox`` and all images derived from ``openstack-base`` one have - basic Python packages (``pip``, ``wheel``, ``setuptools``) upgraded to latest - versions. + basic Python packages (``pip``, ``wheel``, ``setuptools``) upgraded to + latest versions. diff --git a/releasenotes/notes/vitrage-containers-3bfb360357aa628b.yaml b/releasenotes/notes/vitrage-containers-3bfb360357aa628b.yaml index 3d2f1743e0..89bb6597e4 100644 --- a/releasenotes/notes/vitrage-containers-3bfb360357aa628b.yaml +++ b/releasenotes/notes/vitrage-containers-3bfb360357aa628b.yaml @@ -1,6 +1,6 @@ --- features: - - Add Vitrage Dockerfile, Vitrage is the OpenStack RCA (Root Cause Analysis) service for - organizing, analyzing and expanding OpenStack alarms & events, yielding insights - regarding the root cause of problems and deducing their existence before they are - directly detected. Also, it is in the big-tent. + - Add Vitrage Dockerfile, Vitrage is the OpenStack RCA (Root Cause Analysis) + service for organizing, analyzing and expanding OpenStack alarms & events, + yielding insights regarding the root cause of problems and deducing their + existence before they are directly detected. Also, it is in the big-tent. diff --git a/tox.ini b/tox.ini index 5355573584..bb8751071c 100644 --- a/tox.ini +++ b/tox.ini @@ -97,6 +97,8 @@ commands= deps = {[testenv:docs]deps} commands = rm -rf releasenotes/build + reno lint + doc8 -e '.yaml' releasenotes/notes/ sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html [flake8]