Forge Home

portshaker

Module to configure portshaker

6,909 downloads

6,909 latest version

4.5 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

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:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. 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

  • 0.1.0 (latest)
released Oct 26th 2016
This version is compatible with:

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'icann-portshaker', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add icann-portshaker
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install icann-portshaker --version 0.1.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

icann/portshaker — version 0.1.0 Oct 26th 2016

Build Status Puppet Forge Puppet Forge Downloads

portshaker

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with portshaker
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

This module installs portshaker and can also manage the custom scripts, host script and custom modules directories

Setup

What portshaker affects

  • installs portshaker

Setup Requirements

  • puppetlabs-stdlib 4.12.0
  • icann-tea 0.2.5

Beginning with portshaker

The logstash host and the SSL certificate source locations are both mandadory parameters

class {'::portshaker': }

Reference

Classes

Public Classes

Private Classes

Class: portshaker

Main class

Parameters
  • package (String, Default: 'portshaker'): The package to install
  • mirror_base_dir (Tea::Absolutepath, Default: '/var/cache/portshaker'): Base directory for mirrored Ports Trees
  • ports_trees (Array[String] Default: ['default']): Array of ports directories to merge.
  • default_ports_tree (Tea::Absolutepath, Default: '/usr/ports'): ull path of the directory where the 'default' ports tree is located.
  • default_merge_from (Tea::Absolutepath, Default: freebsd): The source to use for the default tree.
  • default_poudriere_tree (Default: default): name of the poudriere_tree to use
  • poudriere_ports_mountpoint (Tea::Absolutepath, Default: /usr/local/poudriere/ports): The directory where poudriere(8) ports directory are mounted.
  • git_branch (String, Default: master): git branch to use if there is a git uri
  • use_zfs (Boolean, Default: false): Weather we should use ZFS
  • use_poudriere (Boolean, Default: false): Weather we should use poudriere
  • portshaker_conf_file (Tea::Absolutepath, Default: /usr/local/etc/portshaker.conf): where to store the config file
  • add_cron (Boolean, Default: true): weather to add cron jobs
  • git_clone_uri (Optional[Tea::HTTPUrl], Default: undef): git uri to merge

Limitations

This module is tested on FreeBSD 10