Update help for image_cache_manager_interval option

The image_cache_manager_interval configuration option help is
updated to:

1. Fix formatting on possible values.
2. Describe the "large number of instances" scenarios to
   watch out for in bug 1804262.
3. Add related options.
4. Clarify the "0" default interval value so it is not confused
   with the 2400 default.

Change-Id: Ia182e758d975e76a6e6f14f29591cb2891d7c83a
Related-Bug: #1804262
This commit is contained in:
Matt Riedemann
2019-08-27 16:04:57 -04:00
parent 912a46c9d4
commit 708c11e96d

View File

@@ -859,10 +859,24 @@ interval_opts = [
help="""
Number of seconds to wait between runs of the image cache manager.
Note that when using shared storage for the ``[DEFAULT]/instances_path``
configuration option across multiple nova-compute services, this periodic
could process a large number of instances. Similarly, using a compute driver
that manages a cluster (like vmwareapi.VMwareVCDriver) could result in
processing a large number of instances. Therefore you may need to adjust the
time interval for the anticipated load, or only run on one nova-compute
service within a shared storage aggregate.
Possible values:
* 0: run at the default rate.
* 0: run at the default interval of 60 seconds (not recommended)
* -1: disable
* Any other value
Related options:
* ``[DEFAULT]/compute_driver``
* ``[DEFAULT]/instances_path``
"""),
cfg.IntOpt('bandwidth_poll_interval',
default=600,