Merge "Tidy up release notes for Stein release"

releasenotes/notes/add-ceilometer-ipmi-b646f886666889a1.yaml

@@ -1,4 +1,5 @@
 ---
 features:
   - |
-    Add ceilometer_ipmi into ceilometer role.
+    Adds support for deploying a ``ceilometer_ipmi`` container for collecting
+    Ceilometer metrics on IPMI.

releasenotes/notes/add-cinder-quobyte-support-0de697a0800fb962.yaml

@@ -1,3 +1,3 @@
 ---
 features:
-  - Add support in Cinder and Nova for Quobyte volumes
+  - Adds support in Cinder and Nova for Quobyte volumes

releasenotes/notes/add-cyborg-c7ee957a2cbe8e99.yaml

@@ -1,3 +1,4 @@
 ---
 features:
-  - Add cyborg ansible role
+  - Adds support for deploying the OpenStack Cyborg service. Cyborg is a
+    service for managing hardware accelerators.

releasenotes/notes/add-migration-interface-b53da3ff04c2a7fe.yaml

@@ -1,5 +1,5 @@
 ---
 features:
   - |
-    Two new parameters (migration_interface, migration_interface_address) to make
+    Adds support for a dedicated migration network. This is configured via the
-    the use of a dedicated migration network possible.
+    variables ``migration_interface`` and ``migration_interface_address``.

releasenotes/notes/add-monasca-grafana-c31d4407c33939e4.yaml

@@ -1,5 +1,5 @@
 ---
 features:
   - |
-    Add support for deploying the Monasca fork of Grafana, which includes
+    Adds support for deploying the Monasca fork of Grafana, which includes
     Keystone integration.

releasenotes/notes/add-monasca-log-metrics-370846df015ff96a.yaml

@@ -1,5 +1,5 @@
 ---
 features:
   - |
-    Add the Monasca Log Metrics service. This service is responsible for
+    Adds support for deploying the Monasca Log Metrics service. This service is
-    generating metrics from log files.
+    responsible for generating metrics from log files.

releasenotes/notes/add-monasca-persister-c8fdd3d127b2438e.yaml

@@ -1,6 +1,6 @@
 ---
 features:
   - |
-    Add support for deploying the Monasca Persister process. The
+    Adds support for deploying the Monasca Persister process. The
     Persister is responsible for reading metrics, alarms and events
     from Kafka and storing them in a variety of backends.

releasenotes/notes/add-monasca-thresh-f7a860ce996684f9.yaml

@@ -1,5 +1,5 @@
 ---
 features:
   - |
-    Add support for deploying the Monasca thresh service, an Apache Storm
+    Adds support for deploying the Monasca thresh service, an Apache Storm
     topology for alerting.

releasenotes/notes/add-neutron-metering-support-4266364hudc5l80c.yaml

@@ -1,3 +1,3 @@
 ---
 features:
-  - Add neutron-metering-agent into kolla-ansible
+  - Adds support for deploying the Neutron metering agent.

releasenotes/notes/add-octavia-custom-policy-6a55d8cd951ce639.yaml

@@ -1,3 +1,3 @@
 ---
 features:
-  - Add support Octavia custom policy.
+  - Adds support for configuring custom policies in Octavia.

releasenotes/notes/add-octavia-network-interface-4e54077c1ca2a2f4.yaml

@@ -1,3 +1,5 @@
 ---
 features:
-  - Add support specific Octavia network interface.
+  - Adds support for using a separate network for Octavia. This is configured
+    via ``octavia_network_interface`` and
+    ``octavia_network_interface_address``.

releasenotes/notes/add-option-to-configure-nova-serial-console-timeout-7cfc764a0c19eb01.yaml

@@ -1,6 +1,6 @@
 ---
 features:
   - |
-    Added an option, haproxy_nova_serialconsole_proxy_tunnel_timeout,
+    Adds an option, ``haproxy_nova_serialconsole_proxy_tunnel_timeout``,
-    to configure the nova_serialconsole_proxy tunnel timeout. This default
+    to configure the ``nova_serialconsole_proxy`` tunnel timeout. The default
     is to keep the websocket connection alive for 10 minutes.

releasenotes/notes/add-prometheus-as-vitrage-datasource-3439b3f9925b8e8e.yaml

@@ -1,4 +1,4 @@
 ---
 features:
   - |
-    Configure Prometheus as Vitrage datasource automatically.
+    Configures Prometheus as a Vitrage datasource automatically.

