Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 3.2.0 #75

Merged
merged 2 commits into from
Jul 2, 2017
+1,200 −315
Merged

Release 3.2.0 #75

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3acc29
Release 3.2.0
dhollinger Jul 2, 2017
9c12295
Added docs to the release
dhollinger Jul 2, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Added docs to the release
@dhollinger
dhollinger committed Jul 2, 2017

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
Learn about vigilant mode
commit 9c12295d168065c69bd75137fccf3f3a8570fb49
18 changes: 9 additions & 9 deletions docs/_index.html
View file
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Documentation by YARD 0.9.8
Documentation by YARD 0.9.9

</title>

@@ -52,7 +52,7 @@
<div class="clear"></div>
</div>

<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.8</h1>
<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.9</h1>
<div id="listing">
<h1 class="alphaindex">Alphabetic Index</h1>

@@ -73,11 +73,6 @@ <h2>Puppet Class Listing A-Z</h2>

</li>

<li>
<span class='object_link'><a href="puppet_classes/autofs_3A_3Amounts.html" title="puppet_classes::autofs::mounts (puppet_class)">autofs::mounts</a></span>

</li>

<li>
<span class='object_link'><a href="puppet_classes/autofs_3A_3Apackage.html" title="puppet_classes::autofs::package (puppet_class)">autofs::package</a></span>

@@ -108,6 +103,11 @@ <h2>Defined Type Listing A-Z</h2>
<li class="letter">A</li>
<ul>

<li>
<span class='object_link'><a href="puppet_defined_types/autofs_3A_3Amap.html" title="puppet_defined_types::autofs::map (puppet_defined_type)">autofs::map</a></span>

</li>

<li>
<span class='object_link'><a href="puppet_defined_types/autofs_3A_3Amount.html" title="puppet_defined_types::autofs::mount (puppet_defined_type)">autofs::mount</a></span>

@@ -141,9 +141,9 @@ <h2>File Listing</h2>
</div>

<div id="footer">
Generated on Sat Jan 14 13:46:48 2017 by
Generated on Sun Jul 2 12:09:02 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.8 (ruby-2.2.6).
0.9.9 (ruby-2.4.1).
</div>

</div>
291 changes: 240 additions & 51 deletions docs/file.README.html
View file
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@
<title>
File: README

&mdash; Documentation by YARD 0.9.8
&mdash; Documentation by YARD 0.9.9

</title>

@@ -115,15 +115,26 @@ <h3>Usage</h3>
<pre class="code puppet"><code class="puppet">include autofs
</code></pre>

<p>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.</p>
<p>By default this installs and starts the autofs service with the module&#39;s default master
file. </p>

<p>To manage the service, use the following code in your profile:</p>
<p>You can also manage the state of the autofs package or service.</p>

<p>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.</p>

<p>For example, to ensure the package is absent:</p>

<pre class="code puppet"><code class="puppet">class { &#39;autofs&#39;:
package_ensure =&gt; &#39;absent&#39;,
}
</code></pre>

<p>To ensure that a service is disabled and not running:</p>

<pre class="code puppet"><code class="puppet">class { &#39;autofs&#39;:
service_ensure =&gt; &#39;stopped&#39;,
service_enable =&gt; false,
service_ensure =&gt; &#39;stopped&#39;
}
</code></pre>

@@ -158,8 +169,7 @@ <h5>auto.home</h5>

<p>In hiera, there&#39;s a <code>autofs::mounts</code> class you can configure, for example:</p>

<pre class="code yaml"><code class="yaml">---
autofs::mounts:
<pre class="code yaml"><code class="yaml">autofs::mounts:
home:
mount: &#39;/home&#39;
mapfile: &#39;/etc/auto.home&#39;
@@ -188,8 +198,7 @@ <h6>Examples:</h6>

<p>Hiera:</p>

<pre class="code yaml"><code class="yaml">---
autofs::mounts:
<pre class="code yaml"><code class="yaml">autofs::mounts:
foo:
mount: &#39;/-&#39;
mapfile: &#39;/etc/auto.foo&#39;
@@ -220,8 +229,7 @@ <h6>Usage</h6>

<p>Hiera:</p>

<pre class="code yaml"><code class="yaml">---
autofs::mounts:
<pre class="code yaml"><code class="yaml">autofs::mounts:
home:
mount: &#39;/home&#39;
mapfile: &#39;/etc/auto.home&#39;
@@ -232,59 +240,240 @@ <h6>Usage</h6>
use_dir: true
</code></pre>

<h4>Map Entries</h4>

