Getting started: Installing modules

This version is out of date. For current versions, see Puppet Enterprise support lifecycle.

After installing PE and Windows agents, you're ready to install modules. Modules are shareable, reusable units of Puppet code that extend Puppet across your infrastructure by automating tasks such as setting up a database, web server, or mail server. In this section, you'll install a module from the Puppet Forge.

The Puppet Forge is a repository for Puppet modules created by Puppet and by the Puppet community. It contains thousands of modules submitted by users and Puppet 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.

In this guide, you install the puppetlabs-wsus_client module, a Puppet Enterprise supported module. In a subsequent section, Writing modules for Windows, you 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.

These instructions assume you have installed a monolithic PE deployment, and installed at least one Windows agent node.

Create the modules directory

By default, Puppet keeps modules in /etc/puppetlabs/code/environments/production/modules or from a Windows directory, C:\ProgramData\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.

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.
Navigate to production and run mkdir modules.

Install a Forge module

The wsus_client module, or Windows Server Update Service (WSUS) module, lets Windows administrators manage operating system updates using their own servers instead of Microsoft's Windows Update servers.

Run puppet module install puppetlabs-wsus_client.
This is the output (on a *nix machine):
Preparing to install into /etc/puppetlabs/code/environments/production/modules ...
Notice: Downloading from ...
Notice: Installing -- do not interrupt ...
└─┬ puppetlabs-wsus_client (v1.0.1)
├── puppetlabs-registry (v1.1.3)
└── puppetlabs-stdlib (v4.11.0)
If you're installing a module directly on your Windows machine, the output looks like this:
PS C:\Users\Administrator> puppet module install puppetlabs-wsus_client
Notice: Preparing to install into 
C:/ProgramData/PuppetLabs/code/environments/production/modules ...
Notice: Downloading from ...
Notice: Installing -- do not interrupt ...
+-- puppetlabs-wsus_client (v1.0.1)
  +-- puppetlabs-registry (v1.1.3)
  +-- puppetlabs-stdlib (v4.11.0)

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

Next: Adding classes to Puppet agent nodes (Windows)

See an issue? Please file a JIRA ticket in our [DOCUMENTATION] project
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.