Merge "Update description for config params of 'rescue' interface"

This commit is contained in:
Zuul 2018-01-28 06:07:14 +00:00 committed by Gerrit Code Review
commit 180234b445
4 changed files with 13 additions and 40 deletions

View File

@ -242,17 +242,14 @@
# "ironic.hardware.interfaces.rescue" entrypoint. When setting # "ironic.hardware.interfaces.rescue" entrypoint. When setting
# this value, please make sure that every enabled hardware # this value, please make sure that every enabled hardware
# type will have the same set of enabled rescue interfaces on # type will have the same set of enabled rescue interfaces on
# every ironic-conductor service. This option is part of # every ironic-conductor service. (list value)
# rescue feature work, which is not currently exposed to
# users. (list value)
#enabled_rescue_interfaces = no-rescue #enabled_rescue_interfaces = no-rescue
# Default rescue interface to be used for nodes that do not # Default rescue interface to be used for nodes that do not
# have rescue_interface field set. A complete list of rescue # have rescue_interface field set. A complete list of rescue
# interfaces present on your system may be found by # interfaces present on your system may be found by
# enumerating the "ironic.hardware.interfaces.rescue" # enumerating the "ironic.hardware.interfaces.rescue"
# entrypoint. This option is part of rescue feature work, # entrypoint. (string value)
# which is not currently exposed to users. (string value)
#default_rescue_interface = <None> #default_rescue_interface = <None>
# Specify the list of storage interfaces to load during # Specify the list of storage interfaces to load during
@ -1267,9 +1264,8 @@
# (integer value) # (integer value)
#check_provision_state_interval = 60 #check_provision_state_interval = 60
# Interval (seconds) between checks of rescue timeouts. This # Interval (seconds) between checks of rescue timeouts.
# option is part of rescue feature work, which is not # (integer value)
# currently exposed to users. (integer value)
# Minimum value: 1 # Minimum value: 1
#check_rescue_state_interval = 60 #check_rescue_state_interval = 60
@ -1364,8 +1360,7 @@
# Timeout (seconds) to wait for a callback from the rescue # Timeout (seconds) to wait for a callback from the rescue
# ramdisk. If the timeout is reached the node will be put in # ramdisk. If the timeout is reached the node will be put in
# the "rescue failed" provision state. Set to 0 to disable # the "rescue failed" provision state. Set to 0 to disable
# timeout. This option is part of rescue feature work, which # timeout. (integer value)
# is not currently exposed to users. (integer value)
# Minimum value: 0 # Minimum value: 0
#rescue_callback_timeout = 1800 #rescue_callback_timeout = 1800
@ -2852,17 +2847,14 @@
# Required for "neutron" network interface, if rescue mode # Required for "neutron" network interface, if rescue mode
# will be used. It is not used for the "flat" or "noop" # will be used. It is not used for the "flat" or "noop"
# network interfaces. If a name is provided, it must be unique # network interfaces. If a name is provided, it must be unique
# among all networks or rescue will fail. This option is part # among all networks or rescue will fail. (string value)
# of rescue feature work, which is not currently exposed to
# users. (string value)
#rescuing_network = <None> #rescuing_network = <None>
# List of Neutron Security Group UUIDs to be applied during # List of Neutron Security Group UUIDs to be applied during
# the node rescue process. Optional for the "neutron" network # the node rescue process. Optional for the "neutron" network
# interface and not used for the "flat" or "noop" network # interface and not used for the "flat" or "noop" network
# interfaces. If not specified, the default security group is # interfaces. If not specified, the default security group is
# used. This option is part of rescue feature work, which is # used. (list value)
# not currently exposed to users. (list value)
#rescuing_network_security_groups = #rescuing_network_security_groups =
# Client retries in the case of a failed request. (integer # Client retries in the case of a failed request. (integer

View File

