From aa7442d7957637382bdeac9ec848af0479d8343b Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Tue, 14 May 2019 14:18:32 -0400 Subject: [PATCH] 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 --- watcher/conf/collector.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/watcher/conf/collector.py b/watcher/conf/collector.py index 75cdc6b59..63762c459 100644 --- a/watcher/conf/collector.py +++ b/watcher/conf/collector.py @@ -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. +"""), ]