<p>In addition to adding map entries via the <code>mapcontents</code> parameter to <code>autofs::mount the</code>autofs::map` type can also be used.</p>

<h5>Usage</h5>

<p>Define:</p>

<pre class="code puppet"><code class="puppet">autofs::map{&#39;data&#39;:
map =&gt; &#39;/etc/auto.data&#39;,
mapcontents =&gt; &#39;data -user,rw,soft server.example.com:/path/to/data,
}
</code></pre>

<p>Hiera:</p>

<pre class="code yaml"><code class="yaml">autofs::maps:
data:
map: &#39;/etc/auto.data&#39;
mapcontent: &#39;data -user,rw server.example.com:/path/to/data&#39;
</code></pre>

<p>It is assumed that the map file itself has already been defined with
and <code>autofs::mount</code> first.</p>

<pre class="code puppet"><code class="puppet">autofs::mount{&#39;auto.data&#39;:
mapfile =&gt; &#39;/etc/auto.data&#39;,
mount =&gt; &#39;/big&#39;,
}
</code></pre>

<h2>Reference</h2>

<h4>Parameters</h4>
<h3>Classes</h3>

<h4>Public Classes</h4>

<ul>
<li><strong>mount_name</strong> - This is a logical, descriptive name for what what autofs will be
mounting. This is represented by the <code>home:</code> and <code>tmp:</code> entries above.</li>
<li><strong>mount</strong> - 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.</li>
<li><strong>mapfile</strong> - 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.</li>
<li><strong>mapcontent</strong> - 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.</li>
<li><strong>options</strong> - This Mapping describes the auto.master options to use (if any)
when mounting the automounts.</li>
<li><strong>order</strong> - This Mapping describes where in the auto.master file the entry will
be placed. Order CANNOT be duplicated.</li>
<li><strong>master</strong> - This Parameter sets the path to the auto.master file. Defaults to
<code>/etc/auto.master</code>.</li>
<li><strong>map_dir</strong> - This Parameter sets the path to the Autofs configuration directory
for map files. Applies only to autofs 5.0.5 or later. Defaults to
<code>/etc/auto.master.d</code>.</li>
<li><strong>use_dir</strong> - This Parameter tells the module if it is going to use $map_dir.
Defaults to <code>false</code>.</li>
<li><strong>direct</strong> - Boolean to allow for indirect map. Defaults to true to be backwards compatible.</li>
<li><strong>execute</strong> - Boolean to set the map to be executable. Defaults to false to be backward compatible.</li>
<li><strong>replace</strong> - Boolean to set the map file to not be replaced. Defaults to true as Puppet File resource does.</li>
<li>autofs: Main class. Contains or calls all other classes or defines.</li>
</ul>

<h2>Limitations</h2>
<h4>Private Classes</h4>

<h4>Puppet platforms</h4>
<ul>
<li>autofs::package: Handles autofs packages.</li>
<li>autofs::service: Handles the service.</li>
</ul>

<p>Release 2.0.0 (and above) only support Puppet 4.x and Puppet Enterprise 2015.2.0 or newer</p>
<h3>Parameters</h3>

<h4>Puppet 3.x Compatibility</h4>
<h4><code>mounts</code></h4>

<p>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:</p>
<p>Optional.</p>

<ul>
<li><code>git clone git@github.com:voxpupuli/puppet-autofs.git -b puppet3 &lt;module_path&gt;/autofs</code></li>
</ul>
<p>Data type: Hash</p>

<p>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 <code>autofs::mount</code> defined type.</p>

<p>Default: <code>undef</code></p>

<h4><code>package_ensure</code></h4>

<p>Data type: String</p>

<p>Determines the state of the package. Can be set to: installed, absent, lastest, or a specific version string.</p>

<p>Default: &#39;installed&#39;</p>

<h4><code>service_ensure</code></h4>

<p>Data type: Enum[&#39;running&#39;, &#39;stopped&#39;]</p>

<p>Determines state of the service.</p>

<p>Default: &#39;running&#39;</p>

<h4><code>service_enable</code></h4>

<p>Support for Puppet 3.x Functionality:</p>
<p>Data type: Boolean</p>

<p>Determines if the service should start with the system boot.</p>

<p>Default: <code>true</code></p>

<h3>Defines</h3>

<h4>Public Defines</h4>

<ul>
<li>No new features will be added to the puppet3 branch.</li>
<li>No new deployments will be issued to the Puppet Forge.</li>
<li>autofs::mount: Builds the autofs configuration.</li>
<li>autofs::map: Builds map entires for autofs configuration.</li>
</ul>

<h3>Parameters for autofs::mount</h3>

<h4><code>mount_name</code></h4>

<p>Data type: String</p>

<p>This is a logical, descriptive name for what what autofs will be
mounting. This is represented by the <code>home:</code> and <code>tmp:</code> entries above.</p>

<h4><code>mount</code></h4>

<p>Data type: Stblib::Absolutepath</p>

<p>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 <code>title</code> of the <code>autofs::mount</code></p>

<h4><code>mapfile</code></h4>

<p>Data type: Stdlib::Absolutepath or Autofs::MapEntry</p>

<p>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 <code>mapfile_manage</code> must be false.</p>

<h4><code>mapfile_manage</code></h4>

<p>Data type: Boolean</p>

<p>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.</p>

<h4><code>mapcontents</code></h4>

<p>Data type: Array</p>

<p>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.</p>

<p>Default: []</p>

<h4><code>options</code></h4>

<p>Optional.</p>

<p>Data type: String</p>

<p>This Mapping describes the auto.master options to use (if any)
when mounting the automounts.</p>

<p>Default: &#39;&#39;</p>

<h4><code>order</code></h4>

<p>Data type: Integer</p>

<p>This Mapping describes where in the auto.master file the entry will
be placed. Order CANNOT be duplicated.</p>

<p>Default: <code>undef</code></p>

<h4><code>master</code></h4>

<p>Data type: Stdlib::Absolutepath</p>

<p>This Parameter sets the path to the auto.master file.</p>

<p>Default: &#39;/etc/auto.master&#39;</p>

<h4><code>map_dir</code></h4>

<p>Data type: Stdlib::Absolutepath</p>

<p>This Parameter sets the path to the Autofs configuration directory
for map files. Applies only to autofs 5.0.5 or later. </p>

<p>Default: &#39;/etc/auto.master.d&#39;</p>

<h4><code>use_dir</code></h4>

<p>Data type: Boolean</p>

<p>This Parameter tells the module if it is going to use $map_dir.</p>

<p>Default: <code>false</code></p>

<h4><code>direct</code></h4>

<p>Data type: Boolean</p>

<p>Enable or disable indirect maps.</p>

<p>Default: <code>true</code></p>

<h4><code>execute</code></h4>

<p>Data type: Boolean</p>

<p>Set mapfile to be executable.</p>

<p>Default: <code>false</code></p>

<h4><code>replace</code></h4>

<p>Data type: Boolean</p>

<p>Whether or not to replace the mapfile if it already exists.</p>

<p>Default: <code>true</code></p>

<h3>Parameters for autofs::map</h3>

<h4><code>mapfile</code></h4>

<p>Data type: Stdlib::Absolutepath</p>

<p>mapfile file to add entry to. e.g &#39;/etc/auto.data&#39;.</p>

<h4><code>mapcontent</code></h4>

<p>Data type: String</p>

<p>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. &#39;data -rw nfs.example.org:/data/big</p>

<h2>Limitations</h2>

<h4>Removals</h4>

<p>Directly calling the <code>autofs::package</code> and <code>autofs::service</code> classes is disabled in 3.0.0.
These are now private classes.</p>

<h4>Puppet platforms</h4>

<p>Compatible with Puppet 4 only. Puppet 4.6.0 will provide best results.</p>

<h4>Operating Systems</h4>

<ul>
@@ -346,9 +535,9 @@ <h2>Authors</h2>
</div></div>

<div id="footer">
Generated on Sat Jan 14 13:46:48 2017 by
Generated on Sun Jul 2 12:09:02 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.8 (ruby-2.2.6).
0.9.9 (ruby-2.4.1).
</div>

</div>
2 changes: 1 addition & 1 deletion docs/frames.html
View file
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@
<html>
<head>
<meta charset="utf-8">
<title>Documentation by YARD 0.9.8</title>
<title>Documentation by YARD 0.9.9</title>
</head>
<script type="text/javascript" charset="utf-8">
var match = unescape(window.location.hash).match(/^#!(.+)/);
291 changes: 240 additions & 51 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@
<title>
File: README

&mdash; Documentation by YARD 0.9.8
&mdash; Documentation by YARD 0.9.9

</title>

@@ -115,15 +115,26 @@ <h3>Usage</h3>
<pre class="code puppet"><code class="puppet">include autofs
</code></pre>

<p>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.</p>
<p>By default this installs and starts the autofs service with the module&#39;s default master
file. </p>

<p>To manage the service, use the following code in your profile:</p>
<p>You can also manage the state of the autofs package or service.</p>

<p>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.</p>

<p>For example, to ensure the package is absent:</p>

<pre class="code puppet"><code class="puppet">class { &#39;autofs&#39;:
package_ensure =&gt; &#39;absent&#39;,
}
</code></pre>

<p>To ensure that a service is disabled and not running:</p>

<pre class="code puppet"><code class="puppet">class { &#39;autofs&#39;:
service_ensure =&gt; &#39;stopped&#39;,
service_enable =&gt; false,
service_ensure =&gt; &#39;stopped&#39;
}
</code></pre>

@@ -158,8 +169,7 @@ <h5>auto.home</h5>

<p>In hiera, there&#39;s a <code>autofs::mounts</code> class you can configure, for example:</p>

<pre class="code yaml"><code class="yaml">---
autofs::mounts:
<pre class="code yaml"><code class="yaml">autofs::mounts:
home:
mount: &#39;/home&#39;
mapfile: &#39;/etc/auto.home&#39;
@@ -188,8 +198,7 @@ <h6>Examples:</h6>

<p>Hiera:</p>

<pre class="code yaml"><code class="yaml">---
autofs::mounts:
<pre class="code yaml"><code class="yaml">autofs::mounts:
foo:
mount: &#39;/-&#39;
mapfile: &#39;/etc/auto.foo&#39;
@@ -220,8 +229,7 @@ <h6>Usage</h6>

<p>Hiera:</p>

<pre class="code yaml"><code class="yaml">---
autofs::mounts:
<pre class="code yaml"><code class="yaml">autofs::mounts:
home:
mount: &#39;/home&#39;
mapfile: &#39;/etc/auto.home&#39;
@@ -232,59 +240,240 @@ <h6>Usage</h6>
use_dir: true
</code></pre>

<h4>Map Entries</h4>

<p>In addition to adding map entries via the <code>mapcontents</code> parameter to <code>autofs::mount the</code>autofs::map` type can also be used.</p>

