diff options
| author | Daniel DeLeo <dan@opscode.com> | 2011-04-07 19:45:24 -0700 |
|---|---|---|
| committer | Daniel DeLeo <dan@opscode.com> | 2011-04-08 10:20:14 -0700 |
| commit | 5a0a3b7867d1e23579da8be9132f7be149ba8346 (patch) | |
| tree | 6595cf72ad881b52d5ffc21b4de8bbb188c75324 | |
| parent | 0ccbd635d5d9db8ee20c62b5e2ecf370836052e4 (diff) | |
| download | chef-5a0a3b7867d1e23579da8be9132f7be149ba8346.tar.gz | |
updated all existing docs and added html manuals
58 files changed, 2026 insertions, 773 deletions
diff --git a/chef/Rakefile b/chef/Rakefile index 9f831197ba..94045326a2 100644 --- a/chef/Rakefile +++ b/chef/Rakefile @@ -78,7 +78,7 @@ namespace :docs do task :man => manfile file(htmlfile => mkd) do - sh "ronn -5 #{RONN_OPTS} #{mkd} --pipe > #{htmlfile}" + sh "ronn -5 #{RONN_OPTS} --style=toc #{mkd} --pipe > #{htmlfile}" end task :html => htmlfile @@ -86,7 +86,11 @@ namespace :docs do else puts "get with the program and install ronn" end + + task :all => [:man, :html] end +task :docs => "docs:all" + diff --git a/chef/distro/common/html/knife-bootstrap.8.html b/chef/distro/common/html/knife-bootstrap.1.html index a487577258..7dc83ac2ab 100644 --- a/chef/distro/common/html/knife-bootstrap.8.html +++ b/chef/distro/common/html/knife-bootstrap.1.html @@ -3,7 +3,7 @@ <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>knife-bootrap(8) - Chef Server REST API utility</title> + <title>knife-bootrap(1) - Install Chef Client on a remote host</title> <style type='text/css' media='all'> /* style: man */ body#manpage {margin:0} @@ -41,6 +41,12 @@ 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: @@ -55,17 +61,21 @@ <div class='man-navigation' style='display:none'> <a href="#NAME">NAME</a> <a href="#SYNOPSIS">SYNOPSIS</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'>knife-bootrap(8)</li> + <li class='tl'>knife-bootrap(1)</li> <li class='tc'>Chef Manual</li> - <li class='tr'>knife-bootrap(8)</li> + <li class='tr'>knife-bootrap(1)</li> </ol> <h2 id="NAME">NAME</h2> <p class="man-name"> - <code>knife-bootrap</code> - <span class="man-whatis">Chef Server REST API utility</span> + <code>knife-bootrap</code> - <span class="man-whatis">Install Chef Client on a remote host</span> </p> <h2 id="SYNOPSIS">SYNOPSIS</h2> @@ -87,9 +97,20 @@ </dl> -<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.</p> +<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.</p> -<p>As of Chef 0.9.8, the bootstrap sub-command supports supplying a template to perform the bootstrap steps. If the distro is not specified (via <code>-d</code> or <code>--distro</code> option), an Ubuntu 10.04 with RubyGems is assumed. The <strong>DISTRO</strong> value corresponds to the base filename of the template, in other words <code>DISTRO</code>.erb. A template file can be specified with the <code>--template-file</code> option in which case the <strong>DISTRO</strong> is not used. The sub-command looks in the following locations for the template to use:</p> +<p>The bootstrap sub-command supports supplying a template to perform the +bootstrap steps. If the distro is not specified (via <code>-d</code> or <code>--distro</code> +option), an Ubuntu 10.04 host bootstrapped with RubyGems is assumed. The +<strong>DISTRO</strong> value corresponds to the base filename of the template, in +other words <code>DISTRO</code>.erb. A template file can be specified with the +<code>--template-file</code> option in which case the <strong>DISTRO</strong> is not used. The +sub-command looks in the following locations for the template to use:</p> <ul> <li><code>bootstrap</code> directory in the installed Chef Knife library.</li> @@ -132,11 +153,28 @@ <p>Additional custom bootstrap templates can be created and stored in <code>.chef/bootstrap/DISTRO.erb</code>, replacing <strong>DISTRO</strong> with the value passed with the <code>-d</code> or <code>--distro</code> option. See <strong>EXAMPLES</strong> for more information.</p> +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong>knife-ssh</strong>(1)</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p> Chef was written by Adam Jacob <a href="mailto:adam@opscode.com" data-bare-link="true">adam@opscode.com</a> with many contributions from the community.</p> + +<h2 id="DOCUMENTATION">DOCUMENTATION</h2> + +<p> This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</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> Knife 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.7</li> <li class='tc'>April 2011</li> - <li class='tr'>knife-bootrap(8)</li> + <li class='tr'>knife-bootrap(1)</li> </ol> </div> diff --git a/chef/distro/common/html/knife-client.1.html b/chef/distro/common/html/knife-client.1.html new file mode 100644 index 0000000000..47ae998d1c --- /dev/null +++ b/chef/distro/common/html/knife-client.1.html @@ -0,0 +1,216 @@ +<!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>knife-client(1) - Manage Chef API Clients</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="#CLIENT-SUB-COMMANDS">CLIENT SUB-COMMANDS</a> + <a href="#BULK-DELETE">BULK DELETE</a> + <a href="#CREATE">CREATE</a> + <a href="#DELETE">DELETE</a> + <a href="#EDIT">EDIT</a> + <a href="#LIST">LIST</a> + <a href="#REREGISTER">REREGISTER</a> + <a href="#SHOW">SHOW</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'>knife-client(1)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>knife-client(1)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>knife-client</code> - <span class="man-whatis">Manage Chef API Clients</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>client</strong> <em>sub-command</em> <em>(options)</em></p> + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>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> + +<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> + +<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.</p> + +<h2 id="CLIENT-SUB-COMMANDS">CLIENT SUB-COMMANDS</h2> + +<h2 id="BULK-DELETE">BULK DELETE</h2> + +<p><strong>knife client bulk delete</strong> <em>regex</em> <em>(options)</em></p> + +<p>Delete clients where the client name matches the regular expression +<em>regex</em> on the Chef Server. The regular expression should be given as a +quoted string, and not surrounded by forward slashes.</p> + +<h2 id="CREATE">CREATE</h2> + +<p><strong>knife client create</strong> <em>client name</em> <em>(options)</em></p> + +<dl> +<dt><code>-a</code>, <code>--admin </code></dt><dd>Create the client as an admin</dd> +<dt><code>-f</code>, <code>--file FILE</code></dt><dd>Write the key to a file</dd> +</dl> + + +<p>Create a new client. This generates an RSA keypair. The private key will +be displayed on <em>STDOUT</em> or written to the named file. The public half +will be stored on the Server. For <em>chef-client</em> systems, the private key +should be copied to the system as <code>/etc/chef/client.pem</code>.</p> + +<p>Admin clients should be created for users that will use <em>knife</em> to +access the API as an administrator. The private key will generally be +copied to <code>~/.chef/client\_name.pem</code> and referenced in the <code>knife.rb</code> +configuration file.</p> + +<h2 id="DELETE">DELETE</h2> + +<p><strong>knife client delete</strong> <em>client name</em> <em>(options)</em></p> + +<p>Deletes a registered client.</p> + +<h2 id="EDIT">EDIT</h2> + +<p><strong>client edit</strong> <em>client name</em> <em>(options)</em></p> + +<p>Edit a registered client.</p> + +<h2 id="LIST">LIST</h2> + +<p><strong>client list</strong> <em>(options)</em></p> + +<dl> +<dt><code>-w</code>, <code>--with-uri</code></dt><dd> Show corresponding URIs</dd> +</dl> + + +<p>List all registered clients.</p> + +<h2 id="REREGISTER">REREGISTER</h2> + +<p><strong>client reregister</strong> <em>client name</em> <em>(options)</em></p> + +<dl> +<dt><code>-f</code>, <code>--file FILE</code></dt><dd>Write the key to a file</dd> +</dl> + + +<p>Regenerate the RSA keypair for a client. The public half will be stored +on the server and the private key displayed on <em>STDOUT</em> or written to +the named file. This operation will invalidate the previous keypair used +by the client, preventing it from authenticating with the Chef Server. +Use care when reregistering the validator client.</p> + +<h2 id="SHOW">SHOW</h2> + +<p><strong>client show</strong> <em>client name</em> <em>(options)</em></p> + +<dl> +<dt><code>-a</code>, <code>--attribute ATTR</code></dt><dd>Show only one attribute</dd> +</dl> + + +<p>Show a client. Output format is determined by the --format option.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong>knife-node</strong>(1)</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p> Chef was written by Adam Jacob <a href="mailto:adam@opscode.com" data-bare-link="true">adam@opscode.com</a> with many contributions from the community.</p> + +<h2 id="DOCUMENTATION">DOCUMENTATION</h2> + +<p> This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</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> Knife 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.7</li> + <li class='tc'>April 2011</li> + <li class='tr'>knife-client(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/chef/distro/common/html/knife-client.8.html b/chef/distro/common/html/knife-client.8.html deleted file mode 100644 index 67e630c6bc..0000000000 --- a/chef/distro/common/html/knife-client.8.html +++ /dev/null @@ -1,140 +0,0 @@ -<!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>knife-client(8) - Chef Server REST API utility</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> -</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="#CLIENT-SUB-COMMANDS">CLIENT SUB-COMMANDS</a> - </div> - - <ol class='man-decor man-head man head'> - <li class='tl'>knife-client(8)</li> - <li class='tc'>Chef Manual</li> - <li class='tr'>knife-client(8)</li> - </ol> - - <h2 id="NAME">NAME</h2> -<p class="man-name"> - <code>knife-client</code> - <span class="man-whatis">Chef Server REST API utility</span> -</p> - -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<p><strong>knife</strong> <strong>client</strong> <em>sub-command</em> <em>(options)</em></p> - -<h2 id="CLIENT-SUB-COMMANDS">CLIENT SUB-COMMANDS</h2> - -<p>Clients are entities that communicate with the Chef Server API.</p> - -<p><strong>client bulk delete REGEX</strong> <em>(options)</em></p> - -<p>Delete clients on the Chef Server based on a regular expression. The regular expression (<em>REGEX</em>) should be in quotes, not in //'s.</p> - -<p><strong>client create CLIENT</strong> <em>(options)</em></p> - -<dl> -<dt><code>-a</code>, <code>--admin </code></dt><dd>Create the client as an admin</dd> -<dt><code>-f</code>, <code>--file FILE</code></dt><dd>Write the key to a file</dd> -</dl> - - -<p>Create a new client. This generates an RSA keypair. The private key will be displayed on <em>STDOUT</em> or written to the named file. The public half will be stored on the Server. For <em>chef-client</em> systems, the private key should be copied to the system as <code>/etc/chef/client.pem</code>.</p> - -<p>Admin clients should be created for users that will use <em>knife</em> to access the API as an administrator. The private key will generally be copied to <code>~/.chef/CLIENT.pem</code> and referenced in the <code>knife.rb</code> configuration file.</p> - -<p><strong>client delete CLIENT</strong> <em>(options)</em></p> - -<p>Deletes a registered client.</p> - -<p><strong>client edit CLIENT</strong> <em>(options)</em></p> - -<p>Edit a registered client.</p> - -<p><strong>client list</strong> <em>(options)</em></p> - -<dl> -<dt><code>-w</code>, <code>--with-uri</code></dt><dd> Show corresponding URIs</dd> -</dl> - - -<p>List all registered clients.</p> - -<p><strong>client reregister CLIENT</strong> <em>(options)</em></p> - -<dl> -<dt><code>-f</code>, <code>--file FILE</code></dt><dd>Write the key to a file</dd> -</dl> - - -<p>Regenerate the RSA keypair for a client. The public half will be stored on the server and the private key displayed on <em>STDOUT</em> or written to the named file.</p> - -<p><strong>client show CLIENT</strong> <em>(options)</em></p> - -<dl> -<dt><code>-a</code>, <code>--attribute ATTR</code></dt><dd>Show only one attribute</dd> -</dl> - - -<p>Show a client.</p> - - - <ol class='man-decor man-foot man foot'> - <li class='tl'>Chef 0.10.0.beta.7</li> - <li class='tc'>April 2011</li> - <li class='tr'>knife-client(8)</li> - </ol> - - </div> -</body> -</html> diff --git a/chef/distro/common/html/knife-configure.1.html b/chef/distro/common/html/knife-configure.1.html new file mode 100644 index 0000000000..6c06ad7782 --- /dev/null +++ b/chef/distro/common/html/knife-configure.1.html @@ -0,0 +1,170 @@ +<!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>knife-configure(1) - Generate configuration files for knife or Chef Client</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="#CONFIGURE-SUBCOMMANDS">CONFIGURE SUBCOMMANDS</a> + <a href="#EXAMPLES">EXAMPLES</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'>knife-configure(1)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>knife-configure(1)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>knife-configure</code> - <span class="man-whatis">Generate configuration files for knife or Chef Client</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>configure</strong> [client] <em>(options)</em></p> + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>Generates a knife.rb configuration file interactively. When given the +--initial option, also creates a new administrative user.</p> + +<h2 id="CONFIGURE-SUBCOMMANDS">CONFIGURE SUBCOMMANDS</h2> + +<p><strong>knife configure</strong> <em>(options)</em></p> + +<dl> +<dt><code>-i</code>, <code>--initial</code></dt><dd>Create an initial API Client</dd> +<dt><code>-r</code>, <code>--repository REPO</code></dt><dd>The path to your chef-repo</dd> +</dl> + + +<p>Create a configuration file for knife. This will prompt for values to +enter into the file. Default values are listed in square brackets if no +other entry is typed. See <strong>knife</strong>(1) for a description of +configuration options.</p> + +<p><strong>knife configure client</strong> <em>directory</em></p> + +<p>Read the <em>knife.rb</em> config file and generate a config file suitable for +use in <em>/etc/chef/client.rb</em> and copy the validation certificate into +the specified <em>directory</em>.</p> + +<h2 id="EXAMPLES">EXAMPLES</h2> + +<ul> +<li><p>On a freshly installed Chef Server, use <em>knife configure -i</em> to +create an administrator and knife configuration file. Leave the +field blank to accept the default value. On most systems, the +default values are acceptable.</p> + +<p>user@host$ knife configure -i<br /> +Please enter the chef server URL: [http://localhost:4000]<br /> +Please enter a clientname for the new client: [username]<br /> +Please enter the existing admin clientname: [chef-webui]<br /> +Please enter the location of the existing admin client's private key: [/etc/chef/webui.pem]<br /> +Please enter the validation clientname: [chef-validator]<br /> +Please enter the location of the validation key: [/etc/chef/validation.pem]<br /> +Please enter the path to a chef repository (or leave blank):<br /> +Creating initial API user...<br /> +Created (or updated) client[username]<br /> +Configuration file written to /home/username/.chef/knife.rb</p> + +<p>This creates a new administrator client named <em>username</em>, writes +a configuration file to <em>/home/username/.chef/knife.rb</em>, and the +private key to <em>/home/username/.chef/username.pem</em>. The +configuration file and private key may be copied to another system +to facilitate administration of the Chef Server from a remote +system. Depending on the value given for the Chef Server URL, you +may need to modify that setting after copying to a remote host.</p></li> +</ul> + + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong>knife</strong>(1) <strong>knife-client</strong>(1)</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p> Chef was written by Adam Jacob <a href="mailto:adam@opscode.com" data-bare-link="true">adam@opscode.com</a> with many contributions from the community.</p> + +<h2 id="DOCUMENTATION">DOCUMENTATION</h2> + +<p> This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</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> Knife 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.7</li> + <li class='tc'>April 2011</li> + <li class='tr'>knife-configure(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/chef/distro/common/html/knife-configure.8.html b/chef/distro/common/html/knife-configure.8.html deleted file mode 100644 index f7d6fdc3c0..0000000000 --- a/chef/distro/common/html/knife-configure.8.html +++ /dev/null @@ -1,101 +0,0 @@ -<!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>knife-configure(8) - Chef Server REST API utility</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> -</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="#CONFIGURE-SUBCOMMANDS">CONFIGURE SUBCOMMANDS</a> - </div> - - <ol class='man-decor man-head man head'> - <li class='tl'>knife-configure(8)</li> - <li class='tc'>Chef Manual</li> - <li class='tr'>knife-configure(8)</li> - </ol> - - <h2 id="NAME">NAME</h2> -<p class="man-name"> - <code>knife-configure</code> - <span class="man-whatis">Chef Server REST API utility</span> -</p> - -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<p><strong>knife</strong> <strong>configure</strong> [client] <em>(options)</em></p> - -<h2 id="CONFIGURE-SUBCOMMANDS">CONFIGURE SUBCOMMANDS</h2> - -<p><strong>configure</strong> <em>(options)</em></p> - -<dl> -<dt><code>-i</code>, <code>--initial</code></dt><dd>Create an initial API Client</dd> -<dt><code>-r</code>, <code>--repository REPO</code></dt><dd>The path to your chef-repo</dd> -</dl> - - -<p>Create a configuration file for knife. This will prompt for values to enter into the file. Default values are listed in square brackets if no other entry is typed. See <strong>CONFIGURATION</strong> below for available options.</p> - -<p><strong>configure client DIRECTORY</strong></p> - -<p>Read the <code>knife.rb</code> config file and generate a config file suitable for use in <code>/etc/chef/client.rb</code> and copy the validation certificate into the specified <em>DIRECTORY</em>.</p> - - - <ol class='man-decor man-foot man foot'> - <li class='tl'>Chef 0.10.0.beta.7</li> - <li class='tc'>April 2011</li> - <li class='tr'>knife-configure(8)</li> - </ol> - - </div> -</body> -</html> diff --git a/chef/distro/common/html/knife-cookbook-site.8.html b/chef/distro/common/html/knife-cookbook-site.1.html index 5f2f970d0b..cdbea4a899 100644 --- a/chef/distro/common/html/knife-cookbook-site.8.html +++ b/chef/distro/common/html/knife-cookbook-site.1.html @@ -3,7 +3,7 @@ <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>knife-cookbook-site(8) - Chef Server REST API utility</title> + <title>knife-cookbook-site(1) - Install and update open source cookbooks</title> <style type='text/css' media='all'> /* style: man */ body#manpage {margin:0} @@ -41,6 +41,12 @@ 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: @@ -56,17 +62,21 @@ <a href="#NAME">NAME</a> <a href="#SYNOPSIS">SYNOPSIS</a> <a href="#COOKBOOK-SITE-SUB-COMMANDS">COOKBOOK SITE SUB-COMMANDS</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'>knife-cookbook-site(8)</li> + <li class='tl'>knife-cookbook-site(1)</li> <li class='tc'>Chef Manual</li> - <li class='tr'>knife-cookbook-site(8)</li> + <li class='tr'>knife-cookbook-site(1)</li> </ol> <h2 id="NAME">NAME</h2> <p class="man-name"> - <code>knife-cookbook-site</code> - <span class="man-whatis">Chef Server REST API utility</span> + <code>knife-cookbook-site</code> - <span class="man-whatis">Install and update open source cookbooks</span> </p> <h2 id="SYNOPSIS">SYNOPSIS</h2> @@ -127,11 +137,28 @@ <p>Uses <code>git</code> 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 <em>-d</em> is specified, all the cookbooks it depends on (via metadata <em>dependencies</em>) are downloaded and untarred as well, each using their own vendor branch.</p> +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong>knife-environment</strong>(1)</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p> Chef was written by Adam Jacob <a href="mailto:adam@opscode.com" data-bare-link="true">adam@opscode.com</a> with many contributions from the community.</p> + +<h2 id="DOCUMENTATION">DOCUMENTATION</h2> + +<p> This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</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> Knife 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.7</li> <li class='tc'>April 2011</li> - <li class='tr'>knife-cookbook-site(8)</li> + <li class='tr'>knife-cookbook-site(1)</li> </ol> </div> diff --git a/chef/distro/common/html/knife-cookbook.8.html b/chef/distro/common/html/knife-cookbook.1.html index d9b1254079..01a6d9357b 100644 --- a/chef/distro/common/html/knife-cookbook.8.html +++ b/chef/distro/common/html/knife-cookbook.1.html @@ -3,7 +3,7 @@ <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>knife-cookbook(8) - Chef Server REST API utility</title> + <title>knife-cookbook(1) - Upload and manage Chef cookbooks</title> <style type='text/css' media='all'> /* style: man */ body#manpage {margin:0} @@ -41,6 +41,12 @@ 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: @@ -59,14 +65,14 @@ </div> <ol class='man-decor man-head man head'> - <li class='tl'>knife-cookbook(8)</li> + <li class='tl'>knife-cookbook(1)</li> <li class='tc'>Chef Manual</li> - <li class='tr'>knife-cookbook(8)</li> + <li class='tr'>knife-cookbook(1)</li> </ol> <h2 id="NAME">NAME</h2> <p class="man-name"> - <code>knife-cookbook</code> - <span class="man-whatis">Chef Server REST API utility</span> + <code>knife-cookbook</code> - <span class="man-whatis">Upload and manage Chef cookbooks</span> </p> <h2 id="SYNOPSIS">SYNOPSIS</h2> @@ -219,7 +225,7 @@ cookbook_email "YOUR_EMAIL" <ol class='man-decor man-foot man foot'> <li class='tl'>Chef 0.10.0.beta.7</li> <li class='tc'>April 2011</li> - <li class='tr'>knife-cookbook(8)</li> + <li class='tr'>knife-cookbook(1)</li> </ol> </div> diff --git a/chef/distro/common/html/knife-data-bag.1.html b/chef/distro/common/html/knife-data-bag.1.html new file mode 100644 index 0000000000..8ff901d287 --- /dev/null +++ b/chef/distro/common/html/knife-data-bag.1.html @@ -0,0 +1,234 @@ +<!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>knife-data-bag(1) - Store arbitrary data on a Chef Server</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="#DATA-BAG-SUB-COMMANDS">DATA BAG SUB-COMMANDS</a> + <a href="#CREATE">CREATE</a> + <a href="#DELETE">DELETE</a> + <a href="#EDIT">EDIT</a> + <a href="#FROM-FILE">FROM FILE</a> + <a href="#LIST">LIST</a> + <a href="#SHOW">SHOW</a> + <a href="#ENCRYPTION-SUPPORT">ENCRYPTION SUPPORT</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'>knife-data-bag(1)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>knife-data-bag(1)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>knife-data-bag</code> - <span class="man-whatis">Store arbitrary data on a Chef Server</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>data bag</strong> <em>sub-command</em> <em>(options)</em></p> + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>Data bags are stores of arbitrary JSON data. Each data bag is a +collection that may contain many items. Data Bag Items are indexed by +the Chef Server and can be searched via <strong>knife-search</strong>(1).</p> + +<p>Data bags are available to all nodes configured by <strong>chef-client</strong>(8), +and are therefore a convenient mechanism to store global information, +such as lists of administrative accounts that should be configured on +all hosts.</p> + +<h2 id="DATA-BAG-SUB-COMMANDS">DATA BAG SUB-COMMANDS</h2> + +<h2 id="CREATE">CREATE</h2> + +<p><strong>knife data bag create</strong> <em>bag name</em> [item id] <em>(options)</em></p> + +<dl> +<dt><code>-s</code>, <code>--secret SECRET</code></dt><dd>A secret key used to encrypt the data bag item. See <strong>encryption support</strong> below.</dd> +<dt><code>--secret-file SECRET_FILE</code></dt><dd>The path to a file containing the secret key to be used to encrypt +the data bag item.</dd> +</dl> + + +<p>If <em>item id</em> is given, creates a new, empty data bag item and opens it for +editing in your editor. The data bag will be created if it does not +exist.</p> + +<p>If <em>item id</em> is not given, the data bag will be created.</p> + +<h2 id="DELETE">DELETE</h2> + +<p><strong>knife data bag delete</strong> <em>bag name</em> [item id] <em>(options)</em></p> + +<p>Delete a data bag, or an item from a data bag.</p> + +<h2 id="EDIT">EDIT</h2> + +<p><strong>knife data bag edit</strong> <em>bag name</em> <em>item id</em> <em>(options)</em></p> + +<dl> +<dt><code>-s</code>, <code>--secret SECRET</code></dt><dd>A secret key used to encrypt the data bag item. See <strong>encryption support</strong> below.</dd> +<dt><code>--secret-file SECRET_FILE</code></dt><dd>The path to a file containing the secret key to be used to encrypt +the data bag item.</dd> +</dl> + + +<p>Edit an item in a data bag.</p> + +<h2 id="FROM-FILE">FROM FILE</h2> + +<p><strong>knife data bag from file</strong> <em>bag name</em> <em>file</em> <em>(options)</em></p> + +<dl> +<dt><code>-s</code>, <code>--secret SECRET</code></dt><dd>A secret key used to encrypt the data bag item. See <strong>encryption support</strong> below.</dd> +<dt><code>--secret-file SECRET_FILE</code></dt><dd>The path to a file containing the secret key to be used to encrypt +the data bag item.</dd> +</dl> + + +<p>Load a data bag item from a JSON file. If <em>file</em> is a relative or +absolute path to the file, that file will be used. Otherwise, the <em>file</em> +parameter is treated as the base name of a data bag file in a Chef +repository, and <code>knife</code> will search for the file in +<code>./data_bags/bag_name/file</code>. For example <code>knife data bag from file users +dan.json</code> would attempt to load the file <code>./data_bags/users/dan.json</code>.</p> + +<h2 id="LIST">LIST</h2> + +<p><strong>knife data bag list</strong> <em>(options)</em></p> + +<dl> +<dt><code>-w</code>, <code>--with-uri</code></dt><dd>Show corresponding URIs</dd> +</dl> + + +<p>Lists the data bags that exist on the Chef Server.</p> + +<h2 id="SHOW">SHOW</h2> + +<p><strong>knife data bag show BAG [ITEM]</strong> <em>(options)</em></p> + +<dl> +<dt><code>-s</code>, <code>--secret SECRET</code></dt><dd>A secret key used to encrypt the data bag item. See <strong>encryption support</strong> below.</dd> +<dt><code>--secret-file SECRET_FILE</code></dt><dd>The path to a file containing the secret key to be used to encrypt +the data bag item.</dd> +</dl> + + +<p>Show a specific data bag or an item in a data bag. The output will be +formatted according to the --format option.</p> + +<h2 id="ENCRYPTION-SUPPORT">ENCRYPTION SUPPORT</h2> + +<p>Data Bag Items may be encrypted to keep their contents secret. This may +be desireable when storing sensitive information such as database +passwords, API keys, etc.</p> + +<p>Data Bag Item encryption uses the AES-256 CBC symmetric key algorithm.</p> + +<p><strong>CAVEATS:</strong> Keys are not encrypted; only values are encrypted. The "id" +of a Data Bag Item is not encrypted, since it is used by Chef Server to +store the item in its database. For example, given the following data bag item:</p> + +<pre><code>{"id": "important_passwords", "secret_password": "opensesame"} +</code></pre> + +<p>The key "secret_password" will be visible to an evesdropper, but the +value "opensesame" will be protected. Both the key "id" and its value +"important_passwords" will be visible to an evesdropper.</p> + +<p>Chef Server does not provide a secure mechanism for distributing +encryption keys.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong>knife-search</strong>(1)</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p> Chef was written by Adam Jacob <a href="mailto:adam@opscode.com" data-bare-link="true">adam@opscode.com</a> with many contributions from the community.</p> + +<h2 id="DOCUMENTATION">DOCUMENTATION</h2> + +<p> This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</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> Knife is distributed with Chef. http://wiki.opscode.com/display/chef/Home</p> + + + <ol class='man-decor man-foot man foot'> + <li class='tl'>Chef 0.10.0.beta.7</li> + <li class='tc'>April 2011</li> + <li class='tr'>knife-data-bag(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/chef/distro/common/html/knife-data-bag.8.html b/chef/distro/common/html/knife-data-bag.8.html deleted file mode 100644 index 9848ba7abb..0000000000 --- a/chef/distro/common/html/knife-data-bag.8.html +++ /dev/null @@ -1,118 +0,0 @@ -<!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>knife-data-bag(8) - Chef Server REST API utility</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> -</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="#DATA-BAG-SUB-COMMANDS">DATA BAG SUB-COMMANDS</a> - </div> - - <ol class='man-decor man-head man head'> - <li class='tl'>knife-data-bag(8)</li> - <li class='tc'>Chef Manual</li> - <li class='tr'>knife-data-bag(8)</li> - </ol> - - <h2 id="NAME">NAME</h2> -<p class="man-name"> - <code>knife-data-bag</code> - <span class="man-whatis">Chef Server REST API utility</span> -</p> - -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<p><strong>knife</strong> <strong>data bag</strong> <em>sub-command</em> <em>(options)</em></p> - -<h2 id="DATA-BAG-SUB-COMMANDS">DATA BAG SUB-COMMANDS</h2> - -<p>Data bags are stores of JSON blobs. These blobs are called items. They are free form JSON and indexed by the Chef Server.</p> - -<p><strong>data bag create BAG [ITEM]</strong> <em>(options)</em></p> - -<p>Create a new data bag, or an item in a data bag.</p> - -<p><strong>data bag delete BAG [ITEM]</strong> <em>(options)</em></p> - -<p>Delete a data bag, or an item from a data bag.</p> - -<p><strong>data bag edit BAG ITEM</strong> <em>(options)</em></p> - -<p>Edit an item in a data bag.</p> - -<p><strong>data bag from file BAG FILE</strong> <em>(options)</em></p> - -<p>Load a data bag item from a JSON file. Looks in the directory <code>data_bags/BAG/ITEM.json</code> unless a relative path is specified.</p> - -<p><strong>data bag list</strong> <em>(options)</em></p> - -<dl> -<dt><code>-w</code>, <code>--with-uri</code></dt><dd>Show corresponding URIs</dd> -</dl> - - -<p>List the available data bags.</p> - -<p><strong>data bag show BAG [ITEM]</strong> <em>(options)</em></p> - -<p>Show a specific data bag or an item in a data bag.</p> - - - <ol class='man-decor man-foot man foot'> - <li class='tl'>Chef 0.10.0.beta.7</li> - <li class='tc'>April 2011</li> - <li class='tr'>knife-data-bag(8)</li> - </ol> - - </div> -</body> -</html> diff --git a/chef/distro/common/html/knife-environment.8.html b/chef/distro/common/html/knife-environment.1.html index 6994b4cc28..236478a7f7 100644 --- a/chef/distro/common/html/knife-environment.8.html +++ b/chef/distro/common/html/knife-environment.1.html @@ -3,7 +3,7 @@ <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>knife-environment(8) - Chef Server REST API utility</title> + <title>knife-environment(1) - Define cookbook policies for the environments in your infrastructure</title> <style type='text/css' media='all'> /* style: man */ body#manpage {margin:0} @@ -41,6 +41,12 @@ 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: @@ -59,14 +65,14 @@ </div> <ol class='man-decor man-head man head'> - <li class='tl'>knife-environment(8)</li> + <li class='tl'>knife-environment(1)</li> <li class='tc'>Chef Manual</li> - <li class='tr'>knife-environment(8)</li> + <li class='tr'>knife-environment(1)</li> </ol> <h2 id="NAME">NAME</h2> <p class="man-name"> - <code>knife-environment</code> - <span class="man-whatis">Chef Server REST API utility</span> + <code>knife-environment</code> - <span class="man-whatis">Define cookbook policies for the environments in your infrastructure</span> </p> <h2 id="SYNOPSIS">SYNOPSIS</h2> @@ -79,7 +85,7 @@ <ol class='man-decor man-foot man foot'> <li class='tl'>Chef 0.10.0.beta.7</li> <li class='tc'>April 2011</li> - <li class='tr'>knife-environment(8)</li> + <li class='tr'>knife-environment(1)</li> </ol> </div> diff --git a/chef/distro/common/html/knife-exec.8.html b/chef/distro/common/html/knife-exec.1.html index 46a6fc8646..4bc2ad6413 100644 --- a/chef/distro/common/html/knife-exec.8.html +++ b/chef/distro/common/html/knife-exec.1.html @@ -3,7 +3,7 @@ <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>knife-exec(8) - Chef Server REST API utility</title> + <title>knife-exec(1) - Run user scripts using the Chef API DSL</title> <style type='text/css' media='all'> /* style: man */ body#manpage {margin:0} @@ -41,6 +41,12 @@ 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: @@ -59,14 +65,14 @@ </div> <ol class='man-decor man-head man head'> - <li class='tl'>knife-exec(8)</li> + <li class='tl'>knife-exec(1)</li> <li class='tc'>Chef Manual</li> - <li class='tr'>knife-exec(8)</li> + <li class='tr'>knife-exec(1)</li> </ol> <h2 id="NAME">NAME</h2> <p class="man-name"> - <code>knife-exec</code> - <span class="man-whatis">Chef Server REST API utility</span> + <code>knife-exec</code> - <span class="man-whatis">Run user scripts using the Chef API DSL</span> </p> <h2 id="SYNOPSIS">SYNOPSIS</h2> @@ -79,7 +85,7 @@ <ol class='man-decor man-foot man foot'> <li class='tl'>Chef 0.10.0.beta.7</li> <li class='tc'>April 2011</li> - <li class='tr'>knife-exec(8)</li> + <li class='tr'>knife-exec(1)</li> </ol> </div> diff --git a/chef/distro/common/html/knife-index.8.html b/chef/distro/common/html/knife-index.1.html index 9968d9e456..b99c0d4890 100644 --- a/chef/distro/common/html/knife-index.8.html +++ b/chef/distro/common/html/knife-index.1.html @@ -3,7 +3,7 @@ <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>knife(8) - Chef Server REST API utility</title> + <title>knife-index(1) - Rebuild the search index on a Chef Server</title> <style type='text/css' media='all'> /* style: man */ body#manpage {margin:0} @@ -41,6 +41,12 @@ 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: @@ -55,17 +61,22 @@ <div class='man-navigation' style='display:none'> <a href="#NAME">NAME</a> <a href="#SYNOPSIS">SYNOPSIS</a> + <a href="#DESCRIPTION">DESCRIPTION</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'>knife(8)</li> + <li class='tl'>knife-index(1)</li> <li class='tc'>Chef Manual</li> - <li class='tr'>knife(8)</li> + <li class='tr'>knife-index(1)</li> </ol> <h2 id="NAME">NAME</h2> <p class="man-name"> - <code>knife</code> - <span class="man-whatis">Chef Server REST API utility</span> + <code>knife-index</code> - <span class="man-whatis">Rebuild the search index on a Chef Server</span> </p> <h2 id="SYNOPSIS">SYNOPSIS</h2> @@ -77,13 +88,36 @@ </dl> -<p>Rebuilds all the search indexes on the server.</p> +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>Rebuilds all the search indexes on the server. This is accomplished by +deleting all objects from the search index, and then forwarding each +item in the database to <strong>chef-expander</strong>(8) via <strong>rabbitmq-server</strong>(1). +Depending on the number of objects in the database, it may take some +time for all objects to be indexed and available for search.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong>knife-search</strong>(1)</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p> Chef was written by Adam Jacob <a href="mailto:adam@opscode.com" data-bare-link="true">adam@opscode.com</a> with many contributions from the community.</p> + +<h2 id="DOCUMENTATION">DOCUMENTATION</h2> + +<p> This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</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> Knife 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.7</li> <li class='tc'>April 2011</li> - <li class='tr'>knife(8)</li> + <li class='tr'>knife-index(1)</li> </ol> </div> diff --git a/chef/distro/common/html/knife-node.1.html b/chef/distro/common/html/knife-node.1.html new file mode 100644 index 0000000000..3489def547 --- /dev/null +++ b/chef/distro/common/html/knife-node.1.html @@ -0,0 +1,268 @@ +<!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>knife-node(1) - Manage the hosts in your infrastructure</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="#NODE-SUB-COMMANDS">NODE SUB-COMMANDS</a> + <a href="#BULK-DELETE">BULK DELETE</a> + <a href="#CREATE">CREATE</a> + <a href="#DELETE">DELETE</a> + <a href="#EDIT">EDIT</a> + <a href="#FROM-FILE">FROM FILE</a> + <a href="#LIST">LIST</a> + <a href="#RUN_LIST-ADD">RUN_LIST ADD</a> + <a href="#RUN_LIST-REMOVE">RUN_LIST REMOVE</a> + <a href="#SHOW">SHOW</a> + <a href="#RUN-LIST-ITEM-FORMAT">RUN LIST ITEM FORMAT</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'>knife-node(1)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>knife-node(1)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>knife-node</code> - <span class="man-whatis">Manage the hosts in your infrastructure</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>node</strong> <em>sub-command</em> <em>(options)</em></p> + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>Nodes are data structures that represent hosts configured with Chef. +Nodes have a <strong>name</strong>, a String that uniquely identifies the node, +<strong>attributes</strong>, a nested Hash of properties that describe how the host +should be configured, a <strong>chef_environment</strong>, a String representing the +environment to which the node belongs, and a <strong>run_list</strong>, an ordered +list of <strong>recipes</strong> or <strong>roles</strong> that chef-client should apply when +configuring a host.</p> + +<p>When a host communicates with a Chef Server, it authenticates using its +<strong>node_name</strong> for identification and signs its reqests with a private +key. The Server validates the request by looking up a <strong>client</strong> object +with a name identical to the <strong>node_name</strong> submitted with the request +and verifes the signature using the public key for that <strong>client</strong> +object. <strong>NOTE</strong> that the <strong>client</strong> is a different object in the +system. It is associated with a node by virtue of having a matching +name.</p> + +<p>By default <strong>chef-client</strong>(8) will create a node using the FQDN of the +host for the node name, though this may be overridden by configuration +settings.</p> + +<h2 id="NODE-SUB-COMMANDS">NODE SUB-COMMANDS</h2> + +<h2 id="BULK-DELETE">BULK DELETE</h2> + +<p><strong>knife node bulk delete</strong> <em>regex</em> <em>(options)</em></p> + +<p>Deletes nodes for which the name matches the regular expression <em>regex</em> +on the Chef Server. The regular expression should be given in quotes, +and should not be surrounded with forward slashes (as is typical of +regular expression literals in scripting languages).</p> + +<h2 id="CREATE">CREATE</h2> + +<p><strong>knife node create</strong> <em>name</em> <em>(options)</em></p> + +<p>Create a new node. Unless the --no-editor option is given, an empty node +object will be created and displayed in your text editor. If the editor +exits with a successful exit status, the node data will be posted to the +Chef Server to create the node.</p> + +<h2 id="DELETE">DELETE</h2> + +<p><strong>knife node delete</strong> <em>name</em> <em>(options)</em></p> + +<p>Deletes the node identified by <em>name</em> on the Chef Server.</p> + +<h2 id="EDIT">EDIT</h2> + +<p><strong>knife node edit</strong> <em>name</em> <em>(options)</em></p> + +<dl> +<dt><code>-a</code>, <code>--all</code></dt><dd>Display all node data in the editor. By default, default, override, +and automatic attributes are not shown.</dd> +</dl> + + +<p>Edit the node identified by <em>name</em>. Like <strong>knife node create</strong>, the node +will be displayed in your text editor unless the -n option is present.</p> + +<h2 id="FROM-FILE">FROM FILE</h2> + +<p><strong>knife node from file</strong> <em>file</em> <em>(options)</em></p> + +<p>Create a node from a JSON format <em>file</em>.</p> + +<h2 id="LIST">LIST</h2> + +<p><strong>knife node list</strong> <em>(options)</em></p> + +<dl> +<dt><code>-w</code>, <code>--with-uri</code></dt><dd>Show corresponding URIs</dd> +</dl> + + +<p>List all nodes.</p> + +<h2 id="RUN_LIST-ADD">RUN_LIST ADD</h2> + +<p><strong>knife node run_list add</strong> <em>name</em> <em>run list item</em> <em>(options)</em></p> + +<dl> +<dt><code>-a</code>, <code>--after ITEM</code></dt><dd>Place the ENTRY in the run list after ITEM</dd> +</dl> + + +<p>Add the <em>run list item</em> to the node's <code>run_list</code>. See Run list</p> + +<h2 id="RUN_LIST-REMOVE">RUN_LIST REMOVE</h2> + +<p><strong>knife node run_list remove</strong> <em>node name</em> <em>run list item</em> <em>(options)</em></p> + +<p>Remove the <em>run list item</em> from the node's <code>run_list</code>.</p> + +<h2 id="SHOW">SHOW</h2> + +<p><strong>knife node show</strong> <em>node name</em> <em>(options)</em></p> + +<dl> +<dt><code>-a</code>, <code>--attribute [ATTR]</code></dt><dd>Show only one attribute</dd> +<dt><code>-r</code>, <code>--run-list </code></dt><dd>Show only the run list</dd> +<dt><code>-F</code>, <code>--format FORMAT</code></dt><dd>Display the node in a different format.</dd> +<dt><code>-m</code>, <code>--medium</code></dt><dd>Display more, but not all, of the node's data when using the default +<em>summary</em> format</dd> +</dl> + + +<p>Displays the node identified by <em>node name</em> on stdout. The amount of +content displayed and the output format are modified by the --format +option. Valid formats are:</p> + +<ul> +<li>summary: +displays the node in a custom, summarized format</li> +<li>text +displays the node data in its entirety using the colorized tree +display</li> +<li>json: +displays the node in JSON format</li> +<li>yaml: +displays the node in YAML format</li> +<li>pp +displays the node using Ruby's pretty printer.</li> +</ul> + + +<p>For brevity, only the first character of the format is required, for +example, -Fj will produce JSON format output.</p> + +<h2 id="RUN-LIST-ITEM-FORMAT">RUN LIST ITEM FORMAT</h2> + +<p>Run list items may be either roles or recipes. When adding a role to a +run list, the correct syntax is "role[ROLE_NAME]"</p> + +<p>When adding a recipe to a run list, there are several valid formats:</p> + +<dl> +<dt>Fully Qualified Format</dt><dd>"recipe[COOKBOOK::RECIPE_NAME]", for example, "recipe[chef::client]"</dd> +<dt>Cookbook Recipe Format</dt><dd>For brevity, the recipe part of the fully qualified format may be omitted, and recipes specified as "COOKBOOK::RECIPE_NAME", e.g., "chef::client"</dd> +<dt>Default Recipe Format</dt><dd>When adding the default recipe of a cookbook to a run list, the recipe name may be omitted as well, e.g., "chef::default" may be written as just "chef"</dd> +</dl> + + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong>knife-client</strong>(1) <strong>knife-search</strong>(1) <strong>knife-role</strong>(1)</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p> Chef was written by Adam Jacob <a href="mailto:adam@opscode.com" data-bare-link="true">adam@opscode.com</a> with many contributions from the community.</p> + +<h2 id="DOCUMENTATION">DOCUMENTATION</h2> + +<p> This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</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> Knife 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.7</li> + <li class='tc'>April 2011</li> + <li class='tr'>knife-node(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/chef/distro/common/html/knife-node.8.html b/chef/distro/common/html/knife-node.8.html deleted file mode 100644 index 5f84d25b20..0000000000 --- a/chef/distro/common/html/knife-node.8.html +++ /dev/null @@ -1,141 +0,0 @@ -<!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>knife-node(8) - Chef Server REST API utility</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> -</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="#NODE-SUB-COMMANDS">NODE SUB-COMMANDS</a> - </div> - - <ol class='man-decor man-head man head'> - <li class='tl'>knife-node(8)</li> - <li class='tc'>Chef Manual</li> - <li class='tr'>knife-node(8)</li> - </ol> - - <h2 id="NAME">NAME</h2> -<p class="man-name"> - <code>knife-node</code> - <span class="man-whatis">Chef Server REST API utility</span> -</p> - -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<p><strong>knife</strong> <strong>node</strong> <em>sub-command</em> <em>(options)</em></p> - -<h2 id="NODE-SUB-COMMANDS">NODE SUB-COMMANDS</h2> - -<p>Nodes are the entities which are configured with Chef. Typically these are servers or workstations. Nodes are registered as a client, by default by the fully qualified domain name (fqdn). A single client may configure more than one node.</p> - -<p><strong>node bulk delete REGEX</strong> <em>(options)</em></p> - -<p>Delete nodes on the Chef Server based on a regular expression. The regular expression (<em>REGEX</em>) should be in quotes, not in //'s.</p> - -<p><strong>node create NODE</strong> <em>(options)</em></p> - -<p>Create a new node.</p> - -<p><strong>node delete NODE</strong> <em>(options)</em></p> - -<p>Delete a single node.</p> - -<p><strong>node edit NODE</strong> <em>(options)</em></p> - -<p>Edit a node.</p> - -<p><strong>node from file FILE</strong> <em>(options)</em></p> - -<p>Create a node from a JSON file.</p> - -<p><strong>node list</strong> <em>(options)</em></p> - -<dl> -<dt><code>-w</code>, <code>--with-uri</code></dt><dd>Show corresponding URIs</dd> -</dl> - - -<p>List all nodes.</p> - -<p><code>node run_list add [NODE] [ENTRY]</code> <em>(options)</em></p> - -<dl> -<dt><code>-a</code>, <code>--after ITEM</code></dt><dd>Place the ENTRY in the run list after ITEM</dd> -</dl> - - -<p>Add a recipe or role to the node's <code>run_list</code>.</p> - -<p><code>node run_list remove [NODE] [ENTRY]</code> <em>(options)</em></p> - -<p>Remove a recipe or role from the node's <code>run_list</code>.</p> - -<p><strong>node show NODE</strong> <em>(options)</em></p> - -<dl> -<dt><code>-a</code>, <code>--attribute [ATTR]</code></dt><dd>Show only one attribute</dd> -<dt><code>-r</code>, <code>--run-list </code></dt><dd>Show only the run list</dd> -</dl> - - -<p>Show a node.</p> - - - <ol class='man-decor man-foot man foot'> - <li class='tl'>Chef 0.10.0.beta.7</li> - <li class='tc'>April 2011</li> - <li class='tr'>knife-node(8)</li> - </ol> - - </div> -</body> -</html> diff --git a/chef/distro/common/html/knife-recipe.8.html b/chef/distro/common/html/knife-recipe.1.html index 8021dd7f96..64d29ff82a 100644 --- a/chef/distro/common/html/knife-recipe.8.html +++ b/chef/distro/common/html/knife-recipe.1.html @@ -3,7 +3,7 @@ <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>knife-recipe(8) - Chef Server REST API utility</title> + <title>knife-recipe(1) - List the recipes available on a Chef Server</title> <style type='text/css' media='all'> /* style: man */ body#manpage {margin:0} @@ -41,6 +41,12 @@ 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: @@ -58,14 +64,14 @@ </div> <ol class='man-decor man-head man head'> - <li class='tl'>knife-recipe(8)</li> + <li class='tl'>knife-recipe(1)</li> <li class='tc'>Chef Manual</li> - <li class='tr'>knife-recipe(8)</li> + <li class='tr'>knife-recipe(1)</li> </ol> <h2 id="NAME">NAME</h2> <p class="man-name"> - <code>knife-recipe</code> - <span class="man-whatis">Chef Server REST API utility</span> + <code>knife-recipe</code> - <span class="man-whatis">List the recipes available on a Chef Server</span> </p> <h2 id="SYNOPSIS">SYNOPSIS</h2> @@ -78,7 +84,7 @@ <ol class='man-decor man-foot man foot'> <li class='tl'>Chef 0.10.0.beta.7</li> <li class='tc'>April 2011</li> - <li class='tr'>knife-recipe(8)</li> + <li class='tr'>knife-recipe(1)</li> </ol> </div> diff --git a/chef/distro/common/html/knife-role.8.html b/chef/distro/common/html/knife-role.1.html index bfb4c121b5..f43e3d9f80 100644 --- a/chef/distro/common/html/knife-role.8.html +++ b/chef/distro/common/html/knife-role.1.html @@ -3,7 +3,7 @@ <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>knife-role(8) - Chef Server REST API utility</title> + <title>knife-role(1) - Group common configuration settings</title> <style type='text/css' media='all'> /* style: man */ body#manpage {margin:0} @@ -41,6 +41,12 @@ 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: @@ -59,14 +65,14 @@ </div> <ol class='man-decor man-head man head'> - <li class='tl'>knife-role(8)</li> + <li class='tl'>knife-role(1)</li> <li class='tc'>Chef Manual</li> - <li class='tr'>knife-role(8)</li> + <li class='tr'>knife-role(1)</li> </ol> <h2 id="NAME">NAME</h2> <p class="man-name"> - <code>knife-role</code> - <span class="man-whatis">Chef Server REST API utility</span> + <code>knife-role</code> - <span class="man-whatis">Group common configuration settings</span> </p> <h2 id="SYNOPSIS">SYNOPSIS</h2> @@ -122,7 +128,7 @@ <ol class='man-decor man-foot man foot'> <li class='tl'>Chef 0.10.0.beta.7</li> <li class='tc'>April 2011</li> - <li class='tr'>knife-role(8)</li> + <li class='tr'>knife-role(1)</li> </ol> </div> diff --git a/chef/distro/common/html/knife-search.8.html b/chef/distro/common/html/knife-search.1.html index eb9573780c..9135cacd36 100644 --- a/chef/distro/common/html/knife-search.8.html +++ b/chef/distro/common/html/knife-search.1.html @@ -3,7 +3,7 @@ <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>knife-search(8) - Chef Server REST API utility</title> + <title>knife-search(1) - Find objects on a Chef Server by query</title> <style type='text/css' media='all'> /* style: man */ body#manpage {margin:0} @@ -41,6 +41,12 @@ 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: @@ -58,14 +64,14 @@ </div> <ol class='man-decor man-head man head'> - <li class='tl'>knife-search(8)</li> + <li class='tl'>knife-search(1)</li> <li class='tc'>Chef Manual</li> - <li class='tr'>knife-search(8)</li> + <li class='tr'>knife-search(1)</li> </ol> <h2 id="NAME">NAME</h2> <p class="man-name"> - <code>knife-search</code> - <span class="man-whatis">Chef Server REST API utility</span> + <code>knife-search</code> - <span class="man-whatis">Find objects on a Chef Server by query</span> </p> <h2 id="SYNOPSIS">SYNOPSIS</h2> @@ -88,7 +94,7 @@ <ol class='man-decor man-foot man foot'> <li class='tl'>Chef 0.10.0.beta.7</li> <li class='tc'>April 2011</li> - <li class='tr'>knife-search(8)</li> + <li class='tr'>knife-search(1)</li> </ol> </div> diff --git a/chef/distro/common/html/knife-ssh.8.html b/chef/distro/common/html/knife-ssh.1.html index b2c6b4df02..671f12c335 100644 --- a/chef/distro/common/html/knife-ssh.8.html +++ b/chef/distro/common/html/knife-ssh.1.html @@ -3,7 +3,7 @@ <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>knife-ssh(8) - Chef Server REST API utility</title> + <title>knife-ssh(1) - Run a command or interactive session on multiple remote hosts</title> <style type='text/css' media='all'> /* style: man */ body#manpage {margin:0} @@ -41,6 +41,12 @@ 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: @@ -58,14 +64,14 @@ </div> <ol class='man-decor man-head man head'> - <li class='tl'>knife-ssh(8)</li> + <li class='tl'>knife-ssh(1)</li> <li class='tc'>Chef Manual</li> - <li class='tr'>knife-ssh(8)</li> + <li class='tr'>knife-ssh(1)</li> </ol> <h2 id="NAME">NAME</h2> <p class="man-name"> - <code>knife-ssh</code> - <span class="man-whatis">Chef Server REST API utility</span> + <code>knife-ssh</code> - <span class="man-whatis">Run a command or interactive session on multiple remote hosts</span> </p> <h2 id="SYNOPSIS">SYNOPSIS</h2> @@ -87,7 +93,7 @@ <ol class='man-decor man-foot man foot'> <li class='tl'>Chef 0.10.0.beta.7</li> <li class='tc'>April 2011</li> - <li class='tr'>knife-ssh(8)</li> + <li class='tr'>knife-ssh(1)</li> </ol> </div> diff --git a/chef/distro/common/html/knife-status.8.html b/chef/distro/common/html/knife-status.1.html index 5de356054b..dd1b3079e2 100644 --- a/chef/distro/common/html/knife-status.8.html +++ b/chef/distro/common/html/knife-status.1.html @@ -3,7 +3,7 @@ <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>knife-status(8) - Chef Server REST API utility</title> + <title>knife-status(1) - Display status information for the nodes in your infrastructure</title> <style type='text/css' media='all'> /* style: man */ body#manpage {margin:0} @@ -41,6 +41,12 @@ 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: @@ -58,14 +64,14 @@ </div> <ol class='man-decor man-head man head'> - <li class='tl'>knife-status(8)</li> + <li class='tl'>knife-status(1)</li> <li class='tc'>Chef Manual</li> - <li class='tr'>knife-status(8)</li> + <li class='tr'>knife-status(1)</li> </ol> <h2 id="NAME">NAME</h2> <p class="man-name"> - <code>knife-status</code> - <span class="man-whatis">Chef Server REST API utility</span> + <code>knife-status</code> - <span class="man-whatis">Display status information for the nodes in your infrastructure</span> </p> <h2 id="SYNOPSIS">SYNOPSIS</h2> @@ -83,7 +89,7 @@ <ol class='man-decor man-foot man foot'> <li class='tl'>Chef 0.10.0.beta.7</li> <li class='tc'>April 2011</li> - <li class='tr'>knife-status(8)</li> + <li class='tr'>knife-status(1)</li> </ol> </div> diff --git a/chef/distro/common/html/knife-tag.8.html b/chef/distro/common/html/knife-tag.1.html index e59811f898..dfcd9c4be7 100644 --- a/chef/distro/common/html/knife-tag.8.html +++ b/chef/distro/common/html/knife-tag.1.html @@ -3,7 +3,7 @@ <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>knife(8) - Chef Server REST API utility</title> + <title>knife-tag(1) - Apply tags to nodes on a Chef Server</title> <style type='text/css' media='all'> /* style: man */ body#manpage {margin:0} @@ -41,6 +41,12 @@ 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: @@ -59,14 +65,14 @@ </div> <ol class='man-decor man-head man head'> - <li class='tl'>knife(8)</li> + <li class='tl'>knife-tag(1)</li> <li class='tc'>Chef Manual</li> - <li class='tr'>knife(8)</li> + <li class='tr'>knife-tag(1)</li> </ol> <h2 id="NAME">NAME</h2> <p class="man-name"> - <code>knife</code> - <span class="man-whatis">Chef Server REST API utility</span> + <code>knife-tag</code> - <span class="man-whatis">Apply tags to nodes on a Chef Server</span> </p> <h2 id="SYNOPSIS">SYNOPSIS</h2> @@ -79,7 +85,7 @@ <ol class='man-decor man-foot man foot'> <li class='tl'>Chef 0.10.0.beta.7</li> <li class='tc'>April 2011</li> - <li class='tr'>knife(8)</li> + <li class='tr'>knife-tag(1)</li> </ol> </div> diff --git a/chef/distro/common/html/knife.8.html b/chef/distro/common/html/knife.1.html index 97b2faf9d5..b5c1d4d2a8 100644 --- a/chef/distro/common/html/knife.8.html +++ b/chef/distro/common/html/knife.1.html @@ -3,7 +3,7 @@ <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>knife(8) - Chef Server REST API utility</title> + <title>knife(1) - Chef Server REST API utility</title> <style type='text/css' media='all'> /* style: man */ body#manpage {margin:0} @@ -41,6 +41,12 @@ 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: @@ -63,14 +69,15 @@ <a href="#FILES">FILES</a> <a href="#CHEF-WORKFLOW">CHEF WORKFLOW</a> <a href="#EXAMPLES">EXAMPLES</a> + <a href="#ENVIRONMENT">ENVIRONMENT</a> <a href="#SEE-ALSO">SEE ALSO</a> <a href="#AUTHOR">AUTHOR</a> </div> <ol class='man-decor man-head man head'> - <li class='tl'>knife(8)</li> + <li class='tl'>knife(1)</li> <li class='tc'>Chef Manual</li> - <li class='tr'>knife(8)</li> + <li class='tr'>knife(1)</li> </ol> <h2 id="NAME">NAME</h2> @@ -84,11 +91,19 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>This manual page documents knife, a command-line utility used to interact with a Chef server directly through the RESTful API. Knife uses sub-commands to take various actions on different types of Chef objects. Some sub-commands take additional options. General options follow sub-commands and their options. A configuration file can be created for common defaults.</p> +<p>This manual page documents knife, a command-line utility used to +interact with a Chef server directly through the RESTful API. Knife uses +sub-commands to take various actions on different types of Chef objects. +Some sub-commands take additional options. General options follow +sub-commands and their options. A configuration file can be created for +common defaults.</p> -<p>Unless otherwise specified, output is in JSON format, and input files are also JSON format.</p> +<p>Unless otherwise specified, output is in JSON format, and input files +are also JSON format.</p> -<p>The Chef class <code>Chef::Config</code> that configures the behavior of how knife runs has options that correspond to command-line options. These are noted as <code>Chef::Config</code> values.</p> +<p>The Chef class <code>Chef::Config</code> that configures the behavior of how knife +runs has options that correspond to command-line options. These are +noted as <code>Chef::Config</code> values.</p> <h2 id="GENERAL-OPTIONS">GENERAL OPTIONS</h2> @@ -113,7 +128,9 @@ <h2 id="SUB-COMMANDS">SUB-COMMANDS</h2> -<p>Knife sub-commands are structured as <em>NOUN verb NOUN (options)</em>. The sub-commands are meant to be intuitively named. Because the Chef Server API is RESTful, sub-commands generally utilize CRUD operations.</p> +<p>Knife sub-commands are structured as <em>NOUN verb NOUN (options)</em>. The +sub-commands are meant to be intuitively named. Because the Chef Server +API is RESTful, sub-commands generally utilize CRUD operations.</p> <ul> <li>create (create)</li> @@ -133,7 +150,11 @@ <h2 id="CONFIGURATION">CONFIGURATION</h2> -<p>The knife configuration file is a Ruby DSL to set configuration parameters for Knife's <strong>GENERAL OPTIONS</strong>. The default location for the config file is <code>~/.chef/knife.rb</code>. If managing multiple Chef repositories, per-repository config files can be created. The file must be <code>.chef/knife.rb</code> in the current directory of the repository.</p> +<p>The knife configuration file is a Ruby DSL to set configuration +parameters for Knife's <strong>GENERAL OPTIONS</strong>. The default location for the +config file is <code>~/.chef/knife.rb</code>. If managing multiple Chef +repositories, per-repository config files can be created. The file must +be <code>.chef/knife.rb</code> in the current directory of the repository.</p> <p>If the config file exists, knife uses these settings for <strong>GENERAL OPTIONS</strong> defaults.</p> @@ -151,41 +172,63 @@ <p><code>log_location</code></p> -<p>Corresponds to the <code>-L</code> or <code>--log-file</code> option. Defaults is <strong>STDOUT</strong>. Valid values are <strong>STDOUT</strong> or a filename.</p> +<p>Corresponds to the <code>-L</code> or <code>--log-file</code> option. Defaults is <strong>STDOUT</strong>. +Valid values are <strong>STDOUT</strong> or a filename.</p> <p><code>node_name</code></p> -<p>User to authenticate to the Chef server. Corresponds to the <code>-u</code> or <code>--user</code> option. This is requested from the user when running this sub-command.</p> +<p>User to authenticate to the Chef server. Corresponds to the <code>-u</code> or +<code>--user</code> option. This is requested from the user when running this +sub-command.</p> <p><code>client_key</code></p> -<p>Private key file to authenticate to the Chef server. Corresponds to the <code>-k</code> or <code>--key</code> option. This is requested from the user when running this sub-command.</p> +<p>Private key file to authenticate to the Chef server. Corresponds to the +<code>-k</code> or <code>--key</code> option. This is requested from the user when running +this sub-command.</p> <p><code>chef_server_url</code></p> -<p>URL of the Chef server. Corresponds to the <code>-s</code> or <code>--server-url</code> option. This is requested from the user when running this sub-command.</p> +<p>URL of the Chef server. Corresponds to the <code>-s</code> or <code>--server-url</code> +option. This is requested from the user when running this sub-command.</p> <p><code>cache_type</code></p> -<p>The type of cache to use. Default is BasicFile. This can be any type of Cache that moneta supports: BasicFile, Berkeley, Couch, DataMapper, File, LMC, Memcache, Memory, MongoDB, Redis, Rufus, S3, SDBM, Tyrant, Xattr, YAML.</p> +<p>The type of cache to use. Default is BasicFile. This can be any type of +Cache that moneta supports: BasicFile, Berkeley, Couch, DataMapper, +File, LMC, Memcache, Memory, MongoDB, Redis, Rufus, S3, SDBM, Tyrant, +Xattr, YAML.</p> <p><code>cache_options</code></p> -<p>Specifies various options to use for caching. Default reads the Chef client configuration (/etc/chef/checksums).</p> +<p>Specifies various options to use for caching. Default reads the Chef +client configuration (/etc/chef/checksums).</p> <p><code>validation_client_name</code></p> -<p>Specifies the name of the client used to validate new clients. This is requested from the user when running the configuration sub-command.</p> +<p>Specifies the name of the client used to validate new clients. This is +requested from the user when running the configuration sub-command.</p> <p><code>validation_key</code></p> -<p>Specifies the private key file to use for generating ec2 instance data for validating new clients. This is implied from the <code>validation_client_name</code>.</p> +<p>Specifies the private key file to use for generating ec2 instance data +for validating new clients. This is implied from the +<code>validation_client_name</code>.</p> <p><code>cookbook_copyright</code> <code>cookbook_email</code> <code>cookbook_license</code></p> -<p>Used by <code>knife cookbook create</code> sub-command to specify the copyright holder, maintainer email and license (respectively) for new cookbooks. The copyright holder is listed as the maintainer in the cookbook's metadata and as the Copyright in the comments of the default recipe. The maintainer email is used in the cookbook metadata. The license determines what preamble to put in the comment of the default recipe, and is listed as the license in the cookbook metadata. Currently supported licenses are "apachev2" and "none". Any other values will result in an empty license in the metadata (needs to be filled in by the author), and no comment preamble in the default recipe.</p> +<p>Used by <code>knife cookbook create</code> sub-command to specify the copyright +holder, maintainer email and license (respectively) for new cookbooks. +The copyright holder is listed as the maintainer in the cookbook's +metadata and as the Copyright in the comments of the default recipe. The +maintainer email is used in the cookbook metadata. The license +determines what preamble to put in the comment of the default recipe, +and is listed as the license in the cookbook metadata. Currently +supported licenses are "apachev2" and "none". Any other values will +result in an empty license in the metadata (needs to be filled in by the +author), and no comment preamble in the default recipe.</p> <p><code>knife[:aws_access_key_id]</code> <code>knife[:aws_secret_access_key]</code></p> @@ -229,11 +272,16 @@ </ul> -<p>A note about git: Opscode and many folks in the Chef community use git, but it is not required, except in the case of the <code>cookbook site vendor</code> sub-command, as it uses git directly. Version control is strongly recommended though, and git fits with a lot of the workflow paradigms.</p> +<p>A note about git: Opscode and many folks in the Chef community use git, +but it is not required, except in the case of the <code>cookbook site vendor</code> +sub-command, as it uses git directly. Version control is strongly +recommended though, and git fits with a lot of the workflow paradigms.</p> <h2 id="EXAMPLES">EXAMPLES</h2> -<p>Example client config (<code>/etc/chef/client.rb</code>) from <code>knife configure client</code>. The same configuration is used when using the <code>knife bootstrap</code> command with the default <code>gem</code> templates that come with Chef.</p> +<p>Example client config (<code>/etc/chef/client.rb</code>) from <code>knife configure +client</code>. The same configuration is used when using the <code>knife bootstrap</code> +command with the default <code>gem</code> templates that come with Chef.</p> <pre><code>log_level :info log_location STDOUT @@ -241,13 +289,19 @@ chef_server_url 'https://api.opscode.com/organizations/ORGNAME' validation_client_name 'ORGNAME-validator' </code></pre> -<p>Setting up a custom bootstrap is fairly straightforward. Create <code>.chef/bootstrap</code> in your Chef Repository directory or in <code>$HOME/.chef/bootstrap</code>. Then create the ERB template file.</p> +<p>Setting up a custom bootstrap is fairly straightforward. Create +<code>.chef/bootstrap</code> in your Chef Repository directory or in +<code>$HOME/.chef/bootstrap</code>. Then create the ERB template file.</p> <pre><code>mkdir ~/.chef/bootstrap vi ~/.chef/bootstrap/debian5.0-apt.erb </code></pre> -<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:</p> +<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:</p> <pre><code>knife bootstrap mynode.example.com --template-file ~/.chef/bootstrap/debian5.0-apt.erb </code></pre> @@ -257,15 +311,27 @@ vi ~/.chef/bootstrap/debian5.0-apt.erb <pre><code>knife bootstrap mynode.example.com --distro debian5.0-apt </code></pre> -<p>The <code>--distro</code> parameter will automatically look in the <code>~/.chef/bootstrap</code> directory for a file named <code>debian5.0-apt.erb</code>.</p> +<p>The <code>--distro</code> parameter will automatically look in the +<code>~/.chef/bootstrap</code> directory for a file named <code>debian5.0-apt.erb</code>.</p> -<p>Templates provided by the Chef installation are located in <code>BASEDIR/lib/chef/knife/bootstrap/*.erb</code>, where <em>BASEDIR</em> is the location where the package or Gem installed the Chef client libraries.</p> +<p>Templates provided by the Chef installation are located in +<code>BASEDIR/lib/chef/knife/bootstrap/*.erb</code>, where <em>BASEDIR</em> is the +location where the package or Gem installed the Chef client libraries.</p> <p>Uploading cookbooks to the Opscode cookbooks site using the user/certificate specifically:</p> <pre><code>knife cookbook site share example Other -k ~/.chef/USERNAME.pem -u USERNAME </code></pre> +<h2 id="ENVIRONMENT">ENVIRONMENT</h2> + +<dl> +<dt class="flush"><code>EDITOR</code></dt><dd>The text editor to use for editing data. The --editor option takes +precedence over this value, and the --no-editor option supresses +data editing entirely.</dd> +</dl> + + <h2 id="SEE-ALSO">SEE ALSO</h2> <p>Full documentation for Chef is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home/.</p> @@ -280,7 +346,7 @@ vi ~/.chef/bootstrap/debian5.0-apt.erb <h2 id="AUTHOR">AUTHOR</h2> -<p>Chef was written by Adam Jacob <a href="mailto:adam@opscode.com" data-bare-link="true">adam@opscode.com</a> of Opscode (http://www.opscode.com), with contributions from the community. This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</a>. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p> +<p>Chef was written by Adam Jacob <a href="mailto:adam@opscode.com" data-bare-link="true">adam@opscode.com</a> of Opscode (<a href="http://www.opscode.com" data-bare-link="true">http://www.opscode.com</a>), with contributions from the community. This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</a>. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p> <p>On Debian systems, the complete text of the Apache 2.0 License can be found in <code>/usr/share/common-licenses/Apache-2.0</code>.</p> @@ -288,7 +354,7 @@ vi ~/.chef/bootstrap/debian5.0-apt.erb <ol class='man-decor man-foot man foot'> <li class='tl'>Chef 0.10.0.beta.7</li> <li class='tc'>April 2011</li> - <li class='tr'>knife(8)</li> + <li class='tr'>knife(1)</li> </ol> </div> diff --git a/chef/distro/common/man/man1/knife-bootstrap.1 b/chef/distro/common/man/man1/knife-bootstrap.1 index 333ad178e9..187f2ff0e8 100644 --- a/chef/distro/common/man/man1/knife-bootstrap.1 +++ b/chef/distro/common/man/man1/knife-bootstrap.1 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE\-BOOTRAP" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-BOOTRAP" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\-bootrap\fR \- Chef Server REST API utility +\fBknife\-bootrap\fR \- Install Chef Client on a remote host . .SH "SYNOPSIS" \fBknife\fR \fBbootstrap\fR \fI(options)\fR @@ -57,7 +57,7 @@ Bootstrap a distro using a template 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\. . .P -As of Chef 0\.9\.8, 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 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: +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: . .IP "\(bu" 4 \fBbootstrap\fR directory in the installed Chef Knife library\. @@ -123,3 +123,15 @@ 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 "SEE ALSO" +\fBknife\-ssh\fR(1) +. +.SH "AUTHOR" +Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\. +. +.SH "DOCUMENTATION" +This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\. +. +.SH "CHEF" +Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR diff --git a/chef/distro/common/man/man1/knife-client.1 b/chef/distro/common/man/man1/knife-client.1 index efcf3a9874..234fd61236 100644 --- a/chef/distro/common/man/man1/knife-client.1 +++ b/chef/distro/common/man/man1/knife-client.1 @@ -1,25 +1,33 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE\-CLIENT" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-CLIENT" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\-client\fR \- Chef Server REST API utility +\fBknife\-client\fR \- Manage Chef API Clients . .SH "SYNOPSIS" \fBknife\fR \fBclient\fR \fIsub\-command\fR \fI(options)\fR . -.SH "CLIENT SUB\-COMMANDS" -Clients are entities that communicate with the Chef Server API\. +.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 -\fBclient bulk delete REGEX\fR \fI(options)\fR +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 -Delete clients on the Chef Server based on a regular expression\. The regular expression (\fIREGEX\fR) should be in quotes, not in //\'s\. +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 "BULK DELETE" +\fBknife client bulk delete\fR \fIregex\fR \fI(options)\fR . .P -\fBclient create CLIENT\fR \fI(options)\fR +Delete clients where the client name matches the regular expression \fIregex\fR on the Chef Server\. The regular expression should be given as a quoted string, and not surrounded by forward slashes\. +. +.SH "CREATE" +\fBknife client create\fR \fIclient name\fR \fI(options)\fR . .TP \fB\-a\fR, \fB\-\-admin\fR @@ -33,21 +41,21 @@ Write the key to a file Create a new client\. This generates an RSA keypair\. The private key will be displayed on \fISTDOUT\fR or written to the named file\. The public half will be stored on the Server\. For \fIchef\-client\fR systems, the private key should be copied to the system as \fB/etc/chef/client\.pem\fR\. . .P -Admin clients should be created for users that will use \fIknife\fR to access the API as an administrator\. The private key will generally be copied to \fB~/\.chef/CLIENT\.pem\fR and referenced in the \fBknife\.rb\fR configuration file\. +Admin clients should be created for users that will use \fIknife\fR to access the API as an administrator\. The private key will generally be copied to \fB~/\.chef/client\e_name\.pem\fR and referenced in the \fBknife\.rb\fR configuration file\. . -.P -\fBclient delete CLIENT\fR \fI(options)\fR +.SH "DELETE" +\fBknife client delete\fR \fIclient name\fR \fI(options)\fR . .P Deletes a registered client\. . -.P -\fBclient edit CLIENT\fR \fI(options)\fR +.SH "EDIT" +\fBclient edit\fR \fIclient name\fR \fI(options)\fR . .P Edit a registered client\. . -.P +.SH "LIST" \fBclient list\fR \fI(options)\fR . .TP @@ -57,22 +65,34 @@ Show corresponding URIs .P List all registered clients\. . -.P -\fBclient reregister CLIENT\fR \fI(options)\fR +.SH "REREGISTER" +\fBclient reregister\fR \fIclient name\fR \fI(options)\fR . .TP \fB\-f\fR, \fB\-\-file FILE\fR Write the key to a file . .P -Regenerate the RSA keypair for a client\. The public half will be stored on the server and the private key displayed on \fISTDOUT\fR or written to the named file\. +Regenerate the RSA keypair for a client\. The public half will be stored on the server and the private key displayed on \fISTDOUT\fR or written to the named file\. This operation will invalidate the previous keypair used by the client, preventing it from authenticating with the Chef Server\. Use care when reregistering the validator client\. . -.P -\fBclient show CLIENT\fR \fI(options)\fR +.SH "SHOW" +\fBclient show\fR \fIclient name\fR \fI(options)\fR . .TP \fB\-a\fR, \fB\-\-attribute ATTR\fR Show only one attribute . .P -Show a client\. +Show a client\. Output format is determined by the \-\-format option\. +. +.SH "SEE ALSO" +\fBknife\-node\fR(1) +. +.SH "AUTHOR" +Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\. +. +.SH "DOCUMENTATION" +This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\. +. +.SH "CHEF" +Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR diff --git a/chef/distro/common/man/man1/knife-configure.1 b/chef/distro/common/man/man1/knife-configure.1 index 5b16451fc3..fba822cdf7 100644 --- a/chef/distro/common/man/man1/knife-configure.1 +++ b/chef/distro/common/man/man1/knife-configure.1 @@ -1,16 +1,19 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE\-CONFIGURE" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-CONFIGURE" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\-configure\fR \- Chef Server REST API utility +\fBknife\-configure\fR \- Generate configuration files for knife or Chef Client . .SH "SYNOPSIS" \fBknife\fR \fBconfigure\fR [client] \fI(options)\fR . +.SH "DESCRIPTION" +Generates a knife\.rb configuration file interactively\. When given the \-\-initial option, also creates a new administrative user\. +. .SH "CONFIGURE SUBCOMMANDS" -\fBconfigure\fR \fI(options)\fR +\fBknife configure\fR \fI(options)\fR . .TP \fB\-i\fR, \fB\-\-initial\fR @@ -21,10 +24,65 @@ Create an initial API Client The path to your chef\-repo . .P -Create a configuration file for knife\. This will prompt for values to enter into the file\. Default values are listed in square brackets if no other entry is typed\. See \fBCONFIGURATION\fR below for available options\. +Create a configuration file for knife\. This will prompt for values to enter into the file\. Default values are listed in square brackets if no other entry is typed\. See \fBknife\fR(1) for a description of configuration options\. . .P -\fBconfigure client DIRECTORY\fR +\fBknife configure client\fR \fIdirectory\fR . .P -Read the \fBknife\.rb\fR config file and generate a config file suitable for use in \fB/etc/chef/client\.rb\fR and copy the validation certificate into the specified \fIDIRECTORY\fR\. +Read the \fIknife\.rb\fR config file and generate a config file suitable for use in \fI/etc/chef/client\.rb\fR and copy the validation certificate into the specified \fIdirectory\fR\. +. +.SH "EXAMPLES" +. +.IP "\(bu" 4 +On a freshly installed Chef Server, use \fIknife configure \-i\fR to create an administrator and knife configuration file\. Leave the field blank to accept the default value\. On most systems, the default values are acceptable\. +. +.IP +user@host$ knife configure \-i +. +.br +Please enter the chef server URL: [http://localhost:4000] +. +.br +Please enter a clientname for the new client: [username] +. +.br +Please enter the existing admin clientname: [chef\-webui] +. +.br +Please enter the location of the existing admin client\'s private key: [/etc/chef/webui\.pem] +. +.br +Please enter the validation clientname: [chef\-validator] +. +.br +Please enter the location of the validation key: [/etc/chef/validation\.pem] +. +.br +Please enter the path to a chef repository (or leave blank): +. +.br +Creating initial API user\.\.\. +. +.br +Created (or updated) client[username] +. +.br +Configuration file written to /home/username/\.chef/knife\.rb +. +.IP +This creates a new administrator client named \fIusername\fR, writes a configuration file to \fI/home/username/\.chef/knife\.rb\fR, and the private key to \fI/home/username/\.chef/username\.pem\fR\. The configuration file and private key may be copied to another system to facilitate administration of the Chef Server from a remote system\. Depending on the value given for the Chef Server URL, you may need to modify that setting after copying to a remote host\. +. +.IP "" 0 +. +.SH "SEE ALSO" +\fBknife\fR(1) \fBknife\-client\fR(1) +. +.SH "AUTHOR" +Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\. +. +.SH "DOCUMENTATION" +This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\. +. +.SH "CHEF" +Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR diff --git a/chef/distro/common/man/man1/knife-cookbook-site.1 b/chef/distro/common/man/man1/knife-cookbook-site.1 index 96bb45d32f..45c1aa4305 100644 --- a/chef/distro/common/man/man1/knife-cookbook-site.1 +++ b/chef/distro/common/man/man1/knife-cookbook-site.1 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE\-COOKBOOK\-SITE" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-COOKBOOK\-SITE" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\-cookbook\-site\fR \- Chef Server REST API utility +\fBknife\-cookbook\-site\fR \- Install and update open source cookbooks . .SH "SYNOPSIS" \fBknife\fR \fBcookbook site\fR \fIsub\-command\fR \fI(options)\fR @@ -77,3 +77,15 @@ Grab dependencies automatically . .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\. +. +.SH "SEE ALSO" +\fBknife\-environment\fR(1) +. +.SH "AUTHOR" +Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\. +. +.SH "DOCUMENTATION" +This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\. +. +.SH "CHEF" +Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR diff --git a/chef/distro/common/man/man1/knife-cookbook.1 b/chef/distro/common/man/man1/knife-cookbook.1 index 6125869efc..316bef8def 100644 --- a/chef/distro/common/man/man1/knife-cookbook.1 +++ b/chef/distro/common/man/man1/knife-cookbook.1 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE\-COOKBOOK" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-COOKBOOK" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\-cookbook\fR \- Chef Server REST API utility +\fBknife\-cookbook\fR \- Upload and manage Chef cookbooks . .SH "SYNOPSIS" \fBknife\fR \fBcookbook\fR \fIsub\-command\fR \fI(options)\fR diff --git a/chef/distro/common/man/man1/knife-data-bag.1 b/chef/distro/common/man/man1/knife-data-bag.1 index c98974c66c..0c8b587f80 100644 --- a/chef/distro/common/man/man1/knife-data-bag.1 +++ b/chef/distro/common/man/man1/knife-data-bag.1 @@ -1,53 +1,130 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE\-DATA\-BAG" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-DATA\-BAG" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\-data\-bag\fR \- Chef Server REST API utility +\fBknife\-data\-bag\fR \- Store arbitrary data on a Chef Server . .SH "SYNOPSIS" \fBknife\fR \fBdata bag\fR \fIsub\-command\fR \fI(options)\fR . -.SH "DATA BAG SUB\-COMMANDS" -Data bags are stores of JSON blobs\. These blobs are called items\. They are free form JSON and indexed by the Chef Server\. +.SH "DESCRIPTION" +Data bags are stores of arbitrary JSON data\. Each data bag is a collection that may contain many items\. Data Bag Items are indexed by the Chef Server and can be searched via \fBknife\-search\fR(1)\. . .P -\fBdata bag create BAG [ITEM]\fR \fI(options)\fR +Data bags are available to all nodes configured by \fBchef\-client\fR(8), and are therefore a convenient mechanism to store global information, such as lists of administrative accounts that should be configured on all hosts\. +. +.SH "DATA BAG SUB\-COMMANDS" +. +.SH "CREATE" +\fBknife data bag create\fR \fIbag name\fR [item id] \fI(options)\fR +. +.TP +\fB\-s\fR, \fB\-\-secret SECRET\fR +A secret key used to encrypt the data bag item\. See \fBencryption support\fR below\. +. +.TP +\fB\-\-secret\-file SECRET_FILE\fR +The path to a file containing the secret key to be used to encrypt the data bag item\. . .P -Create a new data bag, or an item in a data bag\. +If \fIitem id\fR is given, creates a new, empty data bag item and opens it for editing in your editor\. The data bag will be created if it does not exist\. . .P -\fBdata bag delete BAG [ITEM]\fR \fI(options)\fR +If \fIitem id\fR is not given, the data bag will be created\. +. +.SH "DELETE" +\fBknife data bag delete\fR \fIbag name\fR [item id] \fI(options)\fR . .P Delete a data bag, or an item from a data bag\. . -.P -\fBdata bag edit BAG ITEM\fR \fI(options)\fR +.SH "EDIT" +\fBknife data bag edit\fR \fIbag name\fR \fIitem id\fR \fI(options)\fR +. +.TP +\fB\-s\fR, \fB\-\-secret SECRET\fR +A secret key used to encrypt the data bag item\. See \fBencryption support\fR below\. +. +.TP +\fB\-\-secret\-file SECRET_FILE\fR +The path to a file containing the secret key to be used to encrypt the data bag item\. . .P Edit an item in a data bag\. . -.P -\fBdata bag from file BAG FILE\fR \fI(options)\fR +.SH "FROM FILE" +\fBknife data bag from file\fR \fIbag name\fR \fIfile\fR \fI(options)\fR . -.P -Load a data bag item from a JSON file\. Looks in the directory \fBdata_bags/BAG/ITEM\.json\fR unless a relative path is specified\. +.TP +\fB\-s\fR, \fB\-\-secret SECRET\fR +A secret key used to encrypt the data bag item\. See \fBencryption support\fR below\. +. +.TP +\fB\-\-secret\-file SECRET_FILE\fR +The path to a file containing the secret key to be used to encrypt the data bag item\. . .P -\fBdata bag list\fR \fI(options)\fR +Load a data bag item from a JSON file\. If \fIfile\fR is a relative or absolute path to the file, that file will be used\. Otherwise, the \fIfile\fR parameter is treated as the base name of a data bag file in a Chef repository, and \fBknife\fR will search for the file in \fB\./data_bags/bag_name/file\fR\. For example \fBknife data bag from file users dan\.json\fR would attempt to load the file \fB\./data_bags/users/dan\.json\fR\. +. +.SH "LIST" +\fBknife data bag list\fR \fI(options)\fR . .TP \fB\-w\fR, \fB\-\-with\-uri\fR Show corresponding URIs . .P -List the available data bags\. +Lists the data bags that exist on the Chef Server\. +. +.SH "SHOW" +\fBknife data bag show BAG [ITEM]\fR \fI(options)\fR +. +.TP +\fB\-s\fR, \fB\-\-secret SECRET\fR +A secret key used to encrypt the data bag item\. See \fBencryption support\fR below\. +. +.TP +\fB\-\-secret\-file SECRET_FILE\fR +The path to a file containing the secret key to be used to encrypt the data bag item\. +. +.P +Show a specific data bag or an item in a data bag\. The output will be formatted according to the \-\-format option\. +. +.SH "ENCRYPTION SUPPORT" +Data Bag Items may be encrypted to keep their contents secret\. This may be desireable when storing sensitive information such as database passwords, API keys, etc\. +. +.P +Data Bag Item encryption uses the AES\-256 CBC symmetric key algorithm\. . .P -\fBdata bag show BAG [ITEM]\fR \fI(options)\fR +\fBCAVEATS:\fR Keys are not encrypted; only values are encrypted\. The "id" of a Data Bag Item is not encrypted, since it is used by Chef Server to store the item in its database\. For example, given the following data bag item: +. +.IP "" 4 +. +.nf + +{"id": "important_passwords", "secret_password": "opensesame"} +. +.fi +. +.IP "" 0 +. +.P +The key "secret_password" will be visible to an evesdropper, but the value "opensesame" will be protected\. Both the key "id" and its value "important_passwords" will be visible to an evesdropper\. . .P -Show a specific data bag or an item in a data bag\. +Chef Server does not provide a secure mechanism for distributing encryption keys\. +. +.SH "SEE ALSO" +\fBknife\-search\fR(1) +. +.SH "AUTHOR" +Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\. +. +.SH "DOCUMENTATION" +This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\. +. +.SH "CHEF" +Knife is distributed with Chef\. http://wiki\.opscode\.com/display/chef/Home diff --git a/chef/distro/common/man/man1/knife-environment.1 b/chef/distro/common/man/man1/knife-environment.1 index caea0b84bc..c8857684d1 100644 --- a/chef/distro/common/man/man1/knife-environment.1 +++ b/chef/distro/common/man/man1/knife-environment.1 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE\-ENVIRONMENT" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-ENVIRONMENT" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\-environment\fR \- Chef Server REST API utility +\fBknife\-environment\fR \- Define cookbook policies for the environments in your infrastructure . .SH "SYNOPSIS" \fBknife\fR \fBenvironment\fR \fIsub\-command\fR \fI(options)\fR diff --git a/chef/distro/common/man/man1/knife-exec.1 b/chef/distro/common/man/man1/knife-exec.1 index cafac2eae4..b67b6aea6e 100644 --- a/chef/distro/common/man/man1/knife-exec.1 +++ b/chef/distro/common/man/man1/knife-exec.1 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE\-EXEC" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-EXEC" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\-exec\fR \- Chef Server REST API utility +\fBknife\-exec\fR \- Run user scripts using the Chef API DSL . .SH "SYNOPSIS" \fBknife\fR \fBexec\fR \fI(options)\fR diff --git a/chef/distro/common/man/man1/knife-index.1 b/chef/distro/common/man/man1/knife-index.1 index 778a094123..a08322961a 100644 --- a/chef/distro/common/man/man1/knife-index.1 +++ b/chef/distro/common/man/man1/knife-index.1 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-INDEX" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\fR \- Chef Server REST API utility +\fBknife\-index\fR \- Rebuild the search index on a Chef Server . .SH "SYNOPSIS" \fBknife\fR \fBindex rebuild\fR \fI(options)\fR @@ -13,5 +13,17 @@ \fB\-y\fR, \fB\-\-yes\fR don\'t bother to ask if I\'m sure . -.P -Rebuilds all the search indexes on the server\. +.SH "DESCRIPTION" +Rebuilds all the search indexes on the server\. This is accomplished by deleting all objects from the search index, and then forwarding each item in the database to \fBchef\-expander\fR(8) via \fBrabbitmq\-server\fR(1)\. Depending on the number of objects in the database, it may take some time for all objects to be indexed and available for search\. +. +.SH "SEE ALSO" +\fBknife\-search\fR(1) +. +.SH "AUTHOR" +Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\. +. +.SH "DOCUMENTATION" +This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\. +. +.SH "CHEF" +Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR diff --git a/chef/distro/common/man/man1/knife-node.1 b/chef/distro/common/man/man1/knife-node.1 index d6db20f14e..b6f81eb7f6 100644 --- a/chef/distro/common/man/man1/knife-node.1 +++ b/chef/distro/common/man/man1/knife-node.1 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE\-NODE" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-NODE" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\-node\fR \- Chef Server REST API utility +\fBknife\-node\fR \- Manage the hosts in your infrastructure . .SH "SYNOPSIS" \fBknife\fR \fBnode\fR \fIsub\-command\fR \fI(options)\fR @@ -119,6 +119,9 @@ pp displays the node using Ruby\'s pretty printer\. . .IP "" 0 . +.P +For brevity, only the first character of the format is required, for example, \-Fj will produce JSON format output\. +. .SH "RUN LIST ITEM FORMAT" Run list items may be either roles or recipes\. When adding a role to a run list, the correct syntax is "role[ROLE_NAME]" . @@ -138,21 +141,13 @@ Default Recipe Format When adding the default recipe of a cookbook to a run list, the recipe name may be omitted as well, e\.g\., "chef::default" may be written as just "chef" . .SH "SEE ALSO" +\fBknife\-client\fR(1) \fBknife\-search\fR(1) \fBknife\-role\fR(1) . .SH "AUTHOR" -. -.nf - - Chef was written by Adam Jacob <adam@opscode\.com> with many contributions from the community\. -. -.fi +Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\. . .SH "DOCUMENTATION" +This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\. . -.nf - - This manual page was written by Joshua Timberman <joshua@opscode\.com>\. - Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\. -. -.fi - +.SH "CHEF" +Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR diff --git a/chef/distro/common/man/man1/knife-recipe.1 b/chef/distro/common/man/man1/knife-recipe.1 index 432b51411a..3d15408705 100644 --- a/chef/distro/common/man/man1/knife-recipe.1 +++ b/chef/distro/common/man/man1/knife-recipe.1 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE\-RECIPE" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-RECIPE" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\-recipe\fR \- Chef Server REST API utility +\fBknife\-recipe\fR \- List the recipes available on a Chef Server . .SH "SYNOPSIS" \fBknife\fR \fBrecipe list [PATTERN]\fR diff --git a/chef/distro/common/man/man1/knife-role.1 b/chef/distro/common/man/man1/knife-role.1 index 10dad0fab6..6dba91a4c4 100644 --- a/chef/distro/common/man/man1/knife-role.1 +++ b/chef/distro/common/man/man1/knife-role.1 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE\-ROLE" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-ROLE" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\-role\fR \- Chef Server REST API utility +\fBknife\-role\fR \- Group common configuration settings . .SH "SYNOPSIS" \fBknife\fR \fBrole\fR \fIsub\-command\fR \fI(options)\fR diff --git a/chef/distro/common/man/man1/knife-search.1 b/chef/distro/common/man/man1/knife-search.1 index 8ba37de7f8..3f3a5a0a08 100644 --- a/chef/distro/common/man/man1/knife-search.1 +++ b/chef/distro/common/man/man1/knife-search.1 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE\-SEARCH" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-SEARCH" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\-search\fR \- Chef Server REST API utility +\fBknife\-search\fR \- Find objects on a Chef Server by query . .SH "SYNOPSIS" \fBknife\fR \fBsearch INDEX QUERY\fR \fI(options)\fR diff --git a/chef/distro/common/man/man1/knife-ssh.1 b/chef/distro/common/man/man1/knife-ssh.1 index 564e3f3daf..0f5c472f1a 100644 --- a/chef/distro/common/man/man1/knife-ssh.1 +++ b/chef/distro/common/man/man1/knife-ssh.1 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE\-SSH" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-SSH" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\-ssh\fR \- Chef Server REST API utility +\fBknife\-ssh\fR \- Run a command or interactive session on multiple remote hosts . .SH "SYNOPSIS" \fBknife\fR \fBssh QUERY COMMAND\fR \fI(options)\fR diff --git a/chef/distro/common/man/man1/knife-status.1 b/chef/distro/common/man/man1/knife-status.1 index 46912a5b81..cced0789c6 100644 --- a/chef/distro/common/man/man1/knife-status.1 +++ b/chef/distro/common/man/man1/knife-status.1 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE\-STATUS" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-STATUS" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\-status\fR \- Chef Server REST API utility +\fBknife\-status\fR \- Display status information for the nodes in your infrastructure . .SH "SYNOPSIS" \fBknife\fR \fBstatus\fR \fI(options)\fR diff --git a/chef/distro/common/man/man1/knife-tag.1 b/chef/distro/common/man/man1/knife-tag.1 index 12ba4e4ab5..ebef20e314 100644 --- a/chef/distro/common/man/man1/knife-tag.1 +++ b/chef/distro/common/man/man1/knife-tag.1 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE\-TAG" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" -\fBknife\fR \- Chef Server REST API utility +\fBknife\-tag\fR \- Apply tags to nodes on a Chef Server . .SH "SYNOPSIS" \fBknife\fR \fBtag\fR \fIsubcommand\fR \fI(options)\fR diff --git a/chef/distro/common/man/man1/knife.1 b/chef/distro/common/man/man1/knife.1 index 2610039e91..193002671a 100644 --- a/chef/distro/common/man/man1/knife.1 +++ b/chef/distro/common/man/man1/knife.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KNIFE" "8" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" +.TH "KNIFE" "1" "April 2011" "Chef 0.10.0.beta.7" "Chef Manual" . .SH "NAME" \fBknife\fR \- Chef Server REST API utility @@ -318,6 +318,12 @@ knife cookbook site share example Other \-k ~/\.chef/USERNAME\.pem \-u USERNAME . .IP "" 0 . +.SH "ENVIRONMENT" +. +.TP +\fBEDITOR\fR +The text editor to use for editing data\. The \-\-editor option takes precedence over this value, and the \-\-no\-editor option supresses data editing entirely\. +. .SH "SEE ALSO" Full documentation for Chef is located on the Chef wiki, http://wiki\.opscode\.com/display/chef/Home/\. . @@ -334,7 +340,7 @@ Git is a version control system and documented at http://git\-scm\.com/\. This manual page was generated in nroff from Markdown with ronn\. Ryan Tomayko wrote ronn and more information can be found at http://rtomayko\.github\.com/ronn/ronn\.5\.html\. . .SH "AUTHOR" -Chef was written by Adam Jacob \fIadam@opscode\.com\fR of Opscode (http://www\.opscode\.com), with contributions from the community\. This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\. +Chef was written by Adam Jacob \fIadam@opscode\.com\fR of Opscode (\fIhttp://www\.opscode\.com\fR), with contributions from the community\. This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\. . .P On Debian systems, the complete text of the Apache 2\.0 License can be found in \fB/usr/share/common\-licenses/Apache\-2\.0\fR\. diff --git a/chef/distro/common/markdown/man1/knife-bootstrap.mkd b/chef/distro/common/markdown/man1/knife-bootstrap.mkd index 3fff4c3977..dd70f529d0 100644 --- a/chef/distro/common/markdown/man1/knife-bootstrap.mkd +++ b/chef/distro/common/markdown/man1/knife-bootstrap.mkd @@ -1,4 +1,4 @@ -knife-bootrap(8) -- Chef Server REST API utility +knife-bootrap(1) -- Install Chef Client on a remote host ======================================== ## SYNOPSIS @@ -28,9 +28,20 @@ __knife__ __bootstrap__ _(options)_ * `-d`, `--distro DISTRO`: Bootstrap a distro using a template -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. - -As of Chef 0.9.8, the bootstrap sub-command supports supplying a template to perform the bootstrap steps. If the distro is not specified (via `-d` or `--distro` option), an Ubuntu 10.04 with RubyGems is assumed. The __DISTRO__ value corresponds to the base filename of the template, in other words `DISTRO`.erb. A template file can be specified with the `--template-file` option in which case the __DISTRO__ is not used. The sub-command looks in the following locations for the template to use: +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. + +The bootstrap sub-command supports supplying a template to perform the +bootstrap steps. If the distro is not specified (via `-d` or `--distro` +option), an Ubuntu 10.04 host bootstrapped with RubyGems is assumed. The +__DISTRO__ value corresponds to the base filename of the template, in +other words `DISTRO`.erb. A template file can be specified with the +`--template-file` option in which case the __DISTRO__ is not used. The +sub-command looks in the following locations for the template to use: * `bootstrap` directory in the installed Chef Knife library. * `bootstrap` directory in the `$PWD/.chef`. @@ -62,3 +73,16 @@ When this is complete, the bootstrapped node will have: Additional custom bootstrap templates can be created and stored in `.chef/bootstrap/DISTRO.erb`, replacing __DISTRO__ with the value passed with the `-d` or `--distro` option. See __EXAMPLES__ for more information. +## SEE ALSO + __knife-ssh__(1) + +## AUTHOR + Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community. + +## DOCUMENTATION + This manual page was written by Joshua Timberman <joshua@opscode.com>. + Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. + + +## CHEF + Knife is distributed with Chef. <http://wiki.opscode.com/display/chef/Home> diff --git a/chef/distro/common/markdown/man1/knife-client.mkd b/chef/distro/common/markdown/man1/knife-client.mkd index 71981bb033..8764d7d71c 100644 --- a/chef/distro/common/markdown/man1/knife-client.mkd +++ b/chef/distro/common/markdown/man1/knife-client.mkd @@ -1,37 +1,64 @@ -knife-client(8) -- Chef Server REST API utility +knife-client(1) -- Manage Chef API Clients ======================================== ## SYNOPSIS __knife__ __client__ _sub-command_ _(options)_ -## CLIENT SUB-COMMANDS +## 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. + +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. -Clients are entities that communicate with the Chef Server API. +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. + +## CLIENT SUB-COMMANDS -__client bulk delete REGEX__ _(options)_ +## BULK DELETE +__knife client bulk delete__ _regex_ _(options)_ -Delete clients on the Chef Server based on a regular expression. The regular expression (_REGEX_) should be in quotes, not in //'s. +Delete clients where the client name matches the regular expression +_regex_ on the Chef Server. The regular expression should be given as a +quoted string, and not surrounded by forward slashes. -__client create CLIENT__ _(options)_ +## CREATE +__knife client create__ _client name_ _(options)_ * `-a`, `--admin `: Create the client as an admin * `-f`, `--file FILE`: Write the key to a file -Create a new client. This generates an RSA keypair. The private key will be displayed on _STDOUT_ or written to the named file. The public half will be stored on the Server. For _chef-client_ systems, the private key should be copied to the system as `/etc/chef/client.pem`. +Create a new client. This generates an RSA keypair. The private key will +be displayed on _STDOUT_ or written to the named file. The public half +will be stored on the Server. For _chef-client_ systems, the private key +should be copied to the system as `/etc/chef/client.pem`. -Admin clients should be created for users that will use _knife_ to access the API as an administrator. The private key will generally be copied to `~/.chef/CLIENT.pem` and referenced in the `knife.rb` configuration file. +Admin clients should be created for users that will use _knife_ to +access the API as an administrator. The private key will generally be +copied to `~/.chef/client\_name.pem` and referenced in the `knife.rb` +configuration file. -__client delete CLIENT__ _(options)_ +## DELETE +__knife client delete__ _client name_ _(options)_ Deletes a registered client. -__client edit CLIENT__ _(options)_ +## EDIT +__client edit__ _client name_ _(options)_ Edit a registered client. +## LIST __client list__ _(options)_ * `-w`, `--with-uri`: @@ -39,18 +66,36 @@ __client list__ _(options)_ List all registered clients. -__client reregister CLIENT__ _(options)_ +## REREGISTER +__client reregister__ _client name_ _(options)_ * `-f`, `--file FILE`: Write the key to a file -Regenerate the RSA keypair for a client. The public half will be stored on the server and the private key displayed on _STDOUT_ or written to the named file. +Regenerate the RSA keypair for a client. The public half will be stored +on the server and the private key displayed on _STDOUT_ or written to +the named file. This operation will invalidate the previous keypair used +by the client, preventing it from authenticating with the Chef Server. +Use care when reregistering the validator client. -__client show CLIENT__ _(options)_ +## SHOW +__client show__ _client name_ _(options)_ * `-a`, `--attribute ATTR`: Show only one attribute -Show a client. +Show a client. Output format is determined by the --format option. + +## SEE ALSO + __knife-node__(1) + +## AUTHOR + Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community. + +## DOCUMENTATION + This manual page was written by Joshua Timberman <joshua@opscode.com>. + Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. +## CHEF + Knife is distributed with Chef. <http://wiki.opscode.com/display/chef/Home> diff --git a/chef/distro/common/markdown/man1/knife-configure.mkd b/chef/distro/common/markdown/man1/knife-configure.mkd index 11f9de5188..cc7dd1d96e 100644 --- a/chef/distro/common/markdown/man1/knife-configure.mkd +++ b/chef/distro/common/markdown/man1/knife-configure.mkd @@ -1,22 +1,70 @@ -knife-configure(8) -- Chef Server REST API utility +knife-configure(1) -- Generate configuration files for knife or Chef Client ======================================== ## SYNOPSIS __knife__ __configure__ [client] _(options)_ +## DESCRIPTION +Generates a knife.rb configuration file interactively. When given the +--initial option, also creates a new administrative user. + ## CONFIGURE SUBCOMMANDS ## -__configure__ _(options)_ +__knife configure__ _(options)_ * `-i`, `--initial`: Create an initial API Client * `-r`, `--repository REPO`: The path to your chef-repo -Create a configuration file for knife. This will prompt for values to enter into the file. Default values are listed in square brackets if no other entry is typed. See __CONFIGURATION__ below for available options. +Create a configuration file for knife. This will prompt for values to +enter into the file. Default values are listed in square brackets if no +other entry is typed. See __knife__(1) for a description of +configuration options. + +__knife configure client__ _directory_ + +Read the _knife.rb_ config file and generate a config file suitable for +use in _/etc/chef/client.rb_ and copy the validation certificate into +the specified _directory_. + +## EXAMPLES + * On a freshly installed Chef Server, use _knife configure -i_ to + create an administrator and knife configuration file. Leave the + field blank to accept the default value. On most systems, the + default values are acceptable. + + user@host$ knife configure -i + Please enter the chef server URL: [http://localhost:4000] + Please enter a clientname for the new client: [username] + Please enter the existing admin clientname: [chef-webui] + Please enter the location of the existing admin client's private key: [/etc/chef/webui.pem] + Please enter the validation clientname: [chef-validator] + Please enter the location of the validation key: [/etc/chef/validation.pem] + Please enter the path to a chef repository (or leave blank): + Creating initial API user... + Created (or updated) client[username] + Configuration file written to /home/username/.chef/knife.rb + + This creates a new administrator client named _username_, writes + a configuration file to _/home/username/.chef/knife.rb_, and the + private key to _/home/username/.chef/username.pem_. The + configuration file and private key may be copied to another system + to facilitate administration of the Chef Server from a remote + system. Depending on the value given for the Chef Server URL, you + may need to modify that setting after copying to a remote host. + +## SEE ALSO + __knife__(1) __knife-client__(1) + +## AUTHOR + Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community. -__configure client DIRECTORY__ +## DOCUMENTATION + This manual page was written by Joshua Timberman <joshua@opscode.com>. + Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. -Read the `knife.rb` config file and generate a config file suitable for use in `/etc/chef/client.rb` and copy the validation certificate into the specified _DIRECTORY_. +## CHEF + Knife is distributed with Chef. <http://wiki.opscode.com/display/chef/Home> diff --git a/chef/distro/common/markdown/man1/knife-cookbook-site.mkd b/chef/distro/common/markdown/man1/knife-cookbook-site.mkd index 10ad8b7704..81adf0c54f 100644 --- a/chef/distro/common/markdown/man1/knife-cookbook-site.mkd +++ b/chef/distro/common/markdown/man1/knife-cookbook-site.mkd @@ -1,4 +1,4 @@ -knife-cookbook-site(8) -- Chef Server REST API utility +knife-cookbook-site(1) -- Install and update open source cookbooks ======================================== ## SYNOPSIS @@ -54,3 +54,16 @@ __cookbook site vendor COOKBOOK [VERSION]__ _(options)_ Uses `git` 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 _-d_ is specified, all the cookbooks it depends on (via metadata _dependencies_) are downloaded and untarred as well, each using their own vendor branch. +## SEE ALSO + __knife-environment__(1) + +## AUTHOR + Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community. + +## DOCUMENTATION + This manual page was written by Joshua Timberman <joshua@opscode.com>. + Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. + +## CHEF + Knife is distributed with Chef. <http://wiki.opscode.com/display/chef/Home> + diff --git a/chef/distro/common/markdown/man1/knife-cookbook.mkd b/chef/distro/common/markdown/man1/knife-cookbook.mkd index 9f4261eaa2..02ae6f3f90 100644 --- a/chef/distro/common/markdown/man1/knife-cookbook.mkd +++ b/chef/distro/common/markdown/man1/knife-cookbook.mkd @@ -1,4 +1,4 @@ -knife-cookbook(8) -- Chef Server REST API utility +knife-cookbook(1) -- Upload and manage Chef cookbooks ======================================== ## SYNOPSIS diff --git a/chef/distro/common/markdown/man1/knife-data-bag.mkd b/chef/distro/common/markdown/man1/knife-data-bag.mkd index d5aff2d06a..f31802751f 100644 --- a/chef/distro/common/markdown/man1/knife-data-bag.mkd +++ b/chef/distro/common/markdown/man1/knife-data-bag.mkd @@ -1,39 +1,117 @@ -knife-data-bag(8) -- Chef Server REST API utility +knife-data-bag(1) -- Store arbitrary data on a Chef Server ======================================== ## SYNOPSIS __knife__ __data bag__ _sub-command_ _(options)_ +## DESCRIPTION +Data bags are stores of arbitrary JSON data. Each data bag is a +collection that may contain many items. Data Bag Items are indexed by +the Chef Server and can be searched via __knife-search__(1). + +Data bags are available to all nodes configured by __chef-client__(8), +and are therefore a convenient mechanism to store global information, +such as lists of administrative accounts that should be configured on +all hosts. + ## DATA BAG SUB-COMMANDS -Data bags are stores of JSON blobs. These blobs are called items. They are free form JSON and indexed by the Chef Server. +## CREATE +__knife data bag create__ _bag name_ [item id] _(options)_ -__data bag create BAG [ITEM]__ _(options)_ + * `-s`, `--secret SECRET`: + A secret key used to encrypt the data bag item. See __encryption support__ below. + * `--secret-file SECRET_FILE`: + The path to a file containing the secret key to be used to encrypt + the data bag item. -Create a new data bag, or an item in a data bag. +If _item id_ is given, creates a new, empty data bag item and opens it for +editing in your editor. The data bag will be created if it does not +exist. -__data bag delete BAG [ITEM]__ _(options)_ +If _item id_ is not given, the data bag will be created. + +## DELETE +__knife data bag delete__ _bag name_ [item id] _(options)_ Delete a data bag, or an item from a data bag. -__data bag edit BAG ITEM__ _(options)_ +## EDIT +__knife data bag edit__ _bag name_ _item id_ _(options)_ + + * `-s`, `--secret SECRET`: + A secret key used to encrypt the data bag item. See __encryption support__ below. + * `--secret-file SECRET_FILE`: + The path to a file containing the secret key to be used to encrypt + the data bag item. Edit an item in a data bag. -__data bag from file BAG FILE__ _(options)_ +## FROM FILE +__knife data bag from file__ _bag name_ _file_ _(options)_ -Load a data bag item from a JSON file. Looks in the directory `data_bags/BAG/ITEM.json` unless a relative path is specified. + * `-s`, `--secret SECRET`: + A secret key used to encrypt the data bag item. See __encryption support__ below. + * `--secret-file SECRET_FILE`: + The path to a file containing the secret key to be used to encrypt + the data bag item. -__data bag list__ _(options)_ +Load a data bag item from a JSON file. If _file_ is a relative or +absolute path to the file, that file will be used. Otherwise, the _file_ +parameter is treated as the base name of a data bag file in a Chef +repository, and `knife` will search for the file in +`./data_bags/bag_name/file`. For example `knife data bag from file users +dan.json` would attempt to load the file `./data_bags/users/dan.json`. + +## LIST +__knife data bag list__ _(options)_ * `-w`, `--with-uri`: Show corresponding URIs -List the available data bags. +Lists the data bags that exist on the Chef Server. + +## SHOW +__knife data bag show BAG [ITEM]__ _(options)_ + + * `-s`, `--secret SECRET`: + A secret key used to encrypt the data bag item. See __encryption support__ below. + * `--secret-file SECRET_FILE`: + The path to a file containing the secret key to be used to encrypt + the data bag item. + +Show a specific data bag or an item in a data bag. The output will be +formatted according to the --format option. + +## ENCRYPTION SUPPORT +Data Bag Items may be encrypted to keep their contents secret. This may +be desireable when storing sensitive information such as database +passwords, API keys, etc. + +Data Bag Item encryption uses the AES-256 CBC symmetric key algorithm. + +__CAVEATS:__ Keys are not encrypted; only values are encrypted. The "id" +of a Data Bag Item is not encrypted, since it is used by Chef Server to +store the item in its database. For example, given the following data bag item: + {"id": "important_passwords", "secret_password": "opensesame"} +The key "secret\_password" will be visible to an evesdropper, but the +value "opensesame" will be protected. Both the key "id" and its value +"important\_passwords" will be visible to an evesdropper. + +Chef Server does not provide a secure mechanism for distributing +encryption keys. + +## SEE ALSO + __knife-search__(1) -__data bag show BAG [ITEM]__ _(options)_ +## AUTHOR + Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community. -Show a specific data bag or an item in a data bag. +## DOCUMENTATION + This manual page was written by Joshua Timberman <joshua@opscode.com>. + Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. +## CHEF + Knife is distributed with Chef. http://wiki.opscode.com/display/chef/Home diff --git a/chef/distro/common/markdown/man1/knife-environment.mkd b/chef/distro/common/markdown/man1/knife-environment.mkd index 3ecb3d6e6d..9c17dd3465 100644 --- a/chef/distro/common/markdown/man1/knife-environment.mkd +++ b/chef/distro/common/markdown/man1/knife-environment.mkd @@ -1,4 +1,4 @@ -knife-environment(8) -- Chef Server REST API utility +knife-environment(1) -- Define cookbook policies for the environments in your infrastructure ======================================== ## SYNOPSIS diff --git a/chef/distro/common/markdown/man1/knife-exec.mkd b/chef/distro/common/markdown/man1/knife-exec.mkd index d8d9187696..b0edfa0cb6 100644 --- a/chef/distro/common/markdown/man1/knife-exec.mkd +++ b/chef/distro/common/markdown/man1/knife-exec.mkd @@ -1,4 +1,4 @@ -knife-exec(8) -- Chef Server REST API utility +knife-exec(1) -- Run user scripts using the Chef API DSL ======================================== ## SYNOPSIS diff --git a/chef/distro/common/markdown/man1/knife-index.mkd b/chef/distro/common/markdown/man1/knife-index.mkd index eb4793f0ae..812f3fe7dd 100644 --- a/chef/distro/common/markdown/man1/knife-index.mkd +++ b/chef/distro/common/markdown/man1/knife-index.mkd @@ -1,4 +1,4 @@ -knife(8) -- Chef Server REST API utility +knife-index(1) -- Rebuild the search index on a Chef Server ======================================== ## SYNOPSIS @@ -8,4 +8,23 @@ __knife__ __index rebuild__ _(options)_ * `-y`, `--yes`: don't bother to ask if I'm sure -Rebuilds all the search indexes on the server. +## DESCRIPTION +Rebuilds all the search indexes on the server. This is accomplished by +deleting all objects from the search index, and then forwarding each +item in the database to __chef-expander__(8) via __rabbitmq-server__(1). +Depending on the number of objects in the database, it may take some +time for all objects to be indexed and available for search. + +## SEE ALSO + __knife-search__(1) + +## AUTHOR + Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community. + +## DOCUMENTATION + This manual page was written by Joshua Timberman <joshua@opscode.com>. + Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. + +## CHEF + Knife is distributed with Chef. <http://wiki.opscode.com/display/chef/Home> + diff --git a/chef/distro/common/markdown/man1/knife-node.mkd b/chef/distro/common/markdown/man1/knife-node.mkd index ab0bbfe337..4b5d1cf4f8 100644 --- a/chef/distro/common/markdown/man1/knife-node.mkd +++ b/chef/distro/common/markdown/man1/knife-node.mkd @@ -1,4 +1,4 @@ -knife-node(8) -- Chef Server REST API utility +knife-node(1) -- Manage the hosts in your infrastructure ======================================== ## SYNOPSIS @@ -116,6 +116,9 @@ display * pp displays the node using Ruby's pretty printer. +For brevity, only the first character of the format is required, for +example, -Fj will produce JSON format output. + ## RUN LIST ITEM FORMAT Run list items may be either roles or recipes. When adding a role to a run list, the correct syntax is "role[ROLE\_NAME]" @@ -123,18 +126,22 @@ run list, the correct syntax is "role[ROLE\_NAME]" When adding a recipe to a run list, there are several valid formats: * Fully Qualified Format: - "recipe[COOKBOOK::RECIPE_NAME]", for example, "recipe[chef::client]" + "recipe[COOKBOOK::RECIPE\_NAME]", for example, "recipe[chef::client]" * Cookbook Recipe Format: - For brevity, the recipe part of the fully qualified format may be omitted, and recipes specified as "COOKBOOK::RECIPE_NAME", e.g., "chef::client" + For brevity, the recipe part of the fully qualified format may be omitted, and recipes specified as "COOKBOOK::RECIPE\_NAME", e.g., "chef::client" * Default Recipe Format: When adding the default recipe of a cookbook to a run list, the recipe name may be omitted as well, e.g., "chef::default" may be written as just "chef" ## SEE ALSO + __knife-client__(1) __knife-search__(1) __knife-role__(1) ## AUTHOR - Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community. + Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community. ## DOCUMENTATION - This manual page was written by Joshua Timberman <joshua@opscode.com>. - Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. + This manual page was written by Joshua Timberman <joshua@opscode.com>. + Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. + +## CHEF + Knife is distributed with Chef. <http://wiki.opscode.com/display/chef/Home> diff --git a/chef/distro/common/markdown/man1/knife-recipe.mkd b/chef/distro/common/markdown/man1/knife-recipe.mkd index 47bc9cb6ae..c795f13e92 100644 --- a/chef/distro/common/markdown/man1/knife-recipe.mkd +++ b/chef/distro/common/markdown/man1/knife-recipe.mkd @@ -1,8 +1,24 @@ -knife-recipe(8) -- Chef Server REST API utility +knife-recipe(1) -- List the recipes available on a Chef Server ======================================== ## SYNOPSIS __knife__ __recipe list [PATTERN]__ -List the recipes available on the server. The results shown can be limited with the optional PATTERN, which is a regular expression. PATTERN should be given in quotes, without slashes. +List the recipes available on the server. The results shown can be +limited with the optional PATTERN, which is a regular expression. +PATTERN should be given in quotes, without slashes. + +## SEE ALSO + __knife-cookbook__(1) + +## AUTHOR + Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community. + +## DOCUMENTATION + This manual page was written by Joshua Timberman <joshua@opscode.com>. + Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. + +## CHEF + Knife is distributed with Chef. <http://wiki.opscode.com/display/chef/Home> + diff --git a/chef/distro/common/markdown/man1/knife-role.mkd b/chef/distro/common/markdown/man1/knife-role.mkd index e4a6bc6968..ac7b42f27e 100644 --- a/chef/distro/common/markdown/man1/knife-role.mkd +++ b/chef/distro/common/markdown/man1/knife-role.mkd @@ -1,45 +1,79 @@ -knife-role(8) -- Chef Server REST API utility +knife-role(1) -- Group common configuration settings ======================================== ## SYNOPSIS __knife__ __role__ _sub-command_ _(options)_ +## DESCRIPTION +Roles provide a mechanism to group repeated configuration settings. +Roles are data structures that contain __default\_attributes__, and +__override_attributes__, which are nested hashes of configuration +settings, and a __run_list__, which is an ordered list of recipes and +roles that should be applied to a host by chef-client. + +__default_attributes__ will be overridden if they conflict with a value +on a node that includes the role. Conversely, __override_attributes__ +will override any values set on nodes that apply them. + +When __chef-client__(8) configures a host, it will "expand" the +__run_list__ included in that host's node data. The expansion process +will recursively replace any roles in the run\_list with that role's +run\_list. + + ## ROLE SUB-COMMANDS -__role bulk delete REGEX__ _(options)_ +__knife role bulk delete REGEX__ _(options)_ Delete roles on the Chef Server based on a regular expression. The regular expression (_REGEX_) should be in quotes, not in //'s. -__role create ROLE__ _(options)_ +__knife role create ROLE__ _(options)_ * `-d`, `--description`: The role description Create a new role. -__role delete ROLE__ _(options)_ +__knife role delete ROLE__ _(options)_ Delete a role. -__role edit ROLE__ _(options)_ +__knife role edit ROLE__ _(options)_ Edit a role. -__role from file FILE__ _(options)_ +__knife role from file FILE__ _(options)_ Create or update a role from a role Ruby DSL (`.rb`) or JSON file. -__role list__ _(options)_ +__knife role list__ _(options)_ * `-w`, `--with-uri`: Show corresponding URIs List roles. -__role show ROLE__ _(options)_ +__knife role show ROLE__ _(options)_ * `-a`, `--attribute ATTR`: Show only one attribute Show a specific role. + + +## SEE ALSO + __knife-node__(1) + + <http://wiki.opscode.com/display/chef/Attributes> + +## AUTHOR + Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community. + +## DOCUMENTATION + This manual page was written by Joshua Timberman <joshua@opscode.com>. + Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. + +## CHEF + Knife is distributed with Chef. <http://wiki.opscode.com/display/chef/Home> + diff --git a/chef/distro/common/markdown/man1/knife-search.mkd b/chef/distro/common/markdown/man1/knife-search.mkd index 1111385ac5..50ec98592d 100644 --- a/chef/distro/common/markdown/man1/knife-search.mkd +++ b/chef/distro/common/markdown/man1/knife-search.mkd @@ -1,4 +1,4 @@ -knife-search(8) -- Chef Server REST API utility +knife-search(1) -- Find objects on a Chef Server by query ======================================== ## SYNOPSIS @@ -17,6 +17,40 @@ __knife__ __search INDEX QUERY__ _(options)_ The order to sort the results in * `-b`, `--start ROW`: The row to start returning results at + * `-m`, `--medium`: + Display medium sized output when searching nodes using the default + summary format + * `-l`, `--long`: + Display long output when searching nodes using the default summary + format + +## DESCRIPTION + +Search indexes are a feature of the Chef Server and the search +sub-command allows querying any of the available indexes using SOLR +query syntax. The following data types are indexed for search: +* _node_ +* _role_ +* _environment_ +* _data bag_ + +## SYNTAX + +## EXAMPLES + +## SEE ALSO + __knife-ssh__(1) + + <http://wiki.opscode.com/display/chef/Attributes> + +## AUTHOR + Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community. + +## DOCUMENTATION + This manual page was written by Joshua Timberman <joshua@opscode.com>. + Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. + +## CHEF + Knife is distributed with Chef. <http://wiki.opscode.com/display/chef/Home> -Search indexes are a feature of the Chef Server and the search sub-command allows querying any of the available indexes using SOLR query syntax. The following data types are indexed for search: _node_, _role_, _client_, _data bag_. diff --git a/chef/distro/common/markdown/man1/knife-ssh.mkd b/chef/distro/common/markdown/man1/knife-ssh.mkd index 53b24eb30b..c8da64d306 100644 --- a/chef/distro/common/markdown/man1/knife-ssh.mkd +++ b/chef/distro/common/markdown/man1/knife-ssh.mkd @@ -1,4 +1,4 @@ -knife-ssh(8) -- Chef Server REST API utility +knife-ssh(1) -- Run a command or interactive session on multiple remote hosts ======================================== ## SYNOPSIS @@ -16,4 +16,49 @@ __knife__ __ssh QUERY COMMAND__ _(options)_ * `-x`, `--ssh-user USERNAME `: The ssh username -The _ssh_ sub-command opens an ssh session to each of the nodes in the search results of the _QUERY_. This sub-command requires that the net-ssh-multi and highline Ruby libraries are installed. On Debian systems, these are the libnet-ssh-multi-ruby and libhighline-ruby packages. They can also be installed as RubyGems (net-ssh-multi and highline, respectively). +## DESCRIPTION + +The _ssh_ sub-command opens an ssh session to each of the nodes in the +search results of the _QUERY_. This sub-command requires that the +net-ssh-multi and highline Ruby libraries are installed. On Debian +systems, these are the libnet-ssh-multi-ruby and libhighline-ruby +packages. They can also be installed as RubyGems (net-ssh-multi and +highline, respectively). + +## TERMINAL MULTIPLEXING AND TERMINAL TAB SUPPORT +`knife ssh` integrates with several terminal multiplexer programs to +provide a more convenient means of managing multiple ssh sessions. When +the _COMMAND_ option matches one of these, `knife ssh` will create +multiple interactive ssh sessions running locally in the terminal +multiplexer instead of invoking the command on the remote host. + +The available multiplexers are: + * `interactive`: + A built-in multiplexer. `interactive` supports running commands on a + subset of the connected hosts in parallel + * __screen__(1): + Runs ssh interactively inside `screen`. ~/.screenrc will be sourced + if it exists. + * __tmux__(1): + Runs ssh interactively inside tmux. + * `macterm` (Mac OS X only): + Opens a Terminal.app window and creates a tab for each ssh session. + You must install the rb-appscript gem before you can use this + option. + +## SEE ALSO + __knife-search__(1) + + <http://wiki.opscode.com/display/chef/Attributes> + +## AUTHOR + Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community. + +## DOCUMENTATION + This manual page was written by Joshua Timberman <joshua@opscode.com>. + Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. + +## CHEF + Knife is distributed with Chef. <http://wiki.opscode.com/display/chef/Home> + + diff --git a/chef/distro/common/markdown/man1/knife-status.mkd b/chef/distro/common/markdown/man1/knife-status.mkd index 6f639d32da..f333f53fb5 100644 --- a/chef/distro/common/markdown/man1/knife-status.mkd +++ b/chef/distro/common/markdown/man1/knife-status.mkd @@ -1,4 +1,4 @@ -knife-status(8) -- Chef Server REST API utility +knife-status(1) -- Display status information for the nodes in your infrastructure ======================================== ## SYNOPSIS @@ -8,6 +8,31 @@ __knife__ __status__ _(options)_ * `-r`, `--run-list RUN_LIST`: Show the run list -The _status_ sub-command searches the Chef Server for all nodes and displays information about the last time the node checked into the server and executed a `node.save`. The fields displayed are the relative checkin time, the node name, it's operating system platform and version, the fully-qualified domain name and the default IP address. If the `-r` option is given, the node's run list will also be displayed. Note that depending on the configuration of the nodes, the FQDN and IP displayed may not be publicly reachable. +## DESCRIPTION + +The _status_ sub-command searches the Chef Server for all nodes and +displays information about the last time the node checked into the +server and executed a `node.save`. The fields displayed are the relative +checkin time, the node name, it's operating system platform and version, +the fully-qualified domain name and the default IP address. If the `-r` +option is given, the node's run list will also be displayed. Note that +depending on the configuration of the nodes, the FQDN and IP displayed +may not be publicly reachable. + + +## SEE ALSO + __knife-search__(1) + + <http://wiki.opscode.com/display/chef/Attributes> + +## AUTHOR + Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community. + +## DOCUMENTATION + This manual page was written by Joshua Timberman <joshua@opscode.com>. + Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. + +## CHEF + Knife is distributed with Chef. <http://wiki.opscode.com/display/chef/Home> diff --git a/chef/distro/common/markdown/man1/knife-tag.mkd b/chef/distro/common/markdown/man1/knife-tag.mkd index 690cd06ae9..c43c0631dd 100644 --- a/chef/distro/common/markdown/man1/knife-tag.mkd +++ b/chef/distro/common/markdown/man1/knife-tag.mkd @@ -1,4 +1,4 @@ -knife(8) -- Chef Server REST API utility +knife-tag(1) -- Apply tags to nodes on a Chef Server ======================================== ## SYNOPSIS diff --git a/chef/distro/common/markdown/man1/knife.mkd b/chef/distro/common/markdown/man1/knife.mkd index eceff25d48..ebd056c920 100644 --- a/chef/distro/common/markdown/man1/knife.mkd +++ b/chef/distro/common/markdown/man1/knife.mkd @@ -1,4 +1,4 @@ -knife(8) -- Chef Server REST API utility +knife(1) -- Chef Server REST API utility ======================================== ## SYNOPSIS @@ -7,11 +7,19 @@ __knife__ _sub-command_ _(options)_ ## DESCRIPTION -This manual page documents knife, a command-line utility used to interact with a Chef server directly through the RESTful API. Knife uses sub-commands to take various actions on different types of Chef objects. Some sub-commands take additional options. General options follow sub-commands and their options. A configuration file can be created for common defaults. +This manual page documents knife, a command-line utility used to +interact with a Chef server directly through the RESTful API. Knife uses +sub-commands to take various actions on different types of Chef objects. +Some sub-commands take additional options. General options follow +sub-commands and their options. A configuration file can be created for +common defaults. -Unless otherwise specified, output is in JSON format, and input files are also JSON format. +Unless otherwise specified, output is in JSON format, and input files +are also JSON format. -The Chef class `Chef::Config` that configures the behavior of how knife runs has options that correspond to command-line options. These are noted as `Chef::Config` values. +The Chef class `Chef::Config` that configures the behavior of how knife +runs has options that correspond to command-line options. These are +noted as `Chef::Config` values. ## GENERAL OPTIONS @@ -46,7 +54,9 @@ Usage information for sub-commands can be displayed with `knife SUB-COMMAND --he ## SUB-COMMANDS -Knife sub-commands are structured as _NOUN verb NOUN (options)_. The sub-commands are meant to be intuitively named. Because the Chef Server API is RESTful, sub-commands generally utilize CRUD operations. +Knife sub-commands are structured as _NOUN verb NOUN (options)_. The +sub-commands are meant to be intuitively named. Because the Chef Server +API is RESTful, sub-commands generally utilize CRUD operations. * create (create) * list and show (read) @@ -64,7 +74,11 @@ List available recipes from the server. Specify _PATTERN_ as a regular expressio ## CONFIGURATION -The knife configuration file is a Ruby DSL to set configuration parameters for Knife's __GENERAL OPTIONS__. The default location for the config file is `~/.chef/knife.rb`. If managing multiple Chef repositories, per-repository config files can be created. The file must be `.chef/knife.rb` in the current directory of the repository. +The knife configuration file is a Ruby DSL to set configuration +parameters for Knife's __GENERAL OPTIONS__. The default location for the +config file is `~/.chef/knife.rb`. If managing multiple Chef +repositories, per-repository config files can be created. The file must +be `.chef/knife.rb` in the current directory of the repository. If the config file exists, knife uses these settings for __GENERAL OPTIONS__ defaults. @@ -79,41 +93,63 @@ A Ruby symbol specifying the log level. Corresponds to `-l` or `--log_level` opt `log_location` -Corresponds to the `-L` or `--log-file` option. Defaults is __STDOUT__. Valid values are __STDOUT__ or a filename. +Corresponds to the `-L` or `--log-file` option. Defaults is __STDOUT__. +Valid values are __STDOUT__ or a filename. `node_name` -User to authenticate to the Chef server. Corresponds to the `-u` or `--user` option. This is requested from the user when running this sub-command. +User to authenticate to the Chef server. Corresponds to the `-u` or +`--user` option. This is requested from the user when running this +sub-command. `client_key` -Private key file to authenticate to the Chef server. Corresponds to the `-k` or `--key` option. This is requested from the user when running this sub-command. +Private key file to authenticate to the Chef server. Corresponds to the +`-k` or `--key` option. This is requested from the user when running +this sub-command. `chef_server_url` -URL of the Chef server. Corresponds to the `-s` or `--server-url` option. This is requested from the user when running this sub-command. +URL of the Chef server. Corresponds to the `-s` or `--server-url` +option. This is requested from the user when running this sub-command. `cache_type` -The type of cache to use. Default is BasicFile. This can be any type of Cache that moneta supports: BasicFile, Berkeley, Couch, DataMapper, File, LMC, Memcache, Memory, MongoDB, Redis, Rufus, S3, SDBM, Tyrant, Xattr, YAML. +The type of cache to use. Default is BasicFile. This can be any type of +Cache that moneta supports: BasicFile, Berkeley, Couch, DataMapper, +File, LMC, Memcache, Memory, MongoDB, Redis, Rufus, S3, SDBM, Tyrant, +Xattr, YAML. `cache_options` -Specifies various options to use for caching. Default reads the Chef client configuration (/etc/chef/checksums). +Specifies various options to use for caching. Default reads the Chef +client configuration (/etc/chef/checksums). `validation_client_name` -Specifies the name of the client used to validate new clients. This is requested from the user when running the configuration sub-command. +Specifies the name of the client used to validate new clients. This is +requested from the user when running the configuration sub-command. `validation_key` -Specifies the private key file to use for generating ec2 instance data for validating new clients. This is implied from the `validation_client_name`. +Specifies the private key file to use for generating ec2 instance data +for validating new clients. This is implied from the +`validation_client_name`. `cookbook_copyright` `cookbook_email` `cookbook_license` -Used by `knife cookbook create` sub-command to specify the copyright holder, maintainer email and license (respectively) for new cookbooks. The copyright holder is listed as the maintainer in the cookbook's metadata and as the Copyright in the comments of the default recipe. The maintainer email is used in the cookbook metadata. The license determines what preamble to put in the comment of the default recipe, and is listed as the license in the cookbook metadata. Currently supported licenses are "apachev2" and "none". Any other values will result in an empty license in the metadata (needs to be filled in by the author), and no comment preamble in the default recipe. +Used by `knife cookbook create` sub-command to specify the copyright +holder, maintainer email and license (respectively) for new cookbooks. +The copyright holder is listed as the maintainer in the cookbook's +metadata and as the Copyright in the comments of the default recipe. The +maintainer email is used in the cookbook metadata. The license +determines what preamble to put in the comment of the default recipe, +and is listed as the license in the cookbook metadata. Currently +supported licenses are "apachev2" and "none". Any other values will +result in an empty license in the metadata (needs to be filled in by the +author), and no comment preamble in the default recipe. `knife[:aws_access_key_id]` `knife[:aws_secret_access_key]` @@ -154,23 +190,34 @@ When working with Chef and Knife in the local repository, the recommended workfl * Launch instances in the Cloud, OR provision new hosts; see __CLOUD COMPUTING SUB-COMMANDS__ and __BOOTSTRAP SUB-COMMANDS__. * Watch Chef configure systems! -A note about git: Opscode and many folks in the Chef community use git, but it is not required, except in the case of the `cookbook site vendor` sub-command, as it uses git directly. Version control is strongly recommended though, and git fits with a lot of the workflow paradigms. +A note about git: Opscode and many folks in the Chef community use git, +but it is not required, except in the case of the `cookbook site vendor` +sub-command, as it uses git directly. Version control is strongly +recommended though, and git fits with a lot of the workflow paradigms. ## EXAMPLES -Example client config (`/etc/chef/client.rb`) from `knife configure client`. The same configuration is used when using the `knife bootstrap` command with the default `gem` templates that come with Chef. +Example client config (`/etc/chef/client.rb`) from `knife configure +client`. The same configuration is used when using the `knife bootstrap` +command with the default `gem` templates that come with Chef. log_level :info log_location STDOUT chef_server_url 'https://api.opscode.com/organizations/ORGNAME' validation_client_name 'ORGNAME-validator' -Setting up a custom bootstrap is fairly straightforward. Create `.chef/bootstrap` in your Chef Repository directory or in `$HOME/.chef/bootstrap`. Then create the ERB template file. +Setting up a custom bootstrap is fairly straightforward. Create +`.chef/bootstrap` in your Chef Repository directory or in +`$HOME/.chef/bootstrap`. Then create the ERB template file. mkdir ~/.chef/bootstrap vi ~/.chef/bootstrap/debian5.0-apt.erb -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: +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: knife bootstrap mynode.example.com --template-file ~/.chef/bootstrap/debian5.0-apt.erb @@ -178,14 +225,23 @@ Or, knife bootstrap mynode.example.com --distro debian5.0-apt -The `--distro` parameter will automatically look in the `~/.chef/bootstrap` directory for a file named `debian5.0-apt.erb`. +The `--distro` parameter will automatically look in the +`~/.chef/bootstrap` directory for a file named `debian5.0-apt.erb`. -Templates provided by the Chef installation are located in `BASEDIR/lib/chef/knife/bootstrap/*.erb`, where _BASEDIR_ is the location where the package or Gem installed the Chef client libraries. +Templates provided by the Chef installation are located in +`BASEDIR/lib/chef/knife/bootstrap/*.erb`, where _BASEDIR_ is the +location where the package or Gem installed the Chef client libraries. Uploading cookbooks to the Opscode cookbooks site using the user/certificate specifically: knife cookbook site share example Other -k ~/.chef/USERNAME.pem -u USERNAME +## ENVIRONMENT + * `EDITOR`: + The text editor to use for editing data. The --editor option takes + precedence over this value, and the --no-editor option supresses + data editing entirely. + ## SEE ALSO Full documentation for Chef is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home/. @@ -200,6 +256,6 @@ This manual page was generated in nroff from Markdown with ronn. Ryan Tomayko wr ## AUTHOR -Chef was written by Adam Jacob <adam@opscode.com> of Opscode (http://www.opscode.com), with contributions from the community. This manual page was written by Joshua Timberman <joshua@opscode.com>. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. +Chef was written by Adam Jacob <adam@opscode.com> of Opscode (<http://www.opscode.com>), with contributions from the community. This manual page was written by Joshua Timberman <joshua@opscode.com>. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. On Debian systems, the complete text of the Apache 2.0 License can be found in `/usr/share/common-licenses/Apache-2.0`. diff --git a/chef/lib/chef/knife/configure.rb b/chef/lib/chef/knife/configure.rb index e1efdfbb65..b6f3a5b843 100644 --- a/chef/lib/chef/knife/configure.rb +++ b/chef/lib/chef/knife/configure.rb @@ -24,6 +24,10 @@ class Chef attr_reader :chef_server, :new_client_name, :admin_client_name, :admin_client_key attr_reader :chef_repo, :new_client_key, :validation_client_name, :validation_key + deps do + Chef::Knife::ClientCreate.load_deps + end + banner "knife configure (options)" option :repository, diff --git a/chef/lib/chef/knife/help.rb b/chef/lib/chef/knife/help.rb index 6a16fb10da..f0e5f155a3 100644 --- a/chef/lib/chef/knife/help.rb +++ b/chef/lib/chef/knife/help.rb @@ -20,6 +20,8 @@ class Chef class Knife class Help < Chef::Knife + banner "knife help [list|TOPIC]" + def run if name_args.empty? ui.info "Usage: knife SUBCOMMAND (options)" @@ -27,9 +29,9 @@ class Chef ui.msg "" ui.info "For further help:" ui.info(<<-MOAR_HELP) - knife help list list help categories + knife help list list help topics knife help knife show general knife help - knife help CATEGORY show help for a category of commands + knife help TOPIC display the manual for TOPIC knife COMMAND --help show the options for a command MOAR_HELP exit 1 @@ -40,27 +42,27 @@ MOAR_HELP case @query - when 'categories', 'list' - print_help_categories + when 'topics', 'list' + print_help_topics exit 1 when 'intro', 'knife' - @category = 'knife' + @topic = 'knife' else - @category = find_manpages_for_query(@query) + @topic = find_manpages_for_query(@query) end - manpage_path = available_manpages_by_basename[@category] + manpage_path = available_manpages_by_basename[@topic] exec "man #{manpage_path}" end - def help_categories + def help_topics available_manpages_by_basename.keys.map {|c| c.sub(/^knife\-/, '')}.sort end - def print_help_categories + def print_help_topics ui.info "Available help topics are: " - help_categories.each do |category| - ui.msg " #{category}" + help_topics.each do |topic| + ui.msg " #{topic}" end end @@ -71,7 +73,7 @@ MOAR_HELP if possibilities.empty? ui.error "No help found for '#{query}'" ui.msg "" - print_help_categories + print_help_topics exit 1 elsif possibilities.size == 1 possibilities.first |