Update strings docs (voxpupuli#197)

Includes the changes in selinux::module
EmRowlands · Feb 23, 2017 · bf4dc56 · bf4dc56
1 parent 2534853
commit bf4dc56
Show file tree

Hide file tree

Showing 30 changed files with 618 additions and 274 deletions.
diff --git a/docs/_index.html b/docs/_index.html
@@ -88,6 +88,11 @@ <h2>Puppet Class Listing A-Z</h2>
 
             </li>
 
+            <li>
+      <span class='object_link'><a href="puppet_classes/selinux_3A_3Arefpolicy_package.html" title="puppet_classes::selinux::refpolicy_package (puppet_class)">selinux::refpolicy_package</a></span>
+
+            </li>
+
             <li>
       <span class='object_link'><a href="puppet_classes/selinux_3A_3Arestorecond.html" title="puppet_classes::selinux::restorecond (puppet_class)">selinux::restorecond</a></span>
 
@@ -272,7 +277,7 @@ <h2>File Listing</h2>
 </div>
 
       <div id="footer">
-  Generated on Tue Jan 31 20:51:44 2017 by
+  Generated on Fri Feb 17 09:39:19 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.8 (ruby-2.3.3).
 </div>

diff --git a/docs/file.README.html b/docs/file.README.html
@@ -102,6 +102,18 @@ <h2>Get in touch</h2>
 (<a href="https://groups.io/g/voxpupuli/topics">groups.io Webinterface</a>)</li>
 </ul>
 
+<h2>Upgrading from puppet-selinux 0.8.x</h2>
+
+<ul>
+<li>Previously, module building always used the refpolicy framework. The default
+module builder is now &#39;simple&#39;, which uses only checkmodule. Not all features are
+supported with this builder.</li>
+</ul>
+
+<p>To build modules using the refpolicy framework like previous versions did,
+  specify the  &#39;refpolicy&#39; builder either explicitly per module or globally
+  via the main class</p>
+
 <h2>Known problems / limitations</h2>
 
 <ul>
@@ -116,8 +128,6 @@ <h2>Known problems / limitations</h2>
 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>
-<li><code>selinux::module</code> only allows to add a type enforcment file (<code>*.te</code>) but no
-interfaces (<code>*.if</code>) or file-contexts (<code>*.fc</code>).</li>
 <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>
@@ -160,11 +170,14 @@ <h3>More advanced usage</h3>
 are <code>target</code>, <code>minimum</code>, and <code>mls</code>). Note that disabling SELinux requires a reboot
 to fully take effect. It will run in <code>permissive</code> mode until then.</p>
 
-<h3>Deploy a custom module</h3>
+<h3>Deploy a custom module using the refpolicy framework</h3>
 
 <pre class="code puppet"><code class="puppet">selinux::module { &#39;resnet-puppet&#39;:
-  ensure =&gt; &#39;present&#39;,
-  source =&gt; &#39;puppet:///modules/site_puppet/site-puppet.te&#39;,
+  ensure    =&gt; &#39;present&#39;,
+  source_te =&gt; &#39;puppet:///modules/site_puppet/site-puppet.te&#39;,
+  source_fc =&gt; &#39;puppet:///modules/site_puppet/site-puppet.fc&#39;,
+  source_if =&gt; &#39;puppet:///modules/site_puppet/site-puppet.if&#39;,
+  builder   =&gt; &#39;refpolicy&#39;
 }
 </code></pre>
 
@@ -198,10 +211,10 @@ <h3>Things to remember</h3>
 <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
+<pre class="code ruby"><code class="ruby">BEAKER_debug=yes BEAKER_set=&quot;centos-6-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; bundle exec rake beaker &amp;&amp;
+BEAKER_debug=yes BEAKER_set=&quot;centos-7-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; bundle exec rake beaker &amp;&amp;
+BEAKER_debug=yes BEAKER_set=&quot;fedora-24-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; bundle exec rake beaker &amp;&amp;
+BEAKER_debug=yes BEAKER_set=&quot;fedora-25-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; bundle exec rake beaker
 </code></pre>
 
 <h3>Facter facts</h3>
@@ -252,7 +265,7 @@ <h2>Authors</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Tue Jan 31 20:51:44 2017 by
+  Generated on Fri Feb 17 09:39:19 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.8 (ruby-2.3.3).
 </div>

diff --git a/docs/index.html b/docs/index.html
@@ -102,6 +102,18 @@ <h2>Get in touch</h2>
 (<a href="https://groups.io/g/voxpupuli/topics">groups.io Webinterface</a>)</li>
 </ul>
 
