Documentation by YARD 0.9.8
+Documentation by YARD 0.9.9
Alphabetic Index
@@ -73,11 +73,6 @@Puppet Class Listing A-Z
-Defined Type Listing A-Z
-
+
- + autofs::map + + +
-
autofs::mount
@@ -141,9 +141,9 @@
File Listing
Usage
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.
+By default this installs and starts the autofs service with the module's default master +file.
-To manage the service, use the following code in your profile:
+You can also manage the state of the autofs package or service.
+ +By default the module will install the autofs package and start/enable the autofs service. +You can configure this by using the parameters defined in the main init class.
+ +For example, to ensure the package is absent:
+ +class { 'autofs':
+ package_ensure => 'absent',
+}
+To ensure that a service is disabled and not running:
class { 'autofs':
+ service_ensure => 'stopped',
service_enable => false,
- service_ensure => 'stopped'
}
auto.home
In hiera, there's a autofs::mounts class you can configure, for example:
---
-autofs::mounts:
+autofs::mounts:
home:
mount: '/home'
mapfile: '/etc/auto.home'
@@ -188,8 +198,7 @@ Examples:
Hiera:
----
-autofs::mounts:
+autofs::mounts:
foo:
mount: '/-'
mapfile: '/etc/auto.foo'
@@ -220,8 +229,7 @@ Usage
Hiera:
----
-autofs::mounts:
+autofs::mounts:
home:
mount: '/home'
mapfile: '/etc/auto.home'
@@ -232,59 +240,240 @@ Usage
use_dir: true
+Map Entries
+
+In addition to adding map entries via the mapcontents parameter to autofs::mount theautofs::map` type can also be used.
+
+Usage
+
+Define:
+
+autofs::map{'data':
+ map => '/etc/auto.data',
+ mapcontents => 'data -user,rw,soft server.example.com:/path/to/data,
+}
+
+
+Hiera:
+
+autofs::maps:
+ data:
+ map: '/etc/auto.data'
+ mapcontent: 'data -user,rw server.example.com:/path/to/data'
+
+
+It is assumed that the map file itself has already been defined with
+and autofs::mount first.
+
+autofs::mount{'auto.data':
+ mapfile => '/etc/auto.data',
+ mount => '/big',
+}
+
+
Reference
-Parameters
+Classes
+
+Public Classes
-- 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.
+- autofs: Main class. Contains or calls all other classes or defines.
-Limitations
+Private Classes
-Puppet platforms
+
+- autofs::package: Handles autofs packages.
+- autofs::service: Handles the service.
+
-Release 2.0.0 (and above) only support Puppet 4.x and Puppet Enterprise 2015.2.0 or newer
+Parameters
-Puppet 3.x Compatibility
+mounts
-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:
+Optional.
-
-git clone git@github.com:voxpupuli/puppet-autofs.git -b puppet3 <module_path>/autofs
+Data type: Hash
+
+A hash of options that will build the configuration. This hash is passed to the Defined type.
+Each hash key is the equivalent to a parameter in the autofs::mount defined type.
+
+Default: undef
+
+package_ensure
+
+Data type: String
+
+Determines the state of the package. Can be set to: installed, absent, lastest, or a specific version string.
+
+Default: 'installed'
+
+service_ensure
+
+Data type: Enum['running', 'stopped']
+
+Determines state of the service.
+
+Default: 'running'
+
+service_enable
-Support for Puppet 3.x Functionality:
+Data type: Boolean
+
+Determines if the service should start with the system boot.
+
+Default: true
+
+Defines
+
+Public Defines
-- No new features will be added to the puppet3 branch.
-- No new deployments will be issued to the Puppet Forge.
+- autofs::mount: Builds the autofs configuration.
+- autofs::map: Builds map entires for autofs configuration.
+Parameters for autofs::mount
+
+mount_name
+
+Data type: String
+
+This is a logical, descriptive name for what what autofs will be
+mounting. This is represented by the home: and tmp: entries above.
+
+mount
+
+Data type: Stblib::Absolutepath
+
+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. Defaults to the title of the autofs::mount
+
+mapfile
+
+Data type: Stdlib::Absolutepath or Autofs::MapEntry
+
+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.
+When anything other than a simple file path is used mapfile_manage must be false.
+
+mapfile_manage
+
+Data type: Boolean
+
+If true the the mapfile file will be created and maintained. Defaults
+to true. Set this to false when the map file is maintained some other way,
+e.g auto.smb from the autofs package.
+
+mapcontents
+
+Data type: Array
+
+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.
+
+Default: []
+
+options
+
+Optional.
+
+Data type: String
+
+This Mapping describes the auto.master options to use (if any)
+when mounting the automounts.
+
+Default: ''
+
+order
+
+Data type: Integer
+
+This Mapping describes where in the auto.master file the entry will
+be placed. Order CANNOT be duplicated.
+
+Default: undef
+
+master
+
+Data type: Stdlib::Absolutepath
+
+This Parameter sets the path to the auto.master file.
+
+Default: '/etc/auto.master'
+
+map_dir
+
+Data type: Stdlib::Absolutepath
+
+This Parameter sets the path to the Autofs configuration directory
+for map files. Applies only to autofs 5.0.5 or later.
+
+Default: '/etc/auto.master.d'
+
+use_dir
+
+Data type: Boolean
+
+This Parameter tells the module if it is going to use $map_dir.
+
+Default: false
+
+direct
+
+Data type: Boolean
+
+Enable or disable indirect maps.
+
+Default: true
+
+execute
+
+Data type: Boolean
+
+Set mapfile to be executable.
+
+Default: false
+
+replace
+
+Data type: Boolean
+
+Whether or not to replace the mapfile if it already exists.
+
+Default: true
+
+Parameters for autofs::map
+
+mapfile
+
+Data type: Stdlib::Absolutepath
+
+mapfile file to add entry to. e.g '/etc/auto.data'.
+
+mapcontent
+
+Data type: String
+
+This Mapping describes a folder that will be mounted, the
+mount options, and the path to the remote or local share to be mounted. Used in
+mapfile generation. e.g. 'data -rw nfs.example.org:/data/big
+
+Limitations
+
+Removals
+
+Directly calling the autofs::package and autofs::service classes is disabled in 3.0.0.
+These are now private classes.
+
+Puppet platforms
+
+Compatible with Puppet 4 only. Puppet 4.6.0 will provide best results.
+
Operating Systems
@@ -346,9 +535,9 @@ Authors