Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Fetching latest commit…
Cannot retrieve the latest commit at this time.
|Failed to load latest commit information.|
I. About This project helps you to create high quality Puppet modules in a fast and comfortable way. Main targets are to boost your efficiency and Puppet code quality. Use it if you want to get Puppet module skeletons with: - tidy and easily extendable structure - good documentation - source code which follows the official style guide  - parameterized classes  Just call the "new module wizard", answer the questions and start editing. If you want to get an impression of what to expect, you may have a look at the "puppet-boilerplate-modules-example-content"  repository.  <http://docs.puppetlabs.com/guides/style_guide.html>  <http://docs.puppetlabs.com/guides/parameterized_classes.html>  <http://j.mp/X3GnY9> II. Usage 1. Clone the repository: $ git clone git://github.com/syn-systems/puppet-boilerplate-modules.git 2. Call the wizard to create the module skeleton for a new module: $ ./puppet-boilerplate-modules/newmodule.sh You can provide the answers by using parameters. Use "newmodule.sh -h" to get a listing. 3. ??? 4. Profit!!! The "puppet-boilerplate-modules-example-content"  repository is your friend if you need more help. It provides example modules including detailed creation transcripts.  <http://j.mp/X3GnY9> III. How to add a new boilerplate The existing boilerplates may not fit your needs. Therefore it might make sense to add your own boilerplate. The newmodule.sh will list every directory as boilerplate if it can find a "/manifests/init.pp" file in it. So all you have to do is: 1. Create a directory for the new boilerplate (name: [a-zA-Z0-9-_] only). 2. Optional but recommended: put a DESCRIPTION file into the boilerplate's root dir. The newmodule.sh will show the file content when listing the available boilerplates as description then. 3. Add everything your boilerplate needs. Please note that all files have to be UTF-8 encoded so take care your editor can handle UTF-8. 4. The newmodule.sh executes different actions when creating a new skeleton. It copies the chosen boilerplate to the specified target dir, renames files/dirs and does some string replacements to create a useful module skeleton. You can use placeholders for your new boilerplate and newmodule.sh inserts the real data it asked the user for. - The following case sensitive string replacements will be done in every file of your boilerplate: John Doe gets replaced with the author name firstname.lastname@example.org gets replaced with the author email address YYYY gets replaced with the current year boilerplate gets replaced with the module name - "boilerplate" gets replaced with the module name in every file name and dir name. Example: If the user told newmodule.sh that the name for the new module is "test", the file "/manifests/fooboilerplatebar.pp" would be renamed into "/manifests/footestbar.pp". IV. How to remove a boilerplate The newmodule.sh will list every directory as boilerplate if it can find a "/manifests/init.pp" file in it. So you may just delete the boilerplate's directory to remove it or e.g. rename the boilerplate's "/manifests/init.pp" to prevent its listing. V. Contact If you think you have found a bug or have a useful idea (a.k.a. "feature request"), create an issue  on GitHub (preferred), or contact us by mail . Feel free to submit patches as GitHub pull requests (preferred) or by mail as well. However, please try to respect the official style guide  as this project follows its rules.  <https://github.com/syn-systems/puppet-boilerplate-modules/issues>  SYN Systems <email@example.com>  <http://docs.puppetlabs.com/guides/style_guide.html> VI. Other notes If you like this free project, you might buy us a coffee , or get some cool QR Code merchandise . Thank you! :-) Do not hesitate to contact SYN Systems  if you need professional support or if you think we are the ones to get your project done.  <http://syn-systems.com/donate/puppet-modules/>  <http://goqr.me/>  <http://syn-systems.com/>