atomaka/my-boxen
1
0
Fork 0
Code Releases Activity

Merge pull request #53 from kyleprager/master

Browse source 
More detailed documentation on how to include modules.
This commit is contained in:
Will Farrington 2013-02-16 21:58:56 -08:00
commit 923bcf46ae
1 changed files with 43 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
README.md
View file

@ -88,6 +88,49 @@ provide as optional installs under the
tested to be compatible with Boxen. Use the `Puppetfile` to pull them tested to be compatible with Boxen. Use the `Puppetfile` to pull them
in dependencies automatically whenever `boxen` is run. in dependencies automatically whenever `boxen` is run.
### Including boxen modules from github (boxen/puppet-<name>)
You must add the github information for your added Puppet module into your Puppetfile at the root of your
boxen repo (ex. /path/to/your-boxen/Puppetfile):
# Core modules for a basic development environment. You can replace
# some/most of these if you want, but it's not recommended.
github "dnsmasq", "1.0.0"
github "gcc", "1.0.0"
github "git", "1.0.0"
github "homebrew", "1.0.0"
github "hub", "1.0.0"
github "inifile", "0.9.0", :repo => "cprice-puppet/puppetlabs-inifile"
github "nginx", "1.0.0"
github "nodejs", "1.0.0"
github "nvm", "1.0.0"
github "ruby", "1.0.0"
github "stdlib", "3.0.0", :repo => "puppetlabs/puppetlabs-stdlib"
github "sudo", "1.0.0"
# Optional/custom modules. There are tons available at
# https://github.com/boxen.
github "java", "1.0.5"
In the above snippet of a customized Puppetfile, the bottom line
includes the Java module from Github using the tag "1.0.5" from the github repository
"boxen/puppet-java". The function "github" is defined at the top of the Puppetfile
and takes the name of the module, the version, and optional repo location:
def github(name, version, options = nil)
options ||= {}
options[:repo] ||= "boxen/puppet-#{name}"
mod name, version, :github_tarball => options[:repo]
end
Now Puppet knows where to download the module from when you include it in your site.pp or mypersonal.pp file:
# include the java module referenced in my Puppetfile with the line
# github "java", "1.0.5"
include java
### Node definitions ### Node definitions
Puppet has the concept of a Puppet has the concept of a