The 2018 State of DevOps Report
Get the report

Writing modules for *nix quick start guide

+ expand all - collapse all
+ open menu - close menu

Puppet Enterprise 2017.2

  1. Where are modules kept?
  2. How are modules structured?
    1. Edit a module’s manifest and use the edited module
  3. Write a new module
  4. More information about writing classes
  5. Next steps

In this quick start guide, you’ll modify a Forge module, and write a simple module of your own.

Modules are reusable chunks of Puppet code, and are the basic building blocks of any PE deployment. Some modules from the Puppet Forge will precisely fit your needs, but many are almost — but not quite — what you need. As a PE user, you’ll sometimes adapt pre-written modules to suit your deployment’s requirements. In other cases, you’ll need to write your own modules from scratch.

Where are modules kept?

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. You can configure this path with the modulepath setting in puppet.conf.

PE also creates another module directory at /opt/puppetlabs/puppet/modules. Don’t modify anything in this directory, or add modules of your own to it.

How are modules structured?

Modules are directory trees. For example, you’ll find the following files in the puppetlabs-apache module:

  • apache/ (the module name)
    • manifests/
      • init.pp (contains the apache class)
      • php.pp (contains the php class to install PHP for Apache)
      • vhost.pp (contains the Apache virtual hosts class)
    • templates/
      • vhost/
        • _file_header.erb (contains the vhost template, managed by PE)

Every manifest (.pp) file contains a single class. File names map to class names in a predictable way: init.pp contains a class with the same name as the module, in this case apache. <NAME>.pp contains a class called <MODULE NAME>::<NAME>. <NAME>/<OTHER NAME>.pp contains <MODULE NAME>::<NAME>::<OTHER NAME>.

Many modules, including Apache, contain directories other than manifests and templates. For simplicity’s sake, we do not cover them in this introductory guide.

FAQs

Edit a module’s manifest and use the edited module

In this simplified exercise, you’ll modify a template from the puppetlabs-apache module, specifically 'vhost.conf.erb, to include some simple variables that will be automatically populated with facts about your node.

Before you begin, make sure you have installed:

Note: You should be logged in as root or administrator on your nodes.

  1. On the Puppet master, navigate to the modules directory by running cd /etc/puppetlabs/code/environments/production/modules.
  2. Run ls to view the currently installed modules and note that apache is present.

  3. Open apache/templates/vhost/_file_header.erb in a text editor. (Avoid using Notepad because it can introduce errors.) The _file_header.erb file contains the following header:

     # ************************************
 # Vhost template in module puppetlabs-apache
 # Managed by Puppet
 # ************************************
  4. Use PE’s lookup tool, Facter, to collect the following facts about your agent node:
    • run facter operatingsystem (this returns your agent node’s OS)
    • run facter id (this returns the id of the currently logged in user)

  5. Edit the header of _file_header.erb so that it contains the following variables for Facter lookups:

     # ************************************
 # Vhost template in module puppetlabs-apache
 # Managed by Puppet
 #
 # This file is authorized for deployment by <%= scope.lookupvar('::id') %>.
 #
 # This file is authorized for deployment ONLY on <%= scope.lookupvar('::operatingsystem') %> <%= scope.lookupvar('::operatingsystemmajrelease')     %>.
 #
 # Deployment by any other user or on any other system is strictly prohibited.
 # ************************************

  6. In the console, add apache to the available classes, and then add that class to your agent node. Refer to the Adding classes quick start guide if you need help with these steps.

    When Puppet runs, it configures Apache and starts the httpd service. When this happens, a default Apache vhost is created based on the contents of _file_header.erb.

  7. On the agent node, navigate to one of the following locations, depending on your operating system:
    • Redhat-based: /etc/httpd/conf.d
    • Debian-based: /etc/apache2/sites-available

  8. View 15-default.conf; depending on the node’s OS, the header shows some variation of the following contents:

     # ************************************
 # Vhost template in module puppetlabs-apache
 # Managed by Puppet
 #
 # This file is authorized for deployment by root.
 #
 # This file is authorized for deployment ONLY on Redhat 6.
 #
 # Deployment by any other user or on any other system is strictly prohibited.
 # ************************************

As you can see, PE has used Facter to retrieve some key facts about your node, and then used those facts to populate the header of your vhost template.

Write a new module

In this exercise, you will create a class called pe_quickstart_app that manages a PHP-based web app running on an Apache virtual host.

Before you begin, make sure you have installed:

Note: You should be logged in as root or administrator on your nodes.

  1. On the Puppet master, make sure you’re still in the modules directory:cd /etc/puppetlabs/code/environments/production/modules. Then run mkdir -p pe_quickstart_app/manifests to create the new module’s directory and its manifests directory.
  2. Use your text editor to create and open the pe_quickstart_app/manifests/init.pp file.

  3. Edit the init.pp file so it contains the following Puppet code, and then save it and exit the editor:

     class pe_quickstart_app {

   class { 'apache':
     mpm_module => 'prefork',
   }

   include apache::mod::php

   apache::vhost { 'pe_quickstart_app':
     port     => '80',
     docroot  => '/var/www/pe_quickstart_app',
     priority => '10',
   }

   file { '/var/www/pe_quickstart_app/index.php':
     ensure  => file,
     content => "<?php phpinfo() ?>\n",
     mode    => '0644',
   }

 }

    You have written a new module called pe_quickstart_app containing a new class that includes two other classes.

    Additional details about your new class:

    • The class apache has been modified to include the mpm_module attribute; this attribute determines which multi-process module is configured and loaded for the Apache (HTTPD) process. In this case, the value is set to prefork.
    • include apache::mod::php indicates that your new class relies on those classes to function correctly. However, PE understands that your node needs to be classified with these classes and completes that work automatically when you classify your node with the pe_quickstart_app class; in other words, you don’t need to worry about classifying your nodes with Apache and Apache PHP.
    • The priority attribute of 10 ensures that your app has a higher priority on port 80 than the default Apache vhost app.
    • The file /var/pe_quickstart_app/index.php contains whatever is specified by the content attribute. This is the content you see when you launch your app. PE uses the ensure attribute to create that file the first time the class is applied.
  4. Using the workflow from the Adding classes quick start guide, add your new class to the console and assign it to nodes.

Congratulations! Your first module is up and running. There are plenty of additional resources about modules and the creation of modules that you can reference. Check out Puppet: Module fundamentals, Puppet: The modulepath, the Beginner’s guide to modules, and the Puppet Forge.

More information about writing classes

For more information about writing classes, refer to the following documentation:

Next steps

You’ve reached the end of the PE *nix quick start guide series, and can now perform the core workflows of a Puppet user. We recommend the following next steps:

Back to top