Module installation quick start guide

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

The Puppet Forge 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 a subsequent section, Module Writing Basics for Windows QSG 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.

Before you begin: install a monolithic PE deployment, and install 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.

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

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.

  1. 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 http://forgeapi.puppetlabs.com ...
     Notice: Installing -- do not interrupt ...
     /etc/puppetlabs/code/environments/production/modules
     └─┬ 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 https://forgeapi.puppetlabs.com ...
     Notice: Installing -- do not interrupt ...
     C:/ProgramData/PuppetLabs/code/environments/production/modules
     +-- 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)

↑ Back to top