3rdparty/modules/staging/docs/file.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta http-equiv="content-type" content="text/html;charset=utf-8">
   5   <title>file.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>file.pp</h1></th>
  26       <th class=code></th>
  27     </tr>
  28   </thead>
  29   <tbody>
  30     <tr id='section-Define:_staging::file'>
  31       <td class=docs>
  32         <div class="pilwrap">
  33           <a class="pilcrow" href="#section-Define:_staging::file">&#182;</a>
  34         </div>
  35         <h3>Define: staging::file</h3>
  36
  37 <h4>Overview:</h4>
  38
  39 <p>Define resource to retrieve files to staging directories. It is
  40 intententionally not replacing files, as these intend to be large binaries
  41 that are versioned.</p>
  42
  43 <h4>Notes:</h4>
  44
  45 <p>  If you specify a different staging location, please manage the file
  46   resource as necessary.</p>
  47
  48 <h3>Parameters:</h3>
  49
  50 <ul>
  51 <li>[<em>source</em>]:  the source file location, supports local files, puppet://, http://, https://, ftp:// (default: )</li>
  52 <li>[<em>target</em>]:  the target staging directory, if unspecified ${staging::path}/${caller_module_name} (default: undef)</li>
  53 <li>[<em>username</em>]:  https or ftp username (default: undef)</li>
  54 <li>[<em>certificate</em>]:  https certificate file (default: undef)</li>
  55 <li>[<em>password</em>]:  https or ftp user password or https certificate password (default: undef)</li>
  56 <li>[<em>environment</em>]:  environment variable for settings such as http_proxy, https_proxy, of ftp_proxy (default: undef)</li>
  57 <li>[<em>timeout</em>]:  the the time to wait for the file transfer to complete (default: undef)</li>
  58 <li>[<em>subdir</em>]:  (default: $caller_module_name)</li>
  59 </ul>
  60
  61
  62 <h3>Usage:</h3>
  63
  64 <pre><code>$caller_module_name = 'demo'
  65
  66 class { 'staging':
  67   path =&gt; '/tmp/staging',
  68 }
  69
  70 staging::file { 'sample':
  71   source =&gt; 'puppet:///modules/staging/sample',
  72 }
  73
  74 staging::file { 'passwd':
  75   source =&gt; '/etc/passwd',
  76 }
  77
  78 staging::file { 'manpage.html':
  79   source =&gt; 'http://curl.haxx.se/docs/manpage.html',
  80 }
  81 </code></pre>
  82
  83       </td>
  84       <td class=code>
  85         <div class='highlight'><pre><span class="n">define</span> <span class="n">staging</span><span class="o">::</span><span class="n">file</span> <span class="p">(</span>
  86   <span class="vg">$source</span><span class="p">,</span>
  87   <span class="vg">$target</span>      <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
  88   <span class="vg">$username</span>    <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
  89   <span class="vg">$certificate</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
  90   <span class="vg">$password</span>    <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
  91   <span class="vg">$environment</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
  92   <span class="vg">$timeout</span>     <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
  93   <span class="vg">$subdir</span>      <span class="o">=</span> <span class="vg">$caller_module_name</span>
  94 <span class="p">)</span> <span class="p">{</span>
  95
  96   <span class="kp">include</span> <span class="n">staging</span>
  97
  98   <span class="k">if</span> <span class="vg">$target</span> <span class="p">{</span>
  99     <span class="vg">$target_file</span> <span class="o">=</span> <span class="vg">$target</span>
 100     <span class="vg">$staging_dir</span> <span class="o">=</span> <span class="n">staging_parse</span><span class="p">(</span><span class="vg">$target</span><span class="p">,</span> <span class="s1">&#39;parent&#39;</span><span class="p">)</span>
 101   <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
 102     <span class="vg">$staging_dir</span> <span class="o">=</span> <span class="s2">&quot;${staging::path}/${subdir}&quot;</span>
 103     <span class="vg">$target_file</span> <span class="o">=</span> <span class="s2">&quot;${staging_dir}/${name}&quot;</span>
 104
 105     <span class="k">if</span> <span class="o">!</span> <span class="n">defined</span><span class="p">(</span><span class="no">File</span><span class="o">[</span><span class="vg">$staging_dir</span><span class="o">]</span><span class="p">)</span> <span class="p">{</span>
 106       <span class="n">file</span> <span class="p">{</span> <span class="vg">$staging_dir</span><span class="p">:</span>
 107         <span class="k">ensure</span><span class="o">=&gt;</span><span class="n">directory</span><span class="p">,</span>
 108       <span class="p">}</span>
 109     <span class="p">}</span>
 110   <span class="p">}</span>
 111
 112   <span class="no">Exec</span> <span class="p">{</span>
 113     <span class="n">path</span>        <span class="o">=&gt;</span> <span class="s1">&#39;/usr/local/bin:/usr/bin:/bin&#39;</span><span class="p">,</span>
 114     <span class="n">environment</span> <span class="o">=&gt;</span> <span class="vg">$environment</span><span class="p">,</span>
 115     <span class="n">cwd</span>         <span class="o">=&gt;</span> <span class="vg">$staging_dir</span><span class="p">,</span>
 116     <span class="n">creates</span>     <span class="o">=&gt;</span> <span class="vg">$target_file</span><span class="p">,</span>
 117     <span class="n">timeout</span>     <span class="o">=&gt;</span> <span class="vg">$timeout</span><span class="p">,</span>
 118     <span class="n">logoutput</span>   <span class="o">=&gt;</span> <span class="n">on_failure</span><span class="p">,</span>
 119   <span class="p">}</span>
 120
 121   <span class="k">case</span> <span class="vg">$source</span> <span class="p">{</span>
 122     <span class="sr">/^\//</span><span class="p">:</span> <span class="p">{</span>
 123       <span class="n">file</span> <span class="p">{</span> <span class="vg">$target_file</span><span class="p">:</span>
 124         <span class="n">source</span>  <span class="o">=&gt;</span> <span class="vg">$source</span><span class="p">,</span>
 125         <span class="n">replace</span> <span class="o">=&gt;</span> <span class="kp">false</span><span class="p">,</span>
 126       <span class="p">}</span>
 127     <span class="p">}</span>
 128
 129     <span class="sr">/^puppet:\/\//</span><span class="p">:</span> <span class="p">{</span>
 130       <span class="n">file</span> <span class="p">{</span> <span class="vg">$target_file</span><span class="p">:</span>
 131         <span class="n">source</span>  <span class="o">=&gt;</span> <span class="vg">$source</span><span class="p">,</span>
 132         <span class="n">replace</span> <span class="o">=&gt;</span> <span class="kp">false</span><span class="p">,</span>
 133       <span class="p">}</span>
 134     <span class="p">}</span>
 135
 136     <span class="sr">/^http:\/\//</span><span class="p">:</span> <span class="p">{</span>
 137       <span class="nb">exec</span> <span class="p">{</span> <span class="vg">$target_file</span><span class="p">:</span>
 138         <span class="n">command</span>     <span class="o">=&gt;</span> <span class="s2">&quot;curl -L -o ${name} ${source}&quot;</span><span class="p">,</span>
 139       <span class="p">}</span>
 140     <span class="p">}</span>
 141
 142     <span class="sr">/^https:\/\//</span><span class="p">:</span> <span class="p">{</span>
 143       <span class="k">if</span> <span class="vg">$username</span> <span class="p">{</span>
 144         <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;curl -L -o ${name} -u ${username}:${password} ${source}&quot;</span>
 145       <span class="p">}</span> <span class="k">elsif</span> <span class="vg">$certificate</span> <span class="p">{</span>
 146         <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;curl -L -o ${name} -E ${certificate}:${password} ${source}&quot;</span>
 147       <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
 148         <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;curl -L -o ${name} ${source}&quot;</span>
 149       <span class="p">}</span>
 150
 151       <span class="nb">exec</span> <span class="p">{</span> <span class="vg">$target_file</span><span class="p">:</span>
 152         <span class="n">command</span>     <span class="o">=&gt;</span> <span class="vg">$command</span><span class="p">,</span>
 153       <span class="p">}</span>
 154     <span class="p">}</span>
 155
 156     <span class="sr">/^ftp:\/\//</span><span class="p">:</span> <span class="p">{</span>
 157       <span class="k">if</span> <span class="vg">$username</span> <span class="p">{</span>
 158         <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;curl -o ${name} -u ${username}:${password} ${source}&quot;</span>
 159       <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
 160         <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;curl -o ${name} ${source}&quot;</span>
 161       <span class="p">}</span>
 162
 163       <span class="nb">exec</span> <span class="p">{</span> <span class="vg">$target_file</span><span class="p">:</span>
 164         <span class="n">command</span>     <span class="o">=&gt;</span> <span class="vg">$command</span><span class="p">,</span>
 165       <span class="p">}</span>
 166     <span class="p">}</span>
 167
 168     <span class="n">default</span><span class="p">:</span> <span class="p">{</span>
 169       <span class="nb">fail</span><span class="p">(</span><span class="s2">&quot;stage::file: do not recognize source ${source}.&quot;</span><span class="p">)</span>
 170     <span class="p">}</span>
 171   <span class="p">}</span>
 172
 173 <span class="p">}</span></pre></div>
 174       </td>
 175     </tr>
 176   </table>
 177 </div>
 178 </body>