puppet-parse
This project is abandoned
Analyse puppet manifests and report what classes and defines are specified, and their parameters and parameter documentation.
Installation
gem install puppet-parse
Requirements
rdoc >=3.12, <4.0
facter
Supported Platforms
puppet-parse only works on Unix like platforms such as Linux and MacOSX.
Windows is not supported.
Usage
By hand
You can report on one or more manifests by running
puppet-parse <path(s) to file(s)>
Rake task
If you want to parse your entire modules directory, you can add `require 'puppet-parse/puppet-parse' to your Rakefile and then run
rake parse
If you need to ignore certain paths from being parsed:
PuppetParse.configuration.ignore_paths = ["vendor/**/*.pp"]
Sample Output
---
ntp:
parameters:
enabled: true
present: true
enableboot: true
docs:
enabled:
- "Set to 'false' to stop service"
present:
- "Set to 'false' to remove package"
enableboot:
- "Set to 'false' to prevent service starting at boot"
Contributing
You can do any of these:
- Create new Pull Request
- Create an issue
- Write me an email
- Complain about how useless my code is on twitter