Skip to content

Commit

Permalink
Merge pull request voxpupuli#191 from vinzent/update_docs
Browse files Browse the repository at this point in the history 
Fix puppet strings warnings and minor README.md update
  • Loading branch information
@bastelfreak
bastelfreak authored Jan 31, 2017
2 parents 6772bbf + c6878e6 commit 14efd8d
Show file tree
Hide file tree
Showing 38 changed files with 2,380 additions and 413 deletions.
10 changes: 9 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This class manages SELinux on RHEL based systems.

## Requirements

* Puppet 3.8.7 or later
* Puppet 4 or later

## Module Description

Expand Down Expand Up @@ -128,6 +128,14 @@ selinux::boolean { 'puppetagent_manage_all_files': }
* `semanage` requires `--noreload` while in disabled mode when
adding or changing something
* Only few `--list` operations work
* run acceptance tests:

```
BEAKER_debug=yes BEAKER_set="centos-6-x64" PUPPET_INSTALL_TYPE="agent" bundle exec rake beaker
BEAKER_debug=yes BEAKER_set="centos-7-x64" PUPPET_INSTALL_TYPE="agent" bundle exec rake beaker
BEAKER_debug=yes BEAKER_set="fedora-24-x64" PUPPET_INSTALL_TYPE="agent" bundle exec rake beaker
BEAKER_debug=yes BEAKER_set="fedora-25-x64" PUPPET_INSTALL_TYPE="agent" bundle exec rake beaker
```

### Facter facts

Expand Down
99 changes: 95 additions & 4 deletions docs/_index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.7
Documentation by YARD 0.9.8

</title>

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

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

Expand Down Expand Up @@ -133,6 +133,11 @@ <h2>Defined Type Listing A-Z</h2>

</li>

<li>
<span class='object_link'><a href="puppet_defined_types/selinux_3A_3Afcontext_3A_3Aequivalence.html" title="puppet_defined_types::selinux::fcontext::equivalence (puppet_defined_type)">selinux::fcontext::equivalence</a></span>

</li>

<li>
<span class='object_link'><a href="puppet_defined_types/selinux_3A_3Amodule.html" title="puppet_defined_types::selinux::module (puppet_defined_type)">selinux::module</a></span>

Expand Down Expand Up @@ -161,6 +166,92 @@ <h2>Defined Type Listing A-Z</h2>
</table>


<h2>Resource Type Listing A-Z</h2>


<table>
<tr>
<td valign='top' width="33%">


<ul id="alpha_S" class="alpha">
<li class="letter">S</li>
<ul>

<li>
<span class='object_link'><a href="puppet_types/selinux_fcontext.html" title="puppet_types::selinux_fcontext (puppet_type)">selinux_fcontext</a></span>

</li>

<li>
<span class='object_link'><a href="puppet_types/selinux_fcontext_equivalence.html" title="puppet_types::selinux_fcontext_equivalence (puppet_type)">selinux_fcontext_equivalence</a></span>

</li>

<li>
<span class='object_link'><a href="puppet_types/selinux_permissive.html" title="puppet_types::selinux_permissive (puppet_type)">selinux_permissive</a></span>

</li>

<li>
<span class='object_link'><a href="puppet_types/selinux_port.html" title="puppet_types::selinux_port (puppet_type)">selinux_port</a></span>

</li>

</ul>
</ul>

</td>
</tr>
</table>


<h2>Puppet Provider Listing A-Z</h2>


<table>
<tr>
<td valign='top' width="33%">


<ul id="alpha_S" class="alpha">
<li class="letter">S</li>
<ul>

<li>
<span class='object_link'><a href="puppet_providers_selinux_port/semanage.html" title="puppet_providers_selinux_port::semanage (puppet_provider)">semanage</a></span>

<small>(Resource type: selinux_port)</small>

</li>

<li>
<span class='object_link'><a href="puppet_providers_selinux_fcontext/semanage.html" title="puppet_providers_selinux_fcontext::semanage (puppet_provider)">semanage</a></span>

<small>(Resource type: selinux_fcontext)</small>

</li>

<li>
<span class='object_link'><a href="puppet_providers_selinux_permissive/semanage.html" title="puppet_providers_selinux_permissive::semanage (puppet_provider)">semanage</a></span>

<small>(Resource type: selinux_permissive)</small>

</li>

<li>
<span class='object_link'><a href="puppet_providers_selinux_fcontext_equivalence/semanage.html" title="puppet_providers_selinux_fcontext_equivalence::semanage (puppet_provider)">semanage</a></span>

