puppet-runscope_gateway

Table of Contents

1. Overview
2. Requirements - OSes and Puppet modules
3. Usage - Quickly getting started
4. Configuration - Required and optional configuration options
5. Development - Guide for contributing to the module
6. Maintainers - Who helps keep this module up to date
7. 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

• puppet/archive
• puppetlabs/stdlib

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