Skip to content

Latest commit

 

History

History
115 lines (80 loc) · 3.17 KB

README.md

File metadata and controls

115 lines (80 loc) · 3.17 KB

h2o Build Status Puppet Forge

Table of Contents

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

Description

The h2o module handles installing, configuring, and running h2o.

Setup

Setup Requirements

Beginning with h2o

To install the h2o with default parameters, declare the h2o class.

include ::h2o

Usage

Configuring h2o

class { 'h2o':
  package_ensure => '2.2.2-1~ubuntu16.04.1',
}

Configuring modules from Hiera

h2o::package_ensure: '2.2.2-1~ubuntu16.04.1'

Reference

Public Classes

  • h2o: Installs and runs h2o.

Private Classes

  • h2o::install: Installs the h2o package.
  • h2o::repo: Manages the h2o repository.
  • h2o::repo::yum: Manages the Yum repository.
  • h2o::repo::apt: Manages the Apt sources.
  • h2o::service: Manages service.

Parameters

h2o class

  • repo_ensure: Specifies whether the h2o repository should exist. Type is the String. Default: 'present'.
  • package_ensure: What state the package should be in. Type is the String. Default: 'installed'.
  • service_ensure: Whether a service should be running. Type is the String. Default: 'running'.
  • service_enable: Whether a service should be enabled to start at boot. Type is the Boolean. Default: true.

Limitations

This module has been tested on:

  • RedHat Enterprise Linux 6, 7
  • CentOS 6, 7
  • Scientific Linux 6, 7
  • Fedora 22, 23, 24, 25
  • Debian 7, 8
  • Ubuntu 14.04, 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
xenial

# Run beaker acceptance tests
$ BEAKER_set=xenial bundle exec rake beaker