Version information
This version is compatible with:
- Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.7.0 < 6.0.0
- , , , , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-host_core', '1.0.0'
Learn more about managing modules with a PuppetfileDocumentation
host_core
Table of Contents
- Description
- Usage - Configuration options and additional functionality
- Development - Guide for contributing to the module
Description
The host_core module is used to manage host entries in a hosts file. For most systems, the hosts file is located in /etc/hosts
.
Beginning with host_core
To configure a localhost
host entry to resolve to an ip
with a list of host_aliases
use the following:
host { 'localhost':
ensure => 'present',
host_aliases => ['localhost.localdomain', 'localhost4', 'localhost4.localdomain4'],
ip => '127.0.0.1',
target => '/etc/hosts',
}
Usage
For details on usage, please see the host puppet docs.
Reference
Please see REFERENCE.md for the reference documentation.
This module is documented using Puppet Strings.
For a quick primer on how Strings works, please see this blog post or the README.md for Puppet Strings.
To generate documentation locally, run
bundle install
bundle exec puppet strings generate ./lib/**/*.rb
This command will create a browsable _index.html
file in the doc
directory. The references available here are all generated from YARD-style comments embedded in the code base. When any development happens on this module, the impacted documentation should also be updated.
Development
Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.
We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
For more information, see our module contribution guide.
Reference
Table of Contents
Resource types
host
: Installs and manages host entries. For most systems, these entries will just be in/etc/hosts
, but some systems (notably OS X) will have d
Resource types
host
Installs and manages host entries. For most systems, these
entries will just be in /etc/hosts
, but some systems (notably OS X)
will have different solutions.
Properties
The following properties are available in the host
type.
ensure
Valid values: present, absent
The basic property that the resource should be in.
Default value: present
ip
The host's IP address, IPv4 or IPv6.
host_aliases
Any aliases the host might have. Multiple values must be specified as an array.
comment
A comment that will be attached to the line with a # character.
target
The file in which to store service information. Only used by
those providers that write to disk. On most systems this defaults to /etc/hosts
.
Parameters
The following parameters are available in the host
type.
name
namevar
The host name.
Types in this module release
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
1.0.0 - 2018-07-13
Summary
This is the initial release of the extracted host module