<h5>Usage</h5>

<p>Define:</p>

<pre class="code puppet"><code class="puppet">autofs::map{&#39;data&#39;:
map =&gt; &#39;/etc/auto.data&#39;,
mapcontents =&gt; &#39;data -user,rw,soft server.example.com:/path/to/data,
}
</code></pre>

<p>Hiera:</p>

<pre class="code yaml"><code class="yaml">autofs::maps:
data:
map: &#39;/etc/auto.data&#39;
mapcontent: &#39;data -user,rw server.example.com:/path/to/data&#39;
</code></pre>

<p>It is assumed that the map file itself has already been defined with
and <code>autofs::mount</code> first.</p>

<pre class="code puppet"><code class="puppet">autofs::mount{&#39;auto.data&#39;:
mapfile =&gt; &#39;/etc/auto.data&#39;,
mount =&gt; &#39;/big&#39;,
}
</code></pre>

<h2>Reference</h2>

<h4>Parameters</h4>
<h3>Classes</h3>

<h4>Public Classes</h4>

<ul>
<li><strong>mount_name</strong> - This is a logical, descriptive name for what what autofs will be
mounting. This is represented by the <code>home:</code> and <code>tmp:</code> entries above.</li>
<li><strong>mount</strong> - 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.</li>
<li><strong>mapfile</strong> - 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.</li>
<li><strong>mapcontent</strong> - 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.</li>
<li><strong>options</strong> - This Mapping describes the auto.master options to use (if any)
when mounting the automounts.</li>
<li><strong>order</strong> - This Mapping describes where in the auto.master file the entry will
be placed. Order CANNOT be duplicated.</li>
<li><strong>master</strong> - This Parameter sets the path to the auto.master file. Defaults to
<code>/etc/auto.master</code>.</li>
<li><strong>map_dir</strong> - This Parameter sets the path to the Autofs configuration directory
for map files. Applies only to autofs 5.0.5 or later. Defaults to
<code>/etc/auto.master.d</code>.</li>
<li><strong>use_dir</strong> - This Parameter tells the module if it is going to use $map_dir.
Defaults to <code>false</code>.</li>
<li><strong>direct</strong> - Boolean to allow for indirect map. Defaults to true to be backwards compatible.</li>
<li><strong>execute</strong> - Boolean to set the map to be executable. Defaults to false to be backward compatible.</li>
<li><strong>replace</strong> - Boolean to set the map file to not be replaced. Defaults to true as Puppet File resource does.</li>
<li>autofs: Main class. Contains or calls all other classes or defines.</li>
</ul>

<h2>Limitations</h2>
<h4>Private Classes</h4>

<h4>Puppet platforms</h4>
<ul>
<li>autofs::package: Handles autofs packages.</li>
<li>autofs::service: Handles the service.</li>
</ul>

<p>Release 2.0.0 (and above) only support Puppet 4.x and Puppet Enterprise 2015.2.0 or newer</p>
<h3>Parameters</h3>

<h4>Puppet 3.x Compatibility</h4>
<h4><code>mounts</code></h4>

<p>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:</p>
<p>Optional.</p>

<ul>
<li><code>git clone git@github.com:voxpupuli/puppet-autofs.git -b puppet3 &lt;module_path&gt;/autofs</code></li>
</ul>
<p>Data type: Hash</p>

<p>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 <code>autofs::mount</code> defined type.</p>

<p>Default: <code>undef</code></p>

<h4><code>package_ensure</code></h4>

<p>Data type: String</p>

<p>Determines the state of the package. Can be set to: installed, absent, lastest, or a specific version string.</p>

<p>Default: &#39;installed&#39;</p>

<h4><code>service_ensure</code></h4>