@ -56,8 +56,7 @@ opts = [
default=60, default=60,
min=1, min=1,
help=_('Interval (seconds) between checks of rescue ' help=_('Interval (seconds) between checks of rescue '
'timeouts. This option is part of rescue feature ' 'timeouts.')),
'work, which is not currently exposed to users.')),
cfg.IntOpt('deploy_callback_timeout', cfg.IntOpt('deploy_callback_timeout',
default=1800, default=1800,
help=_('Timeout (seconds) to wait for a callback from ' help=_('Timeout (seconds) to wait for a callback from '
@ -157,9 +156,7 @@ opts = [
help=_('Timeout (seconds) to wait for a callback from the ' help=_('Timeout (seconds) to wait for a callback from the '
'rescue ramdisk. If the timeout is reached the node ' 'rescue ramdisk. If the timeout is reached the node '
'will be put in the "rescue failed" provision state. ' 'will be put in the "rescue failed" provision state. '
'Set to 0 to disable timeout. This option is part of ' 'Set to 0 to disable timeout.')),
'rescue feature work, which is not currently exposed '
'to users.')),
cfg.IntOpt('soft_power_off_timeout', cfg.IntOpt('soft_power_off_timeout',
default=600, default=600,
min=1, min=1,

View File

@ -52,18 +52,6 @@ _DEFAULT_IFACE_HELP = _('Default {0} interface to be used for nodes that '
'be found by enumerating the ' 'be found by enumerating the '
'"ironic.hardware.interfaces.{0}" entrypoint.') '"ironic.hardware.interfaces.{0}" entrypoint.')
# TODO(stendulker) Remove this in rescue API patch.
_ENABLED_IFACE_HELP_FOR_RESCUE = (_ENABLED_IFACE_HELP +
_(' This option is part of rescue feature '
'work, which is not currently exposed to '
'users.'))
# TODO(stendulker) Remove this in rescue API patch.
_DEFAULT_IFACE_HELP_FOR_RESCUE = (_DEFAULT_IFACE_HELP +
_(' This option is part of rescue feature '
'work, which is not currently exposed to '
'users.'))
api_opts = [ api_opts = [
cfg.StrOpt( cfg.StrOpt(
'auth_strategy', 'auth_strategy',
@ -151,9 +139,9 @@ driver_opts = [
help=_DEFAULT_IFACE_HELP.format('raid')), help=_DEFAULT_IFACE_HELP.format('raid')),
cfg.ListOpt('enabled_rescue_interfaces', cfg.ListOpt('enabled_rescue_interfaces',
default=['no-rescue'], default=['no-rescue'],
help=_ENABLED_IFACE_HELP_FOR_RESCUE.format('rescue')), help=_ENABLED_IFACE_HELP.format('rescue')),
cfg.StrOpt('default_rescue_interface', cfg.StrOpt('default_rescue_interface',
help=_DEFAULT_IFACE_HELP_FOR_RESCUE.format('rescue')), help=_DEFAULT_IFACE_HELP.format('rescue')),
cfg.ListOpt('enabled_storage_interfaces', cfg.ListOpt('enabled_storage_interfaces',
default=['cinder', 'noop'], default=['cinder', 'noop'],
help=_ENABLED_IFACE_HELP.format('storage')), help=_ENABLED_IFACE_HELP.format('storage')),

View File

@ -98,18 +98,14 @@ opts = [
'network interface, if rescue mode will be used. It ' 'network interface, if rescue mode will be used. It '
'is not used for the "flat" or "noop" network ' 'is not used for the "flat" or "noop" network '
'interfaces. If a name is provided, it must be unique ' 'interfaces. If a name is provided, it must be unique '
'among all networks or rescue will fail. This option ' 'among all networks or rescue will fail.')),
'is part of rescue feature work, which is not currently '
'exposed to users.')),
cfg.ListOpt('rescuing_network_security_groups', cfg.ListOpt('rescuing_network_security_groups',
default=[], default=[],
help=_('List of Neutron Security Group UUIDs to be applied ' help=_('List of Neutron Security Group UUIDs to be applied '
'during the node rescue process. Optional for the ' 'during the node rescue process. Optional for the '
'"neutron" network interface and not used for the ' '"neutron" network interface and not used for the '
'"flat" or "noop" network interfaces. If not ' '"flat" or "noop" network interfaces. If not '
'specified, the default security group is used. This ' 'specified, the default security group is used.')),
'option is part of rescue feature work, which is '
'not currently exposed to users.')),
] ]