+<h2>Upgrading from puppet-selinux 0.8.x</h2>
+
+<ul>
+<li>Previously, module building always used the refpolicy framework. The default
+module builder is now &#39;simple&#39;, which uses only checkmodule. Not all features are
+supported with this builder.</li>
+</ul>
+
+<p>To build modules using the refpolicy framework like previous versions did,
+  specify the  &#39;refpolicy&#39; builder either explicitly per module or globally
+  via the main class</p>
+
 <h2>Known problems / limitations</h2>
 
 <ul>
@@ -116,8 +128,6 @@ <h2>Known problems / limitations</h2>
 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>
-<li><code>selinux::module</code> only allows to add a type enforcment file (<code>*.te</code>) but no
-interfaces (<code>*.if</code>) or file-contexts (<code>*.fc</code>).</li>
 <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>
@@ -160,11 +170,14 @@ <h3>More advanced usage</h3>
 are <code>target</code>, <code>minimum</code>, and <code>mls</code>). Note that disabling SELinux requires a reboot
 to fully take effect. It will run in <code>permissive</code> mode until then.</p>
 
-<h3>Deploy a custom module</h3>
+<h3>Deploy a custom module using the refpolicy framework</h3>
 
 <pre class="code puppet"><code class="puppet">selinux::module { &#39;resnet-puppet&#39;:
-  ensure =&gt; &#39;present&#39;,
-  source =&gt; &#39;puppet:///modules/site_puppet/site-puppet.te&#39;,
+  ensure    =&gt; &#39;present&#39;,
+  source_te =&gt; &#39;puppet:///modules/site_puppet/site-puppet.te&#39;,
+  source_fc =&gt; &#39;puppet:///modules/site_puppet/site-puppet.fc&#39;,
+  source_if =&gt; &#39;puppet:///modules/site_puppet/site-puppet.if&#39;,
+  builder   =&gt; &#39;refpolicy&#39;
 }
 </code></pre>
 
@@ -198,10 +211,10 @@ <h3>Things to remember</h3>
 <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
+<pre class="code ruby"><code class="ruby">BEAKER_debug=yes BEAKER_set=&quot;centos-6-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; bundle exec rake beaker &amp;&amp;
+BEAKER_debug=yes BEAKER_set=&quot;centos-7-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; bundle exec rake beaker &amp;&amp;
+BEAKER_debug=yes BEAKER_set=&quot;fedora-24-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; bundle exec rake beaker &amp;&amp;
+BEAKER_debug=yes BEAKER_set=&quot;fedora-25-x64&quot; PUPPET_INSTALL_TYPE=&quot;agent&quot; bundle exec rake beaker
 </code></pre>
 
 <h3>Facter facts</h3>
@@ -252,7 +265,7 @@ <h2>Authors</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Tue Jan 31 20:51:44 2017 by
+  Generated on Fri Feb 17 09:39:19 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.8 (ruby-2.3.3).
 </div>

diff --git a/docs/puppet_class_list.html b/docs/puppet_class_list.html
@@ -76,21 +76,28 @@ <h1 id="full_list_header">Puppet Class List</h1>
     </li>
 
 
-    <li id="object_puppet_classes::selinux::restorecond" class="odd">
+    <li id="object_puppet_classes::selinux::refpolicy_package" class="odd">
+      <div class="item">
+        <span class='object_link'><a href="puppet_classes/selinux_3A_3Arefpolicy_package.html" title="puppet_classes::selinux::refpolicy_package (puppet_class)">selinux::refpolicy_package</a></span>
+      </div>
+    </li>
+
+
+    <li id="object_puppet_classes::selinux::restorecond" class="even">
       <div class="item">
         <span class='object_link'><a href="puppet_classes/selinux_3A_3Arestorecond.html" title="puppet_classes::selinux::restorecond (puppet_class)">selinux::restorecond</a></span>
       </div>
     </li>
 
 
-    <li id="object_puppet_classes::selinux::restorecond::config" class="even">
+    <li id="object_puppet_classes::selinux::restorecond::config" class="odd">
       <div class="item">
         <span class='object_link'><a href="puppet_classes/selinux_3A_3Arestorecond_3A_3Aconfig.html" title="puppet_classes::selinux::restorecond::config (puppet_class)">selinux::restorecond::config</a></span>
       </div>
     </li>
 
 
-    <li id="object_puppet_classes::selinux::restorecond::service" class="odd">
+    <li id="object_puppet_classes::selinux::restorecond::service" class="even">
       <div class="item">
         <span class='object_link'><a href="puppet_classes/selinux_3A_3Arestorecond_3A_3Aservice.html" title="puppet_classes::selinux::restorecond::service (puppet_class)">selinux::restorecond::service</a></span>
       </div>