From f1c26abc24d60d68048f98da551bdc26443f4a7b Mon Sep 17 00:00:00 2001 From: Dmitry Tantsur Date: Tue, 9 Jan 2018 15:20:53 +0100 Subject: [PATCH] Clean up release notes before a release Change-Id: I9f1344ce247a82689878c9b5f852f0f802e8247e --- .../ansible-deploy-15da234580ca0c30.yaml | 22 ++++++++-------- ...recate-global-region-4dbea91de71ebf59.yaml | 25 +++---------------- ...cated-inspector-opts-b19a08339712cfd7.yaml | 10 ++++---- ...recated-neutron-opts-2e1d9e65f00301d3.yaml | 16 ++++++------ ...rtbeat_agent_version-70f4e64b19b51d87.yaml | 12 ++++----- ...itional-capabilities-4fd72ba50d05676c.yaml | 20 +++++++++------ .../keystoneauth-config-1baa45a0a2dd93b4.yaml | 22 +++------------- .../wsgi-applications-5d36cf2a8885a56d.yaml | 7 +++--- 8 files changed, 51 insertions(+), 83 deletions(-) diff --git a/releasenotes/notes/ansible-deploy-15da234580ca0c30.yaml b/releasenotes/notes/ansible-deploy-15da234580ca0c30.yaml index 526966e530..db854c40ba 100644 --- a/releasenotes/notes/ansible-deploy-15da234580ca0c30.yaml +++ b/releasenotes/notes/ansible-deploy-15da234580ca0c30.yaml @@ -14,16 +14,14 @@ features: ``ironic-staging-drivers`` project to this ``ansible`` interface, operators have to consider the following differences: - - callback-less operation is not supported - - driver_info fields 'ansible_deploy_username' and - 'ansible_deploy_key_file' are deprecated and will be removed - in the Rocky release, use 'ansible_username' and 'ansible_key_file' - respectively - - base path for playbooks can be defined in driver_info as well - (as 'ansible_playbooks_path' field, defaults to the value of - ``[ansible]/playbooks_path`` from ironic configuration file - - default playbooks for actions and cleaning steps file can be set in + - Callback-less operation is not supported. + - Node's ``driver_info`` fields ``ansible_deploy_username`` and + ``ansible_deploy_key_file`` are deprecated and will be removed + in the Rocky release. Instead, please use ``ansible_username`` and + ``ansible_key_file`` respectively. + - Base path for playbooks can be defined in the node's + ``driver_info['ansible_playbooks_path']`` field. The default is the value + of the ``[ansible]/playbooks_path`` option from the ironic configuration + file. + - Default playbooks for actions and cleaning steps file can be set in ironic configuration file as various ``[ansible]/default_*`` options. - - Please read the ``ansible`` deploy interface documentation for more - information. diff --git a/releasenotes/notes/deprecate-global-region-4dbea91de71ebf59.yaml b/releasenotes/notes/deprecate-global-region-4dbea91de71ebf59.yaml index 8f4166ceec..569e634c4b 100644 --- a/releasenotes/notes/deprecate-global-region-4dbea91de71ebf59.yaml +++ b/releasenotes/notes/deprecate-global-region-4dbea91de71ebf59.yaml @@ -4,25 +4,6 @@ deprecations: Configuration option ``[keystone]/region_name`` is deprecated and will be ignored in the Rocky release. Instead, provide per-service ``region_name`` option in the following - configuration file sections: - - - service_catalog (for ironic API discovery from keystone service catalog) - - glance - - neutron - - cinder - - inspector - - swift - -upgrade: - - | - Configuration option ``[keystone]/region_name`` is deprecated - and will be ignored in the Rocky release. - Instead, provide per-service ``region_name`` option in the following - configuration file sections: - - - service_catalog (for ironic API discovery from keystone service catalog) - - glance - - neutron - - cinder - - inspector - - swift + configuration file sections: ``[service_catalog]`` (for bare metal API + endpoint discovery from keystone service catalog), ``[glance]``, + ``[neutron]``, ``[cinder]``, ``[inspector]`` and ``[swift]``. diff --git a/releasenotes/notes/deprecated-inspector-opts-b19a08339712cfd7.yaml b/releasenotes/notes/deprecated-inspector-opts-b19a08339712cfd7.yaml index b1603cc722..01e4274ff1 100644 --- a/releasenotes/notes/deprecated-inspector-opts-b19a08339712cfd7.yaml +++ b/releasenotes/notes/deprecated-inspector-opts-b19a08339712cfd7.yaml @@ -4,14 +4,14 @@ deprecations: Configuration option ``[inspector]/service_url`` is deprecated and will be ignored in the Rocky release. Instead, use ``[inspector]/endpoint_override`` configuration option to set - specific ironic-inspector api address when automatic discovery of - inspector API endpoint from keystone catalog is not desired. + the specific ironic-inspector API endpoint when its automatic discovery + from the keystone catalog is not desired. This new option has no default value (``None``) and must be set explicitly. - | Relying on the value of ``[DEFAULT]/auth_strategy`` configuration option to - configure usage of standalone mode for inspector client is deprecated and + configure usage of standalone mode for ironic-inspector is deprecated and will be impossible the the Rocky release. Instead, set ``[inspector]/auth_type`` configuration option to ``none`` and - provide the inspector API address as ``[inspector]/endpoint_override`` - configuration option. + provide the ironic-inspector inspector API address as + ``[inspector]/endpoint_override`` configuration option. diff --git a/releasenotes/notes/deprecated-neutron-opts-2e1d9e65f00301d3.yaml b/releasenotes/notes/deprecated-neutron-opts-2e1d9e65f00301d3.yaml index dd280e24ba..b5683df5e4 100644 --- a/releasenotes/notes/deprecated-neutron-opts-2e1d9e65f00301d3.yaml +++ b/releasenotes/notes/deprecated-neutron-opts-2e1d9e65f00301d3.yaml @@ -34,14 +34,14 @@ other: The functions/methods in question are: - - ``ironic.common.neutron.get_client`` - - ``ironic.common.neutron.unbind_neutron_port`` - - ``ironic.common.neutron.update_port_address`` - - ``ironic.common.neutron.validate_network`` - - ``ironic.common.neutron.NeutronNetworkInterfaceMixin.get_cleaning_network`` - - ``ironic.common.neutron.NeutronNetworkInterfaceMixin.get_provisioning_network`` - - ``ironic.dhcp.neutron.NeutronDHCPApi.update_port_dhcp_opts`` - - ``ironic.dhcp.none.NeutronDHCPApi.update_port_dhcp_opts`` + - ``ironic.common.neutron.get_client`` + - ``ironic.common.neutron.unbind_neutron_port`` + - ``ironic.common.neutron.update_port_address`` + - ``ironic.common.neutron.validate_network`` + - ``ironic.common.neutron.NeutronNetworkInterfaceMixin.get_cleaning_network`` + - ``ironic.common.neutron.NeutronNetworkInterfaceMixin.get_provisioning_network`` + - ``ironic.dhcp.neutron.NeutronDHCPApi.update_port_dhcp_opts`` + - ``ironic.dhcp.none.NeutronDHCPApi.update_port_dhcp_opts`` If you are using any of the above functions/methods in your out-of-tree ironic driver or driver interface code, you should update the code diff --git a/releasenotes/notes/heartbeat_agent_version-70f4e64b19b51d87.yaml b/releasenotes/notes/heartbeat_agent_version-70f4e64b19b51d87.yaml index 48ddc70cde..e7a78cdc0e 100644 --- a/releasenotes/notes/heartbeat_agent_version-70f4e64b19b51d87.yaml +++ b/releasenotes/notes/heartbeat_agent_version-70f4e64b19b51d87.yaml @@ -1,8 +1,8 @@ --- other: - - The agent heartbeat API (POST /v1/heartbeat/) can now receive a new - ``agent_version`` parameter. If received this will be stored in the node's - driver_internal_info['agent_version'] field. This information will be used - by the Bare Metal service to gracefully degrade support for agent features - that are requested by the Bare Metal service, ensuring that we don't - request a feature that an older ramdisk doesn't support. + - The agent heartbeat API (POST ``/v1/heartbeat/``) can now receive + a new ``agent_version`` parameter. If received, this will be stored in the + node's ``driver_internal_info['agent_version']`` field. This information + will be used by the Bare Metal service to gracefully degrade support for + agent features that are requested by the Bare Metal service, ensuring that + we don't request a feature that an older ramdisk doesn't support. diff --git a/releasenotes/notes/irmc-additional-capabilities-4fd72ba50d05676c.yaml b/releasenotes/notes/irmc-additional-capabilities-4fd72ba50d05676c.yaml index 26b73e8305..65aea55000 100644 --- a/releasenotes/notes/irmc-additional-capabilities-4fd72ba50d05676c.yaml +++ b/releasenotes/notes/irmc-additional-capabilities-4fd72ba50d05676c.yaml @@ -1,13 +1,17 @@ --- features: - | - Adds new capabilities (``server_model``, ``rom_firmware_version``, ``pci_gpu_devices``, - ``trusted_boot`` and ``irmc_firmware_version``) to the iRMC out-of-band hardware inspection - for FUJITSU PRIMERGY bare metal nodes with firmware iRMC S4 and beyond. - Before inspecting, if a server is powered off, it will be turned on automatically. - After inspection, power status will be restored to the previous state. + Adds new capabilities (``server_model``, ``rom_firmware_version``, + ``pci_gpu_devices``, ``trusted_boot`` and ``irmc_firmware_version``) to + the iRMC out-of-band hardware inspection for FUJITSU PRIMERGY bare metal + nodes with firmware iRMC S4 and newer. +other: + - | + During the out-of-band inspection for nodes using the ``irmc`` hardware + type, nodes will be powered on. The original power state will be restored + after inspection is finished. upgrade: - | - Update of python-scciclient to version 0.6.0 is required by the iRMC driver to support - new out-of-band inspection capabilities. If the version is not updated, the new - capabilities will not be updated. + *python-scciclient* of version 0.6.0 or newer is required by the ``irmc`` + hardware type to support new out-of-band inspection capabilities. If an + older version is used, the new capabilities will not be discovered. diff --git a/releasenotes/notes/keystoneauth-config-1baa45a0a2dd93b4.yaml b/releasenotes/notes/keystoneauth-config-1baa45a0a2dd93b4.yaml index 5d9ad4d4cf..6a64de0324 100644 --- a/releasenotes/notes/keystoneauth-config-1baa45a0a2dd93b4.yaml +++ b/releasenotes/notes/keystoneauth-config-1baa45a0a2dd93b4.yaml @@ -1,22 +1,6 @@ --- features: - | - Adds the ability to set keystoneauth settings in the - ``[glance]`` configuration section for service automatic - discovery. - - | - Adds the ability to set keystoneauth settings in the - ``[cinder]`` configuration section for service automatic - discovery. - - | - Adds the ability to set keystoneauth settings in the - ``[inspector]`` configuration section for service automatic - discovery. - - | - Adds the ability to set keystoneauth settings in the - ``[swift]`` configuration section for service automatic - discovery. - - | - Adds the ability to set keystoneauth settings in the - ``[neutron]`` configuration section for service automatic - discovery. + Adds the ability to set keystoneauth settings for automatic service + discovery in the following configuration sections: ``[glance]``, + ``[cinder]``, ``[inspector]``, ``[swift]`` and ``[neutron]``. diff --git a/releasenotes/notes/wsgi-applications-5d36cf2a8885a56d.yaml b/releasenotes/notes/wsgi-applications-5d36cf2a8885a56d.yaml index 06f75cbbfa..5c5aa142f5 100644 --- a/releasenotes/notes/wsgi-applications-5d36cf2a8885a56d.yaml +++ b/releasenotes/notes/wsgi-applications-5d36cf2a8885a56d.yaml @@ -1,8 +1,9 @@ --- upgrade: - - An Ironic API WSGI application script ``ironic-api-wsgi`` is now available. - It is auto-generated by ``pbr`` and allows to run the API service - using WSGI server (for example Nginx and uWSGI or Apache with mod_wsgi). + - A new WSGI application script ``ironic-api-wsgi`` is now available. + It is auto-generated by ``pbr`` and provides the ability to serve + the bare metal API using a WSGI server (for example Nginx and uWSGI or + Apache with mod_wsgi). deprecations: - Using ``ironic/api/app.wsgi`` script is deprecated and it will be removed in Rocky release.