Merge pull request #203 from kenyon/readme

Author: kenyon

README.md

@@ -17,7 +17,6 @@
   * [Requirements](#requirements)
   * [Incompatibilities](#incompatibilities)
 3. [Usage - Configuration options and additional functionality](#usage)
-4. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
 4. [Limitations - OS compatibility, etc](#limitations)
 5. [Development - Guide for contributing to the module](#development)
 6. [Support - When you need help with this module](#support)
@@ -370,333 +369,6 @@ autofs::service_conf_options:
   VALUE_ATTRIBUTE: 'automountInformation'
 ```
 
-## Reference
-
-### Classes
-
-#### Public Classes
-
-* `autofs`: Main class. Contains or calls all other classes or defines.
-
-#### Private Classes
-
-* `autofs::package`: Handles autofs packages.
-* `autofs::service`: Handles the service.
-
-### Parameters
-
-#### `mounts`
-
-Optional.
-
-Data type: Hash
-
-A hash of options that describe Autofs mount points for which entries
-should appear in the master map.  Each entry is equivalent to the title and
-a hash of the parameters of one `autofs::mount` resource.
-
-#### `mapfiles`
-
-Optional.
-
-Data type: Hash
-
-A hash of options that describe Autofs map files that should be managed.
-Each entry is equivalent to the title and a hash of the parameters of one
-`autofs::mapfile` resource.
-
-#### `package_name`
-
-Data type: String or Array[String]
-
-The name of the Autofs package(s).  System-appropriate values for a variety
-of target environments are included with the module, so this parameter
-does not usually need to be specified explicitly.
-
-#### `package_ensure`
-
-Data type: String
-
-Determines the required state of the autofs package. Can be set to: `installed`, `absent`, `lastest`, or a specific
-version string.
-
-Default: 'installed'
-
-#### `service_name`
-
-Data type: String
-
-The name of the Autofs service, as appropriate for use with the target
-environment's tools.  System-appropriate values for a variety of
-target environments are included with the module, so this parameter
-does not usually need to be specified explicitly.
-
-#### `service_ensure`
-
-Data type: Enum['running', 'stopped']
-
-Determines required state of the autofs service.
-
-Default: 'running'
-
-#### `service_enable`
-
-Data type: Boolean
-
-Determines whether the autofs service should start at system boot.
-
-Default: `true`
-
-#### `reload_command`
-
-Optional.
-
-Data type: String
-
-If specified, a command to execute in the target environment to reload
-Autofs configuration without restarting the service.
-
-#### `auto_master_map`
-
-Data type: String
-
-The absolute path to the Autofs master map.  The standard paths used on
-a variety of supported environments are included with the module, so this
-parameter does not usually need to be specified explicitly.
-
-#### `map_file_owner`
-
-Data type: String
-
-The system user who should own the master map and any managed map files.
-May be expressed either as a name or as a uid (in string form).  The
-module defaults to 'root' for most environments and provides alternative
-defaults for supported target environments that ordinarily differ in this
-regard, so it is rarely necessary to specify this parameter explicitly
-unless a non-standard value is desired.
-
-#### `map_file_group`
-
-Data type: String
-
-The system group to which the master map and any managed map files should
-be assigned.  May be expressed either as a name or as a gid (in string
-form).  The module defaults to 'root' for most environments and provides
-alternative defaults for supported target environments that ordinarily
-differ in this regard, so it is rarely necessary to specify this
-parameter explicitly unless a non-standard value is desired.
-
-### Defines
-
-#### Public Defines
-
-* `autofs::mount`: Describes an entry in the master map.
-* `autofs::mapfile`: Describes a (sun-format) map file and, optionally, some or all of its contents.
-* `autofs::mapping`: Describes one (sun-format) filesystem mapping in a specific map file.
-
-### Parameters for autofs::mount
-
-#### `ensure`
-
-Data type: String
-
-The desired state of the mount definition in the master map.  If set to
-`absent`, the resulting master map will not contain a mountpoint definition
-corresponding to this resource. Defaults to `present`.
-
-#### `mount`
-
-Data type: Stblib::Absolutepath
-
-The Autofs mountpoint described by this resource.  When this parameter has the value `/-`, this resource describes a direct
-mount, and the keys in the corresponding map file must be absolute paths to mountpoint directories.  Otherwise, this
-resource describes an indirect map, and this parameter is a base path to the automounted directories
-described by the corresponding map file.   Defaults to the `title` of this `autofs::mount`.
-
-#### `mapfile`
-
-Data type: Stdlib::Absolutepath or Autofs::MapEntry
-
-This parameter designates the automount map serving this mount.  Autofs supports a variety of options
-here, but most commonly this is either an absolute path to a map file or the special string `-hosts`.
-
-#### `options`
-
-Optional.
-
-Data type: String
-
-This parameter provides Autofs and/or mount options to be specified for this
-mount point in the master map.
-
-#### `order`
-
-Data type: Integer
-
-This parameter specifies the relative order of this mount point in the master map.
-
-Default: 1
-
-#### `master`
-
-Data type: Stdlib::Absolutepath
-
-This parameter specifies the path to the master map.  It's system-dependent
-default value is usually the right choice.
-
-Default: (system-dependent)
-
-#### `map_dir`
-
-Data type: Stdlib::Absolutepath
-
-This parameter specifies the path to the Autofs master map drop-in directory
-in which this mount's definition should reside.  This may differ from mount
-to mount. Applies only to autofs 5.0.5 or later, and only when the `use_dir`
-parameter is set to `true`.
-
-Default: '/etc/auto.master.d'
-
-#### `purge_map_dir`
-
-Data type: Boolen
-
-This parameter specifies if the $map_dir path should be purged of unmanaged files.
-
-Default: false
-
-#### `use_dir`
-
-Data type: Boolean
-
-This parameter specifies whether to manage this mount point via its own file
-in a drop-in directory, as opposed to recording it directly in the master
-map.  Relevant only for autofs 5.0.5 or later.
-
-Default: `false`
-
-### Parameters for autofs::mapfile
-
-#### `ensure`
-
-Data type: String
-
-This parameter specifies the target state of this map file, either `present` or `absent`.
-
-Default: 'present'
-
-#### `path`
-
-Data type: Stdlib::Absolutepath
-
-The absolute path to the map file managed by this resource. e.g '/etc/auto.data'.
-
-Default: the `title` of this resource.
-
-#### `mappings`
-
-Data type: Array of Autofs::Fs_mapping
-
-Each element corresponds to one (sun-format) mapping in the file, with a key,
-usually some mount options, and a specification of the filesystem(s) to
-mount.  The filesystem specification format is extremely loose, accommodating
-not only the typical case of a single remote filesystem spec, but also the
-wide variety of Autofs-recognized alternatives such as shared mounts,
-multi-mounts, and replicated mounts.
-
-Example:
-
-```puppet
-[
-  { 'key' => 'dataA', 'options' => 'rw,noexec', 'fs' => 'remote.net:/exports/dataA' }
-]
-```
-
-Default: []
-
-#### `replace`
-
-Data type: Boolean
-
-This parameter specifies whether this map file's contents should be managed
-in the event that the file already exists at the start of the Puppet run.
-It affects not only mappings specified directly in this resource, but also
-any that are specified for this map file via separate `autofs::mapping`
-resources.
-
-Default: `true`
-
-#### `execute`
-
-Data type: Boolean
-
-This parameter specifies whether this map file should be executable.
-
-Default: `false`
-
-### Parameters for autofs::mapping
-
-#### `ensure`
-
-Data type: String
-
-This parameter specifies whether the mapping it describes should be
-present in the target map file, provided that that map file is managed
-via an `autofs::mapfile` resource or the equivalent data among the
-parameters of class `autofs`.  Setting the value `absent` is
-substantially equivalent to altogether omitting any declaration of this
-resource.
-
-Default: 'present'
-
-#### `mapfile`
-
-The absolute path to the target map file hosting this mapping.
-
-#### `key`
-
-Data type: String matching /\A\S+\z/
-
-The autofs key for this mapping.
-
-#### `fs`
-
-Data type: String matching /\S/
-
-The filesystem specification for this mapping.  The Sun map format
-permits a number of alternatives beyond simple, single mappings, and
-this module opts to allow wide latitude in filesystem specification
-instead of trying to codify all the alternatives.
-
-Simple example: 'remote.net:/exports/data'
-
-#### `options`
-
-Optional.
-
-Data type: String matching /A\S+\z/, or an Array of such Strings
-
-Autofs and mount options specific to this mapping.  If given as and array
-then elements are joined with commas (,) to form a single option string.
-Options _should not_ be prefixed with a hyphen (-) unless that is part of
-the option itself.  Options whose names do begin with a hyphen must not
-be first.
-
-example: 'rw,noexec,nodev'
-
-example: \[ 'rw', 'noexec', 'nodev' \]
-
-#### `order`
-
-Data type: Integer
-
-The relative order of this mapping in the target map file.  Does not
-ordinarily need to be specified, because the map file order will be stable
-either way, and the order matters only if the map contains more than one
-mapping for the same key.
-
-Default: 10
-
 ## Limitations
 
 ### Removals
@@ -718,30 +390,7 @@ Compatible with Puppet 4 or greater only. Puppet 4.6.0 or greater
 
 ### Operating Systems
 
-* Supported
-  * Ubuntu
-    * 18.04
-  * CentOS/RHEL/Scientific/Oracle Linux
-    * 7.x
-    * 8.x
-  * SLES
-    * 11 Service Pack 4
-    * 12 Service Pack 1
-  * OpenSUSE 13.1
-  * Debian
-    * 9
-    * 10
-* Self Support - should work, support not provided by developer
-  * Solaris 10, 11
-  * AIX 7.1, 7.2
-  * Fedora 24, 25
-  * SLES 10
-  * CentOS/RHEL/Scientific/Oracle Linux 5.x
-* Unsupported
-  * Windows (Autofs not available)
-  * Mac OS X
-
-For an up2date list of supported modules, take a look at the metadata.json.
+For an up2date list of supported operating systems, take a look at the metadata.json.
 
 ## Development