CI: Add doc8 linting of release notes

Change-Id: I1439aa923a9129b752abb4acfb88559930b2178a
This commit is contained in:
Michal Nasiadka 2020-02-27 13:54:49 +01:00 committed by Radosław Piliszek
parent 0182ea0b7e
commit 328993d8b3
29 changed files with 95 additions and 77 deletions

View File

@ -1,3 +1,4 @@
---
features:
- Add designate-producer ansible role. Orchestrates periodic tasks that are run by designate.
- Add designate-producer ansible role. Orchestrates periodic tasks that are
run by designate.

View File

@ -2,12 +2,13 @@
features:
- |
Add a new flag to explicitly enable provider networks, i.e. networks where
instances directly connect to the physical networks (flat,VLAN). In such
instances directly connect to the physical networks (flat, VLAN). In such
cases external bridges must be configured on compute nodes, like it is done
for self-service (tenant manageable) networks in DVR mode. Otherwise this flag
allows to avoid unnecessary interface and bridge setup on compute nodes
in case of tenant networks in non-DVR mode.
for self-service (tenant manageable) networks in DVR mode. Otherwise this
flag allows to avoid unnecessary interface and bridge setup on compute
nodes in case of tenant networks in non-DVR mode.
upgrade:
- |
By default this flag is disabled. If provider networks were used in previous
releases please set 'enable_neutron_provider_networks' property to 'yes'.
By default this flag is disabled. If provider networks were used in
previous releases, please set ``enable_neutron_provider_networks``
property to 'yes'.

View File

@ -1,5 +1,6 @@
---
upgrade:
- Heka is deprecated and is replaced with Fluentd
- Heka is deprecated and is replaced with Fluentd.
features:
- Add Fluentd role, Fluentd is an open source data collector for unified logging layer
- Add Fluentd role, Fluentd is an open source data collector for unified
logging layer

View File

@ -1,4 +1,4 @@
---
features:
- Freezer is a distributed backup restore and disaster recovery as a service platform
Add freezer ansible role
- Freezer is a distributed backup restore and disaster recovery as a service
platform. Add freezer ansible role.

View File

@ -1,5 +1,6 @@
---
features:
- |
The settings file ``{{ node_custom_config}}/horizon/custom_local_settings`` can be
used in Horizon to overwrite the default local_settings without a need to sync it at image build time.
The settings file ``{{ node_custom_config}}/horizon/custom_local_settings``
can be used in Horizon to overwrite the default local_settings without
a need to sync it at image build time.

View File

@ -1,5 +1,5 @@
---
features:
- Add zun ansible role,Zun is an OpenStack project for the management of containers.
zun quick start guide link is
https://github.com/openstack/zun/blob/master/doc/source/dev/quickstart.rst
- Add zun ansible role. Zun is an OpenStack project for the management of
containers. Please see `Zun quick start guide
<https://github.com/openstack/zun/blob/master/doc/source/dev/quickstart.rst>`__.

View File

@ -1,4 +1,5 @@
---
features:
- |
Add support to Kolla-Ansible for Cloudkitty InfluxDB storage system deployment.
Add support to Kolla-Ansible for Cloudkitty InfluxDB storage system
deployment.

View File

@ -1,5 +1,5 @@
---
features:
- |
Add custom option for docker daemon by configure the docker service. An operator
named "docker_custom_option" will be added.
Add custom option for docker daemon to configure the docker service. A
parameter named ``docker_custom_option`` is added.

View File

@ -1,8 +1,8 @@
---
deprecations:
- |
The following files are deprecated and should be removed during Queens cycle,
use /etc/kolla/config/global.conf instead:
The following files are deprecated and should be removed during Queens
cycle, use ``/etc/kolla/config/global.conf`` instead:
* /etc/kolla/config/database.conf
* /etc/kolla/config/messaging.conf

View File

@ -1,4 +1,5 @@
---
features:
- |
Neutron port_forwarding service plugin, and l3 extension can be enabled with variable enable_neutron_port_forwarding.
Neutron port_forwarding service plugin, and l3 extension can be enabled
with variable ``enable_neutron_port_forwarding``.

View File

