puppet

Module to manage puppet(agent(3)or 4), puppet-server

Module Stats

19,065 downloads

14,163 latest version

2.8 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

released Aug 12th 2016

This version is compatible with:

Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
Puppet >=4.2.0
, ,

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'sjoeboo-puppet', '0.9.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add sjoeboo-puppet

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install sjoeboo-puppet --version 0.9.0

Tags: puppet, puppetserver

Documentation

sjoeboo/puppet — version 0.9.0 Aug 12th 2016

DISCLAIMER

This module started as a fork of jlambert121-puppet, for some fixes/additions, and has since diverged enough I wanted to publish it on its own. This is an awesome module and was already pretty complete when I started to augment it. Credit for 99% of it should go to the original author. I'm simply adding features I need in a production environment.

Overview
Module Description - What the module does and why it is useful
Setup - The basics of getting started with puppet
- What puppet affects
- Beginning with puppet
Usage - Configuration options and additional functionality
- Agent Configuration
- Server Configuration
Reference - An under-the-hood peek at what the module is doing and how
Limitations - OS compatibility, etc.
TODO
Development - Guide for contributing to the module
Changelog/Contributors

Overview

A puppet module to manage puppet-agent(or puppet) and puppetserver (the closure server, not ruby).

Module Description

This is a puppet module to manage puppet(puppet 3.x and 4.x) and puppetserver >= 2.0.0

Currently acceptance tests are a bit wonky due to beaker's inability to handle puppet AIO packages

Setup

What puppet affects

puppet and puppetserver services
cron entry (if desired) for scheduled puppet runs
/etc/puppetlabs/puppet/, /etc/puppetlabs/puppetserver/, maybe /etc/puppet if using a puppet3 agent

Beginning with puppet

This module can be installed with

  puppet module install sjoeboo-puppet

Usage

Basic usage only managing puppet and the puppetmaster at "puppet.${::domain}"

    class { 'puppet': }

Setting up a puppetserver node (with agent running as daemon)

    class { 'puppet':
      runmode => 'service',
      server  => true,
    }

###Parameters

Agent Configuration

#####agent Boolean. Whether or not the agent should be installed

Default: true

#####puppet_version String. Version of the puppet agent to install

Default: latest

#####ca_server String. Hostname of the CA server to be used by the agent

Default: undef

#####use_srv_records Boolean. Whether or not to use DNS SRV records

Default: false

#####srv_domain String. Domain to use for DNS SRV records

Default: undef

#####runmode Enum['cron', 'service', 'none']. How the puppet agent runs should be scheduled.

Default: cron

#####runinterval String. Frequency of agent checkins if runmode is 'service'. No effect otherwise.

Default: 30m

#####environment String. Environment for this agent

Default: production

Server Configuration

#####server Boolean. Whether or not the server should be installed

Default: false

#####dns_alt_names Array[String]. Alternative DNS names for this server

Default: undef

#####fileserver_conf Hash[String, Hash[String, String]]. Fileserver mounts to configure

Default: undef

The format of this value is:

    {
      mountpoint => {
        parameter => value
      }
    }

`manage_hiera`

Boolean. Whether or not this module should manage the hiera.yaml file

Default: true

#####hiera_source String. Source for hiera.yaml to install. Will enable hiera lookups on the server

Default: undef

#####jruby_instances Integer. Number of JRuby instances to start up inside the puppetserver JVM

Default: $::processors[count]-1

Note: if this value is not >= 1, then this is defaulted to 1.

#####server_puppetdb Boolean. Whether or not puppetdb termini and route configuration should be installed

Default: false

#####server_puppetdb_port Integer. Port puppetdb is listening on.

Default: 8081

#####server_puppetdb_server String. Hostname where puppetdb is running. Required if puppetdb => true

Default: undef

#####server_puppetdb_version String. Version of puppetdb-termini to install.

Default: latest

#####server_ca_enabled Boolean. Whether or not to enable the CA server

Default: true

#####server_certname String. Allow overriding certname

Default: undef

#####server_java_opts String. Java options for puppet server

Default: -Xms2g -Xmx2g -XX:MaxPermSize=256m

#####server_log_dir String. Location of puppetserver logs

Default: /var/log/puppetserver

#####server_log_file String. Name of puppetserver logfile

Default: puppetserver.log

#####server_reports Array[String]. List of reports to enable

Default: undef

#####server_version String. Version of puppetserver to install.

Default: latest

#####use_legacy_auth Boolean. Whether to use the deprecated /etc/puppetlabs/puppet/auth.conf (true) or the new /etc/puppetlabs/puppetserver/conf.d/auth.conf (false).

