Improve the help text for compute timeout_opts
Implements blueprint centralize-config-options-newton Change-Id: I784b6569643f3f8fe4f386a2990a9b7cd54617ab
This commit is contained in:
parent
e9a3bca866
commit
d67ea6e554
@ -240,27 +240,89 @@ interval_opts = [
|
|||||||
|
|
||||||
timeout_opts = [
|
timeout_opts = [
|
||||||
cfg.IntOpt("reboot_timeout",
|
cfg.IntOpt("reboot_timeout",
|
||||||
default=0,
|
default=0,
|
||||||
help="Automatically hard reboot an instance if it has been "
|
min=0,
|
||||||
"stuck in a rebooting state longer than N seconds. "
|
help="""
|
||||||
"Set to 0 to disable."),
|
Time interval after which an instance is hard rebooted automatically.
|
||||||
|
|
||||||
|
When doing a soft reboot, it is possible that a guest kernel is
|
||||||
|
completely hung in a way that causes the soft reboot task
|
||||||
|
to not ever finish. Setting this option to a time period in seconds
|
||||||
|
will automatically hard reboot an instance if it has been stuck
|
||||||
|
in a rebooting state longer than N seconds.
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
|
||||||
|
* 0: Disables the option (default).
|
||||||
|
* Any positive integer in seconds: Enables the option.
|
||||||
|
"""),
|
||||||
cfg.IntOpt("instance_build_timeout",
|
cfg.IntOpt("instance_build_timeout",
|
||||||
default=0,
|
default=0,
|
||||||
help="Amount of time in seconds an instance can be in BUILD "
|
min=0,
|
||||||
"before going into ERROR status. "
|
help="""
|
||||||
"Set to 0 to disable."),
|
Maximum time in seconds that an instance can take to build.
|
||||||
|
|
||||||
|
If this timer expires, instance status will be changed to ERROR.
|
||||||
|
Enabling this option will make sure an instance will not be stuck
|
||||||
|
in BUILD state for a longer period.
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
|
||||||
|
* 0: Disables the option (default)
|
||||||
|
* Any positive integer in seconds: Enables the option.
|
||||||
|
"""),
|
||||||
cfg.IntOpt("rescue_timeout",
|
cfg.IntOpt("rescue_timeout",
|
||||||
default=0,
|
default=0,
|
||||||
help="Automatically unrescue an instance after N seconds. "
|
min=0,
|
||||||
"Set to 0 to disable."),
|
help="""
|
||||||
|
Interval to wait before un-rescuing an instance stuck in RESCUE.
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
|
||||||
|
* 0: Disables the option (default)
|
||||||
|
* Any positive integer in seconds: Enables the option.
|
||||||
|
"""),
|
||||||
cfg.IntOpt("resize_confirm_window",
|
cfg.IntOpt("resize_confirm_window",
|
||||||
default=0,
|
default=0,
|
||||||
help="Automatically confirm resizes after N seconds. "
|
min=0,
|
||||||
"Set to 0 to disable."),
|
help="""
|
||||||
|
Automatically confirm resizes after N seconds.
|
||||||
|
|
||||||
|
Resize functionality will save the existing server before resizing.
|
||||||
|
After the resize completes, user is requested to confirm the resize.
|
||||||
|
The user has the opportunity to either confirm or revert all
|
||||||
|
changes. Confirm resize removes the original server and changes
|
||||||
|
server status from resized to active. Setting this option to a time
|
||||||
|
period (in seconds) will automatically confirm the resize if the
|
||||||
|
server is in resized state longer than that time.
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
|
||||||
|
* 0: Disables the option (default)
|
||||||
|
* Any positive integer in seconds: Enables the option.
|
||||||
|
"""),
|
||||||
cfg.IntOpt("shutdown_timeout",
|
cfg.IntOpt("shutdown_timeout",
|
||||||
default=60,
|
default=60,
|
||||||
help="Total amount of time to wait in seconds for an instance "
|
min=1,
|
||||||
"to perform a clean shutdown."),
|
help="""
|
||||||
|
Total time to wait in seconds for an instance toperform a clean
|
||||||
|
shutdown.
|
||||||
|
|
||||||
|
It determines the overall period (in seconds) a VM is allowed to
|
||||||
|
perform a clean shutdown. While performing stop, rescue and shelve,
|
||||||
|
rebuild operations, configuring this option gives the VM a chance
|
||||||
|
to perform a controlled shutdown before the instance is powered off.
|
||||||
|
The default timeout is 60 seconds.
|
||||||
|
|
||||||
|
The timeout value can be overridden on a per image basis by means
|
||||||
|
of os_shutdown_timeout that is an image metadata setting allowing
|
||||||
|
different types of operating systems to specify how much time they
|
||||||
|
need to shut down cleanly.
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
|
||||||
|
* Any positive integer in seconds (default value is 60).
|
||||||
|
""")
|
||||||
]
|
]
|
||||||
|
|
||||||
running_deleted_opts = [
|
running_deleted_opts = [
|
||||||
|
Loading…
Reference in New Issue
Block a user