<p>Data type: Enum[&#39;running&#39;, &#39;stopped&#39;]</p>

<p>Determines state of the service.</p>

<p>Default: &#39;running&#39;</p>

<h4><code>service_enable</code></h4>

<p>Support for Puppet 3.x Functionality:</p>
<p>Data type: Boolean</p>

<p>Determines if the service should start with the system boot.</p>

<p>Default: <code>true</code></p>

<h3>Defines</h3>

<h4>Public Defines</h4>

<ul>
<li>No new features will be added to the puppet3 branch.</li>
<li>No new deployments will be issued to the Puppet Forge.</li>
<li>autofs::mount: Builds the autofs configuration.</li>
<li>autofs::map: Builds map entires for autofs configuration.</li>
</ul>

<h3>Parameters for autofs::mount</h3>

<h4><code>mount_name</code></h4>

<p>Data type: String</p>

<p>This is a logical, descriptive name for what what autofs will be
mounting. This is represented by the <code>home:</code> and <code>tmp:</code> entries above.</p>

<h4><code>mount</code></h4>

<p>Data type: Stblib::Absolutepath</p>

<p>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 <code>title</code> of the <code>autofs::mount</code></p>

<h4><code>mapfile</code></h4>

<p>Data type: Stdlib::Absolutepath or Autofs::MapEntry</p>

<p>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 <code>mapfile_manage</code> must be false.</p>

<h4><code>mapfile_manage</code></h4>

<p>Data type: Boolean</p>

<p>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.</p>

<h4><code>mapcontents</code></h4>

<p>Data type: Array</p>

<p>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.</p>

<p>Default: []</p>

<h4><code>options</code></h4>

<p>Optional.</p>

<p>Data type: String</p>

<p>This Mapping describes the auto.master options to use (if any)
when mounting the automounts.</p>

<p>Default: &#39;&#39;</p>

<h4><code>order</code></h4>

<p>Data type: Integer</p>

<p>This Mapping describes where in the auto.master file the entry will
be placed. Order CANNOT be duplicated.</p>

<p>Default: <code>undef</code></p>

<h4><code>master</code></h4>

<p>Data type: Stdlib::Absolutepath</p>

<p>This Parameter sets the path to the auto.master file.</p>

<p>Default: &#39;/etc/auto.master&#39;</p>

<h4><code>map_dir</code></h4>

<p>Data type: Stdlib::Absolutepath</p>

<p>This Parameter sets the path to the Autofs configuration directory
for map files. Applies only to autofs 5.0.5 or later. </p>

<p>Default: &#39;/etc/auto.master.d&#39;</p>

<h4><code>use_dir</code></h4>

<p>Data type: Boolean</p>

<p>This Parameter tells the module if it is going to use $map_dir.</p>

<p>Default: <code>false</code></p>

<h4><code>direct</code></h4>

<p>Data type: Boolean</p>

<p>Enable or disable indirect maps.</p>

<p>Default: <code>true</code></p>

<h4><code>execute</code></h4>

<p>Data type: Boolean</p>

<p>Set mapfile to be executable.</p>

<p>Default: <code>false</code></p>

<h4><code>replace</code></h4>

<p>Data type: Boolean</p>

<p>Whether or not to replace the mapfile if it already exists.</p>

<p>Default: <code>true</code></p>

<h3>Parameters for autofs::map</h3>

<h4><code>mapfile</code></h4>

<p>Data type: Stdlib::Absolutepath</p>

<p>mapfile file to add entry to. e.g &#39;/etc/auto.data&#39;.</p>

<h4><code>mapcontent</code></h4>

<p>Data type: String</p>

<p>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. &#39;data -rw nfs.example.org:/data/big</p>

<h2>Limitations</h2>

<h4>Removals</h4>

<p>Directly calling the <code>autofs::package</code> and <code>autofs::service</code> classes is disabled in 3.0.0.
These are now private classes.</p>

<h4>Puppet platforms</h4>

<p>Compatible with Puppet 4 only. Puppet 4.6.0 will provide best results.</p>

<h4>Operating Systems</h4>

<ul>
@@ -346,9 +535,9 @@ <h2>Authors</h2>
</div></div>

<div id="footer">
Generated on Sat Jan 14 13:46:48 2017 by
Generated on Sun Jul 2 12:09:02 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.8 (ruby-2.2.6).
0.9.9 (ruby-2.4.1).
</div>

</div>
7 changes: 6 additions & 1 deletion docs/js/app.js
View file
Original file line number Diff line number Diff line change
@@ -224,7 +224,12 @@ function navExpander() {
}

function mainFocus() {
$('#main')[0].focus();
var hash = window.location.hash;
if (hash !== '' && $(hash)[0]) {
$(hash)[0].scrollIntoView();
}

setTimeout(function() { $('#main').focus(); }, 10);
}

$(document).ready(function() {
11 changes: 2 additions & 9 deletions docs/puppet_class_list.html
View file
Original file line number Diff line number Diff line change
@@ -47,21 +47,14 @@ <h1 id="full_list_header">Puppet Class List</h1>
</li>


<li id="object_puppet_classes::autofs::mounts" class="even">
<div class="item">
<span class='object_link'><a href="puppet_classes/autofs_3A_3Amounts.html" title="puppet_classes::autofs::mounts (puppet_class)">autofs::mounts</a></span>
</div>
</li>


<li id="object_puppet_classes::autofs::package" class="odd">
<li id="object_puppet_classes::autofs::package" class="even">
<div class="item">
<span class='object_link'><a href="puppet_classes/autofs_3A_3Apackage.html" title="puppet_classes::autofs::package (puppet_class)">autofs::package</a></span>
</div>
</li>


<li id="object_puppet_classes::autofs::service" class="even">
<li id="object_puppet_classes::autofs::service" class="odd">
<div class="item">
<span class='object_link'><a href="puppet_classes/autofs_3A_3Aservice.html" title="puppet_classes::autofs::service (puppet_class)">autofs::service</a></span>
</div>
234 changes: 216 additions & 18 deletions docs/puppet_classes/autofs.html
View file
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@
<title>
Puppet Class: autofs

&mdash; Documentation by YARD 0.9.8
&mdash; Documentation by YARD 0.9.9

</title>

@@ -70,6 +70,7 @@
</dd>
</dl>
</div>

<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
@@ -80,6 +81,10 @@ <h2>Overview</h2>
<p>This class includes defined types for looping through arrays of configuration
file names.</p>

<p>To use this module, simply declare it in your manifest.
The module now supports the ability to not only enable autofs,
but to also disable or uninstall it completely.</p>

</div>
</div>
<div class="tags">
@@ -94,6 +99,23 @@ <h2>Overview</h2>
<pre class="example code"><code><span class='id identifier rubyid_include'>include</span> <span class='id identifier rubyid_autofs'>autofs</span></code></pre>


<p class="example_title"><div class='inline'><p>Removing the package</p>
</div></p>

<pre class="example code"><code>class { &#39;autofs&#39;:
package_ensure =&gt; &#39;absent&#39;,
}</code></pre>


<p class="example_title"><div class='inline'><p>Disable the autofs service</p>
</div></p>

<pre class="example code"><code>class { &#39;autofs&#39;:
service_ensure =&gt; &#39;stopped&#39;,
service_enable =&gt; false,
}</code></pre>


<p class="example_title"><div class='inline'><p>using hiera with automatic lookup</p>
</div></p>

@@ -128,6 +150,76 @@ <h2>Overview</h2>

</li>

<li>

<span class='name'>maps</span>


<span class='type'>(<tt>Optional[Hash]</tt>)</span>


<em class="default">(defaults to: <tt>undef</tt>)</em>


&mdash;
<div class='inline'><p>the options to build an autofs mapfile.</p>
</div>

</li>

<li>

<span class='name'>package_ensure</span>


<span class='type'>(<tt>String</tt>)</span>


<em class="default">(defaults to: <tt>&#39;installed&#39;</tt>)</em>


&mdash;
<div class='inline'><p>Determines the state of the package. Can be set to: installed, absent, lastest, or a specific version string.</p>
</div>

</li>

<li>

<span class='name'>service_ensure</span>


<span class='type'>(<tt>Enum[ 'stopped', 'running' ]</tt>)</span>


<em class="default">(defaults to: <tt>&#39;running&#39;</tt>)</em>


&mdash;
<div class='inline'><p>Determines state of the service. Can be set to: running or stopped.</p>
</div>

</li>

<li>

<span class='name'>service_enable</span>


<span class='type'>(<tt>Boolean</tt>)</span>


<em class="default">(defaults to: <tt>true</tt>)</em>


&mdash;
<div class='inline'><p>Determines if the service should start with the system boot. true
will start the autofs service on boot. false will not start the autofs service
on boot.</p>
</div>

</li>

</ul>


@@ -275,14 +367,100 @@ <h2>Overview</h2>

</ul>



<p class="tag_title">Options Hash (<tt>maps</tt>):</p>
<ul class="option">

<li>
<span class="name">:mapcontents</span>
<span class="type">(<tt>Array</tt>)</span>
<span class="default">

</span>

&mdash; <div class='inline'><p>Mount point options and parameters. Each
array element represents a line in the mapfile.</p>
</div>

</li>

<li>
<span class="name">:mapfile</span>
<span class="type">(<tt>Stdlib::Absolutepath</tt>)</span>
<span class="default">

</span>

&mdash; <div class='inline'><p>Full path to where the mapfile will be placed</p>
</div>

</li>

<li>
<span class="name">:template</span>
<span class="type">(<tt>Enum['<span class='object_link'><a href="" title="puppet_classes::autofs (puppet_class)">autofs</a></span>/auto.map.erb', '<span class='object_link'><a href="" title="puppet_classes::autofs (puppet_class)">autofs</a></span>/auto.map.exec.erb']</tt>)</span>
<span class="default">

</span>

&mdash; <div class='inline'><p>Template to use the generate the mapfile</p>
</div>

</li>

<li>
<span class="name">:mapmode</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">

</span>

&mdash; <div class='inline'><p>The UNIX permissions to apply to the mapfile.</p>
</div>

</li>

<li>
<span class="name">:replace</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">

</span>

&mdash; <div class='inline'><p>Replace the file if it changes or not.</p>
</div>

</li>

<li>
<span class="name">:order</span>
<span class="type">(<tt>Integer</tt>)</span>
<span class="default">

</span>

&mdash; <div class='inline'><p>The order in which to place mapfile contents.</p>
</div>

</li>

</ul>









<p class="tag_title">See Also:</p>
<ul class="see">

<li><a href="https://voxpupuli.org/puppet-autofs" target="_parent" title="Home">Home</a></li>

<li><a href="https://www.github.com/voxpupuli/autofs-puppet" target="_parent" title="Github">Github</a></li>
<li><a href="https://www.github.com/voxpupuli/puppet-autofs" target="_parent" title="Github">Github</a></li>

<li><a href="https://forge.puppet.com/puppet/autofs" target="_parent" title="Puppet Forge">Puppet Forge</a></li>

@@ -321,31 +499,51 @@ <h2>Overview</h2>
<pre class="lines">


48
49
50
51
52
53
54
55
56
57
58</pre>
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/init.pp', line 48</span>
<pre class="code"><span class="info file"># File 'manifests/init.pp', line 76</span>

class autofs (
Optional[Hash] $mounts = undef
Optional[Hash] $mounts = undef,
Optional[Hash] $maps = undef,
String $package_ensure = &#39;installed&#39;,
Enum[ &#39;stopped&#39;, &#39;running&#39; ] $service_ensure = &#39;running&#39;,
Boolean $service_enable = true,
) {
contain &#39;::autofs::package&#39;
contain &#39;::autofs::service&#39;
unless $package_ensure == &#39;absent&#39; {
contain &#39;::autofs::service&#39;
}

if $mounts {
$data = hiera_hash(&#39;autofs::mounts&#39;, $mounts)
create_resources(&#39;autofs::mount&#39;, $data)
}
if $maps {
$_datamaps = hiera_hash(&#39;autofs::maps&#39;, $maps)
create_resources(&#39;autofs::map&#39;,$_datamaps)
}
}</pre>
</td>
</tr>
@@ -354,9 +552,9 @@ <h2>Overview</h2>
</div>

<div id="footer">
Generated on Sat Jan 14 13:46:48 2017 by
Generated on Sun Jul 2 12:09:02 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.8 (ruby-2.2.6).
0.9.9 (ruby-2.4.1).
</div>

</div>
29 changes: 16 additions & 13 deletions docs/puppet_classes/autofs_3A_3Apackage.html
View file
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@
<title>
Puppet Class: autofs::package

&mdash; Documentation by YARD 0.9.8
&mdash; Documentation by YARD 0.9.9

</title>

@@ -70,6 +70,7 @@
</dd>
</dl>
</div>

<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
@@ -85,6 +86,8 @@ <h2>Overview</h2>
<p>If the code doesn&#39;t find a matching supported OS, then the Puppet run will fail
with a &quot;OS not supported&quot; message.</p>

<p>This is a private class and cannot be called outside of the autofs module.</p>

</div>
</div>
<div class="tags">
@@ -136,9 +139,6 @@ <h2>Overview</h2>
<pre class="lines">


21
22
23
24
25
26
@@ -158,16 +158,20 @@ <h2>Overview</h2>
40
41
42
43</pre>
43
44
45
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/package.pp', line 21</span>
<pre class="code"><span class="info file"># File 'manifests/package.pp', line 24</span>

class autofs::package {
assert_private(&#39;Package class is private, please use main class parameters&#39;)
Package {
ensure =&gt; installed,
ensure =&gt; $autofs::package_ensure,
}
case $::osfamily {
case $facts[&#39;os&#39;][&#39;family&#39;] {
&#39;Debian&#39;, &#39;Ubuntu&#39;: {
package { &#39;autofs&#39;: }
}
@@ -178,11 +182,10 @@ <h2>Overview</h2>
package { &#39;autofs&#39;: }
}
&#39;Solaris&#39;: {
# Solaris includes autofs
# Block to prevent failures
# Already installed in Solaris
}
default: {
fail(&quot;${::operatingsystem} not supported.&quot;)
fail(&quot;${facts[&#39;operatingsystem&#39;]} not supported.&quot;)
}
}
}</pre>
@@ -193,9 +196,9 @@ <h2>Overview</h2>
</div>

<div id="footer">
Generated on Sat Jan 14 13:46:48 2017 by
Generated on Sun Jul 2 12:09:02 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.8 (ruby-2.2.6).
0.9.9 (ruby-2.4.1).
</div>

</div>
121 changes: 20 additions & 101 deletions docs/puppet_classes/autofs_3A_3Aservice.html
View file
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@
<title>
Puppet Class: autofs::service

&mdash; Documentation by YARD 0.9.8
&mdash; Documentation by YARD 0.9.9

</title>

@@ -70,6 +70,7 @@
</dd>
</dl>
</div>

<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
@@ -80,86 +81,12 @@ <h2>Overview</h2>
if necessary. Such as allowing the service to run, but not at
startup.</p>

<p>This class is private and cannot be called outside of the autofs module</p>

</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">

<li>

<span class='name'>ensure</span>


<span class='type'>(<tt>String</tt>)</span>


<em class="default">(defaults to: <tt>running</tt>)</em>


&mdash;
<div class='inline'><p>Determines state of the service. Can be set to: running or stopped.</p>
</div>

</li>

<li>

<span class='name'>enable</span>


<span class='type'>(<tt>Boolean</tt>)</span>


<em class="default">(defaults to: <tt>true</tt>)</em>


&mdash;
<div class='inline'><p>Determines if the service should start with the system boot. true
will start the autofs service on boot. false will not start the autofs service
on boot.</p>
</div>

</li>

<li>

<span class='name'>service_restart</span>


<span class='type'>(<tt>Boolean</tt>)</span>


<em class="default">(defaults to: <tt>true</tt>)</em>


&mdash;
<div class='inline'><p>Determines if the service has a restart command. If true,
puppet will use the restart command to restart the service. If false, the
stop, then start commands will be used instead.</p>
</div>

</li>

<li>

<span class='name'>service_status</span>


<span class='type'>(<tt>Boolean</tt>)</span>


<em class="default">(defaults to: <tt>true</tt>)</em>


&mdash;
<div class='inline'><p>Determines if service has a status command.</p>
</div>

</li>

</ul>


<p class="tag_title">See Also:</p>
<ul class="see">
@@ -207,35 +134,27 @@ <h2>Overview</h2>
<pre class="lines">


19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38</pre>
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/service.pp', line 25</span>
<pre class="code"><span class="info file"># File 'manifests/service.pp', line 19</span>

class autofs::service (
String $ensure = running,
Boolean $enable = true,
Boolean $service_restart = true,
Boolean $service_status = true
){
class autofs::service {
assert_private(&#39;Service class is private, please use main class parameters.&#39;)
service { &#39;autofs&#39;:
ensure =&gt; $ensure,
enable =&gt; $enable,
hasstatus =&gt; $service_status,
hasrestart =&gt; $service_restart,
ensure =&gt; $autofs::service_ensure,
enable =&gt; $autofs::service_enable,
hasstatus =&gt; true,
hasrestart =&gt; true,
require =&gt; Package[&#39;autofs&#39;],
}
}</pre>
@@ -246,9 +165,9 @@ <h2>Overview</h2>
</div>

<div id="footer">
Generated on Sat Jan 14 13:46:48 2017 by
Generated on Sun Jul 2 12:09:02 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.8 (ruby-2.2.6).
0.9.9 (ruby-2.4.1).
</div>

</div>
9 changes: 8 additions & 1 deletion docs/puppet_defined_type_list.html
View file
Original file line number Diff line number Diff line change
@@ -40,7 +40,14 @@ <h1 id="full_list_header">Defined Type List</h1>
<ul id="full_list" class="puppet_defined_type">


<li id="object_puppet_defined_types::autofs::mount" class="odd">
<li id="object_puppet_defined_types::autofs::map" class="odd">
<div class="item">
<span class='object_link'><a href="puppet_defined_types/autofs_3A_3Amap.html" title="puppet_defined_types::autofs::map (puppet_defined_type)">autofs::map</a></span>
</div>
</li>


<li id="object_puppet_defined_types::autofs::mount" class="even">
<div class="item">
<span class='object_link'><a href="puppet_defined_types/autofs_3A_3Amount.html" title="puppet_defined_types::autofs::mount (puppet_defined_type)">autofs::mount</a></span>
</div>
319 changes: 319 additions & 0 deletions docs/puppet_defined_types/autofs_3A_3Amap.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,319 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Defined Type: autofs::map

&mdash; Documentation by YARD 0.9.9

</title>

<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
pathId = "puppet_defined_types::autofs::map";
relpath = '../';
</script>


<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>

<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>


</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../puppet_defined_type_list.html?1"></iframe>
<div id="resizer"></div>
</div>

<div id="main" tabindex="-1">
<div id="header">
<div id="menu">

<a href="../_index.html">Index (a)</a> &raquo;
<span class='title'><span class='object_link'>Defined Types</span></span>
&raquo;
<span class="title">autofs::map</span>

</div>

<div id="search">

<a class="full_list_link" id="puppet_class_list_link"
href="../puppet_class_list.html">

<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>

</div>
<div class="clear"></div>
</div>

<div id="content"><h1>Defined Type: autofs::map</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>
manifests/map.pp
</dd>
</dl>
</div>

<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>Define: autofs::map</p>

<p>Defined type to generate autofs map entry
configuration files.</p>

</div>
</div>
<div class="tags">

<div class="examples">
<p class="tag_title">Examples:</p>


<p class="example_title"><div class='inline'><p>Using the autofs::map defined type to setup automount for nfs data directory.</p>
</div></p>

<pre class="example code"><code>autofs::map { &#39;data&#39;:
mapcontents =&gt; &#39;mydata -user,rw,soft,intr,rsize=32768,wsize=32768 nfs.example.org:/path/to/some/data&#39;,
mapfile =&gt; &#39;/etc/auto.data&#39;,
order =&gt; &#39;01&#39;,
}</code></pre>

</div>
<p class="tag_title">Parameters:</p>
<ul class="param">

<li>

<span class='name'>mapcontents</span>


<span class='type'>(<tt>Array</tt>)</span>



&mdash;
<div class='inline'><p>The mount point options and parameters,
Example: &#39;* -user,rw,soft nfs.example.org:/path/to&#39;</p>
</div>

</li>

<li>

<span class='name'>mapfile</span>


<span class='type'>(<tt>Stdlib::Absolutepath</tt>)</span>



&mdash;
<div class='inline'><p>Name of the &quot;auto.&quot; configuration file that will be generated.</p>
</div>

</li>

<li>

<span class='name'>template</span>


<span class='type'>(<tt>Enum['autofs/auto.map.erb', 'autofs/auto.map.exec.erb']</tt>)</span>


<em class="default">(defaults to: <tt>&#39;autofs/auto.map.erb&#39;</tt>)</em>


&mdash;
<div class='inline'><p>Template to use to generate the mapfile.</p>
</div>

</li>

<li>

<span class='name'>mapmode</span>


<span class='type'>(<tt>String</tt>)</span>


<em class="default">(defaults to: <tt>&#39;0644&#39;</tt>)</em>


&mdash;
<div class='inline'><p>UNIX permissions to be added to the file.</p>
</div>

</li>

<li>

<span class='name'>replace</span>


<span class='type'>(<tt>Boolean</tt>)</span>


<em class="default">(defaults to: <tt>true</tt>)</em>


&mdash;
<div class='inline'><p>Whether or not to replace an existing mapfile of the same filename/path.</p>
</div>

</li>

<li>

<span class='name'>order</span>


<span class='type'>(<tt>Integer</tt>)</span>


<em class="default">(defaults to: <tt>1</tt>)</em>


&mdash;
<div class='inline'><p>Order in which entries will appear in the autofs map file.</p>
</div>

</li>

</ul>


<p class="tag_title">See Also:</p>
<ul class="see">

<li><a href="https://voxpupuli.org/puppet-autofs" target="_parent" title="Home">Home</a></li>

<li><a href="https://voxpupuli.org/puppet-autofs/puppet_classes/autofs.html" target="_parent" title="puppet_classes::autofs">puppet_classes::autofs</a></li>

<li><a href="https://www.github.com/voxpupuli/puppet-autofs" target="_parent" title="Github">Github</a></li>

<li><a href="https://forge.puppet.com/puppet/autofs" target="_parent" title="Puppet Forge">Puppet Forge</a></li>

</ul>
<p class="tag_title">Author:</p>
<ul class="author">

<li>





<div class='inline'><p>Vox Pupuli <a href="mailto:voxpupuli@groups.io">voxpupuli@groups.io</a></p>
</div>

</li>

<li>





<div class='inline'><p>David Hollinger III <a href="mailto:david.hollinger@moduletux.com">david.hollinger@moduletux.com</a></p>
</div>

</li>

</ul>

</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">


29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/map.pp', line 29</span>

define autofs::map (
Array $mapcontents,
Stdlib::Absolutepath $mapfile,
Enum[&#39;autofs/auto.map.erb&#39;, &#39;autofs/auto.map.exec.erb&#39;] $template = &#39;autofs/auto.map.erb&#39;,
String $mapmode = &#39;0644&#39;,
Boolean $replace = true,
Integer $order = 1,
) {

ensure_resource(concat,$mapfile,{
ensure =&gt; present,
owner =&gt; &#39;root&#39;,
group =&gt; &#39;root&#39;,
mode =&gt; $mapmode,
replace =&gt; $replace,
require =&gt; Package[&#39;autofs&#39;],
notify =&gt; Service[&#39;autofs&#39;],
})

concat::fragment{&quot;${mapfile}_${name}_entries&quot;:
target =&gt; $mapfile,
content =&gt; template($template),
order =&gt; $order,
}

}</pre>
</td>
</tr>
</table>
</div>
</div>

<div id="footer">
Generated on Sun Jul 2 12:09:02 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.4.1).
</div>

</div>
</body>
</html>
150 changes: 95 additions & 55 deletions docs/puppet_defined_types/autofs_3A_3Amount.html
View file
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@
<title>
Defined Type: autofs::mount

&mdash; Documentation by YARD 0.9.8
&mdash; Documentation by YARD 0.9.9

</title>

@@ -68,6 +68,7 @@
</dd>
</dl>
</div>

<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
@@ -76,6 +77,8 @@ <h2>Overview</h2>
<p>Defined type to generate autofs mount point
configuration files.</p>

<p>}</p>

</div>
</div>
<div class="tags">
@@ -88,13 +91,23 @@ <h2>Overview</h2>
</div></p>

<pre class="example code"><code>autofs::mount { &#39;home&#39;:
mount =&gt; &#39;/home&#39;,
mapfile =&gt; &#39;/etc/auto.home&#39;,
mapcontents =&gt; [&#39;* -user,rw,soft,intr,rsize=32768,wsize=32768,tcp,nfsvers=3,noacl server.example.com:/path/to/home/shares&#39;],
options =&gt; &#39;--timeout=120&#39;,
order =&gt; 01
mount =&gt; &#39;/home&#39;,
mapfile =&gt; &#39;/etc/auto.home&#39;,
mapcontents =&gt; [&#39;* -user,rw,soft,intr,rsize=32768,wsize=32768,tcp,nfsvers=3,noacl server.example.com:/path/to/home/shares&#39;],
options =&gt; &#39;--timeout=120&#39;,
order =&gt; 01
}</code></pre>


<p class="example_title"><div class='inline'><p>Using autofs::mount defined type to create an enty for an existing auto.smb file.</p>
</div></p>

<pre class="example code"><code>autofs::mount { &#39;smb&#39;:
mount =&gt; &#39;/smb&#39;,
mapfile =&gt; &#39;program:/etc/auto.smb&#39;,
mapfile_manage =&gt; false,
options =&gt; &#39;--timeout=120&#39;,</code></pre>

</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
@@ -104,9 +117,11 @@ <h2>Overview</h2>
<span class='name'>mount</span>


<span class='type'>(<tt>String</tt>)</span>
<span class='type'>(<tt>Stdlib::Absolutepath</tt>)</span>


<em class="default">(defaults to: <tt>$title</tt>)</em>


&mdash;
<div class='inline'><p>Location where you will mount the remote NFS Share.</p>
@@ -119,14 +134,15 @@ <h2>Overview</h2>
<span class='name'>mapfile</span>


<span class='type'>(<tt>String</tt>)</span>
<span class='type'>(<tt>Optional[Variant[Stdlib::Absolutepath,Autofs::Mapentry]]</tt>)</span>


<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
<em class="default">(defaults to: <tt>undef</tt>)</em>


&mdash;
<div class='inline'><p>Name of the &quot;auto.&quot; configuration file that will be generated.</p>
<div class='inline'><p>Name of the &quot;auto.&quot; configuration file that will be generated.
can be a filepath or maptype and path.</p>
</div>

</li>
@@ -154,7 +170,7 @@ <h2>Overview</h2>
<span class='name'>master</span>


<span class='type'>(<tt>String</tt>)</span>
<span class='type'>(<tt>Stdlib::Absolutepath</tt>)</span>


<em class="default">(defaults to: <tt>&#39;/etc/auto.master&#39;</tt>)</em>
@@ -171,7 +187,7 @@ <h2>Overview</h2>
<span class='name'>map_dir</span>


<span class='type'>(<tt>String</tt>)</span>
<span class='type'>(<tt>Stdlib::Absolutepath</tt>)</span>


<em class="default">(defaults to: <tt>&#39;/etc/auto.master.d&#39;</tt>)</em>
@@ -207,7 +223,7 @@ <h2>Overview</h2>
<span class='name'>options</span>


<span class='type'>(<tt>String</tt>)</span>
<span class='type'>(<tt>Optional[String]</tt>)</span>


<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
@@ -227,6 +243,8 @@ <h2>Overview</h2>
<span class='type'>(<tt>Integer</tt>)</span>


<em class="default">(defaults to: <tt>1</tt>)</em>


&mdash;
<div class='inline'><p>Order in which entries will appear in the autofs master file.</p>
@@ -270,6 +288,24 @@ <h2>Overview</h2>

</li>

<li>

<span class='name'>mapfile_manage</span>


<span class='type'>(<tt>Boolean</tt>)</span>


<em class="default">(defaults to: <tt>true</tt>)</em>


&mdash;
<div class='inline'><p>Boolean will manaage the map file specifed in mapfile
paramter.</p>
</div>

</li>

<li>

<span class='name'>replace</span>
@@ -336,17 +372,6 @@ <h2>Overview</h2>
<pre class="lines">


40
41
42
43
44
45
46
47
48
49
50
51
52
53
@@ -423,26 +448,45 @@ <h2>Overview</h2>
124
125
126
127</pre>
127
128
129
130
131
132
133
134
135
136
137
138
139
140</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/mount.pp', line 40</span>
<pre class="code"><span class="info file"># File 'manifests/mount.pp', line 51</span>

define autofs::mount (
String $mount,
Integer $order,
String $options = &#39;&#39;,
String $master = &#39;/etc/auto.master&#39;,
String $map_dir = &#39;/etc/auto.master.d&#39;,
Boolean $use_dir = false,
Boolean $direct = true,
Boolean $execute = false,
String $mapfile = &#39;&#39;,
Array $mapcontents = [],
Boolean $replace = true
Stdlib::Absolutepath $mount = $title,
Integer $order = 1,
Optional[Variant[Stdlib::Absolutepath,Autofs::Mapentry]] $mapfile = undef,
Optional[String] $options = &#39;&#39;,
Stdlib::Absolutepath $master = &#39;/etc/auto.master&#39;,
Stdlib::Absolutepath $map_dir = &#39;/etc/auto.master.d&#39;,
Boolean $use_dir = false,
Boolean $direct = true,
Boolean $execute = false,
Boolean $mapfile_manage = true,
Array $mapcontents = [],
Boolean $replace = true
) {
include &#39;::autofs&#39;

if $mapfile != &#39;&#39; {
if $mapfile.is_a(Autofs::Mapentry) and $mapfile_manage {
fail(&quot;Parameter &#39;mapfile_manage&#39; must be false for complicated &#39;mapfile&#39; ${mapfile}&quot;)
}

if $mapfile {
$contents = &quot;${mount} ${mapfile} ${options}\n&quot;
} else {
$contents = &quot;${mount} ${options}\n&quot;
@@ -463,7 +507,7 @@ <h2>Overview</h2>
group =&gt; &#39;root&#39;,
mode =&gt; &#39;0644&#39;,
ensure_newline =&gt; true,
notify =&gt; Service[ &#39;autofs&#39; ],
notify =&gt; Service[&#39;autofs&#39;],
}
}

@@ -487,7 +531,7 @@ <h2>Overview</h2>
target =&gt; $master,
content =&gt; &quot;+dir:${map_dir}&quot;,
order =&gt; $order,
require =&gt; File[ $map_dir ],
require =&gt; File[$map_dir],
}
}

@@ -497,24 +541,20 @@ <h2>Overview</h2>
group =&gt; &#39;root&#39;,
mode =&gt; $mapperms,
content =&gt; $contents,
require =&gt; File[ $map_dir ],
notify =&gt; Service[ &#39;autofs&#39; ],
require =&gt; File[$map_dir],
notify =&gt; Service[&#39;autofs&#39;],
}
}

if $mapfile != &#39;&#39; {
file { $mapfile:
ensure =&gt; present,
owner =&gt; &#39;root&#39;,
group =&gt; &#39;root&#39;,
mode =&gt; $mapperms,
replace =&gt; $replace,
content =&gt; template($maptempl),
require =&gt; Package[ &#39;autofs&#39; ],
notify =&gt; Service[ &#39;autofs&#39; ],
if $mapfile and $mapfile_manage {
autofs::map { $title:
mapfile =&gt; $mapfile,
mapcontents =&gt; $mapcontents,
replace =&gt; $replace,
template =&gt; $maptempl,
mapmode =&gt; $mapperms,
}
}

}</pre>
</td>
</tr>
@@ -523,9 +563,9 @@ <h2>Overview</h2>
</div>

<div id="footer">
Generated on Sat Jan 14 13:46:48 2017 by
Generated on Sun Jul 2 12:09:02 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.8 (ruby-2.2.6).
0.9.9 (ruby-2.4.1).
</div>

</div>
6 changes: 3 additions & 3 deletions docs/top-level-namespace.html
View file
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@
<title>
Top Level Namespace

&mdash; Documentation by YARD 0.9.8
&mdash; Documentation by YARD 0.9.9

</title>

@@ -90,9 +90,9 @@
</div>

<div id="footer">
Generated on Sat Jan 14 13:46:48 2017 by
Generated on Sun Jul 2 12:09:02 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.8 (ruby-2.2.6).
0.9.9 (ruby-2.4.1).
</div>

</div>
8 changes: 8 additions & 0 deletions manifests/init.pp
View file
Original file line number Diff line number Diff line change
@@ -59,6 +59,14 @@
# @option mounts [Array] :mapcontents Mount point options and parameters. Each
# array element represents a line in the configuration file.
# @option mounts [Boolean] :replace Enforce the configuration state or not.
# @param maps the options to build an autofs mapfile.
# @option maps [Array]:mapcontents Mount point options and parameters. Each
# array element represents a line in the mapfile.
# @option maps [Stdlib::Absolutepath] :mapfile Full path to where the mapfile will be placed
# @option maps [Enum['autofs/auto.map.erb', 'autofs/auto.map.exec.erb']] :template Template to use the generate the mapfile
# @option maps [String] :mapmode The UNIX permissions to apply to the mapfile.
# @option maps [Boolean] :replace Replace the file if it changes or not.
# @option maps [Integer] :order The order in which to place mapfile contents.
# @param package_ensure Determines the state of the package. Can be set to: installed, absent, lastest, or a specific version string.
# @param service_ensure Determines state of the service. Can be set to: running or stopped.
# @param service_enable Determines if the service should start with the system boot. true
5 changes: 4 additions & 1 deletion manifests/map.pp
View file
Original file line number Diff line number Diff line change
@@ -21,8 +21,11 @@
# @param mapcontents The mount point options and parameters,
# Example: '* -user,rw,soft nfs.example.org:/path/to'
# @param mapfile Name of the "auto." configuration file that will be generated.
# @param template Template to use to generate the mapfile.
# @param mapmode UNIX permissions to be added to the file.
# @param replace Whether or not to replace an existing mapfile of the same filename/path.
# @param order Order in which entries will appear in the autofs map file.

#
define autofs::map (
Array $mapcontents,
Stdlib::Absolutepath $mapfile,