From b2ecd089248a6d307322ba31db6b91b0810550d9 Mon Sep 17 00:00:00 2001
From: Julia Kreger <juliaashleykreger@gmail.com>
Date: Tue, 19 Jun 2018 09:06:40 -0700
Subject: [PATCH] Release note clean-ups for ironic release

Lots of misc fixes and changes to make the release notes
a little more consistent.

Change-Id: I8ed616f27a393d5adf015743fc1810a3d9955c55
---
 .../notes/add-inspection-abort-a187e6e5c1f6311d.yaml   |  7 ++++---
 .../add-node-boot-mode-control-9761d4bcbd8c3a0d.yaml   | 10 +++++-----
 ...add-redfish-boot-mode-support-2f1a2568e71c65d0.yaml |  4 ++--
 releasenotes/notes/bug-1745630-d28c8de54cebd329.yaml   |  8 --------
 .../fix-multi-attached-volumes-092ffedbdcf0feac.yaml   |  5 +++--
 .../notes/heartbeat-locked-6e53b68337d5a258.yaml       |  6 +++---
 ...ipxe-command-line-ip-argument-4e92cf8bb912f62d.yaml |  7 ++++---
 .../irmc-support-ipmitool-power-a3480a70753948e5.yaml  |  2 +-
 .../notes/migrate_vif_port_id-5e1496638240933d.yaml    |  2 +-
 .../no-sensors-in-maintenance-7a0ecf418336d105.yaml    |  7 ++++---
 releasenotes/notes/node-fault-8c59c0ecb94ba562.yaml    |  7 ++++---
 releasenotes/notes/orphan-nodes-389cb6d90c2917ec.yaml  |  9 +++++----
 .../notes/power-fault-recovery-6e22f0114ceee203.yaml   |  8 +++++---
 .../pxe-enabled-ports-check-c1736215dce76e97.yaml      |  5 +++--
 .../remove-vifs-on-teardown-707c8e40c46b6e64.yaml      |  5 +++--
 ...terface-for-ilo-hardware-type-2392989d0fef8849.yaml |  6 +++---
 ...erface-for-irmc-hardware-type-17e38197849748e0.yaml |  6 +++---
 ...cenario-for-ilo-hardware-type-ebca86da8fc271f6.yaml |  6 +++---
 18 files changed, 56 insertions(+), 54 deletions(-)
 delete mode 100644 releasenotes/notes/bug-1745630-d28c8de54cebd329.yaml

diff --git a/releasenotes/notes/add-inspection-abort-a187e6e5c1f6311d.yaml b/releasenotes/notes/add-inspection-abort-a187e6e5c1f6311d.yaml
index c3b4af78dd..0cfab097ec 100644
--- a/releasenotes/notes/add-inspection-abort-a187e6e5c1f6311d.yaml
+++ b/releasenotes/notes/add-inspection-abort-a187e6e5c1f6311d.yaml
@@ -3,6 +3,7 @@ features:
   - |
     Adds support to abort the inspection of a node in the ``inspect wait``
     state, as long as this operation is supported by the inspect interface in
-    use. Starting from API 1.41, the node in the ``inspect wait`` state
-    accepts ``abort`` provisioning verb to initiate the abort process.
-    This feature is supported by the ``inspector`` inspect interface.
+    use. A node in the ``inspect wait`` state accepts the ``abort``
+    provisioning verb to initiate the abort process.
+    This feature is supported by the ``inspector`` inspect interface and
+    is available starting with API version 1.41.
diff --git a/releasenotes/notes/add-node-boot-mode-control-9761d4bcbd8c3a0d.yaml b/releasenotes/notes/add-node-boot-mode-control-9761d4bcbd8c3a0d.yaml
index 1c13abd2a3..f22ecdd1ab 100644
--- a/releasenotes/notes/add-node-boot-mode-control-9761d4bcbd8c3a0d.yaml
+++ b/releasenotes/notes/add-node-boot-mode-control-9761d4bcbd8c3a0d.yaml
@@ -6,11 +6,11 @@ other:
     calls to the BMC of the baremetal nodes being managed.
 features:
   - The new ironic configuration setting ``[deploy]/default_boot_mode``
