Debian Codegraph @

docs/init.html

raw
1 <!DOCTYPE html>
2 <html>
3 <head>
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
5 <title>init.pp</title>
6 <link rel="stylesheet" href="http://jashkenas.github.com/docco/resources/docco.css">
7 </head>
8 <body>
9 <div id='container'>
10 <div id="background"></div>
11 <div id="jump_to">
12 Jump To &hellip;
13 <div id="jump_wrapper">
14 <div id="jump_page">
15 <a class="source" href="deploy.html">deploy.pp</a>
16 <a class="source" href="extract.html">extract.pp</a>
17 <a class="source" href="file.html">file.pp</a>
18 <a class="source" href="init.html">init.pp</a>
19 </div>
20 </div>
21 </div>
22 <table cellspacing=0 cellpadding=0>
23 <thead>
24 <tr>
25 <th class=docs><h1>init.pp</h1></th>
26 <th class=code></th>
27 </tr>
28 </thead>
29 <tbody>
30 <tr id='section-Class:_staging'>
31 <td class=docs>
32 <div class="pilwrap">
33 <a class="pilcrow" href="#section-Class:_staging">&#182;</a>
34 </div>
35 <h3>Class: staging</h3>
36
37 <p>This module manages staging and extraction of files from various sources.</p>
38
39 <h4>Actions:</h4>
40
41 <p>Creates the root staging directory. By default files will be created in a subdirectory matching the caller_module_name.</p>
42
43 <p> /opt/staging/</p>
44
45 <pre><code> |-- puppet
46 | `-- puppet.enterprise.2.0.tar.gz
47 `-- tomcat
48 `-- tomcat.5.0.tar.gz
49 </code></pre>
50
51 <h3>Parameters:</h3>
52
53 <ul>
54 <li>[<em>path</em>]: staging directory filepath (default: &lsquo;/opt/staging&rsquo;)</li>
55 <li>[<em>owner</em>]: staging directory owner (default: &lsquo;0&rsquo;)</li>
56 <li>[<em>group</em>]: staging directory group (default: &lsquo;0&rsquo;)</li>
57 <li>[<em>mode</em>]: staging directory permission (default: &lsquo;0755&rsquo;)</li>
58 </ul>
59
60
61 <h3>Usage:</h3>
62
63 <pre><code>include staging
64 </code></pre>
65
66 </td>
67 <td class=code>
68 <div class='highlight'><pre><span class="k">class</span> <span class="n">staging</span> <span class="p">(</span>
69 <span class="vg">$path</span> <span class="o">=</span> <span class="s1">&#39;/opt/staging&#39;</span><span class="p">,</span>
70 <span class="vg">$owner</span> <span class="o">=</span> <span class="s1">&#39;0&#39;</span><span class="p">,</span>
71 <span class="vg">$group</span> <span class="o">=</span> <span class="s1">&#39;0&#39;</span><span class="p">,</span>
72 <span class="vg">$mode</span> <span class="o">=</span> <span class="s1">&#39;0755&#39;</span>
73 <span class="p">)</span> <span class="p">{</span>
74
75 <span class="n">file</span> <span class="p">{</span> <span class="vg">$path</span><span class="p">:</span>
76 <span class="k">ensure</span> <span class="o">=&gt;</span> <span class="n">directory</span><span class="p">,</span>
77 <span class="n">owner</span> <span class="o">=&gt;</span> <span class="vg">$owner</span><span class="p">,</span>
78 <span class="n">group</span> <span class="o">=&gt;</span> <span class="vg">$group</span><span class="p">,</span>
79 <span class="n">mode</span> <span class="o">=&gt;</span> <span class="vg">$mode</span><span class="p">,</span>
80 <span class="p">}</span>
81
82 <span class="p">}</span></pre></div>
83 </td>
84 </tr>
85 </table>
86 </div>
87 </body>