@ -2,7 +2,11 @@
features:
- >
[`blueprint external-mariadb-support <https://blueprints.launchpad.net/kolla-ansible/+spec/external-mariadb-support>`_]
Added External MariaDB server/cluster support
- Added enable_external_mariadb_load_balancer flag
- Added use_preconfigured_databases flag in order to add support for previously created databases / users
- Added use_common_mariadb_user in order to allow the use of a common database user across all databases
Added External MariaDB server/cluster support,
- Added ``enable_external_mariadb_load_balancer`` flag
- >
Added ``use_preconfigured_databases`` flag to support previously created
databases / users
- >
Added ``use_common_mariadb_user`` to allow use of a common database user
across all databases

View File

@ -1,5 +1,5 @@
---
fixes:
- fixed ansible warning when using ansible>2.2
- avoid using ansible reserved action and serial word in playbooks. use kolla_action and
kolla_serial instead.
- Fixed Ansible warning when using ansible>2.2. Avoid using Ansible reserved
action and serial word in playbooks. Use ``kolla_action`` and
``kolla_serial`` instead.

View File

@ -2,6 +2,6 @@
features:
- |
Added ``horizon_keystone_domain_choices`` hash. It can be used to set the
available domains to choose from on the horizon login page. This feature was introduced in
pike release.
https://docs.openstack.org/horizon/latest/configuration/settings.html#openstack-keystone-domain-choices
available domains to choose from on the horizon login page. This feature
was introduced in Pike release.
Please see `<https://docs.openstack.org/horizon/latest/configuration/settings.html#openstack-keystone-domain-choices>`__

View File

@ -1,5 +1,5 @@
---
features:
- |
Implement ceph-nfs service, Nfs-ganesha can be used as a proxy when mounting
ceph file shares.
Implement ``ceph-nfs`` service, ``nfs-ganesha`` can be used as a proxy when
mounting ceph file shares.

View File

@ -1,3 +1,4 @@
---
features:
- Adds support for deploying Masakari, the instance high availability service.
- Adds support for deploying Masakari, the instance high availability
service.

View File

@ -1,12 +1,13 @@
---
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.
deprecations:
- |
As neutron-vpnaas-agent can be loaded by the neutron l3 agent, neutron-vpnaas
standalone mode is not supported. We have already removed the neutron-vpnaas-agent
container, currently, there is no need to keep this role.
As neutron-vpnaas-agent can be loaded by the neutron l3 agent,
neutron-vpnaas standalone mode is not supported. We have already removed
the neutron-vpnaas-agent container, currently, there is no need to keep
this role.

View File

@ -1,5 +1,6 @@
---
upgrade:
- |
The vmware_dvs_host_password, vmware_nsxv_password, and vmware_vcenter_host_password
parameters moved to the passwords.yml file.
The ``vmware_dvs_host_password``, ``vmware_nsxv_password``, and
``vmware_vcenter_host_password`` parameters moved to the ``passwords.yml``
file.

View File

@ -1,5 +1,5 @@
---
features:
- |
``opendaylight_release`` variable is removed, version is discovered automatically
while booting features.
``opendaylight_release`` variable is removed, version is discovered
automatically while booting features.

View File

@ -5,5 +5,5 @@ features:
An example blackbox-exporter module has been added (disabled by default)
called os_endpoint. This allows for the probing of endpoints over HTTP
and HTTPS. This can be used to monitor that OpenStack endpoints return a status
code of either 200 or 300, and the word 'versions' in the payload.
and HTTPS. This can be used to monitor that OpenStack endpoints return a
status code of either 200 or 300, and the word 'versions' in the payload.

View File

@ -2,7 +2,8 @@
fixes:
- |
Fixes templating of Prometheus configuration when Alertmanager is disabled.
In a deployment where Prometheus is enabled and Alertmanager is disabled the
configuration for the Prometheus will fail when templating as the variable
`prometheus_alert_rules` does not contain the key `files`. For details
please see <https://bugs.launchpad.net/kolla-ansible/+bug/1854540>`__.
In a deployment where Prometheus is enabled and Alertmanager is disabled
the configuration for the Prometheus will fail when templating as the
variable ``prometheus_alert_rules`` does not contain the key ``files``.
For details please see
<https://bugs.launchpad.net/kolla-ansible/+bug/1854540>`__.

