boxen

contributions requested

Configure boxen via Boxen

Module Stats

9,311 downloads

8,106 latest version

4.6 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

released Nov 2nd 2015

This version is compatible with:

Darwin

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'halyard-boxen', '3.11.4'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add halyard-boxen

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install halyard-boxen --version 3.11.4

Documentation

halyard/boxen — version 3.11.4 Nov 2nd 2015

puppet-boxen

Module to provide core types, facts, and manifests for Boxen

Changes from upstream

Removed some meta from the project
Set up CircleCI tests
Switched to function bindings over puppet-module-data
Patch osx_defaults to be a bit cleaner
Switch to puppet-sudoers

Usage

In your hiera config:

# Don't include ./ in $PATH
boxen::environment::relative_bin_on_path: false

include boxen

Facts

Boxen loads facts from following locations:

~/.boxen/config.json (weight -1)
$BOXEN_HOME/config/facts/*.json (weight -1)
$BOXEN_REPO_DIR/facts.d/ (weight EXTERNAL_FACT_WEIGHT + 1 = 10001) - various filetypes, see documentation
_MODULEPATH_/_MODULE-NAME_/lib/facter/*.rb (weight set by vendor or default = number of confines, no confines = 0)

Facter itself also loads facts from environment variables with mask FACTER_* (weight 1_000_000).

Default values:

_MODULEPATH_=$BOXEN_REPO_DIR/shared
$BOXEN_REPO_DIR=Dir.pwd - de facto root of this repository, typically cloned into /opt/boxen/repo

Configuration

ENV['BOXEN_HOME']/config/boxen/defaults.json
- Default $BOXEN_HOME = /opt/boxen

Copyright (c) 2013 GitHub, Inc.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.