Default: false

#####server_ssl_cert String. Path to server ssl certificate (see https://docs.puppetlabs.com/puppetserver/2.2/config_file_webserver.html)

Default: undef

#####server_ssl_key String. Path to server ssl key (see https://docs.puppetlabs.com/puppetserver/2.2/config_file_webserver.html)

Default: undef

#####server_ssl_ca_cert String. Path to server ssl CA certificate (see https://docs.puppetlabs.com/puppetserver/2.2/config_file_webserver.html)

Default: undef

#####server_ssl_cert_chain String. Path to server ssl certificate chain (see https://docs.puppetlabs.com/puppetserver/2.2/config_file_webserver.html)

Default: undef

#####server_ssl_crl_path String. Path to server ssl CRL (see https://docs.puppetlabs.com/puppetserver/2.2/config_file_webserver.html)

Default: undef

#####webserver_opts Hash. Hash of webserver.conf options, its up to you to make sure they're "Real" https://docs.puppetlabs.com/puppetserver/2.2/config_file_webserver.html)

Default: undef

Reference

Classes

Public Classes

puppet: Entry point for configuring the module

Private Classes

puppet::agent: Controlls ordering and notfications for agent manipulation
puppet::agent::install: Installs puppet-agent
puppet::agent::config: Manages agent configuration
puppet::agent::service: Manages agent service and cron entries
puppet::common: Common packages and settings for agent and server
puppet::params: Default parameters for the puppet class
puppet::server: Controlls ordering and notifications for server manipulation
puppet::server::install: Manages the server packages and paths
puppet::server::config: Manages the server configuration
puppet::server::service: Manages the server service

Limitations

General

This module is acceptance tested on CentOS 6.5, CentOS 7.0, Ubuntu 12.04, and Ubuntu 14.04. Feedback on other platforms/versions would be appreciated

TODO

Generic agent/common/master config hashes to allow setting and config value?
Add a 100% optional bit to install repos for you?

Development

Improvements and bug fixes are greatly appreciated. See the contributing guide for information on adding and validating tests for PRs.

Changelog / Contributors

Changelog

Contributors

Change Log

[0.9.0]

