From 47376816753ecb81cba4c3f18356c2e161f4b6c7 Mon Sep 17 00:00:00 2001 From: Miles Gould Date: Mon, 13 Feb 2017 13:19:45 +0000 Subject: [PATCH] Improve grammar/readability in Ocata release notes Change-Id: I00829cd4e3f1684e0f385484e116387b7bb61cd3 --- ..._start_if_ironic_api_invalid-7b78fcaba2141cc5.yaml | 9 +++++---- releasenotes/notes/handle-ssl-063a91fb7bdcf9b9.yaml | 11 ++++++----- releasenotes/notes/ipv6-listen-85d40e58156e398f.yaml | 4 ++-- .../notes/ipv6-provision-42e9000f6f6a7a3a.yaml | 4 ++-- .../limit-qemu-img-ram-usage-d7b7a16ac5e9c917.yaml | 2 +- .../notes/lldp-error-handling-5b6576b378ef9c3a.yaml | 2 +- .../notes/no-bash-for-grub-c38369af8cc7cf26.yaml | 4 ++-- .../notes/oslo-config-generator-b0f70b9fb7e23997.yaml | 2 +- ...t_descr-switch_chassis_descr-40f2bb37b5f1fdd1.yaml | 4 ++-- ...eat-if-apiurl-not-configured-5ae8b04ae1e74673.yaml | 2 +- .../notes/uefi-fallback-266c647f6aff58fd.yaml | 6 +++--- 11 files changed, 26 insertions(+), 24 deletions(-) diff --git a/releasenotes/notes/fail_ipa_start_if_ironic_api_invalid-7b78fcaba2141cc5.yaml b/releasenotes/notes/fail_ipa_start_if_ironic_api_invalid-7b78fcaba2141cc5.yaml index 2f4ca3010..a1bbef486 100644 --- a/releasenotes/notes/fail_ipa_start_if_ironic_api_invalid-7b78fcaba2141cc5.yaml +++ b/releasenotes/notes/fail_ipa_start_if_ironic_api_invalid-7b78fcaba2141cc5.yaml @@ -1,8 +1,9 @@ --- fixes: - - Accepting ``ipa-api-url`` value specified in the configuration - file that does not start with either ``https://`` or ``http://``. - Such value leads failure while contacting ironic-api. - This misconfiguration will be detected on ironic-python-agent start. + - Values of ``ipa-api-url`` specified in the configuration + file that do not start with either ``https://`` or ``http://`` are no + longer accepted. + Such values lead to failure while contacting ironic-api. + Such misconfigurations will be detected on ironic-python-agent start. An exception will be raised and an error about the invalid value will be logged. diff --git a/releasenotes/notes/handle-ssl-063a91fb7bdcf9b9.yaml b/releasenotes/notes/handle-ssl-063a91fb7bdcf9b9.yaml index 9115db150..d8dfa83bd 100644 --- a/releasenotes/notes/handle-ssl-063a91fb7bdcf9b9.yaml +++ b/releasenotes/notes/handle-ssl-063a91fb7bdcf9b9.yaml @@ -1,15 +1,16 @@ --- features: - - Ironic Python Agent now can access other services + - Ironic Python Agent can now access other services (Ironic, Inspector, image backend) when those are configured with HTTPS endpoints and use custom server certificates or require client certificates. It is possible to add a custom Certificate Authority (CA) file and client certificate files to the deploy ramdisk during build, and provide paths to those as corresponding new options - in ``ironic_python_agent.conf`` configuration file. - Validation of server certificate can be turned off with ``insecure`` - config option or via ``ipa-insecure`` kernel boot parameter. + in the ``ironic_python_agent.conf`` configuration file. + Validation of the server certificate can be turned off with the + ``insecure`` config option or via the ``ipa-insecure`` kernel boot + parameter. This should make it possible to run IPA in CI-like environments that use - HTTPS endpoints with self-signed sertificates. + HTTPS endpoints with self-signed certificates. diff --git a/releasenotes/notes/ipv6-listen-85d40e58156e398f.yaml b/releasenotes/notes/ipv6-listen-85d40e58156e398f.yaml index 4034733a2..6502c8858 100644 --- a/releasenotes/notes/ipv6-listen-85d40e58156e398f.yaml +++ b/releasenotes/notes/ipv6-listen-85d40e58156e398f.yaml @@ -1,5 +1,5 @@ --- fixes: - - If booted into a kernel that supports IPv6 Ironic Python Agent + - If booted into a kernel that supports IPv6, Ironic Python Agent now listens for connections on both the IPv4 and IPv6 wildcard - address. + addresses. diff --git a/releasenotes/notes/ipv6-provision-42e9000f6f6a7a3a.yaml b/releasenotes/notes/ipv6-provision-42e9000f6f6a7a3a.yaml index 50c9d6cc2..6e0d86d1a 100644 --- a/releasenotes/notes/ipv6-provision-42e9000f6f6a7a3a.yaml +++ b/releasenotes/notes/ipv6-provision-42e9000f6f6a7a3a.yaml @@ -1,6 +1,6 @@ --- fixes: - If using Linux-IO, ISCSI targets now support deploying over - a IPv6 network if booted into a IPv6 enabled kernel. IPv6 will + an IPv6 network if booted into an IPv6 enabled kernel. IPv6 will be used for deployments for all traffic between ironic and IPA - if IPA is passed a IPv6 address in the Ironic api url. + if IPA is passed an IPv6 address in the Ironic API URL. diff --git a/releasenotes/notes/limit-qemu-img-ram-usage-d7b7a16ac5e9c917.yaml b/releasenotes/notes/limit-qemu-img-ram-usage-d7b7a16ac5e9c917.yaml index 56fff0b4f..899e5765c 100644 --- a/releasenotes/notes/limit-qemu-img-ram-usage-d7b7a16ac5e9c917.yaml +++ b/releasenotes/notes/limit-qemu-img-ram-usage-d7b7a16ac5e9c917.yaml @@ -2,4 +2,4 @@ fixes: - | Limits the memory usage of ``qemu-img convert`` command to 1 GiB to - avoid it from causing the host machine to fail due not enough ram. + prevent it from causing the host machine to fail due to not enough RAM. diff --git a/releasenotes/notes/lldp-error-handling-5b6576b378ef9c3a.yaml b/releasenotes/notes/lldp-error-handling-5b6576b378ef9c3a.yaml index 3355d0009..5f8ac6f01 100644 --- a/releasenotes/notes/lldp-error-handling-5b6576b378ef9c3a.yaml +++ b/releasenotes/notes/lldp-error-handling-5b6576b378ef9c3a.yaml @@ -1,6 +1,6 @@ --- fixes: - - Fix LLDP discovery to not fail completely when odd number of bytes is + - Fix LLDP discovery to not fail completely when an odd number of bytes is received in an LLDP package. - Fix raw sockets code to properly propagate exceptions to a caller instead of silencing them and returning None (causing failures later). diff --git a/releasenotes/notes/no-bash-for-grub-c38369af8cc7cf26.yaml b/releasenotes/notes/no-bash-for-grub-c38369af8cc7cf26.yaml index 7855b6e03..b6961f87e 100644 --- a/releasenotes/notes/no-bash-for-grub-c38369af8cc7cf26.yaml +++ b/releasenotes/notes/no-bash-for-grub-c38369af8cc7cf26.yaml @@ -2,5 +2,5 @@ fixes: - | Ironic Python Agent no longer requires 'bash' to be present in the user - image when preparing the partition image for local boot, - and uses default 'sh' interpreter to run 'grub'-related commands instead. + image when preparing the partition image for local boot, and uses the + default 'sh' interpreter to run 'grub'-related commands instead. diff --git a/releasenotes/notes/oslo-config-generator-b0f70b9fb7e23997.yaml b/releasenotes/notes/oslo-config-generator-b0f70b9fb7e23997.yaml index e168b474f..a6b61cea1 100644 --- a/releasenotes/notes/oslo-config-generator-b0f70b9fb7e23997.yaml +++ b/releasenotes/notes/oslo-config-generator-b0f70b9fb7e23997.yaml @@ -1,4 +1,4 @@ --- other: - Ironic Python Agent now uses ``oslo-config-generator`` to create the - sample of configuration file. + sample configuration file. diff --git a/releasenotes/notes/remove-switch_port_descr-switch_chassis_descr-40f2bb37b5f1fdd1.yaml b/releasenotes/notes/remove-switch_port_descr-switch_chassis_descr-40f2bb37b5f1fdd1.yaml index e8eb58d33..d156e6b23 100644 --- a/releasenotes/notes/remove-switch_port_descr-switch_chassis_descr-40f2bb37b5f1fdd1.yaml +++ b/releasenotes/notes/remove-switch_port_descr-switch_chassis_descr-40f2bb37b5f1fdd1.yaml @@ -1,6 +1,6 @@ --- upgrade: - | - Two reserved fields ``switch_port_descr`` and - ``switch_chassis_descr`` were deprecated in + Two reserved fields, ``switch_port_descr`` and + ``switch_chassis_descr``, were deprecated in Newton cycle and now are removed. diff --git a/releasenotes/notes/skip-lookup-and-heartbeat-if-apiurl-not-configured-5ae8b04ae1e74673.yaml b/releasenotes/notes/skip-lookup-and-heartbeat-if-apiurl-not-configured-5ae8b04ae1e74673.yaml index 67aae49d6..e75ac00a2 100644 --- a/releasenotes/notes/skip-lookup-and-heartbeat-if-apiurl-not-configured-5ae8b04ae1e74673.yaml +++ b/releasenotes/notes/skip-lookup-and-heartbeat-if-apiurl-not-configured-5ae8b04ae1e74673.yaml @@ -1,5 +1,5 @@ --- fixes: - If ipa-api-url is not configured in pxe parameters, skip lookup and heartbeat - to avoid ConnectionError when the IPA starts. See https://bugs.launchpad.net/bugs/1643966 + to avoid ConnectionError when IPA starts. See https://bugs.launchpad.net/bugs/1643966 for details. diff --git a/releasenotes/notes/uefi-fallback-266c647f6aff58fd.yaml b/releasenotes/notes/uefi-fallback-266c647f6aff58fd.yaml index 8c11a37a3..921c47249 100644 --- a/releasenotes/notes/uefi-fallback-266c647f6aff58fd.yaml +++ b/releasenotes/notes/uefi-fallback-266c647f6aff58fd.yaml @@ -1,6 +1,6 @@ --- fixes: - - The ironic-python-agent when writing a partition image now - installs grub to the UEFI fallback path. e.g. EFI/BOOT/BOOTX64.EFI + - When writing a partition image, IPA now + installs grub to the UEFI fallback path (e.g. ``EFI/BOOT/BOOTX64.EFI``). The fallback path is used to boot the bare metal node if the NVRAM is - reset. \ No newline at end of file + reset.