From 0fe585ac7c1e8b8e068d6ae0da00edc3da9a4c6c Mon Sep 17 00:00:00 2001 From: Jim Rollenhagen Date: Mon, 8 Aug 2016 21:09:13 -0400 Subject: [PATCH] Clean up release notes for 6.1.0 This corrects some typos, some grammar, and makes formatting of notes generally more consistent. Change-Id: Ic6b48a1877a9b142a4dd1df2ae22342eef99bc76 --- ...agent-erase-fallback-b07613a7042fe236.yaml | 2 +- ...c-allocation-feature-2fd6b4df7943f178.yaml | 2 +- ...-node-resource-class-c31e26df4196293e.yaml | 4 +-- ...cat-console-ipmitool-ab4402ec976c5c96.yaml | 4 +-- ...ing-audit-middleware-b95f2a00baed9750.yaml | 11 +++++--- .../notes/agent-api-bf9f18d8d38075e4.yaml | 6 ++--- .../notes/bug-1592335-7c5835868fe364ea.yaml | 6 ++--- ...lect-deployment-logs-2ec1634847c3f6a5.yaml | 20 +++++++++----- ...etrics-for-api-calls-69f18fd1b9d54b05.yaml | 6 ++--- ...vice-priority-config-509661955a11c28e.yaml | 6 ++--- ...ement-policy-in-code-cbb0216ef5f8224f.yaml | 8 +++--- .../notes/keystone-auth-3155762c524e44df.yaml | 26 ++++++++++++------- .../lookup-heartbeat-f9772521d12a0549.yaml | 6 ++--- ...ate-ilo-certificates-3ab98bb8cfad7d60.yaml | 7 +++-- 14 files changed, 65 insertions(+), 49 deletions(-) diff --git a/releasenotes/notes/add-agent-erase-fallback-b07613a7042fe236.yaml b/releasenotes/notes/add-agent-erase-fallback-b07613a7042fe236.yaml index 3471b16f9b..20a07048cc 100644 --- a/releasenotes/notes/add-agent-erase-fallback-b07613a7042fe236.yaml +++ b/releasenotes/notes/add-agent-erase-fallback-b07613a7042fe236.yaml @@ -8,7 +8,7 @@ features: normal circumstances, the failure of an ATA secure erase operation results in the node being put in ``clean failed`` state. -upgrades: +upgrade: - A new configuration option ``[deploy]continue_if_disk_secure_erase_fails``, which has a default value of False, has been added. The default diff --git a/releasenotes/notes/add-dynamic-allocation-feature-2fd6b4df7943f178.yaml b/releasenotes/notes/add-dynamic-allocation-feature-2fd6b4df7943f178.yaml index 119a155931..2f0aa9a6a5 100644 --- a/releasenotes/notes/add-dynamic-allocation-feature-2fd6b4df7943f178.yaml +++ b/releasenotes/notes/add-dynamic-allocation-feature-2fd6b4df7943f178.yaml @@ -1,5 +1,5 @@ --- features: - - Add Dynamic Allocation feature for the OneView drivers. + - Adds Dynamic Allocation feature for the OneView drivers. deprecations: - Deprecates pre-allocation feature for the OneView drivers. diff --git a/releasenotes/notes/add-node-resource-class-c31e26df4196293e.yaml b/releasenotes/notes/add-node-resource-class-c31e26df4196293e.yaml index d52eca3d25..32602ee837 100644 --- a/releasenotes/notes/add-node-resource-class-c31e26df4196293e.yaml +++ b/releasenotes/notes/add-node-resource-class-c31e26df4196293e.yaml @@ -1,12 +1,12 @@ --- features: - - Adds a `resource_class` field to the node resource, + - Adds a ``resource_class`` field to the node resource, which will be used by Nova to define which nodes may quantitatively match a Nova flavor. Operators should populate this accordingly before deploying the Ocata version of Nova. upgrade: - - Adds a `resource_class` field to the node resource, + - Adds a ``resource_class`` field to the node resource, which will be used by Nova to define which nodes may quantitatively match a Nova flavor. Operators should populate this accordingly before deploying the Ocata diff --git a/releasenotes/notes/add-socat-console-ipmitool-ab4402ec976c5c96.yaml b/releasenotes/notes/add-socat-console-ipmitool-ab4402ec976c5c96.yaml index 3fbc66ab99..9b6e923779 100644 --- a/releasenotes/notes/add-socat-console-ipmitool-ab4402ec976c5c96.yaml +++ b/releasenotes/notes/add-socat-console-ipmitool-ab4402ec976c5c96.yaml @@ -1,5 +1,5 @@ --- features: - Adds support for socat-based serial console to ipmitool-based drivers. - These are available by using the agent_ipmitool_socat and - pxe_ipmitool_socat drivers. + These are available by using the ``agent_ipmitool_socat`` and + ``pxe_ipmitool_socat`` drivers. diff --git a/releasenotes/notes/adding-audit-middleware-b95f2a00baed9750.yaml b/releasenotes/notes/adding-audit-middleware-b95f2a00baed9750.yaml index ef804c304e..31b0833e18 100644 --- a/releasenotes/notes/adding-audit-middleware-b95f2a00baed9750.yaml +++ b/releasenotes/notes/adding-audit-middleware-b95f2a00baed9750.yaml @@ -2,9 +2,12 @@ features: - | The ironic-api service now supports logging audit messages of - api calls. The following configuration parameters have been added. + API calls. The following configuration parameters have been added. By default auditing of ironic-api service is turned off. - * [audit]/enabled - * [audit]/ignore_req_list - * [audit]/audit_map_file + * ``[audit]/enabled`` + * ``[audit]/ignore_req_list`` + * ``[audit]/audit_map_file`` + + Further documentation for this feature is available at + http://docs.openstack.org/developer/ironic/deploy/api-audit-support.html. diff --git a/releasenotes/notes/agent-api-bf9f18d8d38075e4.yaml b/releasenotes/notes/agent-api-bf9f18d8d38075e4.yaml index 6cc426f406..6d262316c3 100644 --- a/releasenotes/notes/agent-api-bf9f18d8d38075e4.yaml +++ b/releasenotes/notes/agent-api-bf9f18d8d38075e4.yaml @@ -1,5 +1,5 @@ --- other: - - The "continue_deploy" and "reboot_to_instance" methods in the - "BaseAgentVendor" class stopped accepting ** arguments. They were never - used anyway; the drivers should stop passing anything there. + - The ``continue_deploy`` and ``reboot_to_instance`` methods in the + ``BaseAgentVendor`` class stopped accepting ** arguments. They were never + used anyway; drivers should stop passing anything there. diff --git a/releasenotes/notes/bug-1592335-7c5835868fe364ea.yaml b/releasenotes/notes/bug-1592335-7c5835868fe364ea.yaml index 371d9eb317..3eabc45b5e 100644 --- a/releasenotes/notes/bug-1592335-7c5835868fe364ea.yaml +++ b/releasenotes/notes/bug-1592335-7c5835868fe364ea.yaml @@ -1,5 +1,5 @@ --- fixes: - - A node using 'agent_ilo' or 'iscsi_ilo' driver has - their 'driver_info/ilo_deploy_iso' field validated - during node validate. This closes bug #1592335. + - A node using the ``agent_ilo`` or ``iscsi_ilo`` driver now has + its ``driver_info/ilo_deploy_iso`` field validated + during node validation. diff --git a/releasenotes/notes/collect-deployment-logs-2ec1634847c3f6a5.yaml b/releasenotes/notes/collect-deployment-logs-2ec1634847c3f6a5.yaml index f2795b5d64..bec89d5b05 100644 --- a/releasenotes/notes/collect-deployment-logs-2ec1634847c3f6a5.yaml +++ b/releasenotes/notes/collect-deployment-logs-2ec1634847c3f6a5.yaml @@ -1,12 +1,18 @@ --- features: - - Adds support for collecting deployment logs from the IPA - ramdisk. Five new configuration options were added, [agent]/group - deploy_logs_collect, [agent]deploy_logs_storage_backend, - [agent]/deploy_logs_local_path, [agent]/deploy_logs_swift_container and - [agent]/deploy_logs_swift_days_to_expire. -upgrades: + - | + Adds support for collecting deployment logs from the IPA + ramdisk. Five new configuration options were added: + + * ``[agent]/deploy_logs_collect`` + * ``[agent]/deploy_logs_storage_backend`` + * ``[agent]/deploy_logs_local_path`` + * ``[agent]/deploy_logs_swift_container`` + * ``[agent]/deploy_logs_swift_days_to_expire``. +upgrade: - Collecting logs on deploy failure is enabled by default and the logs - will be saved to the local disk. Operators upgrading may want to disable + will be saved to the local disk at the location specified by the + configuration option ``[agent]/deploy_logs_local_path`` (by default, + ``/var/log/ironic/deploy``). Operators upgrading may want to disable this feature, enable some form of rotation for the logs or change the configuration to store the logs in Swift to avoid disk space problems. diff --git a/releasenotes/notes/emit-metrics-for-api-calls-69f18fd1b9d54b05.yaml b/releasenotes/notes/emit-metrics-for-api-calls-69f18fd1b9d54b05.yaml index 2397950fd1..09edaa2065 100644 --- a/releasenotes/notes/emit-metrics-for-api-calls-69f18fd1b9d54b05.yaml +++ b/releasenotes/notes/emit-metrics-for-api-calls-69f18fd1b9d54b05.yaml @@ -1,5 +1,5 @@ --- features: - - With this change, ironic now emits timing metrics - for all API methods to statsd, if enabled by config - in the [metrics] and [metrics_statsd] sections. + - Ironic now emits timing metrics for all API methods to statsd, + if enabled by the ``[metrics]`` and ``[metrics_statsd]`` configuration + sections. diff --git a/releasenotes/notes/ilo-erase-device-priority-config-509661955a11c28e.yaml b/releasenotes/notes/ilo-erase-device-priority-config-509661955a11c28e.yaml index 24f2231405..690fe7670b 100644 --- a/releasenotes/notes/ilo-erase-device-priority-config-509661955a11c28e.yaml +++ b/releasenotes/notes/ilo-erase-device-priority-config-509661955a11c28e.yaml @@ -1,5 +1,5 @@ --- deprecations: - - The [ilo]/clean_priority_erase_devices config is deprecated and will be - removed in the Ocata cycle. Please use the [deploy]/erase_devices_priority - config instead. + - The ``[ilo]/clean_priority_erase_devices`` configuration option is + deprecated and will be removed in the Ocata cycle. Please use the + ``[deploy]/erase_devices_priority`` option instead. diff --git a/releasenotes/notes/implement-policy-in-code-cbb0216ef5f8224f.yaml b/releasenotes/notes/implement-policy-in-code-cbb0216ef5f8224f.yaml index 6755307f9f..579444bd19 100644 --- a/releasenotes/notes/implement-policy-in-code-cbb0216ef5f8224f.yaml +++ b/releasenotes/notes/implement-policy-in-code-cbb0216ef5f8224f.yaml @@ -15,8 +15,8 @@ security: upgrade: - | During an upgrade, it is recommended that all deployers re-evaluate the - settings in their /etc/ironic/policy.json file. This file should now be + settings in their ``/etc/ironic/policy.json`` file. This file should now be used only to override default configuration, such as by limiting access to - the Bare Metal service to specific tenants or restricting access to - specific API endpoints. A policy.json.sample file is provided that lists - all supported policies. + the ironic service to specific tenants or restricting access to + specific API endpoints. A ``policy.json.sample`` file is provided that + lists all supported policies. diff --git a/releasenotes/notes/keystone-auth-3155762c524e44df.yaml b/releasenotes/notes/keystone-auth-3155762c524e44df.yaml index 36e4ad614f..61d7b593cd 100644 --- a/releasenotes/notes/keystone-auth-3155762c524e44df.yaml +++ b/releasenotes/notes/keystone-auth-3155762c524e44df.yaml @@ -1,12 +1,12 @@ --- upgrade: - | - New way of configuring access credentials for OpenStack services clients. - For each service both Keystone session options + Changes the way to configure access credentials for OpenStack services + clients. For each service, both Keystone session options (timeout, SSL-related ones) and Keystone auth_plugin options (auth_url, auth_type and corresponding auth_plugin options) - should be specified in the config section for this service. - Config section affected are + should be specified in the configuration section for this service. + Configuration sections affected are: * ``[neutron]`` for Neutron service user * ``[glance]`` for Glance service user @@ -19,23 +19,31 @@ upgrade: Backward-compatible options handling is provided using values from ``[keystone_authtoken]`` config section, - but operators are advised to switch to the new config options. + but operators are advised to switch to the new config options as the + old options are deprecated. The old options will be removed during the + Ocata cycle. For more information on sessions, auth plugins and their settings, - please refer to _http://docs.openstack.org/developer/keystoneauth/ + please refer to http://docs.openstack.org/developer/keystoneauth/. - | - Small change in semantics of default for ``[neutron]url`` option + Small change in semantics of default for ``[neutron]/url`` option * default is changed to None. - * In case when [neutron]auth_strategy is ``noauth``, + * For the case when ``[neutron]/auth_strategy`` is ``noauth``, default means use ``http://$my_ip:9696``. - * In case when [neutron]auth_strategy is ``keystone``, + * For the case when ``[neutron]/auth_strategy`` is ``keystone``, default means to resolve the endpoint from Keystone Catalog. - New config section ``[service_catalog]`` for access credentials used to discover Ironic API URL from Keystone Catalog. Previously credentials from ``[keystone_authtoken]`` section were used, which is now deprecated for such purpose. +deprecations: + - The ``[keystone_authtoken]`` configuration section is deprecated for + configuring clients for other services (but is still used for configuring + API token authentication), in favor of the ``[service_catalog]`` section. + The ability to configure clients for other services via the + ``[keystone_authtoken]`` section will be removed during the Ocata cycle. fixes: - Do not rely on keystonemiddleware config options for instantiating clients for other OpenStack services. diff --git a/releasenotes/notes/lookup-heartbeat-f9772521d12a0549.yaml b/releasenotes/notes/lookup-heartbeat-f9772521d12a0549.yaml index f4ec0cd6fd..e854f7a8b8 100644 --- a/releasenotes/notes/lookup-heartbeat-f9772521d12a0549.yaml +++ b/releasenotes/notes/lookup-heartbeat-f9772521d12a0549.yaml @@ -7,10 +7,10 @@ features: This endpoint is not authenticated to allow ramdisks to access it without passing the credentials to them. deprecations: - - The configuration option ``[agent]heartbeat_timeout`` was renamed to - ``[api]ramdisk_heartbeat_timeout``. The old variant is deprecated. + - The configuration option ``[agent]/heartbeat_timeout`` was renamed to + ``[api]/ramdisk_heartbeat_timeout``. The old variant is deprecated. upgrade: - - A new configuration option ``[api]restrict_lookup`` is added, which + - A new configuration option ``[api]/restrict_lookup`` is added, which restricts the lookup API (normally only used by ramdisks) to only work when the node is in specific states used by the ramdisk, and defaults to True. Operators that need this endpoint to work in any state may set this to diff --git a/releasenotes/notes/validate-ilo-certificates-3ab98bb8cfad7d60.yaml b/releasenotes/notes/validate-ilo-certificates-3ab98bb8cfad7d60.yaml index 9d9d7d1abf..7bfdd026f3 100644 --- a/releasenotes/notes/validate-ilo-certificates-3ab98bb8cfad7d60.yaml +++ b/releasenotes/notes/validate-ilo-certificates-3ab98bb8cfad7d60.yaml @@ -1,8 +1,7 @@ --- features: - Added support to validate iLO SSL certificate in iLO - drivers. - New config parameter '[ilo]/ca_file' added to - specify iLO CA certificate file. - If 'ca_file' is specified, iLO drivers will validate + drivers. A new configuration option ``[ilo]/ca_file`` is added to + specify the iLO CA certificate file. + If ``[ilo]/ca_file`` is specified, the iLO drivers will validate iLO SSL certificates.