releasenotes/notes/add-prometheus-elasticsearch-exporter-4d9b75b5cb8801d1.yaml

@@ -1,5 +1,6 @@
 ---
 features:
   - |
-    Deploys and configures the prometheus-elasticsearch-exporter (https://github.com/justwatchcom/elasticsearch_exporter/)
+    Adds support for deploying the `Prometheus Elasticsearch exporter
-    as part of the prometheus monitoring exporters stack.
+    <https://github.com/justwatchcom/elasticsearch_exporter/>`__ as part of the
+    prometheus monitoring exporters stack.

releasenotes/notes/add-prometheus-openstack-exporter-8fd7b0e6c8e71649.yaml

@@ -1,5 +1,6 @@
 ---
 features:
   - |
-    Deploys and configures the prometheus-openstack-exporter (https://github.com/Linaro/openstack-exporter/)
+    Adds support for deploying the `Prometheus OpenStack exporter
-    as part of the prometheus monitoring exporters stack.
+    <https://github.com/Linaro/openstack-exporter/>`__ as part of the
+    prometheus monitoring exporters stack.

releasenotes/notes/add_monasca_agent-2b3b2f484a9e7168.yaml

@@ -1,4 +1,4 @@
 ---
 features:
-  - Add the Monasca Agent which provides host and application
+  - Adds support for deploying the Monasca Agent, which provides host and
-    specific monitoring data collection and forwarding.
+    application specific monitoring data collection and forwarding.

releasenotes/notes/add_qume_options-8e9f040d0bc36fe6.yaml

@@ -1,7 +1,8 @@
 ---
 features:
   - |
-    Bump up the max_files to 32768 and max_processes to 131072.
+    Adds support for configuring the maximum files and processes limits in the
-    when nova used ceph as backend, the default limit 1024 is not enough.
+    ``nova_libvirt`` container, via the ``qemu_max_files`` and
-    each connection from rbd image to osd needs 1 fd and 2 threads. if we
+    ``qemu_max_processes`` variables. The default values for these are 32768
-    have 200 osds, we need 200 fds and 400 threads for 1 image.
+    and 131072 respectively.  This is useful when Nova uses Ceph as a backend,
+    since the default limit of 1024 is often not enough.

releasenotes/notes/add_ulimit_support-35e8799f29a44d12.yaml

@@ -1,5 +1,5 @@
 ---
 features:
   - |
-    Add ulimit support for kolla_docker which provides ability
+    Adds support for configuring ulimit in containers, extending the dimension
-    of modify docker ulimits。
+    support added in Rocky release.

releasenotes/notes/allow-disabling-keepalived-310321889a848edf.yaml

@@ -1,5 +1,6 @@
 ---
 features:
   - |
-    Add a configuration option `enable_keepalived` to allow disabling the
+    Adds a configuration option ``enable_keepalived`` to allow disabling the
-    service. This is useful when using an external LB in front of HAProxy.
+    ``keepalived`` service. This is useful when using an external load balancer
+    in front of HAProxy.

releasenotes/notes/config-nova-release-97e6fc526a94740e.yaml

@@ -1,12 +1,13 @@
 ---
 features:
   - |
-    You can customise vendor info that is used through out Nova via the
+    Adds support for configuring vendor info in Nova via the ``release`` file.
-    'release' file. To do this place a file called 'release' in one of the
+    To do this place a file called ``release`` in one of the following
-    following locations:
+    locations:
-    /etc/kolla/config/nova/release
+
-    /etc/kolla/config/nova_compute/release
+    * /etc/kolla/config/nova/release
-    /etc/kolla/config/nova_compute/{{ inventory_hostname }}/release
+    * /etc/kolla/config/nova_compute/release
+    * /etc/kolla/config/nova_compute/{{ inventory_hostname }}/release
 
     An example of the file can be seen at
     https://github.com/openstack/nova/blob/master/etc/nova/release.sample

releasenotes/notes/glance-cache-ecf950ba3e9136b1.yaml

@@ -1,6 +1,6 @@
 ---
 features:
   - |
-    Add support to configure glance-cache, enabled with
+    Adds support for configuring ``glance-cache``, enabled with
-    ``enable_glance_image_cache`` and configure cache size
+    ``enable_glance_image_cache``. The cache size is configured via
-    with ``glance_cache_max_size``.
+    ``glance_cache_max_size``.

releasenotes/notes/gnochhi_swift_storage-5d05dab0e20eb43d.yaml

@@ -1,9 +1,9 @@
 ---
 upgrade:
   - |
-    Added swift as gnocchi storage option.
+    Adds swift as a gnocchi storage option.
-    Here is the list of storage options for gnocchi-
+    Here is the list of storage options for gnocchi\:
-    a) Uses swift if swift is enabled.
+    a) Use swift if swift is enabled.
-    b) Uses ceph if ceph is enabled.
+    b) Use ceph if ceph is enabled.
-    c) Defaults to file if swift and ceph are enabled.
+    c) Default to file if swift and ceph are enabled.
-    User has to explicitly set to swift or ceph if both enabled.
+    User has to explicitly set to swift or ceph if both are enabled.

