Files
watcher/watcher/conf/collector.py
Matt Riedemann aa7442d795 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
2019-05-14 14:18:32 -04:00

49 lines
1.4 KiB
Python

# Copyright (c) 2017 NEC Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from oslo_config import cfg
collector = cfg.OptGroup(name='collector',
title='Defines the parameters of '
'the module model collectors')
COLLECTOR_OPTS = [
cfg.ListOpt('collector_plugins',
default=['compute'],
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.
"""),
]
def register_opts(conf):
conf.register_group(collector)
conf.register_opts(COLLECTOR_OPTS,
group=collector)
def list_opts():
return [('collector', COLLECTOR_OPTS)]