From 84f10f2b33dbe54fedf4fa68dad76aebaa3895d3 Mon Sep 17 00:00:00 2001 From: Mark Goddard Date: Tue, 19 May 2020 11:55:23 +0100 Subject: [PATCH] Tidy up release notes for Ussuri Change-Id: If3129b569248eb548fcb987f30d318f59144faa7 --- ...-prometheus-customization-0b173ff7c63ca30f.yaml | 5 +++-- ...ceilometer-upgrade-params-c07eec4c1ef5a3d3.yaml | 5 ++--- ...sible-max-version-support-d74258eec27d3549.yaml | 2 +- ...6789-fix-fernet-bootstrap-36f87e36e4dc6ec9.yaml | 2 +- ...8773-manila-cephfs-driver-f6a75bd15c002363.yaml | 4 ++-- .../notes/ceph-keys-vars-6857d19d291c401d.yaml | 14 +++++++------- ...ure-certificate-authority-aa21fa88234b021e.yaml | 6 +++--- ...authority-into-containers-860cbda3384dd731.yaml | 14 +++++++------- .../docker-image-pruning-fffcffa7e99c6e63.yaml | 2 +- releasenotes/notes/drop-py27-509835da35f047b4.yaml | 4 ++-- .../encrypt-backend-haproxy-fb96285d74fb464c.yaml | 2 +- ...methods-inside-containers-ce2a1410dbdc71f3.yaml | 10 +++++----- ...rnal-ceph-cinder-template-40dc0bc07e717837.yaml | 10 +++++----- .../external-ceph-users-2715eebf8a8df1af.yaml | 12 ++++++------ .../feature-mergepwd-clean-18cbed4d39967e70.yaml | 4 ++-- ...-elasticsearch-kolla-logs-a0ba85d91d1a2c31.yaml | 13 ++++++++++--- .../fix-octavia-cert-config-28f0ef2799406957.yaml | 2 +- ...xternal-self-signed-certs-c631a9d934d31fac.yaml | 7 ++++--- ...horizon_keystone_dropdown-6b9b4e5e9a64f979.yaml | 8 ++++---- .../notes/implement-ovn-80b3a73e6c8a44e7.yaml | 4 ++-- ..._dynamic_pollster_configs-14bd3b6775e6a07a.yaml | 4 ++-- ...ep_extra_provider_options-27c2804e4505aed1.yaml | 5 +++-- .../notes/remove-kolla-ceph-adbb5d66bd0192f3.yaml | 2 +- ...plit_ovs_lb_agents_config-96f1f90e7d678209.yaml | 7 ++++--- 24 files changed, 79 insertions(+), 69 deletions(-) diff --git a/releasenotes/notes/add-mechanism-for-prometheus-customization-0b173ff7c63ca30f.yaml b/releasenotes/notes/add-mechanism-for-prometheus-customization-0b173ff7c63ca30f.yaml index a7ded83164..0cf37655c1 100644 --- a/releasenotes/notes/add-mechanism-for-prometheus-customization-0b173ff7c63ca30f.yaml +++ b/releasenotes/notes/add-mechanism-for-prometheus-customization-0b173ff7c63ca30f.yaml @@ -1,6 +1,7 @@ --- features: - | - Added a mechanism to customize ``prometheus.yml``. Please read the the - `documentation `__. + Adds a mechanism to customize ``prometheus.yml``. Please read the the + `documentation + `__. for more details. diff --git a/releasenotes/notes/allow-custom-ceilometer-upgrade-params-c07eec4c1ef5a3d3.yaml b/releasenotes/notes/allow-custom-ceilometer-upgrade-params-c07eec4c1ef5a3d3.yaml index 2e80730801..38a2b4a394 100644 --- a/releasenotes/notes/allow-custom-ceilometer-upgrade-params-c07eec4c1ef5a3d3.yaml +++ b/releasenotes/notes/allow-custom-ceilometer-upgrade-params-c07eec4c1ef5a3d3.yaml @@ -4,9 +4,8 @@ features: Allow operators to use custom parameters with the ceilometer-upgrade command. This is quite useful when using the dynamic pollster subsystem; that sub-system provides flexibility to create and edit pollsters configs, - which affects gnocchi resource-type configurations. However, Ceilometer + which affects Gnocchi resource-type configurations. However, Ceilometer uses default and hard-coded resource-type configurations; if one customizes some of its default resource-types, he/she can get into trouble during upgrades. Therefore, the only way to work around it is to use the - "--skip-gnocchi-resource-types" flag. This release introduces a method for - operators to execute such customization, and many others if needed. + ``--skip-gnocchi-resource-types`` flag. diff --git a/releasenotes/notes/ansible-max-version-support-d74258eec27d3549.yaml b/releasenotes/notes/ansible-max-version-support-d74258eec27d3549.yaml index 152f483f5a..64b847b447 100644 --- a/releasenotes/notes/ansible-max-version-support-d74258eec27d3549.yaml +++ b/releasenotes/notes/ansible-max-version-support-d74258eec27d3549.yaml @@ -1,7 +1,7 @@ --- upgrade: - | - Adds maximum supported version check for Ansible. Kolla Ansible now + Adds a maximum supported version check for Ansible. Kolla Ansible now requires at least Ansible ``2.8`` and supports up to ``2.9``. See `blueprint `__ diff --git a/releasenotes/notes/bug-1846789-fix-fernet-bootstrap-36f87e36e4dc6ec9.yaml b/releasenotes/notes/bug-1846789-fix-fernet-bootstrap-36f87e36e4dc6ec9.yaml index c60bd36344..15df15e36e 100644 --- a/releasenotes/notes/bug-1846789-fix-fernet-bootstrap-36f87e36e4dc6ec9.yaml +++ b/releasenotes/notes/bug-1846789-fix-fernet-bootstrap-36f87e36e4dc6ec9.yaml @@ -1,6 +1,6 @@ --- fixes: - | - Rework keystone fernet bootstrap which had tendencies to fail on multinode + Reworks Keystone fernet bootstrap which had tendencies to fail on multinode setups. See `bug 1846789 `__ for details. diff --git a/releasenotes/notes/bug-1858773-manila-cephfs-driver-f6a75bd15c002363.yaml b/releasenotes/notes/bug-1858773-manila-cephfs-driver-f6a75bd15c002363.yaml index c6fa4e17ee..cc15a7cd7c 100644 --- a/releasenotes/notes/bug-1858773-manila-cephfs-driver-f6a75bd15c002363.yaml +++ b/releasenotes/notes/bug-1858773-manila-cephfs-driver-f6a75bd15c002363.yaml @@ -1,6 +1,6 @@ --- fixes: - | - Change Manila cephfs share driver to - ``manila.share.drivers.cephfs.driver.CephFSDriver``, old driver was + Changes Manila cephfs share driver to + ``manila.share.drivers.cephfs.driver.CephFSDriver``, as the old driver was deprecated. diff --git a/releasenotes/notes/ceph-keys-vars-6857d19d291c401d.yaml b/releasenotes/notes/ceph-keys-vars-6857d19d291c401d.yaml index eb715d3ba5..de73e9eec2 100644 --- a/releasenotes/notes/ceph-keys-vars-6857d19d291c401d.yaml +++ b/releasenotes/notes/ceph-keys-vars-6857d19d291c401d.yaml @@ -1,13 +1,13 @@ --- features: - | - Introduce user modifiable variables instead of fixed names for Ceph + Introduces user modifiable variables instead of fixed names for Ceph keyring files used by external Ceph functionality. upgrade: - | - For cinder (cinder-volume and cinder-backup), glance-api and manila - keyrings behavior has changed and kolla-ansible deployment will not copy - those keys using wildcards (ceph.*), instead will use newly introduced - variables. Your environment may render unusable after an upgrade if your - keys in /etc/kolla/config do not match default values for introduced - variables. + For cinder (``cinder-volume`` and ``cinder-backup``), ``glance-api`` and + ``manila`` keyrings behavior has changed and Kolla Ansible deployment will + not copy those keys using wildcards (``ceph.*``), instead will use newly + introduced variables. Your environment may render unusable after an upgrade + if your keys in ``/etc/kolla/config`` do not match default values for + introduced variables. diff --git a/releasenotes/notes/configure-certificate-authority-aa21fa88234b021e.yaml b/releasenotes/notes/configure-certificate-authority-aa21fa88234b021e.yaml index 583d34fbc5..4987d6f69a 100644 --- a/releasenotes/notes/configure-certificate-authority-aa21fa88234b021e.yaml +++ b/releasenotes/notes/configure-certificate-authority-aa21fa88234b021e.yaml @@ -1,5 +1,5 @@ --- features: - - Configure all openstack services to use the globally defined Certificate - Authority to verify HTTPs connections. The global CA is configured by the - 'openstack_cacert' parameter. + - Configures all openstack services to use the globally defined Certificate + Authority file to verify HTTPS connections. The global CA file is + configured by the ``openstack_cacert`` parameter. diff --git a/releasenotes/notes/copy-certificate-authority-into-containers-860cbda3384dd731.yaml b/releasenotes/notes/copy-certificate-authority-into-containers-860cbda3384dd731.yaml index f5019df18f..38311e74fa 100644 --- a/releasenotes/notes/copy-certificate-authority-into-containers-860cbda3384dd731.yaml +++ b/releasenotes/notes/copy-certificate-authority-into-containers-860cbda3384dd731.yaml @@ -1,13 +1,13 @@ --- features: - | - When 'kolla_copy_ca_into_containers' is configured to 'yes', the - certificate authority files in /etc/kolla/certificates/ca will be copied - into service containers to enable trust for those CA certificates. This - is required for any certificates that are either self-signed or signed by - a private CA, and are not already present in the service image trust store. - Otherwise, either CA validation will need to be explicitly disabled or the - path to the CA certificate must be configured in the service using + When ``kolla_copy_ca_into_containers`` is configured to ``yes``, the + certificate authority files in ``/etc/kolla/certificates/ca`` will be + copied into service containers to enable trust for those CA certificates. + This is required for any certificates that are either self-signed or signed + by a private CA, and are not already present in the service image trust + store. Otherwise, either CA validation will need to be explicitly disabled + or the path to the CA certificate must be configured in the service using the ``openstack_cacert`` parameter. issues: diff --git a/releasenotes/notes/docker-image-pruning-fffcffa7e99c6e63.yaml b/releasenotes/notes/docker-image-pruning-fffcffa7e99c6e63.yaml index b2a576a1ae..747c05442e 100644 --- a/releasenotes/notes/docker-image-pruning-fffcffa7e99c6e63.yaml +++ b/releasenotes/notes/docker-image-pruning-fffcffa7e99c6e63.yaml @@ -1,7 +1,7 @@ --- features: - | - Adds command ``prune-images`` for Docker image pruning on hosts. See + Adds a ``prune-images`` command for Docker image pruning on hosts. See `blueprint `__ for details. diff --git a/releasenotes/notes/drop-py27-509835da35f047b4.yaml b/releasenotes/notes/drop-py27-509835da35f047b4.yaml index 4d43ef38f8..fdec1b334c 100644 --- a/releasenotes/notes/drop-py27-509835da35f047b4.yaml +++ b/releasenotes/notes/drop-py27-509835da35f047b4.yaml @@ -1,6 +1,6 @@ --- upgrade: - | - Python 2.7 support has been dropped. Last release of kolla-ansible to + Python 2.7 support has been dropped. The last release of Kolla Ansible to support Python 2.7 is OpenStack Train. The minimum version of Python now - supported by kolla-ansible is Python 3.6. + supported by Kolla Ansible is Python 3.6. diff --git a/releasenotes/notes/encrypt-backend-haproxy-fb96285d74fb464c.yaml b/releasenotes/notes/encrypt-backend-haproxy-fb96285d74fb464c.yaml index 72bb288017..8307b120e0 100644 --- a/releasenotes/notes/encrypt-backend-haproxy-fb96285d74fb464c.yaml +++ b/releasenotes/notes/encrypt-backend-haproxy-fb96285d74fb464c.yaml @@ -1,7 +1,7 @@ --- features: - | - Added configuration options to enable backend TLS encryption from HAProxy + Adds configuration options to enable backend TLS encryption from HAProxy to the Keystone, Glance, Heat, Placement, Horizon, Barbican, and Cinder services. When used in conjunction with enabling TLS for service API endpoints, network communcation will be encrypted end to end, from client diff --git a/releasenotes/notes/execute-rest-methods-inside-containers-ce2a1410dbdc71f3.yaml b/releasenotes/notes/execute-rest-methods-inside-containers-ce2a1410dbdc71f3.yaml index d9b26d35f6..2f0b730a20 100644 --- a/releasenotes/notes/execute-rest-methods-inside-containers-ce2a1410dbdc71f3.yaml +++ b/releasenotes/notes/execute-rest-methods-inside-containers-ce2a1410dbdc71f3.yaml @@ -1,8 +1,8 @@ --- features: - | - Delegate executing ansible uri REST methods to service containers using - kolla_toolbox. This will enable any certificates that are already copied - and extracted into the service container to be automatically validated. - This is particularly useful in the case that the certificate is either - self-signed or signed by a local (private) CA. + Delegates execution of the Ansible ``uri`` module to service containers + using ``kolla_toolbox``. This will enable any certificates that are already + copied and extracted into the service container to be automatically + validated. This is particularly useful in the case that the certificate is + either self-signed or signed by a local (private) CA. diff --git a/releasenotes/notes/external-ceph-cinder-template-40dc0bc07e717837.yaml b/releasenotes/notes/external-ceph-cinder-template-40dc0bc07e717837.yaml index 4d486cd5f7..5325988d6e 100644 --- a/releasenotes/notes/external-ceph-cinder-template-40dc0bc07e717837.yaml +++ b/releasenotes/notes/external-ceph-cinder-template-40dc0bc07e717837.yaml @@ -1,8 +1,8 @@ --- upgrade: - | - Default behavior for generating cinder.conf template has changed, - now cinder.conf with rbd-1 section will be generated when external Ceph - functionality is used i.e. cinder_backend_ceph is set to true. - Previously it was only included when Kolla-Ansible internal - Ceph deployment mechanism was used. + The default behavior for generating the ``cinder.conf`` template has + changed. An ``rbd-1`` section will be generated when external Ceph + functionality is used, i.e. ``cinder_backend_ceph`` is set to ``true``. + Previously it was only included when Kolla Ansible internal Ceph + deployment mechanism was used. diff --git a/releasenotes/notes/external-ceph-users-2715eebf8a8df1af.yaml b/releasenotes/notes/external-ceph-users-2715eebf8a8df1af.yaml index 23d102e486..b507de0b4f 100644 --- a/releasenotes/notes/external-ceph-users-2715eebf8a8df1af.yaml +++ b/releasenotes/notes/external-ceph-users-2715eebf8a8df1af.yaml @@ -1,12 +1,12 @@ --- features: - | - Introduce External Ceph user ids as variables to allow non-standard ceph - authentication ids in OpenStack services configuration without the need to + Introduce External Ceph user IDs as variables to allow non-standard Ceph + authentication IDs in OpenStack service configuration without the need to override configuration files. upgrade: - | - Now the rbd part of ``nova.conf`` in ``nova-compute`` is being generated - when ``nova_backend`` is set to ``"rbd"`` (previously it was generated when - both ``enable_ceph`` was ``"yes"`` and ``nova_backend`` was set to - ``"rbd"``). + The ``rbd`` section of ``nova.conf`` for ``nova-compute`` is now generated + when ``nova_backend`` is set to ``"rbd"``. Previously it was only generated + when both ``enable_ceph`` was ``"yes"`` and ``nova_backend`` was set to + ``"rbd"``. diff --git a/releasenotes/notes/feature-mergepwd-clean-18cbed4d39967e70.yaml b/releasenotes/notes/feature-mergepwd-clean-18cbed4d39967e70.yaml index dd60d9bdf5..b0dcc3d8ab 100644 --- a/releasenotes/notes/feature-mergepwd-clean-18cbed4d39967e70.yaml +++ b/releasenotes/notes/feature-mergepwd-clean-18cbed4d39967e70.yaml @@ -1,5 +1,5 @@ --- features: - | - Adds ``--clean`` argument to ``kolla-mergepwd``. It allows to clean old - (not used anymore) keys from the passwords file. + Adds a ``--clean`` argument to ``kolla-mergepwd``. It allows to clean old + (no longer used) keys from the passwords file. diff --git a/releasenotes/notes/fix-issue-with-elasticsearch-kolla-logs-a0ba85d91d1a2c31.yaml b/releasenotes/notes/fix-issue-with-elasticsearch-kolla-logs-a0ba85d91d1a2c31.yaml index e50f56d0b8..55c4ab8ba3 100644 --- a/releasenotes/notes/fix-issue-with-elasticsearch-kolla-logs-a0ba85d91d1a2c31.yaml +++ b/releasenotes/notes/fix-issue-with-elasticsearch-kolla-logs-a0ba85d91d1a2c31.yaml @@ -1,8 +1,15 @@ --- fixes: - | - The kolla_logs Docker volume is now mounted into the Elasticsearch + The ``kolla_logs`` Docker volume is now mounted into the Elasticsearch container to expose logs which were previously written erroneously - to the container filesystem (bug 1859162). It is up to the user to + to the container filesystem. `LP#1859162 + `__ +upgrade: + - | + The ``kolla_logs`` Docker volume is now mounted into the Elasticsearch + container to expose logs which were previously written erroneously + to the container filesystem. It is up to the user to migrate any existing logs if they so desire and this should be - done before applying this fix. + done before applying this fix. `LP#1859162 + `__ diff --git a/releasenotes/notes/fix-octavia-cert-config-28f0ef2799406957.yaml b/releasenotes/notes/fix-octavia-cert-config-28f0ef2799406957.yaml index ec060e119b..ef23d6d7b8 100644 --- a/releasenotes/notes/fix-octavia-cert-config-28f0ef2799406957.yaml +++ b/releasenotes/notes/fix-octavia-cert-config-28f0ef2799406957.yaml @@ -1,7 +1,7 @@ --- fixes: - | - Adapt Octavia to the latest dual CA certificate configuration. The + Adapts Octavia to the latest dual CA certificate configuration. The following files should exist in ``/etc/kolla/config/octavia/``: * ``client.cert-and-key.pem`` diff --git a/releasenotes/notes/generate-internal-external-self-signed-certs-c631a9d934d31fac.yaml b/releasenotes/notes/generate-internal-external-self-signed-certs-c631a9d934d31fac.yaml index 94ea0638e5..7b51059994 100644 --- a/releasenotes/notes/generate-internal-external-self-signed-certs-c631a9d934d31fac.yaml +++ b/releasenotes/notes/generate-internal-external-self-signed-certs-c631a9d934d31fac.yaml @@ -1,9 +1,10 @@ --- features: - | - Generate self signed certificates for both the internal and external - (public) networks. If they are the same network, then the certificate - files will be the same. + Adds support for generating self-signed certificates for both the internal + and external (public) networks via the ``kolla-ansible certificates`` + command. If they are the same network, then the certificate files will be + the same. upgrade: - | The default value for ``kolla_external_fqdn_cacert`` has been changed diff --git a/releasenotes/notes/horizon_keystone_dropdown-6b9b4e5e9a64f979.yaml b/releasenotes/notes/horizon_keystone_dropdown-6b9b4e5e9a64f979.yaml index 0f09b341c7..dceaf9ba1c 100644 --- a/releasenotes/notes/horizon_keystone_dropdown-6b9b4e5e9a64f979.yaml +++ b/releasenotes/notes/horizon_keystone_dropdown-6b9b4e5e9a64f979.yaml @@ -1,7 +1,7 @@ --- 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. - Please see ``__ + Adds support for configuring the available domains to choose from on the + horizon login page via ``horizon_keystone_domain_choices`` hash. This + feature was introduced in Pike release. Please see + ``__ diff --git a/releasenotes/notes/implement-ovn-80b3a73e6c8a44e7.yaml b/releasenotes/notes/implement-ovn-80b3a73e6c8a44e7.yaml index fc40103a4f..5ff34e96bb 100644 --- a/releasenotes/notes/implement-ovn-80b3a73e6c8a44e7.yaml +++ b/releasenotes/notes/implement-ovn-80b3a73e6c8a44e7.yaml @@ -1,8 +1,8 @@ --- features: - | - Implement OVN and its integration with Neutron. This includes deployment - of: + Adds support for deployment of OVN and integration of it with Neutron. This + includes deployment of: * OVN databases (``ovn-sb-db`` and ``ovn-nb-db``) * Southbound and Northbound databases connector (``ovn-northd``) diff --git a/releasenotes/notes/manage_dynamic_pollster_configs-14bd3b6775e6a07a.yaml b/releasenotes/notes/manage_dynamic_pollster_configs-14bd3b6775e6a07a.yaml index cec8fe8b8f..65e6345323 100644 --- a/releasenotes/notes/manage_dynamic_pollster_configs-14bd3b6775e6a07a.yaml +++ b/releasenotes/notes/manage_dynamic_pollster_configs-14bd3b6775e6a07a.yaml @@ -1,8 +1,8 @@ --- features: - | - Add support for managing Ceilometer dynamic pollster configuration in - Kolla-ansible. This feature will look for configurations in + Adds support for managing Ceilometer dynamic pollster configuration in + Kolla Ansible. This feature will look for configurations in ``{{ node_custom_config }}/ceilometer/pollster.d/`` by default. If there are configs there, they are copied to the control nodes, to configure Ceilometer dynamic pollster sub-system. diff --git a/releasenotes/notes/mariadb_wsrep_extra_provider_options-27c2804e4505aed1.yaml b/releasenotes/notes/mariadb_wsrep_extra_provider_options-27c2804e4505aed1.yaml index d30cdcc126..64e07a6235 100644 --- a/releasenotes/notes/mariadb_wsrep_extra_provider_options-27c2804e4505aed1.yaml +++ b/releasenotes/notes/mariadb_wsrep_extra_provider_options-27c2804e4505aed1.yaml @@ -1,5 +1,6 @@ --- features: - | - Introduce new configuration variable `mariadb_wsrep_extra_provider_options` - allowing users to set additional WSREP options. + Introduces a new configuration variable + ``mariadb_wsrep_extra_provider_options`` allowing users to set additional + WSREP options. diff --git a/releasenotes/notes/remove-kolla-ceph-adbb5d66bd0192f3.yaml b/releasenotes/notes/remove-kolla-ceph-adbb5d66bd0192f3.yaml index 9e5c8a1141..3a0a380024 100644 --- a/releasenotes/notes/remove-kolla-ceph-adbb5d66bd0192f3.yaml +++ b/releasenotes/notes/remove-kolla-ceph-adbb5d66bd0192f3.yaml @@ -3,5 +3,5 @@ upgrade: - | Support for deploying Ceph has been removed, after it was deprecated in Stein. Please use an external tool to deploy Ceph and integrate it with - Kolla-Ansible deployed OpenStack by following the `external Ceph guide + Kolla Ansible deployed OpenStack by following the `external Ceph guide `__. diff --git a/releasenotes/notes/split_ovs_lb_agents_config-96f1f90e7d678209.yaml b/releasenotes/notes/split_ovs_lb_agents_config-96f1f90e7d678209.yaml index 133d8c6755..d447ecb80d 100644 --- a/releasenotes/notes/split_ovs_lb_agents_config-96f1f90e7d678209.yaml +++ b/releasenotes/notes/split_ovs_lb_agents_config-96f1f90e7d678209.yaml @@ -2,8 +2,9 @@ upgrade: - | Neutron Linux bridge and Open vSwitch Agents config has been split out into - linuxbridge_agent.ini and openvswitch_agent.ini respectively. - Please move your custom service config from ml2_conf.ini into those files. + ``linuxbridge_agent.ini`` and ``openvswitch_agent.ini`` respectively. + Please move your custom service config from ``ml2_conf.ini`` into those + files. deprecations: - | Customizing Neutron Linux bridge and Open vSwitch Agents config via @@ -11,4 +12,4 @@ deprecations: 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. + but that functionality will be removed in the Victoria release.