Clean up release notes before a release

Also add a prelude for the whole Queens release.

Change-Id: I689e9f4f8d6a7c1877cf39ba0e6e232a20930e90
This commit is contained in:
Dmitry Tantsur 2018-02-07 16:14:03 +01:00 committed by Ruby Loo
parent abb14290fb
commit 3aaf4922f1
7 changed files with 104 additions and 83 deletions

View File

@ -1,8 +1,6 @@
---
other:
- |
Adds new method ``validate_rescue()`` to network interface to validate
Adds new method ``validate_rescue()`` to ``NetworkInterface`` to validate
rescuing network. This method is called during validation of rescue
interface. This fixes the `validation of rescuing network based on
network type in rescue interface
<https://bugs.launchpad.net/ironic/+bug/1747100>`_.
interface.

View File

@ -1,12 +1,4 @@
---
prelude: >
This release deprecates classic drivers in favor of hardware types. Please
check `the migration guide
<https://docs.openstack.org/ironic/latest/admin/upgrade-to-hardware-types.html>`_
for information on which hardware types and interfaces to enable before
upgrade and how to update the nodes. The ``ironic-dbsync
online_data_migrations`` command will handle the migration, if all
required hardware types and interfaces are enabled before the upgrade.
deprecations:
- |
The classic drivers, as well as the ``enabled_drivers`` configuration

View File

@ -1,9 +1,5 @@
---
features:
- Enhanced boot interface 'ilo-pxe' and 'ilo-virtual-media' to support
firmware based booting from iSCSI volume in UEFI boot mode.
upgrade:
- The ``update_persistent_boot`` and ``[un]set_iscsi_info`` interfaces
of 'proliantutils' library has been enhanced to support booting from
an iSCSI volume. To leverage this feature, the 'proliantutils' library
needs to be upgraded to version '2.5.0'.
- The ``ilo-pxe`` and ``ilo-virtual-media`` boot interfaces now support
firmware-based booting from iSCSI volume in UEFI boot mode.
Requires **proliantutils** library version 2.5.0 or newer.

View File

@ -2,32 +2,34 @@
features:
- Adds support for `routed networks
<https://docs.openstack.org/neutron/latest/admin/config-routed-networks>`_
when using ``flat`` network interfaces. This feature requires the
``baremetal`` ml2 mechanism driver and l2 agent in
`openstack/networking-baremetal
<https://docs.openstack.org/networking-baremetal>`_.
when using the ``flat`` network interface. This feature requires the
``baremetal`` ML2 mechanism driver and L2 agent from the
`networking-baremetal <https://docs.openstack.org/networking-baremetal>`_
plugin. See the `networking configuration documentation
<https://docs.openstack.org/ironic/latest/install/configure-networking.html>`_
for more details.
upgrade:
- |
The ``baremetal`` ml2 mechanism driver and l2 agent is now recommended for
use with the ``flat`` network interface. When installed, the ``baremetal``
The ``baremetal`` ML2 mechanism driver and L2 agent should now be used
with the ``flat`` network interface. When installed, the ``baremetal``
mechanism driver and agent ensure that ports are properly bound in the
Networking service. Installation and configuration of the ml2 components
are documented `here <https://docs.openstack.org/networking-baremetal>`_.
Networking service. Installation and configuration of the ML2 components
are documented in the `networking-baremetal project documentation
<https://docs.openstack.org/networking-baremetal>`_.
In a configuration without the ml2 mechanism driver and l2 agent, the
Networking service's ports will not be correctly bound. In the Networking
service ports will have status: ``DOWN``, and binding_vif_type:
``binding_failed``. This was always the status for ironic ``flat`` network
interface ports prior to the introduction of the ``baremetal`` mechanism
driver. For a non-routed network, Bare Metal nodes can still be deployed
and are functional, despite this port binding state in the Networking
service.
Without the ML2 mechanism driver and L2 agent, the Networking service's
ports will not be correctly bound. In the Networking
service, ports will have a ``DOWN`` status, and the ``binding_vif_type``
field equal to ``binding_failed``. This was always the status for the
``flat`` network interface ports prior to the introduction of the
``baremetal`` mechanism driver. For a non-routed network, bare metal nodes
can still be deployed and are functional, despite this port binding state
in the Networking service.
fixes:
- For the ``flat`` networking interface, fixes an issue where the Networking
service would reject port bindings because no host would match the
*host-id* used in such configurations. The ``flat`` networking interface no
- Fixes an issue where the Networking service would reject port bindings
with the ``flat`` network interface because no host would match the
*host-id* used in such configurations. The ``flat`` network interface no
longer requires a networking agent (such as ``neutron-openvswitch-agent``)
to be run on the ``nova-compute`` proxy node which executes the ironic virt
driver. Instead, the interface uses the
`baremetal mechanism driver
driver. Instead, the interface uses the `baremetal mechanism driver
<https://docs.openstack.org/networking-baremetal>`_.

View File

@ -1,14 +0,0 @@
---
features:
- |
Adds rescue interface field to node-related notifications.
Affected notifications are:
* baremetal.node.create.*, new payload version 1.3
* baremetal.node.update.*, new payload version 1.3
* baremetal.node.delete.*, new payload version 1.3
* baremetal.node.maintenance.*, new payload version 1.5
* baremetal.node.console.*, new payload version 1.5
* baremetal.node.power_set.*, new payload version 1.5
* baremetal.node.power_state_corrected.*, new payload version 1.5
* baremetal.node.provision_set.*, new payload version 1.5

