Skip to content

Commit 12754a6

Browse files
author
txaj
committed
Add a section to explain version scoping & known issue for voxpupuli#162
1 parent 2190a9e commit 12754a6

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -815,6 +815,10 @@ class { 'collectd::plugin::zfs_arc':
815815

816816
See metadata.json for supported platforms
817817

818+
##Known issues
819+
820+
Some plugins will need two runs of Puppet to fully generate the configuration for collectd. See #162 for details.
821+
818822
##Development
819823

820824
### Running tests
@@ -830,3 +834,13 @@ bundle exec rake lint
830834
bundle exec rake validate
831835
bundle exec rake spec SPEC_OPTS='--format documentation'
832836
```
837+
838+
### Version scoping
839+
840+
Some plugins or some options in plugins are only available for recent version of collectd.
841+
842+
This module shall not use unsupported configuration directives. Look at [templates/loadplugin.conf.erb](https://github.com/pdxcat/puppet-module-collectd/blob/master/templates/loadplugin.conf.erb) for a hands-on example.
843+
844+
Please make use of the search by branch/tags on the collectd github to see when a function has been first released.
845+
846+
Reading the [collectd.conf.pod](https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod) file is good, validating the presence of the code in the .c files is even better.

0 commit comments

Comments
 (0)