Forge Home

hosts

Manages host entries

885,888 downloads

205 latest version

4.7 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 3.0.0 (latest)
  • 2.7.0
  • 2.6.0
  • 2.5.0
  • 2.4.1
  • 2.4.0
  • 2.3.0
  • 2.2.3
  • 2.2.2
  • 2.2.1
  • 2.1.0
  • 2.0.1
  • 2.0.0
  • 1.0.0 (deleted)
released Sep 27th 2022
This version is compatible with:
  • Puppet Enterprise 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 8.0.0
  • Debian, RedHat, CentOS, OracleLinux, Scientific, Solaris, SLES, SLED, Ubuntu

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'ghoneycutt-hosts', '3.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add ghoneycutt-hosts
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install ghoneycutt-hosts --version 3.0.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

ghoneycutt/hosts — version 3.0.0 Sep 27th 2022

puppet-module-hosts

Table of Contents

  1. Module Description - What the module does and why it is useful
  2. Setup - The basics of getting started with hosts
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

This is a very simple module to manage host entries in /etc/hosts. It works by applying a hash of host resources.

Documented with Puppet Strings at http://ghoneycutt.github.io/puppet-module-hosts/.

Setup

What hosts affects

Generally just the /etc/hosts file though you may use the target attribute of the host resource to manage host entries in other files.

Setup requiremements

The ability to manage /etc/hosts was moved out of Puppet and into a core module at https://github.com/puppetlabs/puppetlabs-host_core and this module relies upon it.

Beginning with hosts

Declare the hosts class.

Usage

The normal use case. If you are not adding the local system by default as shown below, this is a good option. Then you can just add hosts::hosts entries throughout Hiera.

include hosts

Sample profile which implements functionality from previous versions.

# Lookup everything in Hiera using the key 'host_entries' and add the
# local system with its FQDN and IP address.
$hosts = lookup('host_entries', undef, deep, {}) + {
  $facts['networking']['hostname'] => {
    ensure       => present,
    host_aliases => [$facts['networking']['fqdn']],
    ip           => $facts['networking']['ip'],
  }
}

class { 'hosts':
  hosts => $hosts,
}

Limitations

This module officially supports the platforms listed in the metadata.json. It does not fail on unsupported platforms and has been known to work on many, many platforms since its creation in 2010.

Development

See CONTRIBUTING.md

License

See LICENSE file.