Version information
This version is compatible with:
- Puppet Enterprise >= 3.7.0 < 2016.2.0
- Puppet >= 3.0.0 < 5.0.0
- , , , , ,
This module has been deprecated by its author since Oct 27th 2017.
The author has suggested puppet-autofs as its replacement.
Start using this module
Documentation
Autofs Puppet Module
Table of Contents
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
Operating Systems
- Supported
- Ubuntu 14.04/16.04
- CentOS/RHEL/Oracle Linux 6.x/7.x
- Self Support - should work, support not provided by developer
- Solaris 10, 11
- Debian 7, 8
- Unsupported
- Windows (Autofs not available)
- Mac OS X (Autofs Not Available)
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
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.
Contributing
Please feel free to help make the autofs module better. I'm not perfect nor the best out there, so please feel welcome to contribute in the following ways:
- File Bug Reports
- Request Features
- Create Pull Requests for fixes, enhancements or features.
- Contact me for support.
IMPORTANT NOTE ON PULL REQUESTS:
Pull Requests require Spec tests and passing builds or they will NOT be accepted.
Contact
David Hollinger: david.hollinger@moduletux.com
Dependencies
- puppetlabs/stdlib (>= 3.2.0)
- puppetlabs/concat (>= 2.0.0)
Copyright (C) 2014 David Hollinger III Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.