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_defined_types | |
| 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_defined_types')
| -rw-r--r-- | docs/puppet_defined_types/ferm_3A_3Achain.html | 202 | ||||
| -rw-r--r-- | docs/puppet_defined_types/ferm_3A_3Arule.html | 297 |
2 files changed, 0 insertions, 499 deletions
diff --git a/docs/puppet_defined_types/ferm_3A_3Achain.html b/docs/puppet_defined_types/ferm_3A_3Achain.html deleted file mode 100644 index a001974..0000000 --- a/docs/puppet_defined_types/ferm_3A_3Achain.html +++ /dev/null @@ -1,202 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <meta charset="utf-8"> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> -<title> - Defined Type: ferm::chain - - — 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_defined_types::ferm::chain"; - 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 (f)</a> » - <span class='title'><span class='object_link'>Defined Types</span></span> - » - <span class="title">ferm::chain</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: ferm::chain</h1> -<div class="box_info"> - <dl> - <dt>Defined in:</dt> - <dd> - manifests/chain.pp - </dd> - </dl> -</div> - -<h2>Overview</h2> -<div class="docstring"> - <div class="discussion"> - <p>defined resource which creates all rules for one chain</p> - - </div> -</div> -<div class="tags"> - <p class="tag_title">Parameters:</p> -<ul class="param"> - - <li> - - <span class='name'>policy</span> - - - <span class='type'>(<tt>Ferm::Policies</tt>)</span> - - - - — - <div class='inline'><p>Set the default policy for a CHAIN</p> -</div> - - </li> - - <li> - - <span class='name'>disable_conntrack</span> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - — - <div class='inline'><p>disable/enable usage of conntrack</p> -</div> - - </li> - - <li> - - <span class='name'>chain</span> - - - <span class='type'>(<tt>Ferm::Chains</tt>)</span> - - - <em class="default">(defaults to: <tt>$name</tt>)</em> - - - — - <div class='inline'><p>name of the chain that should be managed</p> -</div> - - </li> - -</ul> - - -</div><div class="method_details_list"> - <table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'manifests/chain.pp', line 5</span> - -define ferm::chain ( - Ferm::Policies $policy, - Boolean $disable_conntrack, - Ferm::Chains $chain = $name, -) { - - # concat resource for the chain - $filename = downcase($chain) - concat{"/etc/ferm.d/chains/${chain}.conf": - ensure => 'present', - } - - concat::fragment{"${chain}-policy": - target => "/etc/ferm.d/chains/${chain}.conf", - content => epp( - "${module_name}/ferm_chain_header.conf.epp", { - 'policy' => $policy, - 'disable_conntrack' => $disable_conntrack, - } - ), - order => '01', - } -}</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_defined_types/ferm_3A_3Arule.html b/docs/puppet_defined_types/ferm_3A_3Arule.html deleted file mode 100644 index cad82f6..0000000 --- a/docs/puppet_defined_types/ferm_3A_3Arule.html +++ /dev/null @@ -1,297 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <meta charset="utf-8"> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> -<title> - Defined Type: ferm::rule - - — 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_defined_types::ferm::rule"; - 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 (f)</a> » - <span class='title'><span class='object_link'>Defined Types</span></span> - » - <span class="title">ferm::rule</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: ferm::rule</h1> -<div class="box_info"> - <dl> - <dt>Defined in:</dt> - <dd> - manifests/rule.pp - </dd> - </dl> -</div> - -<h2>Overview</h2> -<div class="docstring"> - <div class="discussion"> - - </div> -</div> -<div class="tags"> - <p class="tag_title">Parameters:</p> -<ul class="param"> - - <li> - - <span class='name'>chain</span> - - - <span class='type'>(<tt>Ferm::Chains</tt>)</span> - - - - </li> - - <li> - - <span class='name'>policy</span> - - - <span class='type'>(<tt>Ferm::Policies</tt>)</span> - - - - </li> - - <li> - - <span class='name'>proto</span> - - - <span class='type'>(<tt>Ferm::Protocols</tt>)</span> - - - - </li> - - <li> - - <span class='name'>comment</span> - - - <span class='type'>(<tt>String</tt>)</span> - - - <em class="default">(defaults to: <tt>$name</tt>)</em> - - - </li> - - <li> - - <span class='name'>dport</span> - - - <span class='type'>(<tt>Optional[Variant[Integer,String]]</tt>)</span> - - - <em class="default">(defaults to: <tt>undef</tt>)</em> - - - </li> - - <li> - - <span class='name'>sport</span> - - - <span class='type'>(<tt>Optional[Variant[Integer,String]]</tt>)</span> - - - <em class="default">(defaults to: <tt>undef</tt>)</em> - - - </li> - - <li> - - <span class='name'>saddr</span> - - - <span class='type'>(<tt>Optional[String]</tt>)</span> - - - <em class="default">(defaults to: <tt>undef</tt>)</em> - - - </li> - - <li> - - <span class='name'>daddr</span> - - - <span class='type'>(<tt>Optional[String]</tt>)</span> - - - <em class="default">(defaults to: <tt>undef</tt>)</em> - - - </li> - - <li> - - <span class='name'>ensure</span> - - - <span class='type'>(<tt>Enum['absent','present']</tt>)</span> - - - <em class="default">(defaults to: <tt>'present'</tt>)</em> - - - </li> - -</ul> - - -</div><div class="method_details_list"> - <table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -1 -2 -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</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'manifests/rule.pp', line 1</span> - -define ferm::rule ( - Ferm::Chains $chain, - Ferm::Policies $policy, - Ferm::Protocols $proto, - String $comment = $name, - Optional[Variant[Integer,String]] $dport = undef, - Optional[Variant[Integer,String]] $sport = undef, - Optional[String] $saddr = undef, - Optional[String] $daddr = undef, - Enum['absent','present'] $ensure = 'present', -){ - $proto_real = "proto ${proto}" - - $dport_real = $dport ? { - undef => '', - default => "dport ${dport}", - } - $sport_real = $sport ? { - undef => '', - default => "sport ${sport}", - } - $saddr_real = $saddr ? { - undef => '', - default => "saddr @ipfilter(${saddr})", - } - $daddr_real = $daddr ? { - undef => '', - default => "daddr @ipfilter(${daddr})" - } - $comment_real = "mod comment comment '${comment}'" - - $rule = squeeze("${comment_real} ${proto_real} ${dport_real} ${sport_real} ${daddr_real} ${saddr_real} ${policy};", ' ') - if $ensure == 'present' { - concat::fragment{"${chain}-${name}": - target => "/etc/ferm.d/chains/${chain}.conf", - content => "${rule}\n", - } - } -}</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 |