RubyGems - chef - Versions diffs - 0.10.0.beta.8 → 0.10.0.beta.9 - Mend

chef 0.10.0.beta.8 → 0.10.0.beta.9

Files changed (70) hide show

data/distro/common/html/knife-bootstrap.1.html +69 -10
data/distro/common/html/knife-client.1.html +25 -22
data/distro/common/html/knife-configure.1.html +1 -1
data/distro/common/html/knife-cookbook-site.1.html +91 -19
data/distro/common/html/knife-cookbook.1.html +216 -76
data/distro/common/html/knife-data-bag.1.html +1 -1
data/distro/common/html/knife-environment.1.html +177 -3
data/distro/common/html/knife-exec.1.html +44 -3
data/distro/common/html/knife-index.1.html +1 -1
data/distro/common/html/knife-node.1.html +5 -3
data/distro/common/html/knife-recipe.1.html +1 -1
data/distro/common/html/knife-role.1.html +83 -19
data/distro/common/html/knife-search.1.html +43 -2
data/distro/common/html/knife-ssh.1.html +57 -2
data/distro/common/html/knife-status.1.html +33 -2
data/distro/common/html/knife-tag.1.html +45 -1
data/distro/common/html/knife.1.html +94 -161
data/distro/common/html/shef.1.html +283 -0
data/distro/common/man/man1/knife-bootstrap.1 +56 -4
data/distro/common/man/man1/knife-client.1 +12 -11
data/distro/common/man/man1/knife-configure.1 +1 -1
data/distro/common/man/man1/knife-cookbook-site.1 +64 -22
data/distro/common/man/man1/knife-cookbook.1 +200 -122
data/distro/common/man/man1/knife-data-bag.1 +1 -1
data/distro/common/man/man1/knife-environment.1 +167 -2
data/distro/common/man/man1/knife-exec.1 +36 -3
data/distro/common/man/man1/knife-index.1 +1 -1
data/distro/common/man/man1/knife-node.1 +2 -1
data/distro/common/man/man1/knife-role.1 +48 -24
data/distro/common/man/man1/knife-search.1 +27 -3
data/distro/common/man/man1/knife-ssh.1 +43 -2
data/distro/common/man/man1/knife-status.1 +14 -2
data/distro/common/man/man1/knife-tag.1 +32 -2
data/distro/common/man/man1/knife.1 +91 -186
data/distro/common/man/man1/shef.1 +237 -26
data/distro/common/markdown/man1/knife-bootstrap.mkd +57 -7
data/distro/common/markdown/man1/knife-client.mkd +19 -17
data/distro/common/markdown/man1/knife-cookbook-site.mkd +63 -15
data/distro/common/markdown/man1/knife-cookbook.mkd +220 -103
data/distro/common/markdown/man1/knife-environment.mkd +144 -1
data/distro/common/markdown/man1/knife-exec.mkd +29 -1
data/distro/common/markdown/man1/knife-node.mkd +1 -1
data/distro/common/markdown/man1/knife-role.mkd +36 -30
data/distro/common/markdown/man1/knife-search.mkd +0 -1
data/distro/common/markdown/man1/knife-ssh.mkd +0 -2
data/distro/common/markdown/man1/knife-status.mkd +0 -2
data/distro/common/markdown/man1/knife-tag.mkd +31 -0
data/distro/common/markdown/man1/knife.mkd +93 -165
data/distro/common/markdown/man1/shef.mkd +189 -0
data/lib/chef/api_client.rb +36 -35
data/lib/chef/application/knife.rb +1 -1
data/lib/chef/client.rb +1 -0
data/lib/chef/cookbook/cookbook_version_loader.rb +29 -7
data/lib/chef/cookbook_uploader.rb +55 -36
data/lib/chef/cookbook_version.rb +3 -1
data/lib/chef/couchdb.rb +0 -1
data/lib/chef/knife/cookbook_list.rb +1 -1
data/lib/chef/knife/cookbook_show.rb +1 -0
data/lib/chef/knife/core/generic_presenter.rb +3 -3
data/lib/chef/knife/help.rb +6 -2
data/lib/chef/knife/tag_create.rb +26 -5
data/lib/chef/knife/tag_delete.rb +34 -5
data/lib/chef/knife/tag_list.rb +24 -6
data/lib/chef/node.rb +1 -0
data/lib/chef/role.rb +1 -0
data/lib/chef/shef.rb +1 -0
data/lib/chef/version.rb +1 -1
metadata +4 -4
data/distro/common/man/man1/knife-recipe.1 +0 -13
data/distro/common/markdown/man1/knife-recipe.mkd +0 -24

