ironic/ironic/conf/ipmi.py
Bob Fournier 3ae7e6880d Change default to `False for use_ipmitool_retries`
A new configuration parameter was introduced in
https://review.opendev.org/#/c/731676/ to work around an
issue with some BMCs that don't support the Cipher
Suites command.  This changes the default value to
``False`` so that Ironic will do the retries by default.

Note that this should not be backported to avoid changing
the behaviour in stable branches.

Change-Id: I34bf7e5d79defc23161213aa8942edace4b87b78
Story: 2007632
Task: 39676
2020-05-29 08:54:20 -04:00

81 lines
3.8 KiB
Python

# Copyright 2016 Intel Corporation
#
# Copyright 2013 International Business Machines Corporation
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from oslo_config import cfg
from ironic.common.i18n import _
opts = [
cfg.IntOpt('command_retry_timeout',
default=60,
mutable=True,
help=_('Maximum time in seconds to retry retryable IPMI '
'operations. (An operation is retryable, for '
'example, if the requested operation fails '
'because the BMC is busy.) Setting this too high '
'can cause the sync power state '
'periodic task to hang when there are slow or '
'unresponsive BMCs.')),
cfg.IntOpt('min_command_interval',
default=5,
mutable=True,
help=_('Minimum time, in seconds, between IPMI operations '
'sent to a server. There is a risk with some hardware '
'that setting this too low may cause the BMC to crash. '
'Recommended setting is 5 seconds.')),
cfg.BoolOpt('use_ipmitool_retries',
default=False,
help=_('When set to True and the parameters are supported by '
'ipmitool, the number of retries and the retry '
'interval are passed to ipmitool as parameters, and '
'ipmitool will do the retries. When set to False, '
'ironic will retry the ipmitool commands. '
'Recommended setting is False')),
cfg.BoolOpt('kill_on_timeout',
default=True,
mutable=True,
help=_('Kill `ipmitool` process invoked by ironic to read '
'node power state if `ipmitool` process does not exit '
'after `command_retry_timeout` timeout expires. '
'Recommended setting is True')),
cfg.BoolOpt('disable_boot_timeout',
default=True,
mutable=True,
help=_('Default timeout behavior whether ironic sends a raw '
'IPMI command to disable the 60 second timeout for '
'booting. Setting this option to False will NOT send '
'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.MultiStrOpt('additional_retryable_ipmi_errors',
default=[],
mutable=True,
help=_('Additional errors ipmitool may encounter, '
'specific to the environment it is run in.')),
cfg.BoolOpt('debug',
default=False,
mutable=True,
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.')),
]
def register_opts(conf):
conf.register_opts(opts, group='ipmi')