-    allows to set the default boot mode when ironic can't pick boot mode
-    automatically based on node configuration, hardware capabilities,
-    bare-metal machine configuration.
+    allows the operator to set the default boot mode when ironic can't
+    pick boot mode automatically based on node configuration, hardware
+    capabilities, or bare-metal machine configuration.
 fixes:
   - If the bare metal machine's boot mode differs from the requested one,
-    ironic will attempt to set requested boot mode on the bare metal
+    ironic will now attempt to set requested boot mode on the bare metal
     machine and fail explicitly if the driver does not support setting
-    boot mode on the node.
\ No newline at end of file
+    boot mode on the node.
diff --git a/releasenotes/notes/add-redfish-boot-mode-support-2f1a2568e71c65d0.yaml b/releasenotes/notes/add-redfish-boot-mode-support-2f1a2568e71c65d0.yaml
index c86bb30ee9..5232c0fb96 100644
--- a/releasenotes/notes/add-redfish-boot-mode-support-2f1a2568e71c65d0.yaml
+++ b/releasenotes/notes/add-redfish-boot-mode-support-2f1a2568e71c65d0.yaml
@@ -1,4 +1,4 @@
 ---
 features:
-  - Adds support for reading and setting bare metal node's boot mode
-    using the ``redfish`` management interface.
+  - Adds support to the ``redfish`` management interface for reading
+    and setting bare metal node's boot mode.
diff --git a/releasenotes/notes/bug-1745630-d28c8de54cebd329.yaml b/releasenotes/notes/bug-1745630-d28c8de54cebd329.yaml
deleted file mode 100644
index 5fafb4be52..0000000000
--- a/releasenotes/notes/bug-1745630-d28c8de54cebd329.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
----
-fixes:
-  - |
-    Fixes a bug to get a node stuck in ``deploying`` state when the size of
-    the configdrive exceeds the limitation of the database. In MySQL, the
-    limitation is about 64KiB. With this fix, the provision state gets
-    ``deploy failed`` in this case. See `bug 1745630
-    <https://bugs.launchpad.net/ironic/+bug/1745630>`_ for details.
diff --git a/releasenotes/notes/fix-multi-attached-volumes-092ffedbdcf0feac.yaml b/releasenotes/notes/fix-multi-attached-volumes-092ffedbdcf0feac.yaml
index ba4aacd5cd..e378101573 100644
--- a/releasenotes/notes/fix-multi-attached-volumes-092ffedbdcf0feac.yaml
+++ b/releasenotes/notes/fix-multi-attached-volumes-092ffedbdcf0feac.yaml
@@ -1,5 +1,6 @@
 ---
 fixes:
   - |
-    Fix an issue with iPXE is used for authentication during boot from volume
-    with multi attached volumes.
+    Fixes an issue with iPXE where the incorrect iscsi volume
+    authentication data was being used with boot from volume when
+    multi-attach volumes were present.
diff --git a/releasenotes/notes/heartbeat-locked-6e53b68337d5a258.yaml b/releasenotes/notes/heartbeat-locked-6e53b68337d5a258.yaml
index f84b3092b6..b7511ca195 100644
--- a/releasenotes/notes/heartbeat-locked-6e53b68337d5a258.yaml
+++ b/releasenotes/notes/heartbeat-locked-6e53b68337d5a258.yaml
@@ -1,6 +1,6 @@
 ---
 fixes:
   - |
-    When a node is found to be locked when a heart beat arrives, no longer
-    records the error in node's ``last_error`` field, since it's not
-    an error in most cases.
+    Fixes an issue where node ramdisk heartbeat operations would collide
+    with conductor locks and erroniously record an error in node's
+    ``last_error`` field.
diff --git a/releasenotes/notes/ipxe-command-line-ip-argument-4e92cf8bb912f62d.yaml b/releasenotes/notes/ipxe-command-line-ip-argument-4e92cf8bb912f62d.yaml
index 9e3bc35420..5cb4869c5e 100644
--- a/releasenotes/notes/ipxe-command-line-ip-argument-4e92cf8bb912f62d.yaml
+++ b/releasenotes/notes/ipxe-command-line-ip-argument-4e92cf8bb912f62d.yaml
@@ -1,7 +1,8 @@
 ---
 fixes:
   - |
