From 99f109698668aa0b2929c8e4f14f1c88d354f734 Mon Sep 17 00:00:00 2001
From: Mark Goddard <mark@stackhpc.com>
Date: Wed, 16 Oct 2019 17:39:09 +0100
Subject: [PATCH] Tidy up release notes for Train
Change-Id: If72fd2c060c8ecd014a61338a3506d93578804b2
---
...apache-wsgi-parameters-282d4e07126663a6.yaml | 5 +++--
...work-tls-configuration-cf9704812f113281.yaml | 6 +++---
...on-custom-dnsmasq-conf-bba1ac18df0dccd4.yaml | 5 +++--
.../add-qinling-role-99d96102837b21f4.yaml | 6 +++---
.../notes/ansible-min-2.5-7fa76f625bf9f359.yaml | 4 ----
.../docker-daemon.json-33d7618aa5a355a8.yaml | 17 ++++++++---------
.../enable-influxdb-tsi-858cc95e99605107.yaml | 4 ++--
.../notes/freezer-backend-531eececd69c0cd4.yaml | 2 +-
.../notes/masakari-ddd930cf5db5f713.yaml | 3 +--
...e-coordination-backend-741ec71946e7567e.yaml | 6 +++---
...heus-blackbox-exporter-ee096376656c3751.yaml | 2 +-
...der-hnas_iscsi-backend-03e6242227b9184c.yaml | 2 +-
...ngine-environment-file-5f1320011b00099d.yaml | 2 +-
.../remove-legacy-docker-3c7d6b9568474e3a.yaml | 6 +++---
...slo-messaging-sections-4769da25bc58aa02.yaml | 8 +-------
.../support_extra_volumes-0598122ed90c8d02.yaml | 4 ++--
.../swift-multi-policies-28bc322b54a82bf9.yaml | 2 +-
.../notes/swift-recon-91592dd93526f1a8.yaml | 2 +-
.../notes/trusted-cacert-3c7061e974b5187d.yaml | 2 +-
19 files changed, 39 insertions(+), 49 deletions(-)
delete mode 100644 releasenotes/notes/ansible-min-2.5-7fa76f625bf9f359.yaml
diff --git a/releasenotes/notes/add-horizon-apache-wsgi-parameters-282d4e07126663a6.yaml b/releasenotes/notes/add-horizon-apache-wsgi-parameters-282d4e07126663a6.yaml
index b4cf841f2..101051160 100644
--- a/releasenotes/notes/add-horizon-apache-wsgi-parameters-282d4e07126663a6.yaml
+++ b/releasenotes/notes/add-horizon-apache-wsgi-parameters-282d4e07126663a6.yaml
@@ -1,5 +1,6 @@
---
features:
- |
- Added parameters ``horizon_wsgi_processes`` and ``horizon_wsgi_threads`` to configure
- the number of processes and threads of WSGI in the Horizon container.
+ Adds variables ``horizon_wsgi_processes`` and ``horizon_wsgi_threads`` to
+ configure the number of processes and threads for WSGI in the Horizon
+ container.
diff --git a/releasenotes/notes/add-internal-network-tls-configuration-cf9704812f113281.yaml b/releasenotes/notes/add-internal-network-tls-configuration-cf9704812f113281.yaml
index be9bdb7fc..c7e71b33a 100644
--- a/releasenotes/notes/add-internal-network-tls-configuration-cf9704812f113281.yaml
+++ b/releasenotes/notes/add-internal-network-tls-configuration-cf9704812f113281.yaml
@@ -1,7 +1,7 @@
---
features:
- |
- Added configuration parameters ``kolla_enable_tls_internal``,
+ Adds configuration variables ``kolla_enable_tls_internal``,
``kolla_internal_fqdn_cert``, and ``kolla_internal_fqdn_cacert`` to
- optionally enable TLS encryption for openstack endpoints on the internal
- network.
+ optionally enable TLS encryption for OpenStack endpoints on the internal
+ API network.
diff --git a/releasenotes/notes/add-neutron-custom-dnsmasq-conf-bba1ac18df0dccd4.yaml b/releasenotes/notes/add-neutron-custom-dnsmasq-conf-bba1ac18df0dccd4.yaml
index fdcce3020..05b32d7c9 100644
--- a/releasenotes/notes/add-neutron-custom-dnsmasq-conf-bba1ac18df0dccd4.yaml
+++ b/releasenotes/notes/add-neutron-custom-dnsmasq-conf-bba1ac18df0dccd4.yaml
@@ -1,6 +1,7 @@
---
features:
- |
- The ``dnsmasq.conf`` configuration file used by the Neutron DHCP agent can be
- overwritten by ``{{ node_custom_config}}/neutron/dnsmasq.conf`` or
+ Adds support for overriding the ``dnsmasq.conf`` configuration file used by
+ the Neutron DHCP agent via
+ ``{{ node_custom_config}}/neutron/dnsmasq.conf`` or
``{{ node_custom_config }}/neutron/{{ inventory_hostname }}/dnsmasq.conf``.
diff --git a/releasenotes/notes/add-qinling-role-99d96102837b21f4.yaml b/releasenotes/notes/add-qinling-role-99d96102837b21f4.yaml
index b2fcdb981..579220e4f 100644
--- a/releasenotes/notes/add-qinling-role-99d96102837b21f4.yaml
+++ b/releasenotes/notes/add-qinling-role-99d96102837b21f4.yaml
@@ -1,5 +1,5 @@
---
features:
- - Adds Qinling Ansible role. Qinling is an OpenStack project
- to provide "Function as a Service". This project aims to
- provide a platform to support serverless functions.
+ - Adds support for deploying Qinling. Qinling is an OpenStack project to
+ provide "Function as a Service". This project aims to provide a platform to
+ support serverless functions.
diff --git a/releasenotes/notes/ansible-min-2.5-7fa76f625bf9f359.yaml b/releasenotes/notes/ansible-min-2.5-7fa76f625bf9f359.yaml
deleted file mode 100644
index 24bd47b24..000000000
--- a/releasenotes/notes/ansible-min-2.5-7fa76f625bf9f359.yaml
+++ /dev/null
@@ -1,4 +0,0 @@
----
-upgrade:
- - |
- Updates the minimum required version of Ansible to 2.5.
diff --git a/releasenotes/notes/docker-daemon.json-33d7618aa5a355a8.yaml b/releasenotes/notes/docker-daemon.json-33d7618aa5a355a8.yaml
index cd0c4aa3c..2cc31a805 100644
--- a/releasenotes/notes/docker-daemon.json-33d7618aa5a355a8.yaml
+++ b/releasenotes/notes/docker-daemon.json-33d7618aa5a355a8.yaml
@@ -1,18 +1,17 @@
---
features:
- |
- Add custom option for docker daemon by altering "docker_custom_config"
- variable (json formatted).
+ Adds support for providing custom configuration options for the Docker
+ daemon via the ``docker_custom_config`` variable (JSON formatted).
upgrade:
- |
- Docker engine configuration changes are now done in
- "/etc/docker/daemon.json" file instead of altering systemd unit (which
- gets removed if present). Also "docker_custom_option" got replaced by
- "docker_custom_config" variable (json formatted).
+ Docker engine configuration changes are now applied in
+ ``/etc/docker/daemon.json`` file instead of altering the systemd unit
+ (which gets removed if present).
deprecations:
- |
- Configuring Docker daemon by "docker_custom_option" (used in systemd unit
- file) is deprecated in favour of "docker_custom_config" variable (stored in
- "daemon.json" config file.
+ Configuring Docker daemon via ``docker_custom_option`` (used in systemd
+ unit file) is deprecated in favour of ``docker_custom_config`` variable
+ which adds options to ``/etc/docker/daemon.json``.
diff --git a/releasenotes/notes/enable-influxdb-tsi-858cc95e99605107.yaml b/releasenotes/notes/enable-influxdb-tsi-858cc95e99605107.yaml
index 5ae348c55..6a17a687a 100644
--- a/releasenotes/notes/enable-influxdb-tsi-858cc95e99605107.yaml
+++ b/releasenotes/notes/enable-influxdb-tsi-858cc95e99605107.yaml
@@ -1,8 +1,8 @@
---
upgrade:
- - InfluxDB TSI has been enabled by default. It is recommended for all
+ - InfluxDB TSI is now enabled by default. It is recommended for all
customers by InfluxData. If you do not want to enable it you can set
- the variable 'influxdb_enable_tsi' to 'False' in 'globals.yml'.
+ the variable ``influxdb_enable_tsi`` to ``False`` in ``globals.yml``.
Instructions to migrate existing data to the new, disk based format
can be found at
https://docs.influxdata.com/influxdb/v1.7/administration/upgrading/
diff --git a/releasenotes/notes/freezer-backend-531eececd69c0cd4.yaml b/releasenotes/notes/freezer-backend-531eececd69c0cd4.yaml
index 71aa964f4..c47de8e3e 100644
--- a/releasenotes/notes/freezer-backend-531eececd69c0cd4.yaml
+++ b/releasenotes/notes/freezer-backend-531eececd69c0cd4.yaml
@@ -1,7 +1,7 @@
---
upgrade:
- |
- Freezer now use MariaDB as default backend for database.
+ Freezer now uses MariaDB as the default database backend.
Elasticsearch remains as an optional backend due to the requirement of
Freezer to use Elasticsearch version 2.3.0. Elasticsearch in kolla-ansible
diff --git a/releasenotes/notes/masakari-ddd930cf5db5f713.yaml b/releasenotes/notes/masakari-ddd930cf5db5f713.yaml
index 3277ac14d..efa2d8b5b 100644
--- a/releasenotes/notes/masakari-ddd930cf5db5f713.yaml
+++ b/releasenotes/notes/masakari-ddd930cf5db5f713.yaml
@@ -1,4 +1,3 @@
---
features:
- - Ansible role and shared configuration to deploy
- Masakari with Kolla-ansible.
+ - Adds support for deploying Masakari, the instance high availability service.
diff --git a/releasenotes/notes/new-variable-designate-coordination-backend-741ec71946e7567e.yaml b/releasenotes/notes/new-variable-designate-coordination-backend-741ec71946e7567e.yaml
index b0239ff97..dbd90a21e 100644
--- a/releasenotes/notes/new-variable-designate-coordination-backend-741ec71946e7567e.yaml
+++ b/releasenotes/notes/new-variable-designate-coordination-backend-741ec71946e7567e.yaml
@@ -1,7 +1,7 @@
---
features:
- |
- Designate coordination backend can now be configured via the
- designate_coordination_backend variable. Coordination is mandatory
+ Adds support for configuring a coordination backend for Designate via the
+ ``designate_coordination_backend`` variable. Coordination is mandatory
when multiple workers are deployed as in a multinode environment.
- Possible values are redis or etcd.
+ Possible values are ``redis`` or ``etcd``.
diff --git a/releasenotes/notes/prometheus-blackbox-exporter-ee096376656c3751.yaml b/releasenotes/notes/prometheus-blackbox-exporter-ee096376656c3751.yaml
index 7a8bed2b4..be0f9815f 100644
--- a/releasenotes/notes/prometheus-blackbox-exporter-ee096376656c3751.yaml
+++ b/releasenotes/notes/prometheus-blackbox-exporter-ee096376656c3751.yaml
@@ -1,7 +1,7 @@
---
features:
- |
- Prometheus blackbox exporter
+ Adds support for deploying Prometheus blackbox exporter
An example blackbox-exporter module has been added (disabled by default)
called os_endpoint. This allows for the probing of endpoints over HTTP
diff --git a/releasenotes/notes/remove-cinder-hnas_iscsi-backend-03e6242227b9184c.yaml b/releasenotes/notes/remove-cinder-hnas_iscsi-backend-03e6242227b9184c.yaml
index eb86beb88..05869c645 100644
--- a/releasenotes/notes/remove-cinder-hnas_iscsi-backend-03e6242227b9184c.yaml
+++ b/releasenotes/notes/remove-cinder-hnas_iscsi-backend-03e6242227b9184c.yaml
@@ -1,7 +1,7 @@
---
deprecations:
- |
- Remove the ``hnas_iscsi`` cinder backend. The Hitachi NAS Platform
+ Removes the ``hnas_iscsi`` cinder backend. The Hitachi NAS Platform
iSCSI driver was `marked as not supported by Cinder
<https://docs.openstack.org/releasenotes/cinder/ocata.html#deprecation-notes>`_
in the Ocata release.
diff --git a/releasenotes/notes/remove-heat-engine-environment-file-5f1320011b00099d.yaml b/releasenotes/notes/remove-heat-engine-environment-file-5f1320011b00099d.yaml
index f358487d2..0edb5fd73 100644
--- a/releasenotes/notes/remove-heat-engine-environment-file-5f1320011b00099d.yaml
+++ b/releasenotes/notes/remove-heat-engine-environment-file-5f1320011b00099d.yaml
@@ -3,5 +3,5 @@ upgrade:
- |
The Heat role has stopped disabling deprecated plugins. To apply this
change to existing deployments, the file
- ```/etc/kolla/heat-engine/_deprecated.yaml`` is automatically removed
+ ``/etc/kolla/heat-engine/_deprecated.yaml`` is automatically removed
during the upgrade.
diff --git a/releasenotes/notes/remove-legacy-docker-3c7d6b9568474e3a.yaml b/releasenotes/notes/remove-legacy-docker-3c7d6b9568474e3a.yaml
index 84927c086..c3f7687df 100644
--- a/releasenotes/notes/remove-legacy-docker-3c7d6b9568474e3a.yaml
+++ b/releasenotes/notes/remove-legacy-docker-3c7d6b9568474e3a.yaml
@@ -1,6 +1,6 @@
---
upgrade:
- |
- Removes support for using the legacy Docker packages, and the variable
- ``docker_legacy_packages``. Docker is now always installed using the
- Community Edition (CE) packages.
+ Removes support for installing Docker using the legacy Docker packages, and
+ the variable ``docker_legacy_packages``. Docker is now always installed
+ using the Community Edition (CE) packages.
diff --git a/releasenotes/notes/standard-oslo-messaging-sections-4769da25bc58aa02.yaml b/releasenotes/notes/standard-oslo-messaging-sections-4769da25bc58aa02.yaml
index 45dc048a5..0e21a5cc6 100644
--- a/releasenotes/notes/standard-oslo-messaging-sections-4769da25bc58aa02.yaml
+++ b/releasenotes/notes/standard-oslo-messaging-sections-4769da25bc58aa02.yaml
@@ -1,13 +1,7 @@
---
features:
- |
- Standard method to execute the configuration of "oslo_messaging" sections
-upgrade:
- - |
- 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``.
+ Adds a standardised method to configure notifications for different services.
deprecations:
- |
The ``enable_cadf_notifications`` variable is deprecated. CADF is the default
diff --git a/releasenotes/notes/support_extra_volumes-0598122ed90c8d02.yaml b/releasenotes/notes/support_extra_volumes-0598122ed90c8d02.yaml
index 50c1504a9..79aa7969a 100644
--- a/releasenotes/notes/support_extra_volumes-0598122ed90c8d02.yaml
+++ b/releasenotes/notes/support_extra_volumes-0598122ed90c8d02.yaml
@@ -1,5 +1,5 @@
---
features:
- |
- Adds support for configuring the extra volumes.
- Split container volumes into `<service_name>_default_volumes` and `<service_name>_extra_volumes`.
+ Adds support for configuring additional Docker volumes for Kolla
+ containers. These are configured via ``<service_name>_extra_volumes``.
diff --git a/releasenotes/notes/swift-multi-policies-28bc322b54a82bf9.yaml b/releasenotes/notes/swift-multi-policies-28bc322b54a82bf9.yaml
index 5e3312283..3cacf42e7 100644
--- a/releasenotes/notes/swift-multi-policies-28bc322b54a82bf9.yaml
+++ b/releasenotes/notes/swift-multi-policies-28bc322b54a82bf9.yaml
@@ -1,6 +1,6 @@
---
features:
- |
- Add a new variable to be used by the swift role, ``swift_extra_ring_files``.
+ 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.
diff --git a/releasenotes/notes/swift-recon-91592dd93526f1a8.yaml b/releasenotes/notes/swift-recon-91592dd93526f1a8.yaml
index 2e703989f..f6a112e35 100644
--- a/releasenotes/notes/swift-recon-91592dd93526f1a8.yaml
+++ b/releasenotes/notes/swift-recon-91592dd93526f1a8.yaml
@@ -1,7 +1,7 @@
---
features:
- |
- Enable Swift Recon
+ Adds support for Swift Recon.
Adds the necessary configuration to the Swift account, container
and object configuration files to enable the Swift recon cli.
diff --git a/releasenotes/notes/trusted-cacert-3c7061e974b5187d.yaml b/releasenotes/notes/trusted-cacert-3c7061e974b5187d.yaml
index d873f204d..92dcd6834 100644
--- a/releasenotes/notes/trusted-cacert-3c7061e974b5187d.yaml
+++ b/releasenotes/notes/trusted-cacert-3c7061e974b5187d.yaml
@@ -1,6 +1,6 @@
---
features:
- |
- Add support for configuration of trusted CA certificate file.
+ Adds support for configuration of a trusted CA certificate file.
CA bundle file must be added to both the Horizon and Kolla Toolbox
containers for this to work correctly.
--
GitLab