From f8f9740a0b639d9d8490c7ac5348c2663bc1d346 Mon Sep 17 00:00:00 2001
From: Julia Kreger <juliaashleykreger@gmail.com>
Date: Mon, 20 Apr 2020 10:15:54 -0700
Subject: [PATCH] Prepare release notes/docs for 15.0 release
Change-Id: I60b5d7fe1039bc8f04e0f515dcf1b1e9fd2f50be
---
doc/source/contributor/webapi-version-history.rst | 14 +++++++-------
.../agent-token-support-0a5b5aa1585dfbb5.yaml | 2 +-
.../bump-min-ansible-ver-a78e7885c0e9d361.yaml | 5 ++---
...ksum-recalculation-sha256-fd3d5b4b0b757e86.yaml | 3 ++-
.../image_checksum_optional-381acf9e441d2a58.yaml | 2 +-
...e-redfish-set-boot-device-e38e9e9442ab5750.yaml | 8 ++++----
...ptional-redfish-system-id-3f6e8b0ac989cb9b.yaml | 3 +--
...k-connection-network-type-71103d919e27fc5d.yaml | 2 +-
.../redfish-add-root-prefix-03b5f31ec6bbd146.yaml | 7 ++++---
.../rename-iso-builder-func-46694ed6ded84f4a.yaml | 4 ++--
...secrets_to_generate_token-55af0f43e5a80b9e.yaml | 2 +-
11 files changed, 26 insertions(+), 26 deletions(-)
diff --git a/doc/source/contributor/webapi-version-history.rst b/doc/source/contributor/webapi-version-history.rst
index e7feb584f8..731ce2d629 100644
--- a/doc/source/contributor/webapi-version-history.rst
+++ b/doc/source/contributor/webapi-version-history.rst
@@ -2,7 +2,7 @@
REST API Version History
========================
-1.65 (Ussuri, master)
+1.65 (Ussuri, 15.0)
---------------------
Added ``lessee`` field to the node object. The field should match the
@@ -10,7 +10,7 @@ Added ``lessee`` field to the node object. The field should match the
then the allocation process will only match the allocation with a node
that has the same ``owner`` or ``lessee``.
-1.64 (Ussuri, master)
+1.64 (Ussuri, 15.0)
---------------------
Added the ``network_type`` to the port objects ``local_link_connection`` field.
@@ -19,7 +19,7 @@ type is ``unmanaged`` other fields are not required. Use ``unmanaged`` when the
neutron ``network_interface`` is required, but the network is in fact a flat
network where no actual switch management is done.
-1.63 (Ussuri, master)
+1.63 (Ussuri, 15.0)
---------------------
Added the following new endpoints for indicator management:
@@ -33,14 +33,14 @@ Added the following new endpoints for indicator management:
* ``PUT /v1/nodes/<node_ident>/management/indicators/<component>/<indicator_ident>``
change state of the desired indicators of the component.
-1.62 (Ussuri, master)
+1.62 (Ussuri, 15.0)
---------------------
This version of the API is to signify capability of an ironic deployment
to support the ``agent token`` functionality with the
``ironic-python-agent``.
-1.61 (Ussuri, master)
+1.61 (Ussuri, 14.0)
---------------------
Added ``retired`` field to the node object to mark nodes for retirement.
@@ -49,7 +49,7 @@ cleaning. ``manageable`` nodes which have this flag set cannot be
moved to available. Also added ``retired_reason`` to specify the
retirement reason.
-1.60 (Ussuri, master)
+1.60 (Ussuri, 14.0)
---------------------
Added ``owner`` field to the allocation object. The field should match the
@@ -57,7 +57,7 @@ Added ``owner`` field to the allocation object. The field should match the
allocation process will only match the allocation with a node that has the
same ``owner`` field set.
-1.59 (Ussuri, master)
+1.59 (Ussuri, 14.0)
---------------------
Added the ability to specify a ``vendor_data`` dictionary field in the
diff --git a/releasenotes/notes/agent-token-support-0a5b5aa1585dfbb5.yaml b/releasenotes/notes/agent-token-support-0a5b5aa1585dfbb5.yaml
index f133e0365b..6ee0ef8459 100644
--- a/releasenotes/notes/agent-token-support-0a5b5aa1585dfbb5.yaml
+++ b/releasenotes/notes/agent-token-support-0a5b5aa1585dfbb5.yaml
@@ -1,7 +1,7 @@
---
features:
- |
- Adds support of ``agent token`` which serves as a mechanism to secure
+ Adds support of "agent token" which serves as a mechanism to secure
the normally unauthenticated API endpoints in ironic which are used in
the mechanics of baremetal provisioning. This feature is optional, however
operators may require this feature by changing the
diff --git a/releasenotes/notes/bump-min-ansible-ver-a78e7885c0e9d361.yaml b/releasenotes/notes/bump-min-ansible-ver-a78e7885c0e9d361.yaml
index dd0e4787dc..27c53cd9b9 100644
--- a/releasenotes/notes/bump-min-ansible-ver-a78e7885c0e9d361.yaml
+++ b/releasenotes/notes/bump-min-ansible-ver-a78e7885c0e9d361.yaml
@@ -1,6 +1,5 @@
---
upgrade:
- |
- The minimum supported version of Ansible is now 2.7.
- All the precedent versions are not maintained anymore, version 2.7 grants
- at least security fixes.
\ No newline at end of file
+ The minimum supported version of ``Ansible`` is now ``2.7``.
+ All support for previous Ansible versions is no longer maintained.
diff --git a/releasenotes/notes/image-checksum-recalculation-sha256-fd3d5b4b0b757e86.yaml b/releasenotes/notes/image-checksum-recalculation-sha256-fd3d5b4b0b757e86.yaml
index 1edd2a4839..a72bdbba42 100644
--- a/releasenotes/notes/image-checksum-recalculation-sha256-fd3d5b4b0b757e86.yaml
+++ b/releasenotes/notes/image-checksum-recalculation-sha256-fd3d5b4b0b757e86.yaml
@@ -7,4 +7,5 @@ upgrade:
security:
- |
Image checksum recalculation when images are forced to raw images, are now
- calculated using SHA3-256 if MD5 was selected. This is now unconditional.
+ calculated using ``SHA3-256`` if MD5 was selected.
+ This is now unconditional.
diff --git a/releasenotes/notes/image_checksum_optional-381acf9e441d2a58.yaml b/releasenotes/notes/image_checksum_optional-381acf9e441d2a58.yaml
index 892534b593..0964458d7d 100644
--- a/releasenotes/notes/image_checksum_optional-381acf9e441d2a58.yaml
+++ b/releasenotes/notes/image_checksum_optional-381acf9e441d2a58.yaml
@@ -1,7 +1,7 @@
---
features:
- |
- Adds the cability for the ``instance_info\image_checksum`` value
+ Adds the capability for the ``instance_info\image_checksum`` value
to be optional in stand-alone deployments if the
``instance_info\image_os_hash_algo`` and
``instance_info\image_os_hash_value`` fields are populated.
diff --git a/releasenotes/notes/improve-redfish-set-boot-device-e38e9e9442ab5750.yaml b/releasenotes/notes/improve-redfish-set-boot-device-e38e9e9442ab5750.yaml
index a2ff17280d..a9c735e3fd 100644
--- a/releasenotes/notes/improve-redfish-set-boot-device-e38e9e9442ab5750.yaml
+++ b/releasenotes/notes/improve-redfish-set-boot-device-e38e9e9442ab5750.yaml
@@ -1,7 +1,7 @@
---
features:
- |
- Makes management interface of ``redfish`` hardware type not changing
- current boot frequency if currently set is the same as the desired one.
- The goal is to avoid touching potentially faulty BMC option whenever
- possible.
+ Makes management interface of ``redfish`` hardware type not change the
+ current boot frequency if the current setting is the same as the desired
+ one. The goal is to avoid touching a potentially faulty BMC option
+ whenever possible.
diff --git a/releasenotes/notes/optional-redfish-system-id-3f6e8b0ac989cb9b.yaml b/releasenotes/notes/optional-redfish-system-id-3f6e8b0ac989cb9b.yaml
index 094ec18b89..a6a9ccc30e 100644
--- a/releasenotes/notes/optional-redfish-system-id-3f6e8b0ac989cb9b.yaml
+++ b/releasenotes/notes/optional-redfish-system-id-3f6e8b0ac989cb9b.yaml
@@ -5,6 +5,5 @@ features:
optional. If not specified in ``driver_info``, and the target BMC manages
a single ComputerSystem, ironic will assume that system. Otherwise, ironic
will fail requiring explicit ``redfish_system_id`` specification in
- ``driver_info``. The minimum version for the sushy library is now
- 3.1.0.
+ ``driver_info``.
diff --git a/releasenotes/notes/port-local-link-connection-network-type-71103d919e27fc5d.yaml b/releasenotes/notes/port-local-link-connection-network-type-71103d919e27fc5d.yaml
index 0f68a4e0ab..923e417c12 100644
--- a/releasenotes/notes/port-local-link-connection-network-type-71103d919e27fc5d.yaml
+++ b/releasenotes/notes/port-local-link-connection-network-type-71103d919e27fc5d.yaml
@@ -3,5 +3,5 @@ features:
- |
To allow use of the ``neutron`` network interface in combination with
``flat`` provider networks where no actual switch management is done. The
- `local_link_connection` field on ports is extended to support the
+ ``local_link_connection`` field on ports is extended to support the
``network_type`` field.
diff --git a/releasenotes/notes/redfish-add-root-prefix-03b5f31ec6bbd146.yaml b/releasenotes/notes/redfish-add-root-prefix-03b5f31ec6bbd146.yaml
index beae61f687..ea5c0dd73c 100644
--- a/releasenotes/notes/redfish-add-root-prefix-03b5f31ec6bbd146.yaml
+++ b/releasenotes/notes/redfish-add-root-prefix-03b5f31ec6bbd146.yaml
@@ -1,7 +1,8 @@
---
features:
- |
- Add `root_prefix` parameter to the sushy context based on the path of
- `redfish_address`. Defaults to sushy root_prefix default (`/redfish/v1/`).
+ Adds a ``root_prefix`` parameter to the sushy context based on the path of
+ ``redfish_address``. Defaults to sushy ``root_prefix`` default
+ (``/redfish/v1/``).
This is needed if the Redfish API is not located in the default
- /redfish/v1/ endpoint.
+ ``/redfish/v1/`` endpoint.
diff --git a/releasenotes/notes/rename-iso-builder-func-46694ed6ded84f4a.yaml b/releasenotes/notes/rename-iso-builder-func-46694ed6ded84f4a.yaml
index 8bc40b621f..22401835f8 100644
--- a/releasenotes/notes/rename-iso-builder-func-46694ed6ded84f4a.yaml
+++ b/releasenotes/notes/rename-iso-builder-func-46694ed6ded84f4a.yaml
@@ -1,6 +1,6 @@
---
fixes:
- |
- Renames misleadingly named `images.create_isolinux_image_for_uefi`
- function into `images.create_esp_image_for_uefi`. The new name
+ Renames misleadingly named ``images.create_isolinux_image_for_uefi``
+ function into ``images.create_esp_image_for_uefi``. The new name
reflects what's actually going on under the hood.
diff --git a/releasenotes/notes/use_secrets_to_generate_token-55af0f43e5a80b9e.yaml b/releasenotes/notes/use_secrets_to_generate_token-55af0f43e5a80b9e.yaml
index 473fbd68dc..05b61a2e03 100644
--- a/releasenotes/notes/use_secrets_to_generate_token-55af0f43e5a80b9e.yaml
+++ b/releasenotes/notes/use_secrets_to_generate_token-55af0f43e5a80b9e.yaml
@@ -2,4 +2,4 @@
security:
- |
The secret token that is used for IPA verification will be generated using
- the secrets module to be in compliance with the FIPS 140-2 standard.
+ the secrets module to be in compliance with the ``FIPS 140-2`` standard.