-    The iPXE template kernel command line argument ``ip`` has been removed as it
-    is incompatible with the ``BOOTIF`` and missing ``autoconf`` parameters with
-    dracut. Further details can be found in
+    Fixes a compatability issue where the iPXE kernel command line was no
+    longe compatible with dracut. The ``ip`` parameter has been removed
+    as it is incompatible with the ``BOOTIF`` and missing ``autoconf``
+    parameters when dracut is used. Further details can be found in
     `storyboard <https://storyboard.openstack.org/#!/story/2001969>`_.
diff --git a/releasenotes/notes/irmc-support-ipmitool-power-a3480a70753948e5.yaml b/releasenotes/notes/irmc-support-ipmitool-power-a3480a70753948e5.yaml
index 910370791e..aee8e6b606 100644
--- a/releasenotes/notes/irmc-support-ipmitool-power-a3480a70753948e5.yaml
+++ b/releasenotes/notes/irmc-support-ipmitool-power-a3480a70753948e5.yaml
@@ -1,4 +1,4 @@
 ---
 features:
   - |
-    Adds support for ``ipmitool`` power interface to ``irmc`` hardware type.
+    Adds support for the ``ipmitool`` power interface to the ``irmc`` hardware type.
diff --git a/releasenotes/notes/migrate_vif_port_id-5e1496638240933d.yaml b/releasenotes/notes/migrate_vif_port_id-5e1496638240933d.yaml
index 4f7d39354a..6c4d6ac64c 100644
--- a/releasenotes/notes/migrate_vif_port_id-5e1496638240933d.yaml
+++ b/releasenotes/notes/migrate_vif_port_id-5e1496638240933d.yaml
@@ -8,6 +8,6 @@ upgrade:
     the port's or port group's extra['vif_port_id'] will not be supported
     starting with the Stein release.
 
-    Any out-of-tree network interface implementation that had a different
+    Any out-of-tree network interface implementations that had a different
     behavior in support of attach/detach VIFs via the port or port group's
     extra['vif_port_id'] must be updated appropriately.
diff --git a/releasenotes/notes/no-sensors-in-maintenance-7a0ecf418336d105.yaml b/releasenotes/notes/no-sensors-in-maintenance-7a0ecf418336d105.yaml
index a2b55b2b93..57b6718a64 100644
--- a/releasenotes/notes/no-sensors-in-maintenance-7a0ecf418336d105.yaml
+++ b/releasenotes/notes/no-sensors-in-maintenance-7a0ecf418336d105.yaml
@@ -1,4 +1,5 @@
 ---
-fixes:
-  - No longer tries to collect or report sensors data for nodes in maintenance
-    mode. See `bug 1652741 <https://bugs.launchpad.net/bugs/1652741>`_.
+other:
+  - The conductor no longer tries to collect or report sensors data for
+    nodes in maintenance mode.
+    See `bug 1652741 <https://bugs.launchpad.net/bugs/1652741>`_.
diff --git a/releasenotes/notes/node-fault-8c59c0ecb94ba562.yaml b/releasenotes/notes/node-fault-8c59c0ecb94ba562.yaml
index 0b7ff33c99..a397d86309 100644
--- a/releasenotes/notes/node-fault-8c59c0ecb94ba562.yaml
+++ b/releasenotes/notes/node-fault-8c59c0ecb94ba562.yaml
@@ -4,7 +4,8 @@ features:
     Adds support for the ``fault`` field in the node, beginning with API
     version 1.42. This field records the fault, if any, detected by ironic for
     a node. If no fault is detected, the ``fault`` is ``None``. The ``fault``
-    is set to one of following values according to different circumstances:
+    field value is set to one of following values according to
+    different circumstances:
 
     * ``power failure``: when a node is put into maintenance due to power sync
       failures that exceed max retries.