View File

@ -1,5 +1,5 @@
---
upgrade:
- |
Support for deployment of OpenDaylight controller and configuration of Neutron related to
integration with OpenDaylight have been removed.
Support for deployment of OpenDaylight controller and configuration of
Neutron related to integration with OpenDaylight have been removed.

View File

@ -1,6 +1,7 @@
---
upgrade:
- |
The following files /etc/kolla/config/database.conf and /etc/kolla/config/messaging.conf
used to generate Openstack services config files are redundant with /etc/kolla/config/global.conf.
The following files ``/etc/kolla/config/database.conf`` and
``/etc/kolla/config/messaging.conf`` used to generate Openstack services
files are redundant with ``/etc/kolla/config/global.conf``.
They have been removed in order to simplify codebase.

View File

@ -6,9 +6,9 @@ upgrade:
Please move your custom service config from ml2_conf.ini into those files.
deprecations:
- |
Customizing Neutron Linux bridge and Open vSwitch Agents config via ml2_conf.ini
is deprecated. The config has been split out for these agents into
linuxbridge_agent.ini and openvswitch_agent.ini respectively.
In this release (Ussuri) custom service config ml2_conf.ini overrides will still
be used when merging configs - but that functionality will be removed
in V release.
Customizing Neutron Linux bridge and Open vSwitch Agents config via
``ml2_conf.ini`` is deprecated. The config has been split out for these
agents into ``linuxbridge_agent.ini`` and ``openvswitch_agent.ini``
respectively. In this release (Ussuri) custom service config
``ml2_conf.ini`` overrides will still be used when merging configs - but
but that functionality will be removed in V release.

View File

@ -1,10 +1,11 @@
---
features:
- |
Adds a standardised method to configure notifications for different services.
Adds a standardised method to configure notifications for different
services.
deprecations:
- |
The ``enable_cadf_notifications`` variable is deprecated. CADF is the default
notification format in keystone. To enable keystone notifications, users should
now set ``keystone_default_notifications_topic_enabled`` to ``yes`` or enable
Ceilometer via ``enable_ceilometer``.
The ``enable_cadf_notifications`` variable is deprecated. CADF is the
default notification format in keystone. To enable keystone notifications,
users should now set ``keystone_default_notifications_topic_enabled`` to
``yes`` or enable Ceilometer via ``enable_ceilometer``.

View File

@ -1,5 +1,5 @@
---
features:
- |
Add support for ceph-dashboard. It enables 'dashboard' module in ceph cluster.
Its uses command 'ceph mgr module enable dashboard'.
Add support for ceph-dashboard. It enables 'dashboard' module in ceph
cluster.

View File

@ -1,6 +1,6 @@
---
features:
- |
Adds a new variable to be used by the swift role, ``swift_extra_ring_files``.
It allows to pass additional ring files to be deployed in the context of
a multi-policy setup.
Adds a new variable to be used by the swift role,
``swift_extra_ring_files``. It allows to pass additional ring files to be
deployed in the context of a multi-policy setup.

View File

@ -16,8 +16,8 @@ features:
``swift_replication_interface``, which defaults to
``swift_storage_interface``.
If a separate replication network is used, Kolla Ansible now deploys separate
replication servers for the accounts, containers and objects, that listen on
this network. In this case, these services handle only replication traffic, and
the original account-, container- and object- servers only handle storage
user requests.
If a separate replication network is used, Kolla Ansible now deploys
separate replication servers for the accounts, containers and objects,
that listen on this network. In this case, these services handle only
replication traffic, and the original account-, container- and object-
servers only handle storage user requests.

View File

@ -1,4 +1,5 @@
---
features:
- |
Adds support for the Swift S3 API, enabled via the ``enable_swift_s3api`` flag.
Adds support for the Swift S3 API, enabled via the ``enable_swift_s3api``
flag.

View File

@ -46,6 +46,7 @@ commands =
{toxinidir}/tools/run-bashate.sh
flake8 {posargs}
doc8 doc/source
doc8 -e '.yaml' releasenotes/notes/
python {toxinidir}/tools/validate-all-file.py
bandit --skip B303 -r ansible kolla_ansible tests tools
yamllint -s .