diff options
| author | Zuul <zuul@review.opendev.org> | 2020-11-02 11:48:22 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2020-11-02 11:48:22 +0000 |
| commit | f356356486a3fa1bf7e4cd7c29fdbe4733bad6cd (patch) | |
| tree | f35fccf40226146bc9691aca9f99eff93e860c1c | |
| parent | d84e88769e6239663c4c025d26e78b67259df1a2 (diff) | |
| parent | 066a96a9266b5e434750e1a0f2174be2a5d3b5ae (diff) | |
| download | ironic-python-agent-f356356486a3fa1bf7e4cd7c29fdbe4733bad6cd.tar.gz | |
Merge "Follow-up to API version setting"
| -rw-r--r-- | ironic_python_agent/config.py | 11 | ||||
| -rw-r--r-- | releasenotes/notes/manually-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 b3c7eb15..44266603 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 3f4e02bc..257805ac 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. |