Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

pe_console

Puppet Enterprise console module
Project URLRSS FeedReport issues

10,370 downloads

10,098 latest version

3.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.

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:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. 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

  • 0.0.2 (latest)
  • 0.0.1
released Oct 2nd 2013

Start using this module

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

Add this module to your Puppetfile:

mod 'reidmv-pe_console', '0.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add reidmv-pe_console
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install reidmv-pe_console --version 0.0.2

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

reidmv/pe_console — version 0.0.2 Oct 2nd 2013

#pe_console

####Table of Contents

  1. Overview - What is the [Modulename] module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with [Modulename]
  4. Usage - Configuration options and additional functionality
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

##Overview

Pe_console quickly and simply sets up the Puppet Enterprise Console.

##Module Description

A brief description of the technology (if applicable) the module is working with, and how the module interacts with that technology. This section should answer the questions: "What does this module do?" and "Why would I use it?"

If your module has a range of functionality (installation, configuration, managment, etc.) this is the time to mention it.

##Setup

###What pe_console affects

  • A list of files, packages, services, or operations that the module will alter, impact, or execute on a user's system.
  • This is a great place to stick any Warnings.

###Setup Requirements

You must have downloaded the Puppet Enterprise bundle and have it present on the system you are running the module on.

While you may run any PE Deploy module individually, it is advices that you have run

###Beginning with [Modulename]

The very basic steps needed for a user to get the module running.

##Usage

Classes, types, and resources for customizing, configuring and doing the fancy stuff with your module.

##Reference

###Class: pe_console

This is a top-level wrapper class intended to be used in an environment where most parameters come from hiera. Every default should be undef if it's really just a passthrough to a lower-level class (defaults will be supplied by that lower-level class).

##Limitations

OS compatibility, etc.

##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.

You can read the complete module contribution guide on the Puppet Labs wiki.

##Release Notes Optional

If you aren't using changelog.