From 552b3ef946f62e9ce37f60501af93838a8087fcc Mon Sep 17 00:00:00 2001 From: dparalen Date: Tue, 15 Aug 2017 15:12:32 +0200 Subject: [PATCH] PXE filter options have no effect yet Updating the CONTRIBUTING.rst, config.py and example.conf to inform the Operator (and Developer) that the PXE filter options have no effect yet. Change-Id: I032114934e300af1e1908369552f1b06c939002f --- CONTRIBUTING.rst | 2 ++ example.conf | 5 +++-- ironic_inspector/conf.py | 5 +++-- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6642e3a08..707c6127e 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -320,6 +320,8 @@ the database:: Implementing PXE Filter Drivers ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. note:: It is not possible yet to use PXE filter drivers. + Background ---------- diff --git a/example.conf b/example.conf index d2f4e9a12..3f694884f 100644 --- a/example.conf +++ b/example.conf @@ -789,11 +789,12 @@ # From ironic_inspector # -# PXE boot filter driver to use, such as iptables (string value) +# PXE boot filter driver to use, such as iptables. This option has no +# effect yet. (string value) #driver = noop # Amount of time in seconds, after which repeat periodic update of the -# filter. (integer value) +# filter. This option has no effect yet. (integer value) # Minimum value: 0 #sync_period = 15 diff --git a/ironic_inspector/conf.py b/ironic_inspector/conf.py index b043e9e66..57b855f29 100644 --- a/ironic_inspector/conf.py +++ b/ironic_inspector/conf.py @@ -190,10 +190,11 @@ SERVICE_OPTS = [ PXE_FILTER_OPTS = [ cfg.StrOpt('driver', default='noop', - help=_('PXE boot filter driver to use, such as iptables')), + help=_('PXE boot filter driver to use, such as iptables. ' + 'This option has no effect yet.')), cfg.IntOpt('sync_period', default=15, min=0, help=_('Amount of time in seconds, after which repeat periodic ' - 'update of the filter.')), + 'update of the filter. This option has no effect yet.')), ] cfg.CONF.register_opts(SERVICE_OPTS)