diff options
| author | jamescott <jamescott@opscode.com> | 2014-02-04 11:16:11 -0800 |
|---|---|---|
| committer | jamescott <jamescott@opscode.com> | 2014-02-04 11:16:11 -0800 |
| commit | 3743ff393832422dd5c36d9c093f11646889df01 (patch) | |
| tree | 1f172649bcd92e4df0f81da767b8618421a02959 /distro/common/html/knife_upload.html | |
| parent | 2a615c49ac61218704d3a34ba20922b94a31ed76 (diff) | |
| download | chef-3743ff393832422dd5c36d9c093f11646889df01.tar.gz | |
add HTML file for manpage output testing
Diffstat (limited to 'distro/common/html/knife_upload.html')
| -rw-r--r-- | distro/common/html/knife_upload.html | 268 |
1 files changed, 268 insertions, 0 deletions
diff --git a/distro/common/html/knife_upload.html b/distro/common/html/knife_upload.html new file mode 100644 index 0000000000..3c7774cc8a --- /dev/null +++ b/distro/common/html/knife_upload.html @@ -0,0 +1,268 @@ + + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>knife upload — Knife Man Pages</title> + + <link rel="stylesheet" href="_static/chef.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '', + VERSION: '', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <link rel="shortcut icon" href="_static/chef.ico"/> + <link rel="top" title="Knife Man Pages" href="index.html" /> + </head> + <body> +<div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px"> +<a href="http://docs.opscode.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a> +</div> + + <div class="related"> + <h3>Navigation</h3> + <ul> + <li><a href="http://docs.opscode.com/chef/knife.html" target="_products">Knife</a>•</li> + <li><a href="http://docs.opscode.com/chef/resources.html" target="_products">Resources</a>•</li> + <li><a href="http://docs.opscode.com/chef/dsl_recipe.html" target="_products">Recipe DSL</a>•</li> + <li><a href="http://docs.opscode.com/chef/lwrps_custom.html" target="_products">LWRPs</a>•</li> + <li><a href="http://docs.opscode.com/search.html">Search the Docs</a>•</li> + <li><a href="http://docs.opscode.com/">Home</a> »</li> + + </ul> + </div> + + <div class="sphinxsidebar"> + <div class="sphinxsidebarwrapper"> + <p class="logo"><a href="knife.html"> + <img class="logo" src="_static/chef_logo.png" alt="Logo"/> + </a></p> + <h3><a href="knife.html">Table Of Contents</a></h3> + <ul> +<li><a class="reference internal" href="#">knife upload</a><ul> +<li><a class="reference internal" href="#syntax">Syntax</a></li> +<li><a class="reference internal" href="#options">Options</a><ul> +<li><a class="reference internal" href="#knife-rb-settings">knife.rb Settings</a></li> +</ul> +</li> +<li><a class="reference internal" href="#examples">Examples</a></li> +</ul> +</li> +</ul> + + </div> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <div class="section" id="knife-upload"> +<h1>knife upload<a class="headerlink" href="#knife-upload" title="Permalink to this headline">¶</a></h1> +<p>The <strong>knife upload</strong> subcommand is used to upload roles, cookbooks, environments, and data bags to the server from the current working directory in the chef-repo. This subcommand is often used in conjunction with <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">diff</span></tt>, which can be used to see exactly what changes will be uploaded, and then <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">download</span></tt>, which does the opposite of <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">upload</span></tt>.</p> +<div class="section" id="syntax"> +<h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> +<p>This argument has the following syntax:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife upload <span class="o">[</span>PATTERN...<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span> +</pre></div> +</div> +</div> +<div class="section" id="options"> +<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Review the list of <a class="reference internal" href="knife_common_options.html"><em>common options</em></a> available to this (and all) Knife subcommands and plugins.</p> +</div> +<p>This subcommand has the following options:</p> +<dl class="docutils"> +<dt><tt class="docutils literal"><span class="pre">--chef-repo-path</span> <span class="pre">PATH</span></tt></dt> +<dd>The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by <tt class="docutils literal"><span class="pre">chef_repo_path</span></tt> in config.rb.</dd> +<dt><tt class="docutils literal"><span class="pre">--concurrency</span></tt></dt> +<dd>The number of allowed concurrent connections. Default: <tt class="docutils literal"><span class="pre">10</span></tt>.</dd> +<dt><tt class="docutils literal"><span class="pre">--[no-]diff</span></tt></dt> +<dd>Indicates that only new and modified files will be uploaded. Set to <tt class="docutils literal"><span class="pre">false</span></tt> to upload all files. Default: <tt class="docutils literal"><span class="pre">true</span></tt>.</dd> +<dt><tt class="docutils literal"><span class="pre">--[no-]force</span></tt></dt> +<dd>Use <tt class="docutils literal"><span class="pre">--force</span></tt> to upload roles, cookbooks, etc. even if the file in the directory is identical (by default, no <tt class="docutils literal"><span class="pre">POST</span></tt> or <tt class="docutils literal"><span class="pre">PUT</span></tt> is performed unless an actual change would be made). Default: <tt class="docutils literal"><span class="pre">--no-force</span></tt>.</dd> +<dt><tt class="docutils literal"><span class="pre">--[no-]freeze</span></tt></dt> +<dd>Indicates that a cookbook cannot be modified; any changes to this cookbook must be included as a new version. Only the <tt class="docutils literal"><span class="pre">--force</span></tt> option can override this setting. Default: <tt class="docutils literal"><span class="pre">false</span></tt>.</dd> +<dt><tt class="docutils literal"><span class="pre">-n</span></tt>, <tt class="docutils literal"><span class="pre">--dry-run</span></tt></dt> +<dd>Indicates that no action is taken and that results are only printed out. Default: <tt class="docutils literal"><span class="pre">false</span></tt>.</dd> +<dt><tt class="docutils literal"><span class="pre">--[no-]purge</span></tt></dt> +<dd>Use <tt class="docutils literal"><span class="pre">--purge</span></tt> to delete roles, cookbooks, etc. from the server if their corresponding files do not exist in the chef-repo. By default, such objects are left alone and NOT purged. Default: <tt class="docutils literal"><span class="pre">--no-purge</span></tt>.</dd> +<dt><tt class="docutils literal"><span class="pre">--[no-]recurse</span></tt></dt> +<dd>Use <tt class="docutils literal"><span class="pre">--no-recurse</span></tt> to disable uploading a directory recursively. Default: <tt class="docutils literal"><span class="pre">--recurse</span></tt>.</dd> +<dt><tt class="docutils literal"><span class="pre">--repo-mode</span> <span class="pre">MODE</span></tt></dt> +<dd>The layout of the local chef-repo. Possible values: <tt class="docutils literal"><span class="pre">static</span></tt>, <tt class="docutils literal"><span class="pre">everything</span></tt>, or <tt class="docutils literal"><span class="pre">hosted_everything</span></tt>. Use <tt class="docutils literal"><span class="pre">static</span></tt> for just roles, environments, cookbooks, and data bags. By default, <tt class="docutils literal"><span class="pre">everything</span></tt> and <tt class="docutils literal"><span class="pre">hosted_everything</span></tt> are dynamically selected depending on the server type. Default: <tt class="docutils literal"><span class="pre">everything</span></tt> / <tt class="docutils literal"><span class="pre">hosted_everything</span></tt>.</dd> +</dl> +<div class="section" id="knife-rb-settings"> +<h3>knife.rb Settings<a class="headerlink" href="#knife-rb-settings" title="Permalink to this headline">¶</a></h3> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">See <tt class="xref doc docutils literal"><span class="pre">knife.rb</span></tt> for more information about how to add optional settings to the knife.rb file.</p> +</div> +<p>The following <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">upload</span></tt> settings can be added to the knife.rb file:</p> +<dl class="docutils"> +<dt><tt class="docutils literal"><span class="pre">knife[:chef_repo_path]</span></tt></dt> +<dd>Use to add the <tt class="docutils literal"><span class="pre">--chef-repo-path</span></tt> option.</dd> +<dt><tt class="docutils literal"><span class="pre">knife[:concurrency]</span></tt></dt> +<dd>Use to add the <tt class="docutils literal"><span class="pre">--concurrency</span></tt> option.</dd> +<dt><tt class="docutils literal"><span class="pre">knife[:recurse]</span></tt></dt> +<dd>Use to add the <tt class="docutils literal"><span class="pre">--recurse</span></tt> option.</dd> +<dt><tt class="docutils literal"><span class="pre">knife[:repo_mode]</span></tt></dt> +<dd>Use to add the <tt class="docutils literal"><span class="pre">--repo-mode</span></tt> option.</dd> +</dl> +</div> +</div> +<div class="section" id="examples"> +<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2> +<p>The following examples show how to use this Knife subcommand:</p> +<p><strong>Upload the entire chef-repo</strong></p> +<p>Browse to the top level of the chef-repo and enter:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife upload +</pre></div> +</div> +<p>or from anywhere in the chef-repo, enter:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife upload / +</pre></div> +</div> +<p><strong>Upload the /cookbooks directory</strong></p> +<p>Browse to the top level of the chef-repo and enter:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife upload cookbooks +</pre></div> +</div> +<p>or from anywhere in the chef-repo, enter:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife upload /cookbooks +</pre></div> +</div> +<p><strong>Upload the /environments directory</strong></p> +<p>Browse to the top level of the chef-repo and enter:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife upload environments +</pre></div> +</div> +<p>or from anywhere in the chef-repo, enter:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife upload /environments +</pre></div> +</div> +<p><strong>Upload a single environment</strong></p> +<p>Browse to the top level of the chef-repo and enter:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife upload environments/production.json +</pre></div> +</div> +<p>or from the <tt class="docutils literal"><span class="pre">environments/</span></tt> directory, enter:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife upload production.json +</pre></div> +</div> +<p><strong>Upload the /roles directory</strong></p> +<p>Browse to the top level of the chef-repo and enter:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife upload roles +</pre></div> +</div> +<p>or from anywhere in the chef-repo, enter:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife upload /roles +</pre></div> +</div> +<p><strong>Upload cookbooks and roles</strong></p> +<p>Browse to the top level of the chef-repo and enter:</p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife upload cookbooks/apache<span class="se">\*</span> roles/webserver.json +</pre></div> +</div> +<p><strong>Use output of knife deps to pass command to knife upload</strong></p> +<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife upload <span class="sb">`</span>knife deps nodes/*.json<span class="sb">`</span> +</pre></div> +</div> +</div> +</div> + + + </div> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li><a href="http://docs.opscode.com/chef/knife.html" target="_products">Knife</a>•</li> + <li><a href="http://docs.opscode.com/chef/resources.html" target="_products">Resources</a>•</li> + <li><a href="http://docs.opscode.com/chef/dsl_recipe.html" target="_products">Recipe DSL</a>•</li> + <li><a href="http://docs.opscode.com/chef/lwrps_custom.html" target="_products">LWRPs</a>•</li> + <li><a href="http://docs.opscode.com/search.html">Search the Docs</a>•</li> + <li><a href="http://docs.opscode.com/">Home</a> »</li> + + </ul> + </div> + + + <div class="footer"> + Documentation for current man pages for Knife. + + Send feedback to <a href="mailto:docs@getchef.com">docs@getchef.com</a>. + This work is licensed under a Creative Commons Attribution 3.0 Unported License. + + </div> + +<!-- Start of Async Google Analytics Code --> +<script type="text/javascript"> +var _gaq = _gaq || []; +var pluginUrl = (('https:' == document.location.protocol) ? 'https://ssl.' : 'http://www.') + 'google-analytics.com/plugins/ga/inpage_linkid.js'; +_gaq.push(['_setAccount', 'UA-6369228-7']); +_gaq.push(['_setDomainName', '.opscode.com']); +_gaq.push(['_setAllowHash', false]); +_gaq.push(['_setAllowLinker', true]); +_gaq.push(['_addIgnoredRef','opscode.com']); +_gaq.push(['_trackPageview']); + +(function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; + ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; + s.parentNode.insertBefore(ga, s); })(); +</script> +<!-- End of Async Google Analytics Code --> + + + +<!-- Start of Contact Analytics Code --> +<script type="text/javascript"> +(function() { + var didInit = false; + function initMunchkin() { + if(didInit === false) { + didInit = true; + Munchkin.init('255-VFB-268'); + } + } + var s = document.createElement('script'); + s.type = 'text/javascript'; + s.async = true; + s.src = document.location.protocol + '//munchkin.marketo.net/munchkin.js'; + s.onreadystatechange = function() { + if (this.readyState == 'complete' || this.readyState == 'loaded') { + initMunchkin(); + } + }; + s.onload = initMunchkin; + document.getElementsByTagName('head')[0].appendChild(s); +})(); +</script> +<!-- End of Contact Analytics Code --> + + + </body> +</html>
\ No newline at end of file |