diff options
| author | Tim Meusel <tim@bastelfreak.de> | 2019-10-01 14:52:15 +0200 |
|---|---|---|
| committer | Tim Meusel <tim@bastelfreak.de> | 2019-10-01 14:52:15 +0200 |
| commit | 8a15bac595fd96debe52dc437bd34f682564b2b6 (patch) | |
| tree | 7e27d43323ef201e7a8d594a333187dc3c25e9a9 /docs/puppet_classes | |
| parent | 936d5f7c4b41ae8249f432827370815f2ec88dae (diff) | |
| download | puppet-ferm-8a15bac595fd96debe52dc437bd34f682564b2b6.tar.gz puppet-ferm-8a15bac595fd96debe52dc437bd34f682564b2b6.tar.bz2 | |
delete legacy docs/ folder
We now have a REFERENCE.md in the repository. We don't need the docs/
folder anymore.
Diffstat (limited to 'docs/puppet_classes')
| -rw-r--r-- | docs/puppet_classes/ferm.html | 316 | ||||
| -rw-r--r-- | docs/puppet_classes/ferm_3A_3Aconfig.html | 201 | ||||
| -rw-r--r-- | docs/puppet_classes/ferm_3A_3Ainstall.html | 125 | ||||
| -rw-r--r-- | docs/puppet_classes/ferm_3A_3Aservice.html | 149 |
4 files changed, 0 insertions, 791 deletions
diff --git a/docs/puppet_classes/ferm.html b/docs/puppet_classes/ferm.html deleted file mode 100644 index cbabd5c..0000000 --- a/docs/puppet_classes/ferm.html +++ /dev/null @@ -1,316 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <meta charset="utf-8"> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> -<title> - Puppet Class: ferm - - — Documentation by YARD 0.9.12 - -</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_classes::ferm"; - 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_class_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 (f)</a> » - <span class='title'><span class='object_link'>Puppet Classes</span></span> - » - <span class="title">ferm</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>Puppet Class: ferm</h1> -<div class="box_info"> - - - <dl> - <dt>Defined in:</dt> - <dd> - manifests/init.pp - </dd> - </dl> -</div> - -<h2>Overview</h2> -<div class="docstring"> - <div class="discussion"> - <p>Class: ferm</p> - -<p>This class manages ferm installation and rule generation on modern linux systems</p> - -<p>class{'ferm': - manage_service => true, -}</p> - - </div> -</div> -<div class="tags"> - - <div class="examples"> - <p class="tag_title">Examples:</p> - - - <p class="example_title"><div class='inline'><p>deploy ferm and start it</p> -</div></p> - - <pre class="example code"><code></code></pre> - - </div> -<p class="tag_title">Parameters:</p> -<ul class="param"> - - <li> - - <span class='name'>manage_service</span> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - — - <div class='inline'><p>disable/enable the management of the ferm daemon -Default value: false -Allowed values: (true|false)</p> -</div> - - </li> - - <li> - - <span class='name'>manage_configfile</span> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - — - <div class='inline'><p>disable/enable the management of the ferm default config -Default value: false -Allowed values: (true|false)</p> -</div> - - </li> - - <li> - - <span class='name'>configfile</span> - - - <span class='type'>(<tt>Stdlib::Absolutepath</tt>)</span> - - - - — - <div class='inline'><p>path to the config file -Default value: /etc/ferm.conf -Allowed values: Stdlib::Absolutepath</p> -</div> - - </li> - - <li> - - <span class='name'>disable_conntrack</span> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - — - <div class='inline'><p>disable/enable the generation of conntrack rules -Default value: false -Allowed values: (true|false)</p> -</div> - - </li> - - <li> - - <span class='name'>forward_policy</span> - - - <span class='type'>(<tt>Ferm::Policies</tt>)</span> - - - - — - <div class='inline'><p>default policy for the FORWARD chain -Default value: DROP -Allowed values: (ACCEPT|DROP|REJECT)</p> -</div> - - </li> - - <li> - - <span class='name'>output_policy</span> - - - <span class='type'>(<tt>Ferm::Policies</tt>)</span> - - - - — - <div class='inline'><p>default policy for the OUTPUT chain -Default value: ACCEPT -Allowed values: (ACCEPT|DROP|REJECT)</p> -</div> - - </li> - - <li> - - <span class='name'>input_policy</span> - - - <span class='type'>(<tt>Ferm::Policies</tt>)</span> - - - - — - <div class='inline'><p>default policy for the INPUT chain -Default value: DROP -Allowed values: (ACCEPT|DROP|REJECT)</p> -</div> - - </li> - - <li> - - <span class='name'>rules</span> - - - <span class='type'>(<tt>Hash</tt>)</span> - - - - — - <div class='inline'><p>a hash that holds all data for ferm::rule -Default value: Empty Hash -Allowed value: Any Hash</p> -</div> - - </li> - -</ul> - - -</div><div class="method_details_list"> - <table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'manifests/init.pp', line 34</span> - -class ferm ( - Boolean $manage_service, - Boolean $manage_configfile, - Stdlib::Absolutepath $configfile, - Boolean $disable_conntrack, - Ferm::Policies $forward_policy, - Ferm::Policies $output_policy, - Ferm::Policies $input_policy, - Hash $rules, -) { - contain ferm::install - contain ferm::config - contain ferm::service - - Class['ferm::install'] - -> Class['ferm::config'] - ~> Class['ferm::service'] - - $rules.each |$rulename, $attributes| { - ferm::rule{$rulename: - * => $attributes, - } - } - # import all exported resources with ferm rules for this node - Ferm::Rule <<| tag == $trusted['certname'] |>> -}</pre> - </td> - </tr> - </table> -</div> -</div> - - <div id="footer"> - Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>. -</div> - - </div> - </body> -</html>
\ No newline at end of file diff --git a/docs/puppet_classes/ferm_3A_3Aconfig.html b/docs/puppet_classes/ferm_3A_3Aconfig.html deleted file mode 100644 index 139230c..0000000 --- a/docs/puppet_classes/ferm_3A_3Aconfig.html +++ /dev/null @@ -1,201 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <meta charset="utf-8"> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> -<title> - Puppet Class: ferm::config - - — Documentation by YARD 0.9.12 - -</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_classes::ferm::config"; - 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_class_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 (f)</a> » - <span class='title'><span class='object_link'>Puppet Classes</span></span> - » - <span class="title">ferm::config</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>Puppet Class: ferm::config</h1> -<div class="box_info"> - - - <dl> - <dt>Defined in:</dt> - <dd> - manifests/config.pp - </dd> - </dl> -</div> - -<h2>Overview</h2> -<div class="docstring"> - <div class="discussion"> - <p>This class handles the configuration file. Avoid modifying private classes.</p> - - </div> -</div> -<div class="tags"> - - -</div><div class="method_details_list"> - <table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'manifests/config.pp', line 3</span> - -class ferm::config { - - # this is a private class - assert_private("You're not supposed to do that!") - - # copy static files to ferm - # on a long term point of view, we want to package this - file{'/etc/ferm.d': - ensure => 'directory', - } - -> file{'/etc/ferm.d/definitions': - ensure => 'directory', - } - -> file{'/etc/ferm.d/chains': - ensure => 'directory', - } - - if $ferm::manage_configfile { - concat{$ferm::configfile: - ensure => 'present', - } - concat::fragment{'ferm_header.conf': - target => $ferm::configfile, - content => epp("${module_name}/ferm_header.conf.epp"), - order => '01', - } - - concat::fragment{'ferm.conf': - target => $ferm::configfile, - content => epp("${module_name}/ferm.conf.epp"), - order => '50', - } - } - - ferm::chain{'INPUT': - policy => $ferm::input_policy, - disable_conntrack => $ferm::disable_conntrack, - } - ferm::chain{'FORWARD': - policy => $ferm::forward_policy, - disable_conntrack => $ferm::disable_conntrack, - } - ferm::chain{'OUTPUT': - policy => $ferm::output_policy, - disable_conntrack => $ferm::disable_conntrack, - } -}</pre> - </td> - </tr> - </table> -</div> -</div> - - <div id="footer"> - Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>. -</div> - - </div> - </body> -</html>
\ No newline at end of file diff --git a/docs/puppet_classes/ferm_3A_3Ainstall.html b/docs/puppet_classes/ferm_3A_3Ainstall.html deleted file mode 100644 index c6e1b12..0000000 --- a/docs/puppet_classes/ferm_3A_3Ainstall.html +++ /dev/null @@ -1,125 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <meta charset="utf-8"> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> -<title> - Puppet Class: ferm::install - - — Documentation by YARD 0.9.12 - -</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_classes::ferm::install"; - 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_class_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 (f)</a> » - <span class='title'><span class='object_link'>Puppet Classes</span></span> - » - <span class="title">ferm::install</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>Puppet Class: ferm::install</h1> -<div class="box_info"> - - - <dl> - <dt>Defined in:</dt> - <dd> - manifests/install.pp - </dd> - </dl> -</div> - -<h2>Overview</h2> -<div class="docstring"> - <div class="discussion"> - <p>This class handles the configuration file. Avoid modifying private classes.</p> - - </div> -</div> -<div class="tags"> - - -</div><div class="method_details_list"> - <table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -3 -4 -5 -6 -7 -8 -9 -10 -11</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'manifests/install.pp', line 3</span> - -class ferm::install { - - # this is a private class - assert_private("You're not supposed to do that!") - - package{'ferm': - ensure => 'latest', - } -}</pre> - </td> - </tr> - </table> -</div> -</div> - - <div id="footer"> - Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>. -</div> - - </div> - </body> -</html>
\ No newline at end of file diff --git a/docs/puppet_classes/ferm_3A_3Aservice.html b/docs/puppet_classes/ferm_3A_3Aservice.html deleted file mode 100644 index cfa5022..0000000 --- a/docs/puppet_classes/ferm_3A_3Aservice.html +++ /dev/null @@ -1,149 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <meta charset="utf-8"> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> -<title> - Puppet Class: ferm::service - - — Documentation by YARD 0.9.12 - -</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_classes::ferm::service"; - 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_class_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 (f)</a> » - <span class='title'><span class='object_link'>Puppet Classes</span></span> - » - <span class="title">ferm::service</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>Puppet Class: ferm::service</h1> -<div class="box_info"> - - - <dl> - <dt>Defined in:</dt> - <dd> - manifests/service.pp - </dd> - </dl> -</div> - -<h2>Overview</h2> -<div class="docstring"> - <div class="discussion"> - <p>This class handles the configuration file. Avoid modifying private classes.</p> - - </div> -</div> -<div class="tags"> - - -</div><div class="method_details_list"> - <table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'manifests/service.pp', line 3</span> - -class ferm::service { - - # this is a private class - assert_private("You're not supposed to do that!") - - if $ferm::manage_service { - service{'ferm': - ensure => 'running', - enable => true, - } - - # on Ubuntu, we can't start the service, unless we set ENABLED=true in /etc/default/ferm... - if ($facts['os']['name'] == 'Ubuntu') { - file_line{'enable_ferm': - path => '/etc/default/ferm', - line => 'ENABLED="yes"', - match => 'ENABLED=', - } - } - } -}</pre> - </td> - </tr> - </table> -</div> -</div> - - <div id="footer"> - Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>. -</div> - - </div> - </body> -</html>
\ No newline at end of file |