| 1 |
<!DOCTYPE html> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="content-type" content="text/html;charset=utf-8"> |
| 5 |
<title>deploy.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 … |
| 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>deploy.pp</h1></th> |
| 26 |
<th class=code></th> |
| 27 |
</tr> |
| 28 |
</thead> |
| 29 |
<tbody> |
| 30 |
<tr id='section-Define:_staging::deploy'> |
| 31 |
<td class=docs> |
| 32 |
<div class="pilwrap"> |
| 33 |
<a class="pilcrow" href="#section-Define:_staging::deploy">¶</a> |
| 34 |
</div> |
| 35 |
<h3>Define: staging::deploy</h3> |
| 36 |
|
| 37 |
<p>The define resource extracts compressed file to a staging location.</p> |
| 38 |
|
| 39 |
<h3>Parameters:</h3> |
| 40 |
|
| 41 |
<ul> |
| 42 |
<li>[<em>source</em>]: the source file location, supports local files, puppet://, http://, https://, ftp:// (default: )</li> |
| 43 |
<li>[<em>target</em>]: the target extraction directory (default: )</li> |
| 44 |
<li>[<em>staging_path</em>]: the staging location for compressed file. defaults to ${staging::path}/${caller_module_name} (default: undef)</li> |
| 45 |
<li>[<em>username</em>]: https or ftp username (default: undef)</li> |
| 46 |
<li>[<em>certificate</em>]: https certifcate file (default: undef)</li> |
| 47 |
<li>[<em>password</em>]: https or ftp user password or https certificate password (default: undef)</li> |
| 48 |
<li>[<em>environment</em>]: environment variable for settings such as http_proxy (default: undef)</li> |
| 49 |
<li>[<em>timeout</em>]: the time to wait for the file transfer to complete (default: undef)</li> |
| 50 |
<li>[<em>user</em>]: extract file as this user (default: undef)</li> |
| 51 |
<li>[<em>group</em>]: extract group as this group (default: undef)</li> |
| 52 |
<li>[<em>creates</em>]: the file/folder created after extraction. if unspecified defaults to ${target}/${name} (default: undef)</li> |
| 53 |
<li>[<em>unless</em>]: alternative way to conditionally extract file (default: undef)</li> |
| 54 |
<li>[<em>onlyif</em>]: alternative way to conditionally extract file (default: undef)</li> |
| 55 |
</ul> |
| 56 |
|
| 57 |
|
| 58 |
<h3>Usage:</h3> |
| 59 |
|
| 60 |
<pre><code>staging::deploy { 'sample.tar.gz': |
| 61 |
source => 'puppet:///modules/staging/sample.tar.gz', |
| 62 |
target => '/usr/local', |
| 63 |
} |
| 64 |
</code></pre> |
| 65 |
|
| 66 |
</td> |
| 67 |
<td class=code> |
| 68 |
<div class='highlight'><pre><span class="n">define</span> <span class="n">staging</span><span class="o">::</span><span class="n">deploy</span> <span class="p">(</span> |
| 69 |
<span class="vg">$source</span><span class="p">,</span> |
| 70 |
<span class="vg">$target</span><span class="p">,</span> |
| 71 |
<span class="vg">$staging_path</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span> |
| 72 |
<span class="vg">$username</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span> |
| 73 |
<span class="vg">$certificate</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span> |
| 74 |
<span class="vg">$password</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span> |
| 75 |
<span class="vg">$environment</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span> |
| 76 |
<span class="vg">$timeout</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span> |
| 77 |
<span class="vg">$user</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span> |
| 78 |
<span class="vg">$group</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span> |
| 79 |
<span class="vg">$creates</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span> |
| 80 |
<span class="vg">$unless</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span> |
| 81 |
<span class="vg">$onlyif</span> <span class="o">=</span> <span class="k">undef</span> |
| 82 |
<span class="p">)</span> <span class="p">{</span> |
| 83 |
|
| 84 |
<span class="n">staging</span><span class="o">::</span><span class="n">file</span> <span class="p">{</span> <span class="vg">$name</span><span class="p">:</span> |
| 85 |
<span class="n">source</span> <span class="o">=></span> <span class="vg">$source</span><span class="p">,</span> |
| 86 |
<span class="n">target</span> <span class="o">=></span> <span class="vg">$staging_path</span><span class="p">,</span> |
| 87 |
<span class="n">username</span> <span class="o">=></span> <span class="vg">$username</span><span class="p">,</span> |
| 88 |
<span class="n">certificate</span> <span class="o">=></span> <span class="vg">$certificate</span><span class="p">,</span> |
| 89 |
<span class="n">password</span> <span class="o">=></span> <span class="vg">$password</span><span class="p">,</span> |
| 90 |
<span class="n">environment</span> <span class="o">=></span> <span class="vg">$environment</span><span class="p">,</span> |
| 91 |
<span class="n">subdir</span> <span class="o">=></span> <span class="vg">$caller_module_name</span><span class="p">,</span> |
| 92 |
<span class="n">timeout</span> <span class="o">=></span> <span class="vg">$timeout</span><span class="p">,</span> |
| 93 |
<span class="p">}</span> |
| 94 |
|
| 95 |
<span class="n">staging</span><span class="o">::</span><span class="n">extract</span> <span class="p">{</span> <span class="vg">$name</span><span class="p">:</span> |
| 96 |
<span class="n">target</span> <span class="o">=></span> <span class="vg">$target</span><span class="p">,</span> |
| 97 |
<span class="n">source</span> <span class="o">=></span> <span class="vg">$staging_path</span><span class="p">,</span> |
| 98 |
<span class="n">user</span> <span class="o">=></span> <span class="vg">$user</span><span class="p">,</span> |
| 99 |
<span class="n">group</span> <span class="o">=></span> <span class="vg">$group</span><span class="p">,</span> |
| 100 |
<span class="n">environment</span> <span class="o">=></span> <span class="vg">$environment</span><span class="p">,</span> |
| 101 |
<span class="n">subdir</span> <span class="o">=></span> <span class="vg">$caller_module_name</span><span class="p">,</span> |
| 102 |
<span class="n">creates</span> <span class="o">=></span> <span class="vg">$creates</span><span class="p">,</span> |
| 103 |
<span class="k">unless</span> <span class="o">=></span> <span class="vg">$unless</span><span class="p">,</span> |
| 104 |
<span class="n">onlyif</span> <span class="o">=></span> <span class="vg">$onlyif</span><span class="p">,</span> |
| 105 |
<span class="nb">require</span> <span class="o">=></span> <span class="no">Staging</span><span class="o">::</span><span class="no">File</span><span class="o">[</span><span class="vg">$name</span><span class="o">]</span><span class="p">,</span> |
| 106 |
<span class="p">}</span> |
| 107 |
|
| 108 |
<span class="p">}</span></pre></div> |
| 109 |
</td> |
| 110 |
</tr> |
| 111 |
</table> |
| 112 |
</div> |
| 113 |
</body> |