releasenotes/notes/implement-neutron-rolling-upgrade-a7b3124eab7adfa2.yaml

@@ -1,6 +1,6 @@
 ---
 features:
   - |
-    Implement Neutron rolling upgrade logic, apply for: neutron,
+    Implements Neutron rolling upgrade logic, applied for Neutron server,
-    vpnaas and fwaas because only these projects have supported for
+    VPNaaS and FWaaS because only these projects have support for rolling
-    rolling upgrade database migration.
+    upgrade database migration.

releasenotes/notes/implement-nova-rolling-upgrade-f3b2d8382f725cb2.yaml

@@ -1,4 +1,4 @@
 ---
 features:
   - |
-    Implement Nova rolling upgrade logic
+    Implements Nova rolling upgrade logic.

releasenotes/notes/implement-swift-rolling-upgrade-bb715b173263f844.yaml

@@ -1,5 +1,5 @@
 ---
 features:
   - |
-    Implement Swift rolling upgrade logic, enabled by default at
+    Implements Swift rolling upgrade logic, enabled via
-    swift_enable_rolling_upgrade: "yes" in etc/kolla/globals.yml file.
+    ``swift_enable_rolling_upgrade``, which is ``true`` by default.

releasenotes/notes/kibana-custom-config-74afd6ddee462ed8.yaml

@@ -1,3 +1,4 @@
 ---
 features:
-  - Adds ability to provide a custom kibana config.
+  - Adds support for providing custom kibana configuration via
+    ``/etc/kolla/config/kibana/kibana.yml``.

releasenotes/notes/limit-docker-log-size-33133da03b232ece.yaml

@@ -2,7 +2,6 @@
 features:
   - Docker logs are no longer allowed to grow unbounded and have
     been limited to a fixed size per container. Two new variables
-    have been added, `docker_log_max_file` and `docker_log_max_size`
+    have been added, ``docker_log_max_file`` and ``docker_log_max_size`` which
-    which default to 5 and 50MB respectively. This means that for
+    default to 5 and 50MB respectively. This means that for each container,
-    each container, there should be no more than 250MB of Docker
+    there should be no more than 250MB of Docker logs.
-    logs.

releasenotes/notes/link_kolla_logs-e57a1e583f2872eb.yaml

@@ -1,6 +1,6 @@
 ---
-other:
+features:
   - |
-    Link kolla_logs docker volume to /var/log/kolla.
+    Adds a symbolic link from the ``kolla_logs`` docker volume to
-    Shorter log path will help to debug from log.
+    ``/var/log/kolla``, making it easier to find log files.  The volume path is
-    The volume path is compatible with docker-engine and docker-ce.
+    compatible with docker-engine and docker-ce.

releasenotes/notes/mariadb-xtrabackup-d4f48464dd6baaea.yaml

@@ -1,7 +1,8 @@
 ---
 features:
   - |
-    Supports taking a backup of all MariaDB-hosted databases using Percona XtraBackup.
+    Adds support for taking a backup of all MariaDB-hosted databases using
+    Percona XtraBackup.
 security:
   - |
     When the MariaDB backup option is enabled, it will create a new database

releasenotes/notes/module-load-946eaecb55cb31f0.yaml

@@ -1,5 +1,5 @@
 ---
 features:
   - Adds support for loading kernel modules required by containers. This is
-    required since kolla images are removing support for loading kernel modules
+    required since kolla images removed support for loading kernel modules
-    from within the container.
+    from within the container in the Stein release.

releasenotes/notes/onos-support-2ea385cceb8104d6.yaml

@@ -1,5 +1,6 @@
 ---
 features:
   - |
-    Add onos support, Networking-onos is Neutron's sub-project to provide
+    Add support for configuring Neutron to use an ONOS SDN controller via
-    connectivity between Neutron/Neutron's sub-project's and ONOS.
+    the ``networking-onos`` project.  Networking-onos is Neutron's sub-project
+    to provide connectivity between Neutron and ONOS.

