Forge Home

boundary

Boundary meter module

24,875 downloads

21,886 latest version

2.8 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.

Version information

  • 1.3.0 (latest)
  • 1.2.0
  • 1.1.0
  • 1.0.4
  • 1.0.3
  • 1.0.2
  • 1.0.0
released Jul 4th 2013
This module has been deprecated by its author since Apr 4th 2023.

Start using this module

Documentation

puppetlabs/boundary — version 1.3.0 Jul 4th 2013

Boundary module

This is the Boundary module.

To use it:

class { 'boundary':
  id     => 'organisation_id',
  apikey => 'apikey',
  tags   => [ 'these', 'are', 'tags' ]
} 

To remove a meter change your include to:

class { 'boundary::delete':
  id     => 'organisation_id',
  apikey => 'apikey',
}

To specify a stand-alone probe you can use the boundary_meter resource:

boundary_meter { "nameofprobe":
  ensure  => present,
  id      => '1234556789',
  apikey  => 'abcdef123456',
  tags    => [ "production", "web", "cluster" ],
}

You can also use the proxy_addr and proxy_port options to specify a proxy server if required.

Dashboard Support

It is possible to use this module from Puppet Dashboard (aka Console). To use the module add boundary to the list of classes. Then add the boundary class directly to a node or a group. The following dashboard parameters are supported:

  • apikey
  • id
  • collector
  • collector_port
  • tags

The tags parameter is an array of tag names to apply to this bprobe (e.g., [ 'a', 'list', 'of', 'tags' ] ).

Report processor

The module also contains a report processor that can send the results of Puppet runs as Boundary annotations. Reports will only be created for Puppet runs that had changes or failed. To use it:

  1. Install puppet-boundary as a module in your Puppet master's module path.

  2. Update the boundary_orgid and boundary_apikey variables in the boundary.yaml file with your Boundary connection details.

  3. Enable pluginsync and reports on your master and clients in puppet.conf

    [master]
    report = true
    reports = boundary
    pluginsync = true
    [agent]
    report = true
    pluginsync = true
    
  4. Run the Puppet client and sync the report as a plugin

Author

James Turnbull james@puppetlabs.com

The boundary_meter type and provider is heavily based on work by Joe Williams and Ben Black from Boundary.

Copyright

Puppet Labs 2011-2013

License

Apache 2.0