add puppetserver 2.5.0 support by splitting bootstrap.cfg and ca.cfg per [(https://docs.puppet.com/puppetserver/2.5/release_notes.html)]

[0.8.8]

adds webserver_opts hash to allow you to pass arbitrary key/value pairs for webserver.conf

[0.8.5]

added agent_config_hash which will take key:value pairs for agent config options so now we supper them all

0.8.1 (2016-03-03)

Full Changelog

Closed issues:

Move dns_alt_names to [main] section #50

Merged pull requests:

move dns_alt_names up into master, placed by puppet::common #51 (sjoeboo)

0.8.0 (2016-03-03)

Full Changelog

Closed issues:

puppetserver.config.erb file missing USER and GROUP #47
Unexposed options => Raw? #34

Merged pull requests:

Adding USER and GROUP so the service can start on Debian. #48 (mgeggie-uber)
Added support for use-legacy-auth-conf setting in puppetserver.conf - defaulting to false as per puppet defaults. #46 (greigm)

0.7.0 (2016-01-30)

Full Changelog

Closed issues:

puppet::params::puppetdb does not manage puppetdb-termini as described #41

Merged pull requests:

Manage puppetdb #45 (rnelson0)
(GH41) When puppetdb is false, do not manage puppetdb at all #42 (rnelson0)
One small bugfix and added the ability to set agent runinterval. #40 (greigm)

0.6.0 (2015-12-15)

Full Changelog

Closed issues:

Please provide the ability to disable hiera.yaml management #36
bootstrap.cfg template lacks trapperkeeper authorization service line #35

Merged pull requests:

version bump: 0.6.0 #39 (jlambert121)
add authorization service to bootstrap #38 (jlambert121)
provide the ability to not manage hiera.yaml #37 (jlambert121)
Exposed ability to set number of jruby instances and set a sane default. #32 (jbehrends)
version bump: 0.5.0 #31 (jlambert121)

0.5.0 (2015-10-23)

Full Changelog

Closed issues:

Feature Request: Enable ca-proxy similar to passenger or pe-ca-proxy #12

Merged pull requests:

Roidelapluie master #30 (jlambert121)
bump puppet requirement to >= 4.2.0 #29 (jlambert121)
updating config templates to match what's shipped with puppetserver-2.1.1 (v4.2) #28 (jbehrends)
Updating to reflect name change of the puppetdb-terminus package to puppetdb-termini #27 (jbehrends)
correct source url in metadata #25 (jlambert121)
allow changing environment from agent #24 (jlambert121)
format todo list properly #23 (mmckinst)
version bump: 0.3.2 #22 (jlambert121)

0.3.2 (2015-05-02)

Full Changelog

Merged pull requests:

fix undefined variable in fileserver template #21 (jlambert121)

0.3.1 (2015-05-01)

Full Changelog

Merged pull requests:

version bump: 0.3.1 #20 (jlambert121)
fix for puppetserver.conf paths #19 (jlambert121)
add support for puppet firewall module #18 (jlambert121)
fix spec test #17 (jlambert121)
version bump: 0.3.0 #16 (jlambert121)

0.3.0 (2015-05-01)

Merged pull requests:

update puppetserver logs dir #15 (jlambert121)
documentation update #14 (jlambert121)
support puppet 4.0 #13 (jlambert121)
fix spec tests #11 (jlambert121)
move dns_alt_name to main section #10 (jlambert121)
add lint plugins #9 (jlambert121)
version bump: 0.2.0 #8 (jlambert121)
update puppet.conf parameters #7 (jlambert121)
enable trusted_node_data #6 (jlambert121)
normalize common files #5 (jlambert121)
fix path to fileserver template #4 (jlambert121)
fix server::config::fileserver var #3 (jlambert121)
update templates for puppetserver 1.0 #2 (jlambert121)
add travis support #1 (jlambert121)

* This Change Log was automatically generated by github_changelog_generator

                              Apache License
                        Version 2.0, January 2004
                     http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

   "License" shall mean the terms and conditions for use, reproduction,
   and distribution as defined by Sections 1 through 9 of this document.

   "Licensor" shall mean the copyright owner or entity authorized by
   the copyright owner that is granting the License.

   "Legal Entity" shall mean the union of the acting entity and all
   other entities that control, are controlled by, or are under common
   control with that entity. For the purposes of this definition,
   "control" means (i) the power, direct or indirect, to cause the
   direction or management of such entity, whether by contract or
   otherwise, or (ii) ownership of fifty percent (50%) or more of the
   outstanding shares, or (iii) beneficial ownership of such entity.

   "You" (or "Your") shall mean an individual or Legal Entity
   exercising permissions granted by this License.

   "Source" form shall mean the preferred form for making modifications,
   including but not limited to software source code, documentation
   source, and configuration files.

   "Object" form shall mean any form resulting from mechanical
   transformation or translation of a Source form, including but
   not limited to compiled object code, generated documentation,
   and conversions to other media types.

   "Work" shall mean the work of authorship, whether in Source or
   Object form, made available under the License, as indicated by a
   copyright notice that is included in or attached to the work
   (an example is provided in the Appendix below).

   "Derivative Works" shall mean any work, whether in Source or Object
   form, that is based on (or derived from) the Work and for which the
   editorial revisions, annotations, elaborations, or other modifications
   represent, as a whole, an original work of authorship. For the purposes
   of this License, Derivative Works shall not include works that remain
   separable from, or merely link (or bind by name) to the interfaces of,
   the Work and Derivative Works thereof.

   "Contribution" shall mean any work of authorship, including
   the original version of the Work and any modifications or additions
   to that Work or Derivative Works thereof, that is intentionally
   submitted to Licensor for inclusion in the Work by the copyright owner
   or by an individual or Legal Entity authorized to submit on behalf of
   the copyright owner. For the purposes of this definition, "submitted"
   means any form of electronic, verbal, or written communication sent
   to the Licensor or its representatives, including but not limited to
   communication on electronic mailing lists, source code control systems,
   and issue tracking systems that are managed by, or on behalf of, the
   Licensor for the purpose of discussing and improving the Work, but
   excluding communication that is conspicuously marked or otherwise
   designated in writing by the copyright owner as "Not a Contribution."

   "Contributor" shall mean Licensor and any individual or Legal Entity
   on behalf of whom a Contribution has been received by Licensor and
   subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   copyright license to reproduce, prepare Derivative Works of,
   publicly display, publicly perform, sublicense, and distribute the
   Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   (except as stated in this section) patent license to make, have made,
   use, offer to sell, sell, import, and otherwise transfer the Work,
   where such license applies only to those patent claims licensable
   by such Contributor that are necessarily infringed by their
   Contribution(s) alone or by combination of their Contribution(s)
   with the Work to which such Contribution(s) was submitted. If You
   institute patent litigation against any entity (including a
   cross-claim or counterclaim in a lawsuit) alleging that the Work
   or a Contribution incorporated within the Work constitutes direct
   or contributory patent infringement, then any patent licenses
   granted to You under this License for that Work shall terminate
   as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
   Work or Derivative Works thereof in any medium, with or without
   modifications, and in Source or Object form, provided that You
   meet the following conditions:

   (a) You must give any other recipients of the Work or
       Derivative Works a copy of this License; and

   (b) You must cause any modified files to carry prominent notices
       stating that You changed the files; and

   (c) You must retain, in the Source form of any Derivative Works
       that You distribute, all copyright, patent, trademark, and
       attribution notices from the Source form of the Work,
       excluding those notices that do not pertain to any part of
       the Derivative Works; and

   (d) If the Work includes a "NOTICE" text file as part of its
       distribution, then any Derivative Works that You distribute must
       include a readable copy of the attribution notices contained
       within such NOTICE file, excluding those notices that do not
       pertain to any part of the Derivative Works, in at least one
       of the following places: within a NOTICE text file distributed
       as part of the Derivative Works; within the Source form or
       documentation, if provided along with the Derivative Works; or,
       within a display generated by the Derivative Works, if and
       wherever such third-party notices normally appear. The contents
       of the NOTICE file are for informational purposes only and
       do not modify the License. You may add Your own attribution
       notices within Derivative Works that You distribute, alongside
       or as an addendum to the NOTICE text from the Work, provided
       that such additional attribution notices cannot be construed
       as modifying the License.

   You may add Your own copyright statement to Your modifications and
   may provide additional or different license terms and conditions
   for use, reproduction, or distribution of Your modifications, or
   for any such Derivative Works as a whole, provided Your use,
   reproduction, and distribution of the Work otherwise complies with
   the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
   any Contribution intentionally submitted for inclusion in the Work
   by You to the Licensor shall be under the terms and conditions of
   this License, without any additional terms or conditions.
   Notwithstanding the above, nothing herein shall supersede or modify
   the terms of any separate license agreement you may have executed
   with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
   names, trademarks, service marks, or product names of the Licensor,
   except as required for reasonable and customary use in describing the
   origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
   agreed to in writing, Licensor provides the Work (and each
   Contributor provides its Contributions) on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
   implied, including, without limitation, any warranties or conditions
   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
   PARTICULAR PURPOSE. You are solely responsible for determining the
   appropriateness of using or redistributing the Work and assume any
   risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
   whether in tort (including negligence), contract, or otherwise,
   unless required by applicable law (such as deliberate and grossly
   negligent acts) or agreed to in writing, shall any Contributor be
   liable to You for damages, including any direct, indirect, special,
   incidental, or consequential damages of any character arising as a
   result of this License or out of the use or inability to use the
   Work (including but not limited to damages for loss of goodwill,
   work stoppage, computer failure or malfunction, or any and all
   other commercial damages or losses), even if such Contributor
   has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
   the Work or Derivative Works thereof, You may choose to offer,
   and charge a fee for, acceptance of support, warranty, indemnity,
   or other liability obligations and/or rights consistent with this
   License. However, in accepting such obligations, You may act only
   on Your own behalf and on Your sole responsibility, not on behalf
   of any other Contributor, and only if You agree to indemnify,
   defend, and hold each Contributor harmless for any liability
   incurred by, or claims asserted against, such Contributor by reason
   of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

   To apply the Apache License to your work, attach the following
   boilerplate notice, with the fields enclosed by brackets "[]"
   replaced with your own identifying information. (Don't include
   the brackets!)  The text should be enclosed in the appropriate
   comment syntax for the file format. We also recommend that a
   file or class name and description of purpose be included on the
   same "printed page" as the copyright notice for easier
   identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

puppet

Support the Puppet Community by contributing to this module

Version information

This version is compatible with:

Start using this module

Documentation

DISCLAIMER

Table of Contents

Overview

Module Description

Setup

What puppet affects

Beginning with puppet

Usage

Agent Configuration

Server Configuration

manage_hiera

Reference

Classes

Public Classes

Private Classes

Limitations

General

TODO

Development

Changelog / Contributors

Change Log

[0.9.0]

[0.8.8]

[0.8.5]

0.8.1 (2016-03-03)

0.8.0 (2016-03-03)

0.7.0 (2016-01-30)

0.6.0 (2015-12-15)

0.5.0 (2015-10-23)

0.3.2 (2015-05-02)

0.3.1 (2015-05-01)

0.3.0 (2015-05-01)

Dependencies

`manage_hiera`