@@ -13,6 +14,6 @@ features:
     * ``rescue abort failure``: when a node is put into maintenance due to
       failure of cleaning up during rescue abort.
 
-    The ``fault`` will be set to ``None`` if an operator manually set
+    The ``fault`` field will be set to ``None`` if an operator manually set
     maintenance to ``False``. The ``fault`` field can be used as a filter for
-    querying nodes.
\ No newline at end of file
+    querying nodes.
diff --git a/releasenotes/notes/orphan-nodes-389cb6d90c2917ec.yaml b/releasenotes/notes/orphan-nodes-389cb6d90c2917ec.yaml
index c5c3f1e116..f660ecc0b9 100644
--- a/releasenotes/notes/orphan-nodes-389cb6d90c2917ec.yaml
+++ b/releasenotes/notes/orphan-nodes-389cb6d90c2917ec.yaml
@@ -1,9 +1,10 @@
 ---
 fixes:
   - |
-    On node take over, any locks that are left from the old conductor are
-    cleared by the new one. Previously it only happened for nodes in
-    ``DEPLOYING`` state.
+    Fixes an issue where only nodes in ``DEPLOYING`` state would have
+    locks cleared for the nodes. Now upon node take over, any locks
+    that are left from the old conductor are cleared by the new one.
+other:
   - |
     On taking over nodes in ``CLEANING`` state, the new conductor moves them
-    to ``CLEAN FAIL`` and set maintenance.
+    to the ``CLEAN FAIL`` state and sets maintenance.
diff --git a/releasenotes/notes/power-fault-recovery-6e22f0114ceee203.yaml b/releasenotes/notes/power-fault-recovery-6e22f0114ceee203.yaml
index a7184d7766..3f7fccf8a8 100644
--- a/releasenotes/notes/power-fault-recovery-6e22f0114ceee203.yaml
+++ b/releasenotes/notes/power-fault-recovery-6e22f0114ceee203.yaml
@@ -13,6 +13,8 @@ upgrade:
     ``[conductor]power_failure_recovery_interval``, which is enabled and set
     to 300 seconds by default. In case the default value is not suitable for
     the needs or scale of a deployment, please make adjustment or turn it off
-    during upgrade. The power failure recovery does not apply to nodes that
-    were in maintenance mode due to power failure before upgrade, they have
-    to be manually moved out of maintenance mode.
\ No newline at end of file
+    during upgrade.
+  - |
+    Power failure recovery does not apply to nodes that were in maintenance
+    mode due to power failure before upgrade, they have to be manually moved
+    out of maintenance mode.
diff --git a/releasenotes/notes/pxe-enabled-ports-check-c1736215dce76e97.yaml b/releasenotes/notes/pxe-enabled-ports-check-c1736215dce76e97.yaml
index ad0abb5d7e..a07c806239 100644
--- a/releasenotes/notes/pxe-enabled-ports-check-c1736215dce76e97.yaml
+++ b/releasenotes/notes/pxe-enabled-ports-check-c1736215dce76e97.yaml
@@ -1,6 +1,7 @@
 ---
 fixes:
   - |
-    When creating a neutron port for booting a ramdisk, an error is raised if
-    there are no PXE-enabled ports available for the node. See `bug 2001811
+    Fixes an issue where no error was raised if there were no PXE-enabled
+    ports available for the node, when creating a neutron port.
+    See `bug 2001811
     <https://storyboard.openstack.org/#!/story/2001811>`_ for more details.
diff --git a/releasenotes/notes/remove-vifs-on-teardown-707c8e40c46b6e64.yaml b/releasenotes/notes/remove-vifs-on-teardown-707c8e40c46b6e64.yaml
index ae3d03e4ca..4b323fa151 100644
--- a/releasenotes/notes/remove-vifs-on-teardown-707c8e40c46b6e64.yaml
+++ b/releasenotes/notes/remove-vifs-on-teardown-707c8e40c46b6e64.yaml
@@ -3,13 +3,14 @@ upgrade:
   - |
     The behavior for retention of VIF interface attachments has changed.
 
