openstack/ironic-python-agent
Code Issues Proposed changes

Follow-up to API version setting

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

Change-Id: Id77b0d72f3d78e5befd05fbdb6b21bc780f4ddfe
This commit is contained in:
Julia Kreger 2020-10-28 12:17:43 -07:00 committed by Jay Faulkner
parent 80575566b1
commit 066a96a926
2 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
ironic_python_agent/config.py
View File

@ -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)

6
releasenotes/notes/manually-configure-ironic-api-version-517afd0a423036ad.yaml
View File

@ -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.