releasenotes/notes/remove-deprecated-compute-groups-5273e945720edddc.yaml

@@ -1,7 +1,8 @@
 ---
 upgrade:
   - |
-    Previously deprecated compute groups 'inner-compute' and 'external-compute'
+    Previously deprecated compute groups ``inner-compute`` and
-    have now been removed in favor of the more simple 'compute' group. Please
+    ``external-compute`` have now been removed in favor of the more simple
-    be sure to update your inventory.  Set 'neutron_compute_dvr_mode' on nodes
+    ``compute`` group. Please be sure to update your inventory.  Set
-    with which you wish to customise the value for neutron's 'agent_mode'.
+    ``neutron_compute_dvr_mode`` on nodes with which you wish to customise the
+    value for neutron's ``agent_mode``.

releasenotes/notes/split-haproxy-config-by-service-90c2d89de1829e8a.yaml

@@ -2,10 +2,10 @@
 features:
   - |
     HAProxy configuration is now split per service, which makes creating and
-    updating service configs much simpler.
+    updating service configurations much simpler.
 upgrade:
   - |
-    All haproxy related variables have been moved from the ``haproxy`` role to
+    All HAProxy-related variables have been moved from the ``haproxy`` role to
     the ``haproxy-common`` role, with the exception of the following which were
     also split and renamed after the move\:
 

releasenotes/notes/stein-prelude-0fd9e090eb54e566.yaml

@@ -0,0 +1,6 @@
+---
+prelude: |
+  The Kolla Ansible ``8.0.0`` release is the first release in the Stein cycle.
+  Highlights include full support for the OpenStack Monasca project, support
+  for the Placement service which has been extracted from Nova, and support
+  for performing full or incremental backups of the MariaDB database.

releasenotes/notes/stop-per-service-85a996bb2751ed52.yaml

@@ -1,11 +1,6 @@
 ---
 features:
   - |
-    Add support to stop a service with ``kolla-ansible stop`` command.
+    Adds support for stopping a service with the ``kolla-ansible stop``
-    This feature will allow to stop specific services with ``--tags`` and
+    command.  This feature allows specific services to be stopped with
-    ``--limit`` to a host.
+    ``--tags`` and ``--limit`` to limit the changes to a subset of hosts.
-upgrade:
-  - |
-    New ``kolla-ansible stop`` command requires the usage of
-    ``--yes-i-really-really-mean-it`` to avoid accidentally
-    stopping services.

releasenotes/notes/support-check-and-diff-mode-for-genconfig-97703a2ed13ab9ec.yaml

@@ -1,6 +1,7 @@
 ---
 features:
   - |
-    Support ansible check and diff module for generate configurations. You could
+    Adds support for Ansible check and diff mode when generating configuration.
-    use ``EXTRA_OPTS='--check --diff' kolla-ansible genconfig`` to check what
+    It is possible to use ``EXTRA_OPTS='--check --diff' kolla-ansible
-    the configuration file will be like in dry-run mode.
+    genconfig`` to check what the configuration file will be like in dry-run
+    mode.

releasenotes/notes/swift-replication-network-40ecd13e4339f299.yaml

@@ -7,13 +7,14 @@ features:
     In a deployment where both Ceph and Swift have been deployed,
     this changes adds functionalality to support optional seperation
     of storage network traffic. This adds two new network interfaces
-    'swift_storage_interface' and 'swift_replication_interface' which maintain
+    ``swift_storage_interface`` and ``swift_replication_interface`` which
-    backwards compatibility.
+    maintain backwards compatibility.
 
-    The Swift access network interface is configured via 'swift_storage_interface',
+    The Swift access network interface is configured via
-    which defaults to 'storage_interface'. The Swift replication network
+    ``swift_storage_interface``, which defaults to ``storage_interface``. The
-    interface is configured via 'swift_replication_interface', which
+    Swift replication network interface is configured via
-    defaults to 'swift_storage_interface'.
+    ``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

releasenotes/notes/toggle-custom-horizon-policy-files-f8e91efbb80ac0d6.yaml

@@ -1,4 +1,5 @@
 ---
 features:
   - |
-    Add configuration to enable/disable custom horizon policy files per-service even if the service is not being deployed by kolla-ansible.
+    Adds configuration variables to enable/disable custom horizon policy files
+    per-service even if the service is not being deployed by kolla-ansible.