runscope_gateway

Puppet module for Runscope Gateway Agent

Module Stats

7,462 downloads

7,462 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 Feb 29th 2016

This version is compatible with:

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'cloudmine-runscope_gateway', '0.1.1'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add cloudmine-runscope_gateway

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install cloudmine-runscope_gateway --version 0.1.1

Tags: monitoring, runscope, runscope-gateway

Documentation

cloudmine/runscope_gateway — version 0.1.1 Feb 29th 2016

puppet-runscope_gateway

Overview
Requirements - OSes and Puppet modules
Usage - Quickly getting started
Configuration - Required and optional configuration options
Development - Guide for contributing to the module
Maintainers - Who helps keep this module up to date
Release Notes / Changelog

Overview

Puppet module for Runscope Gateway Agent.

Requirements

Operation Systems

These are the operating systems for which the module has been tested.

Ubuntu 14.04

Puppet Modules

Usage

If you do not already have an application token for the Runscope Gateway Agent, generate one by manually downloading, unzipping, and running the command without arguments the first time or generate one in the Runscope web interface.

Using Hiera

Add required configuration hiera in the appropriate location for your environment, e.g.

runscope_gateway::token: my-runscope-app-token

Then add include runscope_gateway in your site.pp or add runscope_gateway to your classes hiera.

Directly without Hiera

class { 'runscope_gateway':
  token => 'my-runscope-app-token',
}

Configuration

Required Configuration

Parameter	Description	Type	Default
token	Runscope application token	String	undef

Optional Configuration

Parameter	Description	Type	Default
certfile	Agent HTTPS certificate file	String	undef
config_dir	Configuration directory	String	(auto-detected, see params.pp)
group	Group for running agent	String	runscope
group_manage	Whether to manage agent group creation	Boolean	true
hostname	Agent hostname	String	`$::fqdn`
http	Enable agent HTTP support	Boolean	true
http_port	Agent HTTP port	Fixnum	8000
https	Enable agent HTTPS support	Boolean	false
https_port	Agent HTTPS port	Fixnum	8443
install_binary	Installation binary filename	String	(auto-detected, see params.pp)
install_dir	Installation directory	String	(auto-detected, see params.pp)
interface	Agent interface to bind	String	undef
keyfile	Agent HTTPS key file	String	undef
service_enable	Enable agent service on boot	Boolean	true
service_ensure	Ensure agent service running	Boolean	true
service_manage	Whether to manage agent service	Boolean	true
service_style	OS service style	String	(auto-detected, see params.pp)
url	Full URL to agent zip file	String	(auto-detected, see params.pp)
user	User for running agent	String	runscope
user_manage	Whether to manage agent user creation	Boolean	true

Development

Full development and testing workflow with rspec-puppet, puppet-lint, and friends: TESTING.md

To use aws instead of virtualbox vagrant hosts

vagrant plugin install vagrant-aws
vagrant plugin install puppet
vagrant plugin install nugrant (https://github.com/maoueh/nugrant)
sudo gem install puppet
Debug comands by setting VAGRANT_LOG to the appropriate level

VAGRANT_LOG=debug vagrant $command (to debug)

create ~/.vagrantuser

aws:
  access_key: "YOUR_KEY"
  secret_key: "YOUR_SECRET"
  keypair_name: "$USERNAME"
  ssh_username: "$USERNAME"
  ssh_pubkey: "FULL_PATH_TO_PEM"

vagrant up --provider aws dummy
vagrant ssh
vagrant halt | suspend | destroy

Maintainers

CloudMine Engineering

Types in this module release

anchor

A simple resource type intended to be used as an anchor in a composite class.

In Puppet 2.6, when a class declares another class, the resources in the interior class are not contained by the exterior class. This interacts badly with the pattern of composing complex modules from smaller classes, as it makes it impossible for end users to specify order relationships between the exterior class and other modules.

The anchor type lets you work around this. By sandwiching any interior classes between two no-op resources that are contained by the exterior class, you can ensure that all resources in the module are contained.

  class ntp {
    # These classes will have the correct order relationship with each
    # other. However, without anchors, they won't have any order
    # relationship to Class['ntp'].
    class { 'ntp::package': }
    -> class { 'ntp::config': }
    -> class { 'ntp::service': }

    # These two resources "anchor" the composed classes within the ntp
    # class.
    anchor { 'ntp::begin': } -> Class['ntp::package']
    Class['ntp::service']    -> anchor { 'ntp::end': }
  }

This allows the end user of the ntp module to establish require and before relationships with Class['ntp']:

  class { 'ntp': } -> class { 'mcollective': }
  class { 'mcollective': } -> class { 'ntp': }

Parameters
name	The name of the anchor resource.

file_line

Ensures that a given line is contained within a file. The implementation matches the full line, including whitespace at the beginning and end. If the line is not contained in the given file, Puppet will append the line to the end of the file to ensure the desired state. Multiple resources may be declared to manage multiple lines in the same file.

Example:

    file_line { 'sudo_rule':
      path => '/etc/sudoers',
      line => '%sudo ALL=(ALL) ALL',
    }

    file_line { 'sudo_rule_nopw':
      path => '/etc/sudoers',
      line => '%sudonopw ALL=(ALL) NOPASSWD: ALL',
    }

In this example, Puppet will ensure both of the specified lines are
contained in the file /etc/sudoers.

Match Example:

    file_line { 'bashrc_proxy':
      ensure => present,
      path   => '/etc/bashrc',
      line   => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128',
      match  => '^export HTTP_PROXY=',
    }

In this code example match will look for a line beginning with export
followed by HTTP_PROXY and replace it with the value in line.

Match Example With `ensure => absent`:

    file_line { 'bashrc_proxy':
      ensure            => absent,
      path              => '/etc/bashrc',
      line              => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128',
      match             => '^export HTTP_PROXY=',
      match_for_absence => true,
    }

In this code example match will look for a line beginning with export
followed by HTTP_PROXY and delete it.  If multiple lines match, an
error will be raised unless the `multiple => true` parameter is set.

**Autorequires:** If Puppet is managing the file that will contain the line
being managed, the file_line resource will autorequire that file.

Parameters
after	An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place)
ensure
line	The line to be appended to the file or used to replace matches found by the match attribute.
match	An optional ruby regular expression to run against existing lines in the file. If a match is found, we replace that line rather than adding a new line. A regex comparison is performed against the line value and if it does not match an exception will be raised.
match_for_absence	An optional value to determine if match should be applied when ensure => absent. If set to true and match is set, the line that matches match will be deleted. If set to false (the default), match is ignored when ensure => absent.
multiple	An optional value to determine if match can change multiple lines. If set to false, an exception will be raised if more than one line matches
name	An arbitrary name used as the identity of the resource.
path	The file Puppet will ensure contains the line specified by the line parameter.
provider
replace	If true, replace line that matches. If false, do not write line if a match is found

Providers
ruby

Copyright (c) 2016 CloudMine, Inc.  http://cloudmineinc.com/

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.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started