View File

@ -0,0 +1,31 @@
---
prelude: |
The 10.1.0 (Queens) release includes many new features and bug fixes.
Please review the "Upgrade Notes" sections (for 9.2.0, 10.0.0 and 10.1.0)
which describe the required actions to upgrade your installation from
9.1.x (Pike) to 10.1.0 (Queens).
A few major changes since 9.1.x (Pike) are worth mentioning:
- New `traits API
<https://developer.openstack.org/api-ref/baremetal/#node-traits-nodes>`_.
- New ``ansible`` deploy interface that allows greater customization of
the provisioning process.
- Support for rescuing and unrescuing nodes.
- Support for `routed networks
<https://docs.openstack.org/neutron/latest/admin/config-routed-networks>`_
when using the ``flat`` network interface.
- New ``xclarity`` hardware type for managing Lenovo server hardware.
Finally, this release deprecates classic drivers in favor of hardware
types. Please check `the migration guide
<https://docs.openstack.org/ironic/latest/admin/upgrade-to-hardware-types.html>`_
for information on which hardware types and interfaces to enable before
upgrade and how to update the nodes. The ``ironic-dbsync
online_data_migrations`` command will handle the migration, if all
required hardware types and interfaces are enabled before the upgrade.

View File

@ -1,39 +1,55 @@
---
features:
- |
Adds version 1.38 of the Bare Metal API, which provides supports for
rescuing (and unrescuing) a node. This includes:
Adds support for rescuing and unrescuing nodes:
* A node in the ``active`` provision state can be rescued via the
``GET /v1/nodes/{node_ident}/states/provision`` API, by specifying
``rescue`` as the ``target`` value, and a ``rescue_password``
value. When the node has been rescued, it will be in the ``rescue``
provision state. A rescue ramdisk will be running, configured with
the specified ``rescue_password``, and listening with ssh on the
tenant network.
- Adds version 1.38 of the Bare Metal API, which includes:
* A node in the ``rescue`` provision state can be unrescued (to the
``active`` state) via the
``GET /v1/nodes/{node_ident}/states/provision`` API, by specifying
``unrescue`` as the ``target`` value.
* A node in the ``active`` provision state can be rescued via the
``GET /v1/nodes/{node_ident}/states/provision`` API, by specifying
``rescue`` as the ``target`` value, and a ``rescue_password``
value. When the node has been rescued, it will be in the ``rescue``
provision state. A rescue ramdisk will be running, configured with
the specified ``rescue_password``, and listening with ssh on the
tenant network.
* The ``rescue_interface`` field of the node resource. A rescue
interface can be set when creating or updating a node.
* A node in the ``rescue`` provision state can be unrescued (to the
``active`` state) via the
``GET /v1/nodes/{node_ident}/states/provision`` API, by specifying
``unrescue`` as the ``target`` value.
* It also exposes ``default_rescue_interface`` and
``enable_rescue_interfaces`` fields of the driver resource.
* The ``rescue_interface`` field of the node resource. A rescue
interface can be set when creating or updating a node.
* Adds new configuration options ``[DEFAULT]/enabled_rescue_interfaces``
and ``[DEFAULT]/default_rescue_interface``. Rescue interfaces are
enabled via the ``[DEFAULT]/enabled_rescue_interfaces``. A default
rescue interface to use when creating or updating nodes can be
specified with the ``[DEFAULT]/enabled_rescue_interfaces``.
* The ``default_rescue_interface`` and ``enabled_rescue_interfaces``
fields of the driver resource.
* Adds new options ``[conductor]/check_rescue_state_interval`` and
``[conductor]/rescue_callback_timeout`` to fail the rescue operation
upon timeout, for the nodes that are stuck in the rescue wait state.
- Adds new configuration options for the rescue feature:
* Adds support for providing separate ``rescuing`` network with its
security groups using new options ``[neutron]/rescuing_network`` and
``[neutron]/rescuing_network_security_groups`` respectively. It is
required to provide ``[neutron]/rescuing_network``.
* Rescue interfaces are enabled via
``[DEFAULT]/enabled_rescue_interfaces``. A default rescue interface
to use when creating or updating nodes can be specified with
``[DEFAULT]/enabled_rescue_interfaces``.
* Adds ``[conductor]/check_rescue_state_interval`` and
``[conductor]/rescue_callback_timeout`` to fail the rescue operation
upon timeout, for the nodes that are stuck in the rescue wait state.
* Adds support for providing ``rescuing`` network (UUIR or name) with its
security groups using new options ``[neutron]/rescuing_network`` and
``[neutron]/rescuing_network_security_groups`` respectively. It is
required to provide ``[neutron]/rescuing_network``. Alternatively,
the rescuing network can be provided per node via the node's
``driver_info['rescuing_network']`` field.
- Adds ``rescue_interface`` field to the following node-related
notifications:
* ``baremetal.node.create.*``, new payload version 1.3
* ``baremetal.node.update.*``, new payload version 1.3
* ``baremetal.node.delete.*``, new payload version 1.3
* ``baremetal.node.maintenance.*``, new payload version 1.5
* ``baremetal.node.console.*``, new payload version 1.5
* ``baremetal.node.power_set.*``, new payload version 1.5
* ``baremetal.node.power_state_corrected.*``, new payload version 1.5
* ``baremetal.node.provision_set.*``, new payload version 1.5