-    If your use of the BareMetal service is reliant upon the behavior of
+    If your use of the Bare Metal service is reliant upon the behavior of
     the VIFs being retained, which was introduced as a behavior change
     during the Ocata cycle, then you must update your tooling to explicitly
     re-add the VIF attachments prior to deployment.
 fixes:
   - |
-    Removes all records of VIF attachments upon the teardown of a deployed
+    Fixes potential case of VIF records being orphaned as the service
+    now removes all records of VIF attachments upon the teardown of a deployed
     node. This is in order to resolve issues related to where it is
     operationally impossible in some circumstances to remove a VIF
     attachment while a node is being undeployed as the Compute service
diff --git a/releasenotes/notes/rescue-interface-for-ilo-hardware-type-2392989d0fef8849.yaml b/releasenotes/notes/rescue-interface-for-ilo-hardware-type-2392989d0fef8849.yaml
index 622c90d986..fe7d913d86 100644
--- a/releasenotes/notes/rescue-interface-for-ilo-hardware-type-2392989d0fef8849.yaml
+++ b/releasenotes/notes/rescue-interface-for-ilo-hardware-type-2392989d0fef8849.yaml
@@ -1,7 +1,7 @@
 ---
 features:
   - |
-    Adds support for rescue interface ``agent`` for ``ilo`` hardware type
-    when corresponding boot interface being used is ``ilo-virtual-media``.
-    The supported values of rescue interface for ``ilo`` hardware type
+    Adds support for rescue interface ``agent`` for the ``ilo`` hardware type
+    when the corresponding boot interface being used is ``ilo-virtual-media``.
+    The supported values of the rescue interface for the ``ilo`` hardware type
     are ``agent`` and ``no-rescue``. The default value is ``no-rescue``.
diff --git a/releasenotes/notes/rescue-interface-for-irmc-hardware-type-17e38197849748e0.yaml b/releasenotes/notes/rescue-interface-for-irmc-hardware-type-17e38197849748e0.yaml
index 652262b276..48e49bd8bd 100644
--- a/releasenotes/notes/rescue-interface-for-irmc-hardware-type-17e38197849748e0.yaml
+++ b/releasenotes/notes/rescue-interface-for-irmc-hardware-type-17e38197849748e0.yaml
@@ -1,7 +1,7 @@
 ---
 features:
   - |
-    Adds support for rescue interface ``agent`` for ``irmc`` hardware type
-    when corresponding boot interface is ``irmc-virtual-media``.
+    Adds support for rescue interface ``agent`` for the ``irmc`` hardware type
+    when the corresponding boot interface is ``irmc-virtual-media``.
     The supported values of rescue interface for ``irmc`` hardware type
-    are ``agent`` and ``no-rescue``. The default value is ``no-rescue``.
\ No newline at end of file
+    are ``agent`` and ``no-rescue``. The default value is ``no-rescue``.
diff --git a/releasenotes/notes/update-boot_mode-for-cleaning-scenario-for-ilo-hardware-type-ebca86da8fc271f6.yaml b/releasenotes/notes/update-boot_mode-for-cleaning-scenario-for-ilo-hardware-type-ebca86da8fc271f6.yaml
index 5cd7f3f189..ff6f984793 100644
--- a/releasenotes/notes/update-boot_mode-for-cleaning-scenario-for-ilo-hardware-type-ebca86da8fc271f6.yaml
+++ b/releasenotes/notes/update-boot_mode-for-cleaning-scenario-for-ilo-hardware-type-ebca86da8fc271f6.yaml
@@ -1,8 +1,8 @@
 ---
 fixes:
   - |
-    Updates the boot mode on the baremetal for cleaning scenario as per
-    given ``boot_mode`` in node's properties/capabilities. This change
-    is for ``ilo`` hardware type.
+    Fixes an issue where the ``ilo`` hardware type would not properly
+    update the boot mode on the bare metal machine for cleaning as per
+    given ``boot_mode`` in node's properties/capabilities.
     See `bug 1559835 <https://bugs.launchpad.net/ironic/+bug/1559835>`_
     for more details.