Enhance the collector_plugins option help text

This enhances the [collector]/collector_plugins
config option help text to mention the storage
and baremetal in-tree collectors and the ability
to load out-of-tree collectors via extension point.

While doing this, the help text is formatted for
prettier rst rendering in the docs.

Change-Id: Ifd32c95c664c4e9586c250e6bceaeaba2e2df417
This commit is contained in:
Matt Riedemann
2019-05-14 14:18:32 -04:00
parent 9922dec025
commit aa7442d795

View File

@@ -23,7 +23,18 @@ collector = cfg.OptGroup(name='collector',
COLLECTOR_OPTS = [
cfg.ListOpt('collector_plugins',
default=['compute'],
help='The cluster data model plugin names'),
help="""
The cluster data model plugin names.
Supported in-tree collectors include:
* ``compute`` - data model collector for nova
* ``storage`` - data model collector for cinder
* ``baremetal`` - data model collector for ironic
Custom data model collector plugins can be defined with the
``watcher_cluster_data_model_collectors`` extension point.
"""),
]