Bug 1425821

Summary:	Parameter descriptions are missing from the collectd-environment.yaml
Product:	Red Hat OpenStack	Reporter:	Leonid Natapov <lnatapov>
Component:	openstack-tripleo-heat-templates	Assignee:	Juan Badia Payno <jbadiapa>
Status:	CLOSED ERRATA	QA Contact:	Leonid Natapov <lnatapov>
Severity:	high	Docs Contact:
Priority:	high
Version:	11.0 (Ocata)	CC:	lars, mburns, mmagr, oblaut, rhel-osp-director-maint, sclewis, slinaber
Target Milestone:	z2	Keywords:	Triaged, ZStream
Target Release:	11.0 (Ocata)
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:	openstack-tripleo-heat-templates-6.1.0-2.el7ost	Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2017-09-13 21:43:17 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Leonid Natapov 2017-02-22 14:21:07 UTC

As part of Performance Monitoring integration with tripleo we have a collectd-environment.yaml installed on the undercloud node.

This file is missing parameter description so user don't have a clue what parameters should be there.


Check github for the parameters.

https://github.com/openstack/tripleo-heat-templates/blob/master/puppet/services/metrics/collectd.yaml#L45,L50

Comment 1 Lars Kellogg-Stedman 2017-03-21 13:47:19 UTC

There is an upstream review for this @ https://review.openstack.org/#/c/440759/1

Comment 2 Juan Badia Payno 2017-04-25 07:41:12 UTC

The patch https://review.openstack.org/#/c/440759 is merged

Comment 9 Martin Magr 2017-07-26 21:57:14 UTC

Test instructions: verify that /usr/share/openstack-tripleo-heat-templates/environments/collectd-environment.yaml has a verbose documentation of parameters.

Comment 10 Leonid Natapov 2017-07-27 08:30:03 UTC

fixed.
-------
 collectd-environment.yaml looks like this:    

resource_registry:
      OS::TripleO::Services::Collectd: ../puppet/services/metrics/collectd.yaml
     
    # parameter_defaults:
    #
    ## Collectd server configuration
    #   CollectdServer: collectd0.example.com
    #
    ################
    #### Other config parameters, the values shown here are the defaults
    ################
    #
    #   CollectdServerPort: 25826
    #   CollectdSecurityLevel: None
    #
    ################
    #### If CollectdSecurityLevel is set to Encrypt or Sign
    #### the following parameters are also needed
    ###############
    #
    #   CollectdUsername: user
    #   CollectdPassword: password
    #
    ## CollectdDefaultPlugins, These are the default plugins used by collectd
    #
    #   CollectdDefaultPlugins:
    #     - disk
    #     - interface
    #     - load
    #     - memory
    #     - processes
    #     - tcpconns
    #
    ## Extra plugins can be enabled by the CollectdExtraPlugins parameter:
    ## All the plugins availables are:
    #
    #   CollectdExtraPlugins:
    #     - disk
    #     - df
    #
    ## You can use ExtraConfig (or one of the related *ExtraConfig keys)
    ## to configure collectd.  See the documentation for puppet-collectd at
    ## https://github.com/voxpupuli/puppet-collectd for details.
    #
    #   ExtraConfig:
    #     collectd::plugin::disk::disks:
    #       - "/^[vhs]d[a-f][0-9]?$/"
    #     collectd::plugin::df::mountpoints:
    #       - "/"
    #     collectd::plugin::df::ignoreselected: false
    #     collectd::plugin::cpu::valuespercentage: true

Comment 13 errata-xmlrpc 2017-09-13 21:43:17 UTC

Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2017:2721