diff options
Diffstat (limited to 'distro/common/html/ctl_chef_shell.html')
| -rw-r--r-- | distro/common/html/ctl_chef_shell.html | 163 |
1 files changed, 0 insertions, 163 deletions
diff --git a/distro/common/html/ctl_chef_shell.html b/distro/common/html/ctl_chef_shell.html deleted file mode 100644 index e655ec9146..0000000000 --- a/distro/common/html/ctl_chef_shell.html +++ /dev/null @@ -1,163 +0,0 @@ -<!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>chef-shell — chef-client Man Pages</title> - - <link rel="stylesheet" href="_static/guide.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> - - - </head> - <body> -<div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px"> -<a href="http://docs.getchef.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a> -</div> - - - - - <div class="document"> - <div class="documentwrapper"> - - <div class="body"> - - <div class="section" id="chef-shell"> -<h1>chef-shell<a class="headerlink" href="#chef-shell" title="Permalink to this headline">¶</a></h1> -<p>chef-shell is a recipe debugging tool that allows the use of breakpoints within recipes. chef-shell runs as an Interactive Ruby (IRb) session. chef-shell supports both recipe and attribute file syntax, as well as interactive debugging features.</p> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">chef-shell is the new name for Shef as of Chef 11.x. chef-shell is backwards compatible and aside from the name change, has the same set of functionality as with previous releases.</p> -</div> -<p>The chef-shell executable is run as a command-line tool.</p> -<div class="section" id="modes"> -<h2>Modes<a class="headerlink" href="#modes" title="Permalink to this headline">¶</a></h2> -<p>chef-shell is tool that allows knife to be run using an Interactive Ruby (IRb) session. chef-shell currently supports recipe and attribute file syntax, as well as interactive debugging features. chef-shell has three run modes:</p> -<table border="1" class="docutils"> -<colgroup> -<col width="40%" /> -<col width="60%" /> -</colgroup> -<thead valign="bottom"> -<tr class="row-odd"><th class="head">Mode</th> -<th class="head">Description</th> -</tr> -</thead> -<tbody valign="top"> -<tr class="row-even"><td>Standalone</td> -<td>No cookbooks are loaded, and the run list is empty. This mode is the default.</td> -</tr> -<tr class="row-odd"><td>Solo</td> -<td>chef-shell acts as a chef-solo client. It attempts to load the chef-solo configuration file and JSON attributes. If the JSON attributes set a run list, it will be honored. Cookbooks will be loaded in the same way that chef-solo loads them. chef-solo mode is activated with the <tt class="docutils literal"><span class="pre">-s</span></tt> or <tt class="docutils literal"><span class="pre">--solo</span></tt> command line option, and JSON attributes are specified in the same way as for chef-solo, with <tt class="docutils literal"><span class="pre">-j</span> <span class="pre">/path/to/chef-solo.json</span></tt>.</td> -</tr> -<tr class="row-even"><td>Client</td> -<td>chef-shell acts as a chef-client. During startup, it reads the chef-client configuration file and contacts the Chef server to get attributes and cookbooks. The run list will be set in the same way as normal chef-client runs. chef-client mode is activated with the <tt class="docutils literal"><span class="pre">-z</span></tt> or <tt class="docutils literal"><span class="pre">--client</span></tt> options. You can also specify the configuration file with <tt class="docutils literal"><span class="pre">-c</span> <span class="pre">CONFIG</span></tt> and the server URL with <tt class="docutils literal"><span class="pre">-S</span> <span class="pre">SERVER_URL</span></tt>.</td> -</tr> -</tbody> -</table> -</div> -<div class="section" id="options"> -<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2> -<p>This command has the following syntax:</p> -<div class="highlight-python"><div class="highlight"><pre>chef-shell OPTION VALUE OPTION VALUE ... -</pre></div> -</div> -<p>This command has the following options:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--standalone</span></tt></dt> -<dd>Use to run chef-shell in standalone mode.</dd> -<dt><tt class="docutils literal"><span class="pre">-c</span> <span class="pre">CONFIG</span></tt>, <tt class="docutils literal"><span class="pre">--config</span> <span class="pre">CONFIG</span></tt></dt> -<dd>The configuration file to use.</dd> -<dt><tt class="docutils literal"><span class="pre">-h</span></tt>, <tt class="docutils literal"><span class="pre">--help</span></tt></dt> -<dd>Shows help for the command.</dd> -<dt><tt class="docutils literal"><span class="pre">-j</span> <span class="pre">PATH</span></tt>, <tt class="docutils literal"><span class="pre">--json-attributes</span> <span class="pre">PATH</span></tt></dt> -<dd><p class="first">The path to a file that contains JSON data.</p> -<p>Use this option to define a <tt class="docutils literal"><span class="pre">run_list</span></tt> object. For example, a JSON file similar to:</p> -<div class="highlight-javascript"><div class="highlight"><pre><span class="s2">"run_list"</span><span class="o">:</span> <span class="p">[</span> - <span class="s2">"recipe[base]"</span><span class="p">,</span> - <span class="s2">"recipe[foo]"</span><span class="p">,</span> - <span class="s2">"recipe[bar]"</span><span class="p">,</span> - <span class="s2">"role[webserver]"</span> -<span class="p">],</span> -</pre></div> -</div> -<p>may be used by running <tt class="docutils literal"><span class="pre">chef-client</span> <span class="pre">-j</span> <span class="pre">path/to/file.json</span></tt>.</p> -<p>In certain situations this option may be used to update <tt class="docutils literal"><span class="pre">normal</span></tt> attributes.</p> -<div class="last admonition warning"> -<p class="first admonition-title">Warning</p> -<p>Any other attribute type that is contained in this JSON file will be treated as a <tt class="docutils literal"><span class="pre">normal</span></tt> attribute. For example, attempting to update <tt class="docutils literal"><span class="pre">override</span></tt> attributes using the <tt class="docutils literal"><span class="pre">-j</span></tt> option:</p> -<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span> - <span class="s2">"name"</span><span class="o">:</span> <span class="s2">"dev-99"</span><span class="p">,</span> - <span class="s2">"description"</span><span class="o">:</span> <span class="s2">"Install some stuff"</span><span class="p">,</span> - <span class="s2">"override_attributes"</span><span class="o">:</span> <span class="p">{</span> - <span class="s2">"apptastic"</span><span class="o">:</span> <span class="p">{</span> - <span class="s2">"enable_apptastic"</span><span class="o">:</span> <span class="s2">"false"</span><span class="p">,</span> - <span class="s2">"apptastic_tier_name"</span><span class="o">:</span> <span class="s2">"dev-99.bomb.com"</span> - <span class="p">}</span> - <span class="p">}</span> -<span class="p">}</span> -</pre></div> -</div> -<p>will result in a node object similar to:</p> -<div class="last highlight-javascript"><div class="highlight"><pre><span class="p">{</span> - <span class="s2">"name"</span><span class="o">:</span> <span class="s2">"maybe-dev-99"</span><span class="p">,</span> - <span class="s2">"normal"</span><span class="o">:</span> <span class="p">{</span> - <span class="s2">"name"</span><span class="o">:</span> <span class="s2">"dev-99"</span><span class="p">,</span> - <span class="s2">"description"</span><span class="o">:</span> <span class="s2">"Install some stuff"</span><span class="p">,</span> - <span class="s2">"override_attributes"</span><span class="o">:</span> <span class="p">{</span> - <span class="s2">"apptastic"</span><span class="o">:</span> <span class="p">{</span> - <span class="s2">"enable_apptastic"</span><span class="o">:</span> <span class="s2">"false"</span><span class="p">,</span> - <span class="s2">"apptastic_tier_name"</span><span class="o">:</span> <span class="s2">"dev-99.bomb.com"</span> - <span class="p">}</span> - <span class="p">}</span> - <span class="p">}</span> -<span class="p">}</span> -</pre></div> -</div> -</div> -</dd> -<dt><tt class="docutils literal"><span class="pre">-l</span> <span class="pre">LEVEL</span></tt>, <tt class="docutils literal"><span class="pre">--log-level</span> <span class="pre">LEVEL</span></tt></dt> -<dd>The level of logging that will be stored in a log file.</dd> -<dt><tt class="docutils literal"><span class="pre">-s</span></tt>, <tt class="docutils literal"><span class="pre">--solo</span></tt></dt> -<dd>Use to run chef-shell in chef-solo mode.</dd> -<dt><tt class="docutils literal"><span class="pre">-S</span> <span class="pre">CHEF_SERVER_URL</span></tt>, <tt class="docutils literal"><span class="pre">--server</span> <span class="pre">CHEF_SERVER_URL</span></tt></dt> -<dd>The URL for the Chef server.</dd> -<dt><tt class="docutils literal"><span class="pre">-v</span></tt>, <tt class="docutils literal"><span class="pre">--version</span></tt></dt> -<dd>The version of the chef-client.</dd> -<dt><tt class="docutils literal"><span class="pre">-z</span></tt>, <tt class="docutils literal"><span class="pre">--client</span></tt></dt> -<dd>Use to run chef-shell in chef-client mode.</dd> -</dl> -</div> -</div> - - - </div> - - </div> - - - <div class="clearer"></div> - </div> - - - - - </body> -</html>
\ No newline at end of file |