Move ipmi logging to a separate option
The IPMI verbose output being turned on by the debug option is confusing and misleading, and since many operators run ironic in debug mode anyway, it doesn't make much sense to spam logs with errors and information that can be misleading to a less experienced operator. Also... less logging output. Back-porting per discussion[0] in IRC where we believe this is the best action possible and the verbose ipmitool output tends not to be extremely helpful for operators. [0]: http://eavesdrop.openstack.org/irclogs/%23openstack-ironic/%23openstack-ironic.2020-04-01.log.html#t2020-04-01T16:02:43 Change-Id: I0fae7bad5613865dfd4d1c663be08d40debe157a (cherry picked from commit1e514b6440
) (cherry picked from commit3e5816e10a
)
This commit is contained in:
parent
9c116c4ef3
commit
d1aa76d0c1
|
@ -49,6 +49,12 @@ opts = [
|
|||
'that command, the default value is True. It may be '
|
||||
'overridden by per-node \'ipmi_disable_boot_timeout\' '
|
||||
'option in node\'s \'driver_info\' field.')),
|
||||
cfg.BoolOpt('debug',
|
||||
default=False,
|
||||
help=_('Enables all ipmi commands to be executed with an '
|
||||
'additional debugging output. This is a separate '
|
||||
'option as ipmitool can log a substantial amount '
|
||||
'of misleading text when in this mode.')),
|
||||
]
|
||||
|
||||
|
||||
|
|
|
@ -445,7 +445,7 @@ def _get_ipmitool_args(driver_info, pw_file=None):
|
|||
args.append('-f')
|
||||
args.append(pw_file)
|
||||
|
||||
if CONF.debug:
|
||||
if CONF.ipmi.debug:
|
||||
args.append('-v')
|
||||
|
||||
# ensure all arguments are strings
|
||||
|
|
|
@ -454,6 +454,7 @@ class Base(db_base.DbTestCase):
|
|||
enabled_console_interfaces=['fake', 'ipmitool-socat',
|
||||
'ipmitool-shellinabox',
|
||||
'no-console'])
|
||||
self.config(debug=True, group="ipmi")
|
||||
self.node = obj_utils.create_test_node(
|
||||
self.context,
|
||||
console_interface='ipmitool-socat',
|
||||
|
@ -2569,7 +2570,7 @@ class IPMIToolShellinaboxTestCase(db_base.DbTestCase):
|
|||
ipmi_cmd = self.console._get_ipmi_cmd(driver_info, 'pw_file')
|
||||
expected_ipmi_cmd = ("/:%(uid)s:%(gid)s:HOME:ipmitool "
|
||||
"-I lanplus -H %(address)s -L ADMINISTRATOR "
|
||||
"-U %(user)s -f pw_file -v" %
|
||||
"-U %(user)s -f pw_file" %
|
||||
{'uid': os.getuid(), 'gid': os.getgid(),
|
||||
'address': driver_info['address'],
|
||||
'user': driver_info['username']})
|
||||
|
@ -2583,7 +2584,7 @@ class IPMIToolShellinaboxTestCase(db_base.DbTestCase):
|
|||
ipmi_cmd = self.console._get_ipmi_cmd(driver_info, 'pw_file')
|
||||
expected_ipmi_cmd = ("/:%(uid)s:%(gid)s:HOME:ipmitool "
|
||||
"-I lanplus -H %(address)s -L ADMINISTRATOR "
|
||||
"-f pw_file -v" %
|
||||
"-f pw_file" %
|
||||
{'uid': os.getuid(), 'gid': os.getgid(),
|
||||
'address': driver_info['address']})
|
||||
self.assertEqual(expected_ipmi_cmd, ipmi_cmd)
|
||||
|
@ -2717,7 +2718,7 @@ class IPMIToolSocatDriverTestCase(IPMIToolShellinaboxTestCase):
|
|||
ipmi_cmd = self.console._get_ipmi_cmd(driver_info, 'pw_file')
|
||||
expected_ipmi_cmd = ("ipmitool -I lanplus -H %(address)s "
|
||||
"-L ADMINISTRATOR -U %(user)s "
|
||||
"-f pw_file -v" %
|
||||
"-f pw_file" %
|
||||
{'address': driver_info['address'],
|
||||
'user': driver_info['username']})
|
||||
self.assertEqual(expected_ipmi_cmd, ipmi_cmd)
|
||||
|
@ -2730,7 +2731,7 @@ class IPMIToolSocatDriverTestCase(IPMIToolShellinaboxTestCase):
|
|||
ipmi_cmd = self.console._get_ipmi_cmd(driver_info, 'pw_file')
|
||||
expected_ipmi_cmd = ("ipmitool -I lanplus -H %(address)s "
|
||||
"-L ADMINISTRATOR "
|
||||
"-f pw_file -v" %
|
||||
"-f pw_file" %
|
||||
{'address': driver_info['address']})
|
||||
self.assertEqual(expected_ipmi_cmd, ipmi_cmd)
|
||||
|
||||
|
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
features:
|
||||
- |
|
||||
Adds a new ``[ipmi]debug`` option that allows users to explicitly turn
|
||||
IPMI command debugging on, as opposed to relying upon the system debug
|
||||
setting ``[DEFAULT]debug``. Users wishing to continue to log this output
|
||||
should set ``[ipmi]debug`` to ``True`` in their ironic.conf.
|
||||
upgrade:
|
||||
- Debug logging control has been moved to the ``[ipmi]debug`` configuration
|
||||
setting as opposed to the "conductor" ``[DEFAULT]debug`` setting as
|
||||
the existing ``ipmitool`` output can be extremely misleading for users.
|
||||
Operators who wish to continue to log ``ipmitool`` verbose output in their
|
||||
logs should explicitly set the ``[ipmi]debug`` command to True.
|
Loading…
Reference in New Issue