Autofs Puppet Module

Table of Contents

1. Description - - What the module does and why it is useful
2. Setup - The basics of getting started with Autofs

• The module manages the following
• Requirements
• Incompatibilities

3. Usage - Configuration options and additional functionality
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc
6. Development - Guide for contributing to the module
7. Support - When you need help with this module

Description

The Autofs module is a Puppet module for managing the configuration of automount network file system. This is a global module designed to be used by any organization. This module assumes the use of Hiera to set variables and serve up configuration files.

Setup

The Module manages the following:

• Autofs package
• Autofs service
• Autofs Configuration File (/etc/auto.master)
• Autofs Map Files (i.e. /etc/auto.home)

Requirements

• The stdlib Puppet Library
• The concat Puppet Module

Usage

The module includes a single class:

include autofs

By default this installs and starts the autofs service with the default master file. No parameters exist yet, but are in active development to allow for more granular control.

To manage the service, use the following code in your profile:

class { 'autofs':
  service_enable => false,
  service_ensure => 'stopped'
}

Map Files

To setup the Autofs Map Files, there is a defined type that can be used:

autofs::mount { 'home':
  mount       => '/home',
  mapfile     => '/etc/auto.home',
  mapcontents => ['* -user,rw,soft,intr,rsize=32768,wsize=32768,tcp,nfsvers=3,noacl server.example.com:/path/to/home/shares'],
  options     => '--timeout=120',
  order       => 01
}

This will generate content in both the auto.master file and a new auto.home map file:

auto.master

/home /etc/auto.home --timeout=120

auto.home

* -user,rw,soft,intr,rsize=32768,wsize=32768,tcp,nfsvers=3,noacl server.example.com:/path/to/home/shares

The defined type requires all parameters, except direct and execute, to build the autofs config. The direct and execute parameters allow for the creation of indirect mounts, see the Parameters section for more information on the defaults for direct and execute.

In hiera, there's a autofs::mounts class you can configure, for example:

---
autofs::mounts:
  home:
    mount: '/home'
    mapfile: '/etc/auto.home'
    mapcontents:
      - '* -user,rw,soft,intr,rsize=32768,wsize=32768,tcp,nfsvers=3,noacl server.example.com:/path/to/home/shares'
    options: '--timeout=120'
    order: 01

Direct Map /- arugment

The autofs module also supports the use of the built in autofs /- argument used with Direct Maps.

Examples:

Define:

autofs::mount { 'foo':
  mount       => '/-',
  mapfile     => '/etc/auto.foo',
  mapcontents => ['/foo -o options /bar'],
  options     => '--timeout=120',
  order       => 01
}

Hiera:

---
autofs::mounts:
  foo:
    mount: '/-'
    mapfile: '/etc/auto.foo'
    mapcontents:
      - '/foo -o options /bar'
    options: '--timeout=120'
    order: 01

Autofs +dir: options

The autofs module now supports the use of the +dir: option in the auto.master. This option is 100% functional, but does require some work to simplify it.

Usage

Define:

autofs::mount { 'home':
  mount       => '/home',
  mapfile     => '/etc/auto.home',
  mapcontents => ['* -user,rw,soft,intr,rsize=32768,wsize=32768,tcp,nfsvers=3,noacl server.example.com:/path/to/home/shares'],
  options     => '--timeout=120',
  order       => 01,
  use_dir     => true
}

Hiera:

---
autofs::mounts:
  home:
    mount: '/home'
    mapfile: '/etc/auto.home'
    mapcontents:
      - '* -user,rw,soft,intr,rsize=32768,wsize=32768,tcp,nfsvers=3,noacl server.example.com:/path/to/home/shares'
    options: '--timeout=120'
    order: 01
    use_dir: true

Reference

Parameters

• mount_name - This is a logical, descriptive name for what what autofs will be mounting. This is represented by the home: and tmp: entries above.
• mount - This Mapping describes where autofs will be mounting to. This map entry is referenced by concat as part of the generation of the /etc/auto.master file.
• mapfile - This Mapping describes the name and path of the autofs map file. This mapping is used in the auto.master generation, as well as generating the map file from the auto.map.erb template. This parameter is no longer required.
• mapcontent - This Mapping describes the folders that will be mounted, the mount options, and the path to the remote or local share to be mounted. Used in mapfile generation.
• options - This Mapping describes the auto.master options to use (if any) when mounting the automounts.
• order - This Mapping describes where in the auto.master file the entry will be placed. Order CANNOT be duplicated.
• master - This Parameter sets the path to the auto.master file. Defaults to /etc/auto.master.
• map_dir - This Parameter sets the path to the Autofs configuration directory for map files. Applies only to autofs 5.0.5 or later. Defaults to /etc/auto.master.d.
• use_dir - This Parameter tells the module if it is going to use $map_dir. Defaults to false.
• direct - Boolean to allow for indirect map. Defaults to true to be backwards compatible.
• execute - Boolean to set the map to be executable. Defaults to false to be backward compatible.
• replace - Boolean to set the map file to not be replaced. Defaults to true as Puppet File resource does.

Limitations

Puppet platforms

Release 2.0.0 (and above) only support Puppet 4.x and Puppet Enterprise 2015.2.0 or newer

Puppet 3.x Compatibility

Puppet 3.x was End of Life starting January 1st, 2017, if Puppet 3.x functionality is still needed, please install using one of the following method:

• git clone [email protected]:voxpupuli/puppet-autofs.git -b puppet3 <module_path>/autofs

Support for Puppet 3.x Functionality:

• No new features will be added to the puppet3 branch.
• No new deployments will be issued to the Puppet Forge.

Operating Systems

• Supported
  • Ubuntu
    • 14.04
    • 16.04
  • CentOS/RHEL/Scientific/Oracle Linux
    • 6.x
    • 7.x
  • SLES
    • 11 Service Pack 4
    • 12 Service Pack 1
  • OpenSUSE 13.1
  • Debian
    • 7 "Wheezy"
    • 8 "Jessie"
• Self Support - should work, support not provided by developer
  • Solaris 10, 11
  • Fedora 24, 25
  • SLES 10
  • CentOS/RHEL/Scientific/Oracle Linux 5.x
• Unsupported
  • Windows (Autofs not available)
  • Mac OS X (Autofs Not Available)

Development

Please see the CONTRIBUTING.md file for instructions regarding development environments and testing.

Authors

• Vox Pupuli: [email protected]
• David Hollinger: [email protected]