From 066a96a9266b5e434750e1a0f2174be2a5d3b5ae Mon Sep 17 00:00:00 2001
From: Julia Kreger <juliaashleykreger@gmail.com>
Date: Wed, 28 Oct 2020 12:17:43 -0700
Subject: [PATCH] Follow-up to API version setting

Follow-up on Ib96a1057792f45f2e4554671e32c436140463ee8 to
improve some of the wording and review feedback by
Dmitry Tantsur.

Change-Id: Id77b0d72f3d78e5befd05fbdb6b21bc780f4ddfe
---
 ironic_python_agent/config.py                         | 11 +++++++----
 ...configure-ironic-api-version-517afd0a423036ad.yaml |  6 +++---
 2 files changed, 10 insertions(+), 7 deletions(-)

diff --git a/ironic_python_agent/config.py b/ironic_python_agent/config.py
index b3c7eb15c..442666030 100644
--- a/ironic_python_agent/config.py
+++ b/ironic_python_agent/config.py
@@ -284,10 +284,13 @@ cli_opts = [
                     'connection when downloading an image.'),
     cfg.StrOpt('ironic_api_version',
                default=APARAMS.get('ipa-ironic-api-version', None),
-               help='Ironic API version in format "x.x". If not set, version '
-                    'will be auto-detected. This is not a recommended '
-                    'configuration.')
-
+               help='Ironic API version in format "x.x". If not set, the API '
+                    'version will be auto-detected. Defining an API version '
+                    'using this setting is not advisiable nor recommended as '
+                    'it blocks auto-detection of the API version. '
+                    'This is an advanced override setting which may only '
+                    'be useful if the environment requires API version '
+                    'auto-detection to be disabled or blocked.'),
 ]
 
 CONF.register_cli_opts(cli_opts)
diff --git a/releasenotes/notes/manually-configure-ironic-api-version-517afd0a423036ad.yaml b/releasenotes/notes/manually-configure-ironic-api-version-517afd0a423036ad.yaml
index 3f4e02bc2..257805acd 100644
--- a/releasenotes/notes/manually-configure-ironic-api-version-517afd0a423036ad.yaml
+++ b/releasenotes/notes/manually-configure-ironic-api-version-517afd0a423036ad.yaml
@@ -2,6 +2,6 @@
 features:
   - |
     Deployers in highly-secure environments can now manually set Ironic API
-    version instead of relying on unauthentication autodetection via
-    ipa-ironic-api-version on the kernel command line. This is not a
-    reccomended configuration.
+    version instead of relying on unauthenticated autodetection via
+    the ``ipa-ironic-api-version`` on the kernel command line. This is not a
+    recommended configuration.