Module Installation Quick Start Guide

A newer version is available; see the version menu above for details.

Overview

In this guide, you’ll install the puppetlabs-wsus_client module, a Puppet Enterprise supported module. Modules contain classes, which are named chunks of Puppet code and are the primary means by which Puppet Enterprise configures and manages nodes.

The Puppet Labs Forge contains thousands of modules submitted by users and Puppet Labs module developers that you can use. In addition, PE customers can take advantage of supported modules; these modules–designed to make common services easier–are tested and maintained by Puppet Labs.

In Module Writing Basics for Windows QSG you’ll learn more about modules, including how to write your own modules.

The process for installing a module is the same on both Windows and *nix operating systems.

Prerequisites: This guide assumes you’ve already installed a monolithic PE deployment, and have installed at least one Windows agent node.

Installing a Forge Module

  1. To install the wsus_client module, run puppet module install puppetlabs-wsus_client. Here’s what happens:

     Preparing to install into /etc/puppetlabs/code/environments/production/modules ...
     Notice: Downloading from http://forgeapi.puppetlabs.com ...
     Notice: Installing -- do not interrupt ...
     /etc/puppetlabs/code/environments/production/modules
     └── puppetlabs-wsus_client
    

You have just installed a Puppet module. All of the classes in the module are now available to be added to the console and assigned to nodes.

A Quick Note about Modules Directories

By default, Puppet keeps modules in /etc/puppetlabs/code/environments/production/modules. This includes modules installed by PE, those that you download from the Forge, and those you write yourself. In a fresh installation, you need to create this modules subdirectory yourself by navigating to /etc/puppetlabs/code/environments/production and running mkdir modules.

Note: PE creates two other module directories: /opt/puppetlabs/puppet/modules and /etc/puppetlabs/staging-code/modules. Don’t modify anything in or add modules of your own to /opt/puppetlabs/puppet/modules. The /etc/puppetlabs/staging-code/modules directory is for file sync use only; if you are not using Code Manager or file sync, do not add code to this directory.


Next: Adding Classes to Puppet Agent Nodes (Windows)

↑ Back to top