boost

Table of Contents

1. Module Description - What the module does and why it is useful
2. Setup - The basics of getting started with boost
   • Beginning with boost
3. Usage - Configuration options and additional functionality
   • Install header packages
   • Install all headers packages and the documentation
   • Uninstall a Boost library
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module
7. Contributors

Module Description

This module installs Boost libraries.

Setup

Beginning with boost

class { 'boost':
  packages => {
    'signals' => {},
    'system' => {},
  }
}

Usage

Install header packages

class { 'boost':
  devel    => true,
  packages => {
    'signals' => {},
    'system' => {},
  }
}

Install all headers packages and the documentation

class { 'boost':
  all_devel => true,
  doc       => true,
}

Uninstall a Boost library

class { 'boost':
  packages => {
    'signals' => {
      ensure => 'absent',
    },
  }
}

Reference

Classes

Public Classes

• boost: Main class, includes all other classes.

Private Classes

• boost::install: Handles the packages.

Parameters

The following parameters are available in the ::boost class:

package_ensure

Tells Puppet whether the Boost packages should be installed, and what version. Valid options: 'present', 'latest', or a specific version number. Default value: 'present'

packages

Tells Puppet which Boost libraries to install. Valid options: hash. Default value: {}

prefix

Tells Puppet what is the first part of Boost packages name. Valid options: string. Default value: varies by operating system

suffix

Tells Puppet what is the last part of Boost packages name. Valid options: string. Default value: varies by operating system

suffix_dev

Tells Puppet what is the last part of Boost header packages name. Valid options: string. Default value: varies by operating system

version

Tells Puppet what is the version part of the Boost packages name. Only needed for Debian family OSes. Valid options: string. Default value: varies by operating system

Defines

Public defines

• boost:📦 Adds a Boost librarie.

Parameters

The following parameters are available in the ::boost::package define:

devel

Tells Puppet whether the Boost header package should be installed. Valid options: boolean. Default value: false

ensure

Tells Puppet whether the Boost package should be installed, and what version. Valid options: 'present', 'latest', or a specific version number. Default value: 'present'

prefix

Tells Puppet what is the first part of the Boost package name. Valid options: string. Default value: varies by operating system

suffix

Tells Puppet what is the last part of the Boost package name. Valid options: string. Default value: varies by operating system

suffix_dev

Tells Puppet what is the last part of the Boost header package name. Valid options: string. Default value: varies by operating system

version

Tells Puppet what is the version part of the Boost package name. Only needed for Debian family OSes. Valid options: string. Default value: varies by operating system

Limitations

RedHat and Debian family OSes are officially supported. Tested and built on Debian and CentOS.

Development

Solution Libre modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great.

Fork this module on GitHub

Contributors

The list of contributors can be found at: https://github.com/solution-libre/puppet-boost/graphs/contributors