Skip to content
This module configures the Hosts file.
Ruby Puppet HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
lib/facter
manifests
spec
templates
.fixtures.yml
.gitignore
.msync.yml
.rspec
.rubocop.yml
.sync.yml
.travis.yml
.yardopts
CHANGELOG.md
Gemfile
LICENSE
README.md
Rakefile
metadata.json

README.md

hosts

Build Status Code Coverage Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores

Table of Contents

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

Overview

This module configures the Hosts file.

Module Description

This module handles configuring Hosts across a range of operating systems and distributions.

Setup

What hosts affects

  • hosts configuration file.

Setup Requirements

Beginning with hosts

Install hosts with the default parameters (No configuration files will be changed).

    class { 'hosts': }

Install hosts with the recommended parameters.

    class { 'hosts':
      config_file_template => "hosts/${::lsbdistcodename}/etc/hosts.erb",
    }

Usage

Update the hosts package.

    class { 'hosts':
      package_ensure => 'latest',
    }

Remove the hosts package.

    class { 'hosts':
      package_ensure => 'absent',
    }

Purge the hosts package (All configuration files will be removed).

    class { 'hosts':
      package_ensure => 'purged',
    }

Deploy the configuration files from source directory.

    class { 'hosts':
      config_dir_source => "puppet:///modules/hosts/${::lsbdistcodename}/etc",
    }

Deploy the configuration files from source directory (Unmanaged configuration files will be removed).

    class { 'hosts':
      config_dir_purge  => true,
      config_dir_source => "puppet:///modules/hosts/${::lsbdistcodename}/etc",
    }

Deploy the configuration file from source.

    class { 'hosts':
      config_file_source => "puppet:///modules/hosts/${::lsbdistcodename}/etc/hosts",
    }

Deploy the configuration file from string.

    class { 'hosts':
      config_file_string => '# THIS FILE IS MANAGED BY PUPPET',
    }

Deploy the configuration file from template.

    class { 'hosts':
      config_file_template => "hosts/${::lsbdistcodename}/etc/hosts.erb",
    }

Deploy the configuration file from custom template (Additional parameters can be defined).

    class { 'hosts':
      config_file_template     => "hosts/${::lsbdistcodename}/etc/hosts.erb",
      config_file_options_hash => {
        'key' => 'value',
      },
    }

Deploy additional configuration files from source, string or template.

    class { 'hosts':
      config_file_hash => {
        'hosts.2nd' => {
          config_file_path   => '/etc/hosts.2nd',
          config_file_source => "puppet:///modules/hosts/${::lsbdistcodename}/etc/hosts.2nd",
        },
        'hosts.3rd' => {
          config_file_path   => '/etc/hosts.3rd',
          config_file_string => '# THIS FILE IS MANAGED BY PUPPET',
        },
        'hosts.4th' => {
          config_file_path     => '/etc/hosts.4th',
          config_file_template => "hosts/${::lsbdistcodename}/etc/hosts.4th.erb",
        },
      },
    }

Reference

Classes

Public Classes

  • hosts: Main class, includes all other classes.

Private Classes

  • hosts::install: Handles the packages.
  • hosts::config: Handles the configuration file.

Parameters

package_ensure

Determines if the package should be installed. Valid values are 'present', 'latest', 'absent' and 'purged'. Defaults to 'present'.

package_name

Determines the name of package to manage. Defaults to 'undef'.

package_list

Determines if additional packages should be managed. Defaults to 'undef'.

config_dir_ensure

Determines if the configuration directory should be present. Valid values are 'absent' and 'directory'. Defaults to 'directory'.

config_dir_path

Determines if the configuration directory should be managed. Defaults to '/etc'

config_dir_purge

Determines if unmanaged configuration files should be removed. Valid values are 'true' and 'false'. Defaults to 'false'.

config_dir_recurse

Determines if the configuration directory should be recursively managed. Valid values are 'true' and 'false'. Defaults to 'true'.

config_dir_source

Determines the source of a configuration directory. Defaults to 'undef'.

config_file_ensure

Determines if the configuration file should be present. Valid values are 'absent' and 'present'. Defaults to 'present'.

config_file_path

Determines if the configuration file should be managed. Defaults to '/etc/hosts'

config_file_owner

Determines which user should own the configuration file. Defaults to 'root'.

config_file_group

Determines which group should own the configuration file. Defaults to 'root'.

config_file_mode

Determines the desired permissions mode of the configuration file. Defaults to '0644'.

config_file_source

Determines the source of a configuration file. Defaults to 'undef'.

config_file_string

Determines the content of a configuration file. Defaults to 'undef'.

config_file_template

Determines the content of a configuration file. Defaults to 'undef'.

config_file_require

Determines which package a configuration file depends on. Defaults to 'undef'.

config_file_hash

Determines which configuration files should be managed via hosts::define. Defaults to '{}'.

config_file_options_hash

Determines which parameters should be passed to an ERB template. Defaults to '{}'.

Limitations

This module has been tested on:

  • Debian 6/7/8
  • Ubuntu 12.04/14.04/16.04

Development

Bug Report

If you find a bug, have trouble following the documentation or have a question about this module - please create an issue.

Pull Request

If you are able to patch the bug or add the feature yourself - please make a pull request.

Contributors

The list of contributors can be found at: https://github.com/dhoppe/puppet-hosts/graphs/contributors

You can’t perform that action at this time.