<small>(Resource type: selinux_fcontext_equivalence)</small>

</li>

</ul>
</ul>

</td>
</tr>
</table>



Expand All @@ -181,9 +272,9 @@ <h2>File Listing</h2>
</div>

<div id="footer">
Generated on Fri Jan 13 15:43:22 2017 by
Generated on Tue Jan 31 20:51:44 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.7 (ruby-2.3.3).
0.9.8 (ruby-2.3.3).
</div>

</div>
Expand Down
39 changes: 26 additions & 13 deletions docs/file.README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
File: README

&mdash; Documentation by YARD 0.9.7
&mdash; Documentation by YARD 0.9.8

</title>

Expand Down Expand Up @@ -85,7 +85,7 @@ <h2>Overview</h2>
<h2>Requirements</h2>

<ul>
<li>Puppet 3.8.7 or later</li>
<li>Puppet 4 or later</li>
</ul>

<h2>Module Description</h2>
Expand All @@ -108,7 +108,11 @@ <h2>Known problems / limitations</h2>
<li>If SELinux is disabled and you want to switch to permissive or enforcing you
are required to reboot the system (limitation of SELinux). The module won&#39;t
do this for you.</li>
<li>If you add filecontexts with <code>semange fcontext</code> (what <code>selinux::fcontext</code>
<li>If SELinux is disabled and the user wants enforcing mode, the module
will downgrade to permissive mode instead to avoid transitioning directly from
disabled to enforcing state after a reboot and potentially breaking the system.
The user will receive a warning when this happens,</li>
<li>If you add filecontexts with <code>semanage fcontext</code> (what <code>selinux::fcontext</code>
does) the order is important. If you add /my/folder before /my/folder/subfolder
only /my/folder will match (limitation of SELinux). There is no such limitation
to file-contexts defined in SELinux modules. (GH-121)</li>
Expand All @@ -117,19 +121,21 @@ <h2>Known problems / limitations</h2>
<li>While SELinux is disabled the defined types <code>selinux::boolean</code>,
<code>selinux::fcontext</code>, <code>selinux::port</code> will produce puppet agent runtime errors
because the used tools fail.</li>
<li><code>selinux::port</code> has the <code>action</code> parameter which if you specify <code>-d</code> or
<code>--delete</code> silently does nothing. (GH-164)</li>
<li><code>selinux::permissive</code> allows only to set a domain to permissive but not to
remove it. (GH-165)</li>
<li>If you try to remove a built-in permissive type, the operation will appear to succeed
but will actually have no effect, making your puppet runs non-idempotent.</li>
<li>The <code>selinux_port</code> provider may misbehave if the title does not correspond to
the format it expects. Users should use the <code>selinux::port</code> define instead except
when purging resources</li>
<li>Defining port ranges that overlap with existing ranges is currently not detected, and will
cause semanage to error when the resource is applied.</li>
</ul>

<h2>Usage</h2>

<p>There is puppet-strings generated documentation available in the docs/ folder
of the github repo.</p>
<p>Generated puppet strings documentation with examples is available from
<a href="https://voxpupuli.org/puppet-selinux/">https://voxpupuli.org/puppet-selinux/</a></p>

<p>It will be available at <a href="http://voxpupuli.org/pupppet-selinux">http://voxpupuli.org/pupppet-selinux</a> some time in
the future.</p>
<p>It&#39;s also included in the docs/ folder as simple html pages.</p>

<h2>Reference</h2>

Expand Down Expand Up @@ -189,8 +195,15 @@ <h3>Things to remember</h3>
adding or changing something</li>
<li>Only few <code>--list</code> operations work</li>
</ul></li>
<li>run acceptance tests:</li>
</ul>

<pre class="code ruby"><code class="ruby">BEAKER_debug=yes BEAKER_set=&quot;centos-6-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; be rake beaker
BEAKER_debug=yes BEAKER_set=&quot;centos-7-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; be rake beaker
BEAKER_debug=yes BEAKER_set=&quot;fedora-24-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; be rake beaker
BEAKER_debug=yes BEAKER_set=&quot;fedora-25-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; be rake beaker
</code></pre>

<h3>Facter facts</h3>

<p>The fact values might be unexpected while in disabled mode. One could expect
Expand Down Expand Up @@ -239,9 +252,9 @@ <h2>Authors</h2>
</div></div>

<div id="footer">
Generated on Fri Jan 13 15:43:22 2017 by
Generated on Tue Jan 31 20:51:44 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.7 (ruby-2.3.3).
0.9.8 (ruby-2.3.3).
</div>

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

&mdash; Documentation by YARD 0.9.7
&mdash; Documentation by YARD 0.9.8

</title>

Expand Down Expand Up @@ -85,7 +85,7 @@ <h2>Overview</h2>
<h2>Requirements</h2>

<ul>
<li>Puppet 3.8.7 or later</li>
<li>Puppet 4 or later</li>
</ul>

<h2>Module Description</h2>
Expand All @@ -108,7 +108,11 @@ <h2>Known problems / limitations</h2>
<li>If SELinux is disabled and you want to switch to permissive or enforcing you
are required to reboot the system (limitation of SELinux). The module won&#39;t
do this for you.</li>
<li>If you add filecontexts with <code>semange fcontext</code> (what <code>selinux::fcontext</code>
<li>If SELinux is disabled and the user wants enforcing mode, the module
will downgrade to permissive mode instead to avoid transitioning directly from
disabled to enforcing state after a reboot and potentially breaking the system.
The user will receive a warning when this happens,</li>
<li>If you add filecontexts with <code>semanage fcontext</code> (what <code>selinux::fcontext</code>
does) the order is important. If you add /my/folder before /my/folder/subfolder
only /my/folder will match (limitation of SELinux). There is no such limitation
to file-contexts defined in SELinux modules. (GH-121)</li>
Expand All @@ -117,19 +121,21 @@ <h2>Known problems / limitations</h2>
<li>While SELinux is disabled the defined types <code>selinux::boolean</code>,
<code>selinux::fcontext</code>, <code>selinux::port</code> will produce puppet agent runtime errors
because the used tools fail.</li>
<li><code>selinux::port</code> has the <code>action</code> parameter which if you specify <code>-d</code> or
<code>--delete</code> silently does nothing. (GH-164)</li>
<li><code>selinux::permissive</code> allows only to set a domain to permissive but not to
remove it. (GH-165)</li>
<li>If you try to remove a built-in permissive type, the operation will appear to succeed
but will actually have no effect, making your puppet runs non-idempotent.</li>
<li>The <code>selinux_port</code> provider may misbehave if the title does not correspond to
the format it expects. Users should use the <code>selinux::port</code> define instead except
when purging resources</li>
<li>Defining port ranges that overlap with existing ranges is currently not detected, and will
cause semanage to error when the resource is applied.</li>
</ul>

<h2>Usage</h2>

<p>There is puppet-strings generated documentation available in the docs/ folder
of the github repo.</p>
<p>Generated puppet strings documentation with examples is available from
<a href="https://voxpupuli.org/puppet-selinux/">https://voxpupuli.org/puppet-selinux/</a></p>

<p>It will be available at <a href="http://voxpupuli.org/pupppet-selinux">http://voxpupuli.org/pupppet-selinux</a> some time in
the future.</p>
<p>It&#39;s also included in the docs/ folder as simple html pages.</p>

<h2>Reference</h2>

Expand Down Expand Up @@ -189,8 +195,15 @@ <h3>Things to remember</h3>
adding or changing something</li>
<li>Only few <code>--list</code> operations work</li>
</ul></li>
<li>run acceptance tests:</li>
</ul>

<pre class="code ruby"><code class="ruby">BEAKER_debug=yes BEAKER_set=&quot;centos-6-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; be rake beaker
BEAKER_debug=yes BEAKER_set=&quot;centos-7-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; be rake beaker
BEAKER_debug=yes BEAKER_set=&quot;fedora-24-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; be rake beaker
BEAKER_debug=yes BEAKER_set=&quot;fedora-25-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; be rake beaker
</code></pre>

<h3>Facter facts</h3>

<p>The fact values might be unexpected while in disabled mode. One could expect
Expand Down Expand Up @@ -239,9 +252,9 @@ <h2>Authors</h2>
</div></div>

<div id="footer">
Generated on Fri Jan 13 15:43:22 2017 by
Generated on Tue Jan 31 20:51:44 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.7 (ruby-2.3.3).
0.9.8 (ruby-2.3.3).
</div>

</div>
Expand Down
8 changes: 8 additions & 0 deletions docs/puppet_class_list.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@ <h1 id="full_list_header">Puppet Class List</h1>
Defined Types
</a></span>

<span><a target="_self" href="puppet_type_list.html">
Resource Types
</a></span>

<span><a target="_self" href="puppet_provider_list.html">
Providers
</a></span>

</div>

<div id="search">Search: <input type="text" /></div>
Expand Down
Loading

0 comments on commit 14efd8d

Please sign in to comment.