Version information
released Feb 26th 2017
This version is compatible with:
- Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >=4.0.0 < 5.0.0
- , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'hfm-tinyproxy', '0.1.1'Learn more about managing modules with a PuppetfileDocumentation
hfm/tinyproxy — version 0.1.1 Feb 26th 2017
tinyproxy 
Table of Contents
Description
The tinyproxy module handles installing, configuring, and running tinyproxy.
Setup
Setup Requirements
The tinyproxy module requires the following puppet modules:
- puppetlabs-stdlib (>= 4.0.0 < 5.0.0)
- puppetlabs-apt (>= 2.0.0 < 3.0.0) (only Debian-based distributions)
- stahnma-epel (>= 1.0.0 < 2.0.0) (only RedHat-based distributions)
Beginning with tinyproxy
To install the tinyproxy with default parameters, declare the tinyproxy class.
include ::tinyproxy
Usage
Configuring tinyproxy
class { '::tinyproxy':
use_epel => true,
package_ensure => 'installed',
config_ensure => 'file',
service_ensure => 'running',
service_enable => true,
}
Configuring modules from Hiera
---
tinyproxy::use_epel: true
tinyproxy::package_ensure: installed
tinyproxy::config_ensure: file
tinyproxy::service_ensure: running
tinyproxy::service_enable: true
Reference
Public Classes
tinyproxy: Installs, configures, and runs tinyproxy.
Private Classes
tinyproxy::install: Installs the tinyproxy package.tinyproxy::config: Configures tinyproxy.conf.tinyproxy::service: Manages service.
Parameters
Class: tinyproxy
use_epel: Whether epel repository should be installed. Type is Boolean. Default: true.package_ensure: What state the tinyproxy package should be in. Type is String. Default: 'installed'.config_ensure: Whether the tinyproxy.conf should exist. Type is Enum['file', 'absent']. Default: 'file'.service_ensure: Whether a service should be running. Type is Enum['running', 'stopped']. Default: 'running'.service_enable: Whether a service should be enabled to start at boot. Type is Boolean. Default: true.
Limitations
This module has been tested on:
- RedHat Enterprise Linux 7
- CentOS 7
- Scientific Linux 7
- Debian 8
- Ubuntu 16.04
Development
Running tests
The tinyproxy module contains tests for both rspec-puppet (unit tests) and beaker-rspec (acceptance tests) to verify functionality. For detailed information on using these tools, please see their respective documentation.
Testing quickstart
- Unit tests:
$ bundle install
$ bundle exec rake test
- Acceptance tests using docker:
# List available beaker nodesets
$ bundle exec rake beaker_nodes
centos7
jessie
xenial
# Run beaker acceptance tests
$ BEAKER_set=centos7 bundle exec rake beaker
Dependencies
- puppetlabs-stdlib (>= 4.0.0 < 5.0.0)
- stahnma-epel (>= 1.0.0 < 2.0.0)
- puppetlabs-apt (>= 2.0.0 < 3.0.0)
The MIT License (MIT) Copyright (c) 2017 OKUMURA Takahiro 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.