data/distro/common/html/shef.1.html ADDED Viewed

@@ -0,0 +1,283 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>shef(1) - Interactive Chef Console</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+  <style type='text/css' media='all'>
+  /* style: toc */
+  .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
+  .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
+  .man-navigation a:hover {color:#111;text-decoration:underline}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#SYNTAX">SYNTAX</a>
+    <a href="#PRIMARY-MODE">PRIMARY MODE</a>
+    <a href="#RECIPE-MODE">RECIPE MODE</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+    <a href="#BUGS">BUGS</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+    <a href="#AUTHOR">AUTHOR</a>
+    <a href="#DOCUMENTATION">DOCUMENTATION</a>
+    <a href="#CHEF">CHEF</a>
+  </div>
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>shef(1)</li>
+    <li class='tc'>Chef Manual</li>
+    <li class='tr'>shef(1)</li>
+  </ol>
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>shef</code> - <span class="man-whatis">Interactive Chef Console</span>
+</p>
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+<p><strong>shef</strong> [<em>named configuration</em>] <em>(options)</em></p>
+<dl>
+<dt><code>-S</code>, <code>--server CHEF_SERVER_URL</code></dt><dd>The chef server URL</dd>
+<dt><code>-z</code>, <code>--client</code></dt><dd>chef-client mode</dd>
+<dt><code>-c</code>, <code>--config CONFIG</code></dt><dd>The configuration file to use</dd>
+<dt><code>-j</code>, <code>--json-attributes JSON_ATTRIBS</code></dt><dd>Load attributes from a JSON file or URL</dd>
+<dt><code>-l</code>, <code>--log-level LOG_LEVEL</code></dt><dd>Set the logging level</dd>
+<dt><code>-s</code>, <code>--solo</code></dt><dd>chef-solo shef session</dd>
+<dt><code>-a</code>, <code>--standalone</code></dt><dd>standalone shef session</dd>
+<dt><code>-v</code>, <code>--version</code></dt><dd>Show chef version</dd>
+<dt><code>-h</code>, <code>--help</code></dt><dd>Show command options</dd>
+</dl>
+<p>When no --config option is specified, shef attempts to load a default configuration file:</p>
+<ul>
+<li>If a <em>named configuration</em> is given, shef will load ~/.chef/<em>named
+configuration</em>/shef.rb</li>
+<li>If no <em>named configuration</em> is given shef will load ~/.chef/shef.rb if it exists</li>
+<li>Shef falls back to loading /etc/chef/client.rb or /etc/chef/solo.rb if -z or
+-s options are given and no shef.rb can be found.</li>
+<li>The --config option takes precedence over implicit configuration
+paths.</li>
+</ul>
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+<p><code>shef</code> is an <span class="man-ref">irb<span class="s">(1)</span></span> (interactive ruby) session customized for Chef.
+<code>shef</code> serves two primary functions: it provides a means to
+interact with a Chef Server interactively using a convenient DSL; it
+allows you to define and run Chef recipes interactively.</p>
+<h2 id="SYNTAX">SYNTAX</h2>
+<p>Shef uses irb's subsession feature to provide multiple modes of
+interaction. In addition to the primary mode which is entered on start,
+<code>recipe</code> and <code>attributes</code> modes are available.</p>
+<h2 id="PRIMARY-MODE">PRIMARY MODE</h2>
+<p>The following commands are available in the primary
+session:</p>
+<dl>
+<dt class="flush"><code>help</code></dt><dd>Prints a list of available commands</dd>
+<dt class="flush"><code>version</code></dt><dd>Prints the Chef version</dd>
+<dt class="flush"><code>recipe</code></dt><dd>Switches to <code>recipe</code> mode</dd>
+<dt><code>attributes</code></dt><dd>Switches to <code>attributes</code> mode</dd>
+<dt><code>run_chef</code></dt><dd>Initiates a chef run</dd>
+<dt class="flush"><code>reset</code></dt><dd>reinitializes shef</dd>
+<dt><code>echo :on|:off</code></dt><dd>Turns irb's echo function on or off. Echo is <em>on</em> by default.</dd>
+<dt><code>tracing :on|:off</code></dt><dd>Turns irb's function tracing feature on or off. Tracing is extremely
+verbose and expected to be of interest primarily to developers.</dd>
+<dt class="flush"><code>node</code></dt><dd>Returns the <em>node</em> object for the current host. See <span class="man-ref">knife-node<span class="s">(1)</span></span>
+for more information about nodes.</dd>
+<dt class="flush"><code>ohai</code></dt><dd>Prints the attributes of <em>node</em></dd>
+</dl>
+<p>In addition to these commands, shef provides a DSL for accessing data on
+the Chef Server. When working with remote data in shef, you chain method
+calls in the form <em>object type</em>.<em>operation</em>, where <em>object type</em> is in
+plural form. The following object types are available:</p>
+<ul>
+<li><code>nodes</code></li>
+<li><code>roles</code></li>
+<li><code>data_bags</code></li>
+<li><code>clients</code></li>
+<li><code>cookbooks</code></li>
+</ul>
+<p>For each <em>object type</em> the following operations are available:</p>
+<dl>
+<dt><em>object type</em>.all(<em>&amp;block</em>)</dt><dd>Loads all items from the server. If the optional code <em>block</em> is
+given, each item will be passed to the block and the results
+returned, similar to ruby's <code>Enumerable#map</code> method.</dd>
+<dt><em>object type</em>.show(<em>object name</em>)</dt><dd><p>Aliased as <em>object type</em>.load</p>
+<p>Loads the singular item identified by <em>object name</em>.</p></dd>
+<dt><em>object type</em>.search(<em>query</em>, <em>&amp;block</em>)</dt><dd><p>Aliased as <em>object type</em>.find</p>
+<p>Runs a search against the server and returns the matching items. If
+the optional code <em>block</em> is given each item will be passed to the
+block and the results returned.</p>
+<p>The <em>query</em> may be a Solr/Lucene format query given as a String, or
+a Hash of conditions. If a Hash is given, the options will be ANDed
+together. To join conditions with OR, use negative queries, or any
+advanced search syntax, you must provide give the query in String
+form.</p></dd>
+<dt><em>object type</em>.transform(:all|<em>query</em>, <em>&amp;block</em>)</dt><dd><p>Aliased as <em>object type</em>.bulk_edit</p>
+<p>Bulk edit objects by processing them with the (required) code <em>block</em>.
+You can edit all objects of the given type by passing the Symbol
+<code>:all</code> as the argument, or only a subset by passing a <em>query</em> as the
+argument. The <em>query</em> is evaluated in the same way as with
+<strong>search</strong>.</p>
+<p>The return value of the code <em>block</em> is used to alter the behavior
+of <code>transform</code>. If the value returned from the block is <code>nil</code> or
+<code>false</code>, the object will not be saved. Otherwise, the object is
+saved after being passed to the block. This behavior can be
+exploited to create a dry run to test a data transformation.</p></dd>
+</dl>
+<h2 id="RECIPE-MODE">RECIPE MODE</h2>
+<p>Recipe mode implements Chef's recipe DSL. Exhaustively documenting this
+DSL is outside the scope of this document. See the following pages in
+the Chef documentation for more information:</p>
+<ul>
+<li><a href="http://wiki.opscode.com/display/chef/Resources" data-bare-link="true">http://wiki.opscode.com/display/chef/Resources</a></li>
+<li><a href="http://wiki.opscode.com/display/chef/Recipes" data-bare-link="true">http://wiki.opscode.com/display/chef/Recipes</a></li>
+</ul>
+<p>Once you have defined resources in the recipe, you can trigger a
+convergence run via <code>run_chef</code></p>
+<h2 id="EXAMPLES">EXAMPLES</h2>
+<ul>
+<li><p>A "Hello World" interactive recipe</p>
+<p>chef > recipe<br />
+chef:recipe > echo :off<br />
+chef:recipe > file "/tmp/hello_world"<br />
+chef:recipe > run_chef<br />
+[Sat, 09 Apr 2011 08:56:56 -0700] INFO: Processing file[/tmp/hello_world] action create ((irb#1) line 2)<br />
+[Sat, 09 Apr 2011 08:56:56 -0700] INFO: file[/tmp/hello_world] created file /tmp/hello_world<br />
+chef:recipe > pp ls '/tmp'<br />
+[".",<br />
+"..",<br />
+"hello_world"]</p></li>
+<li><p>Search for <em>nodes</em> by role, and print their IP addresses</p>
+<p>chef > nodes.find(:roles => 'monitoring-server') {|n| n[:ipaddress] }<br />
+=> ["10.254.199.5"]</p></li>
+<li><p>Remove the role <em>obsolete</em> from every node in the system</p>
+<p>chef > nodes.transform(:all) {|n| n.run_list.delete('role[obsolete]') }<br />
+ => [node[chef098b2.opschef.com], node[ree-woot], node[graphite-dev], node[fluke.localdomain], node[ghost.local], node[kallistec]]</p></li>
+</ul>
+<h2 id="BUGS">BUGS</h2>
+<p>The name <code>shef</code> is clever in print but is confusing when spoken aloud.
+Pronouncing <code>shef</code> as <code>chef console</code> is an imperfect workaround.</p>
+<p><code>shef</code> often does not perfectly replicate the context in which
+<span class="man-ref">chef-client<span class="s">(8)</span></span> configures a host, which may lead to discrepancies in
+observed behavior.</p>
+<p><code>shef</code> has to duplicate much code from chef-client's internal libraries
+and may become out of sync with the behavior of those libraries.</p>
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+<p>  <span class="man-ref">chef-client<span class="s">(8)</span></span> <span class="man-ref">knife<span class="s">(1)</span></span>
+  <a href="http://wiki.opscode.com/display/chef/Shef" data-bare-link="true">http://wiki.opscode.com/display/chef/Shef</a></p>
+<h2 id="AUTHOR">AUTHOR</h2>
+<p>   Chef was written by Adam Jacob <a href="&#x6d;&#97;&#105;&#x6c;&#x74;&#111;&#x3a;&#x61;&#100;&#x61;&#109;&#64;&#111;&#112;&#x73;&#99;&#111;&#x64;&#x65;&#x2e;&#99;&#111;&#x6d;" data-bare-link="true">&#97;&#x64;&#97;&#x6d;&#x40;&#x6f;&#112;&#x73;&#99;&#x6f;&#x64;&#x65;&#46;&#x63;&#111;&#x6d;</a> with many
+   contributions from the community. Shef was written by Daniel DeLeo.</p>
+<h2 id="DOCUMENTATION">DOCUMENTATION</h2>
+<p>   This manual page was written by Daniel DeLeo <a href="&#109;&#x61;&#105;&#108;&#116;&#111;&#x3a;&#100;&#97;&#110;&#64;&#x6f;&#112;&#115;&#99;&#111;&#100;&#101;&#x2e;&#x63;&#x6f;&#109;" data-bare-link="true">&#100;&#x61;&#x6e;&#x40;&#111;&#x70;&#x73;&#x63;&#x6f;&#x64;&#101;&#x2e;&#x63;&#111;&#x6d;</a>.
+   Permission is granted to copy, distribute and / or modify this
+   document under the terms of the Apache 2.0 License.</p>
+<h2 id="CHEF">CHEF</h2>
+<p>   Shef is distributed with Chef. <a href="http://wiki.opscode.com/display/chef/Home" data-bare-link="true">http://wiki.opscode.com/display/chef/Home</a></p>
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'>Chef 0.10.0.beta.9</li>
+    <li class='tc'>April 2011</li>
+    <li class='tr'>shef(1)</li>
+  </ol>
+  </div>
+</body>
+</html>

data/distro/common/man/man1/knife-bootstrap.1 CHANGED Viewed

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "KNIFE\-BOOTRAP" "1" "April 2011" "Chef 0.10.0.beta.8" "Chef Manual"
+.TH "KNIFE\-BOOTRAP" "1" "April 2011" "Chef 0.10.0.beta.9" "Chef Manual"
 .
 .SH "NAME"
 \fBknife\-bootrap\fR \- Install Chef Client on a remote host
@@ -53,8 +53,8 @@ Execute the bootstrap via sudo
 \fB\-d\fR, \fB\-\-distro DISTRO\fR
 Bootstrap a distro using a template
 .
-.P
-Performs a Chef Bootstrap on the target node\. The goal of the bootstrap is to get Chef installed on the target system so it can run Chef Client with a Chef Server\. The main assumption is a baseline OS installation exists\. This sub\-command is used internally by some cloud computing server create commands and the others will be migrated in a future version of Chef\.
+.SH "DESCRIPTION"
+Performs a Chef Bootstrap on the target node\. The goal of the bootstrap is to get Chef installed on the target system so it can run Chef Client with a Chef Server\. The main assumption is a baseline OS installation exists\. This sub\-command is used internally by some cloud computing plugins\.
 .
 .P
 The bootstrap sub\-command supports supplying a template to perform the bootstrap steps\. If the distro is not specified (via \fB\-d\fR or \fB\-\-distro\fR option), an Ubuntu 10\.04 host bootstrapped with RubyGems is assumed\. The \fBDISTRO\fR value corresponds to the base filename of the template, in other words \fBDISTRO\fR\.erb\. A template file can be specified with the \fB\-\-template\-file\fR option in which case the \fBDISTRO\fR is not used\. The sub\-command looks in the following locations for the template to use:
@@ -71,7 +71,7 @@ The bootstrap sub\-command supports supplying a template to perform the bootstra
 .IP "" 0
 .
 .P
-The default bootstrap templates are scripts that get copied to the target node (FQDN)\. As of Chef 0\.9\.8, the following distros are supported:
+The default bootstrap templates are scripts that get copied to the target node (FQDN)\. The following distros are supported:
 .
 .IP "\(bu" 4
 centos5\-gems
@@ -124,6 +124,58 @@ Have run Chef with its default run list if one is specfied\.
 .P
 Additional custom bootstrap templates can be created and stored in \fB\.chef/bootstrap/DISTRO\.erb\fR, replacing \fBDISTRO\fR with the value passed with the \fB\-d\fR or \fB\-\-distro\fR option\. See \fBEXAMPLES\fR for more information\.
 .
+.SH "EXAMPLES"
+Setting up a custom bootstrap is fairly straightforward\. Create a \fB\.chef/bootstrap\fR directory in your Chef Repository or in \fB$HOME/\.chef/bootstrap\fR\. Then create the ERB template file\.
+.
+.IP "" 4
+.
+.nf
+mkdir ~/\.chef/bootstrap
+vi ~/\.chef/bootstrap/debian5\.0\-apt\.erb
+.
+.fi
+.
+.IP "" 0
+.
+.P
+For example, to create a new bootstrap template that should be used when setting up a new Debian node\. Edit the template to run the commands, set up the validation certificate and the client configuration file, and finally to run chef\-client on completion\. The bootstrap template can be called with:
+.
+.IP "" 4
+.
+.nf
+knife bootstrap mynode\.example\.com \-\-template\-file ~/\.chef/bootstrap/debian5\.0\-apt\.erb
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Or,
+.
+.IP "" 4
+.
+.nf
+knife bootstrap mynode\.example\.com \-\-distro debian5\.0\-apt
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The \fB\-\-distro\fR parameter will automatically look in the \fB~/\.chef/bootstrap\fR directory for a file named \fBdebian5\.0\-apt\.erb\fR\.
+.
+.P
+Templates provided by the Chef installation are located in \fBBASEDIR/lib/chef/knife/bootstrap/*\.erb\fR, where \fIBASEDIR\fR is the location where the package or Gem installed the Chef client libraries\.
+.
+.SH "BUGS"
+\fBknife bootstrap\fR is not capable of bootstrapping multiple hosts in parallel\.
+.
+.P
+The bootstrap script is passed as an argument to sh(1) on the remote system, so sensitive information contained in the script will be visible to other users via the process list using tools such as ps(1)\.
+.
 .SH "SEE ALSO"
 \fBknife\-ssh\fR(1)
 .

data/distro/common/man/man1/knife-client.1 CHANGED Viewed

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "KNIFE\-CLIENT" "1" "April 2011" "Chef 0.10.0.beta.8" "Chef Manual"
+.TH "KNIFE\-CLIENT" "1" "April 2011" "Chef 0.10.0.beta.9" "Chef Manual"
 .
 .SH "NAME"
 \fBknife\-client\fR \- Manage Chef API Clients
@@ -9,16 +9,8 @@
 .SH "SYNOPSIS"
 \fBknife\fR \fBclient\fR \fIsub\-command\fR \fI(options)\fR
 .
-.SH "DESCRIPTION"
-Clients are identities used for communication with the Chef Server API, roughly equivalent to user accounts on the Chef Server, except that clients only communicate with the Chef Server API and are authenticated via request signatures\.
-.
-.P
-In the typical case, there will be one client object on the server for each node, and the corresponding client and node will have identical names\.
-.
-.P
-In the Chef authorization model, there is one special client, the "validator", which is authorized to create new non\-administrative clients but has minimal privileges otherwise\. This identity is used as a sort of "guest account" to create a client identity when initially setting up a host for management with Chef\.
-.
-.SH "CLIENT SUB\-COMMANDS"
+.SH "SUB\-COMMANDS"
+Client subcommands follow a basic create, read, update, delete (CRUD) pattern\. The Following subcommands are available:
 .
 .SH "BULK DELETE"
 \fBknife client bulk delete\fR \fIregex\fR \fI(options)\fR
@@ -85,6 +77,15 @@ Show only one attribute
 .P
 Show a client\. Output format is determined by the \-\-format option\.
 .
+.SH "DESCRIPTION"
+Clients are identities used for communication with the Chef Server API, roughly equivalent to user accounts on the Chef Server, except that clients only communicate with the Chef Server API and are authenticated via request signatures\.
+.
+.P
+In the typical case, there will be one client object on the server for each node, and the corresponding client and node will have identical names\.
+.
+.P
+In the Chef authorization model, there is one special client, the "validator", which is authorized to create new non\-administrative clients but has minimal privileges otherwise\. This identity is used as a sort of "guest account" to create a client identity when initially setting up a host for management with Chef\.
+.
 .SH "SEE ALSO"
 \fBknife\-node\fR(1)
 .

data/distro/common/man/man1/knife-configure.1 CHANGED Viewed

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "KNIFE\-CONFIGURE" "1" "April 2011" "Chef 0.10.0.beta.8" "Chef Manual"
+.TH "KNIFE\-CONFIGURE" "1" "April 2011" "Chef 0.10.0.beta.9" "Chef Manual"
 .
 .SH "NAME"
 \fBknife\-configure\fR \- Generate configuration files for knife or Chef Client

data/distro/common/man/man1/knife-cookbook-site.1 CHANGED Viewed

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "KNIFE\-COOKBOOK\-SITE" "1" "April 2011" "Chef 0.10.0.beta.8" "Chef Manual"
+.TH "KNIFE\-COOKBOOK\-SITE" "1" "April 2011" "Chef 0.10.0.beta.9" "Chef Manual"
 .
 .SH "NAME"
 \fBknife\-cookbook\-site\fR \- Install and update open source cookbooks
@@ -10,10 +10,43 @@
 \fBknife\fR \fBcookbook site\fR \fIsub\-command\fR \fI(options)\fR
 .
 .SH "COOKBOOK SITE SUB\-COMMANDS"
-The following sub\-commands are still in the context of cookbooks, but they make use of Opscode\'s Cookbook Community site, \fIhttp://cookbooks\.opscode\.com/\fR\. That site has an API, and these sub\-commands utilize that API, rather than the Chef Server API\.
+\fBknife cookbook site\fR provides the following subcommands:
+.
+.SH "INSTALL"
+\fBcookbook site install COOKBOOK [VERSION]\fR \fI(options)\fR
+.
+.TP
+\fB\-d\fR, \fB\-\-dependencies\fR
+Grab dependencies automatically
+.
+.P
+Uses git(1) version control in conjunction with the cookbook site to install community contributed cookbooks to your local cookbook repository\. Running \fBknife cookbook site install\fR does the following:
+.
+.IP "1." 4
+A new "pristine copy" branch is created in git for tracking the upstream;
+.
+.IP "2." 4
+All existing cookbooks are removed from the branch;
+.
+.IP "3." 4
+The cookbook is downloaded from the cookbook site in tarball form;
+.
+.IP "4." 4
+The downloaded cookbook is untarred, and its contents commited via git;
+.
+.IP "5." 4
+The pristine copy branch is merged into the master branch\.
+.
+.IP "" 0
+.
+.P
+By installing cookbook with this process, you can locally modify the upstream cookbook in your master branch ant let git maintain your changes as a separate patch\. When an updated upstream version becomes available, you will be able to merge the upstream changes while maintaining your local modifications\.
 .
 .P
-\fBcookbook site download COOKBOOK [VERSION]\fR \fI(options)\fR
+If \fI\-d\fR is specified, the process is applied recursively to all the cookbooks \fICOOKBOOK\fR depends on (via metadata \fIdependencies\fR)\.
+.
+.SH "DOWNLOAD"
+\fBknife cookbook site download COOKBOOK [VERSION]\fR \fI(options)\fR
 .
 .TP
 \fB\-f\fR, \fB\-\-file FILE\fR
@@ -22,8 +55,8 @@ The filename to write to
 .P
 Downloads a specific cookbook from the Community site, optionally specifying a certain version\.
 .
-.P
-\fBcookbook site list\fR \fI(options)\fR
+.SH "LIST"
+\fBknife cookbook site list\fR \fI(options)\fR
 .
 .TP
 \fB\-w\fR, \fB\-\-with\-uri\fR
@@ -32,14 +65,14 @@ Show corresponding URIs
 .P
 Lists available cookbooks from the Community site\.
 .
-.P
-\fBcookbook site search QUERY\fR \fI(options)\fR
+.SH "SEARCH"
+\fBknife cookbook site search QUERY\fR \fI(options)\fR
 .
 .P
-Searches the Community site with the specified query\.
+Searches for available cookbooks matching the specified query\.
 .
-.P
-\fBcookbook site share COOKBOOK CATEGORY\fR \fI(options)\fR
+.SH "SHARE"
+\fBknife cookbook site share COOKBOOK CATEGORY\fR \fI(options)\fR
 .
 .TP
 \fB\-k\fR, \fB\-\-key KEY\fR
@@ -54,32 +87,41 @@ API Client Username
 A colon\-separated path to look for cookbooks in
 .
 .P
-Uploads the specified cookbook using the given category to the Opscode cookbooks site\. Requires a login user and certificate for the Opscode Cookbooks site\. See \fBEXAMPLES\fR for usage if the Opscode user and certificate pair are not used for authenticating with the Chef Server\. In other words, if the Chef Server is not the Opscode Platform\.
+Uploads the specified cookbook using the given category to the Opscode cookbooks site\. Requires a login user and certificate for the Opscode Cookbooks site\. By default, knife will use the username and API key you\'ve configured in your configuration file; otherwise you must explicitly set these values on the command line or use an alternate configuration file\.
 .
-.P
-\fBcookbook site unshare COOKBOOK\fR
+.SH "UNSHARE"
+\fBknife cookbook site unshare COOKBOOK\fR
 .
 .P
 Stops sharing the specified cookbook on the Opscode cookbooks site\.
 .
-.P
-\fBcookbook site show COOKBOOK [VERSION]\fR \fI(options)\fR
+.SH "SHOW"
+\fBknife cookbook site show COOKBOOK [VERSION]\fR \fI(options)\fR
 .
 .P
 Shows information from the site about a particular cookbook\.
 .
+.SH "DESCRIPTION"
+The cookbook site, \fIhttp://community\.opscode\.com/\fR, is a cookbook distribution service operated by Opscode\. This service provides users with a central location to publish cookbooks for sharing with other community members\.
+.
 .P
-\fBcookbook site vendor COOKBOOK [VERSION]\fR \fI(options)\fR
+\fBknife cookbook site\fR commands provide an interface to the cookbook site\'s HTTP API\. For commands that read data from the API, no account is required\. In order to upload cookbooks using the \fBknife cookbook site share\fR command, you must create an account on the cookbook site and configure your credentials via command line option or in your knife configuration file\.
 .
-.TP
-\fB\-d\fR, \fB\-\-dependencies\fR
-Grab dependencies automatically
+.SH "EXAMPLES"
+Uploading cookbooks to the Opscode cookbooks site:
 .
-.P
-Uses \fBgit\fR version control in conjunction with the cookbook site to download upstream cookbooks\. A new vendor branch is created in git, the cookbook downloaded from the site and untarred, then the master branch is merged\. This allows the user to track upstream changes to cookbooks while merging in customizations\. If \fI\-d\fR is specified, all the cookbooks it depends on (via metadata \fIdependencies\fR) are downloaded and untarred as well, each using their own vendor branch\.
+.IP "" 4
+.
+.nf
+knife cookbook site share example Other \-k ~/\.chef/USERNAME\.pem \-u USERNAME
+.
+.fi
+.
+.IP "" 0
 .
 .SH "SEE ALSO"
-\fBknife\-environment\fR(1)
+\fBknife\-cookbook(1)\fR \fIhttp://community\.opscode\.com/cookbooks\fR
 .
 .SH "AUTHOR"
 Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\.