diff options
| author | Seth Chisamore <schisamo@opscode.com> | 2012-10-30 10:39:35 -0400 |
|---|---|---|
| committer | Seth Chisamore <schisamo@opscode.com> | 2012-10-30 10:39:35 -0400 |
| commit | 24dc69a9a97e82a6e4207de68d6dcc664178249b (patch) | |
| tree | 19bb289c9f88b4bbab066bc56b95d6d222fd5c35 /distro/common/html | |
| parent | 9348c1c9c80ee757354d624b7dc1b78ebc7605c4 (diff) | |
| download | chef-24dc69a9a97e82a6e4207de68d6dcc664178249b.tar.gz | |
[OC-3564] move core Chef to the repo root \o/ \m/
The opscode/chef repository now only contains the core Chef library code
used by chef-client, knife and chef-solo!
Diffstat (limited to 'distro/common/html')
25 files changed, 5054 insertions, 0 deletions
diff --git a/distro/common/html/chef-client.8.html b/distro/common/html/chef-client.8.html new file mode 100644 index 0000000000..cdcee9c7fd --- /dev/null +++ b/distro/common/html/chef-client.8.html @@ -0,0 +1,145 @@ +<!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>chef-client(8) - Runs a client node connecting to 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="#SEE-ALSO">SEE ALSO</a> + <a href="#AUTHOR">AUTHOR</a> + </div> + + <ol class='man-decor man-head man head'> + <li class='tl'>chef-client(8)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>chef-client(8)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>chef-client</code> - <span class="man-whatis">Runs a client node connecting to a chef-server.</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>chef-client</strong> <em>(options)</em></p> + +<dl> +<dt><code>-S</code>, <code>--server CHEFSERVERURL</code></dt><dd>The chef server URL</dd> +<dt><code>-c</code>, <code>--config CONFIG</code></dt><dd>The configuration file to use</dd> +<dt><code>-d</code>, <code>--daemonize</code></dt><dd>Daemonize the process</dd> +<dt><code>-g</code>, <code>--group GROUP</code></dt><dd>Group to set privilege to</dd> +<dt><code>-i</code>, <code>--interval SECONDS</code></dt><dd>Run chef-client periodically, in seconds</dd> +<dt><code>-j</code>, <code>--json-attributes JSON_ATTRIBS</code></dt><dd>Load attributes from a JSON file or URL</dd> +<dt><code>-E</code>, <code>--environment ENVIRONMENT</code></dt><dd>Set the Chef Environment on the node</dd> +<dt><code>-l</code>, <code>--log_level LEVEL</code></dt><dd>Set the log level (debug, info, warn, error, fatal)</dd> +<dt><code>-L</code>, <code>--logfile LOGLOCATION</code></dt><dd>Set the log file location, defaults to STDOUT - recommended for +daemonizing</dd> +<dt><code>-N</code>, <code>--node-name NODE_NAME</code></dt><dd>The node name for this client</dd> +<dt><code>-o</code>, <code>--override-runlist</code></dt><dd>Replace current run list with specified items</dd> +<dt><code>-K</code>, <code>--validation_key KEY_FILE</code></dt><dd>Set the validation key file location, used for registering new clients</dd> +<dt><code>-k</code>, <code>--client_key KEY_FILE</code></dt><dd>Set the client key file location</dd> +<dt><code>-s</code>, <code>--splay SECONDS</code></dt><dd>The splay time for running at intervals, in seconds</dd> +<dt><code>-u</code>, <code>--user USER</code></dt><dd>User to set privilege to</dd> +<dt><code>-P</code>, <code>--pid PIDFILE</code></dt><dd>Set the PID file location, defaults to /tmp/chef-client.pid</dd> +<dt class="flush"><code>--once</code></dt><dd>Cancel any interval or splay options, run chef once and exit</dd> +<dt><code>-v</code>, <code>--version</code></dt><dd>Show chef version</dd> +<dt><code>-h</code>, <code>--help</code></dt><dd>Show this message</dd> +</dl> + + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>The Chef Client is where almost all of the work in Chef is done. It +communicates with the Chef Server via REST, authenticates via Signed +Header Authentication, and compiles and executes Cookbooks.</p> + +<p>A Chef Client does work on behalf of a Node. A single Chef Client can +run recipes for multiple Nodes.</p> + +<p>Clients are where all the action happens - the Chef Server and Chef Expander +are largely services that exist only to provide the Client with information.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p>Full documentation for Chef and chef-client is located on the Chef +wiki, http://wiki.opscode.com/display/chef/Home.</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p>Chef was written by Adam Jacob <a href="mailto:adam@ospcode.com" data-bare-link="true">adam@ospcode.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> with +help2man. 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 /usr/share/common-licenses/Apache-2.0.</p> + + + <ol class='man-decor man-foot man foot'> + <li class='tl'>Chef 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>chef-client(8)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/chef-expander.8.html b/distro/common/html/chef-expander.8.html new file mode 100644 index 0000000000..ba17920e1e --- /dev/null +++ b/distro/common/html/chef-expander.8.html @@ -0,0 +1,164 @@ +<!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>chef-expander(8) - fetches messages from RabbitMQ, processes, and loads into chef-solr</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="#SEE-ALSO">SEE ALSO</a> + <a href="#AUTHOR">AUTHOR</a> + </div> + + <ol class='man-decor man-head man head'> + <li class='tl'>chef-expander(8)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>chef-expander(8)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>chef-expander</code> - <span class="man-whatis">fetches messages from RabbitMQ, processes, and loads into chef-solr</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>chef-expander</strong> <em>(options)</em></p> + +<dl> +<dt><code>-c</code>, <code>--config CONFIG_FILE</code></dt><dd>a configuration file to use</dd> +<dt><code>-i</code>, <code>--index INDEX</code></dt><dd>the slot this node will occupy in the ring</dd> +<dt><code>-n</code>, <code>--node-count NUMBER</code></dt><dd>the number of nodes in the ring</dd> +<dt><code>-l</code>, <code>--log-level LOG_LEVEL</code></dt><dd>set the log level</dd> +<dt><code>-L</code>, <code>--logfile LOG_LOCATION</code></dt><dd>Logfile to use</dd> +<dt><code>-d</code>, <code>--daemonize</code></dt><dd>fork into the background</dd> +<dt><code>-P</code>, <code>--pid PIDFILE</code></dt><dd>PID file</dd> +<dt><code>-h</code>, <code>--help</code></dt><dd>show help message</dd> +<dt><code>-v</code>, <code>--version</code></dt><dd>show the version and exit</dd> +</dl> + + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>Chef Expander fetches messages from RabbitMQ, processes them into the +correct format to be loaded into Solr and loads them into Solr.</p> + +<p><strong>Running Chef Expander</strong></p> + +<p>Chef Expander is designed for clustered operation, though small +installations will only need one worker process. To run Chef +Expander with one worker process, run chef-expander -n 1. +You will then have a master and worker process, which looks like +this in ps:</p> + +<pre><code>your-shell> ps aux|grep expander +you 52110 0.1 0.7 2515476 62748 s003 S+ 3:49PM 0:00.80 chef-expander worker #1 (vnodes 0-1023) +you 52108 0.1 0.5 2492880 41696 s003 S+ 3:49PM 0:00.91 ruby bin/chef-expander -n 1 +</code></pre> + +<p>Workers are single threaded and therefore cannot use more than 100% +of a single CPU. If you find that your queues are getting backlogged, +increase the number of workers</p> + +<p><strong>Design</strong></p> + +<p>Chef Expander uses 1024 queues (called vnodes in some places) to allow +you to scale the number of Chef Expander workers to meet the needs of +your infrastructure. When objects are saved in the API server, they are +added to queues based on their database IDs. These queues can be assigned +to different Chef Expander workers to distribute the load of processing +the index updates.</p> + +<p><strong>Chef Expander Operation and Troubleshooting</strong></p> + +<p>Chef Expander includes chef-expanderctl, a management program that allows +you to get status information or change the logging verbosity (without +restarting).</p> + +<p>See <strong>chef-expanderctl</strong>(8) for details.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p><strong>chef-expanderctl</strong>(8) +<strong>chef-solr</strong>(8)</p> + +<p>Full documentation for Chef and chef-server is located on the Chef +wiki, http://wiki.opscode.com/display/chef/Home.</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p>Chef was written by Adam Jacob <a href="mailto:adam@ospcode.com" data-bare-link="true">adam@ospcode.com</a> of Opscode +(http://www.opscode.com), with contributions from the community. This +manual page was created by Nuo Yan <a href="mailto:nuo@opscode.com" data-bare-link="true">nuo@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 /usr/share/common-licenses/Apache-2.0.</p> + + + <ol class='man-decor man-foot man foot'> + <li class='tl'>Chef 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>chef-expander(8)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/chef-expanderctl.8.html b/distro/common/html/chef-expanderctl.8.html new file mode 100644 index 0000000000..2ce15e019a --- /dev/null +++ b/distro/common/html/chef-expanderctl.8.html @@ -0,0 +1,146 @@ +<!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>chef-expanderctl(8) - management program for chef-expander</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="#SEE-ALSO">SEE ALSO</a> + <a href="#AUTHOR">AUTHOR</a> + </div> + + <ol class='man-decor man-head man head'> + <li class='tl'>chef-expanderctl(8)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>chef-expanderctl(8)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>chef-expanderctl</code> - <span class="man-whatis">management program for chef-expander</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>chef-expanderctl</strong> <em>COMMAND</em></p> + +<p><strong>Commands:</strong></p> + +<dl> +<dt class="flush"><code>help</code></dt><dd>Show help message</dd> +<dt><code>queue-depth</code></dt><dd>display the aggregate queue backlog</dd> +<dt><code>queue-status</code></dt><dd>show the backlog and consumer count for each vnode queue</dd> +<dt><code>node-status</code></dt><dd>show the status of the nodes in the cluster</dd> +<dt><code>log-level</code></dt><dd>sets the log level of all nodes in the cluster</dd> +</dl> + + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>Chef-expanderctl is a management program that allows +you to get status information or change the logging +verbosity (without restarting). chef-expanderctl has +the following commands:</p> + +<ul> +<li><strong>chef-expanderctl help</strong> +prints usage.</li> +<li><strong>chef-expanderctl queue-depth</strong> +Shows the total number of messages in the queues.</li> +<li><strong>chef-expanderctl queue-status</strong> +Show the number of messages in each queue. This is mainly of use when +debugging a Chef Expander cluster.</li> +<li><strong>chef-expanderctl log-level LEVEL</strong> +Sets the log level on a running Chef Expander or cluster. +If you suspect that a worker process is stuck, as long as you are using +clustered operation, you can simply kill the worker process and it will +be restarted by the master process.</li> +</ul> + + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p><strong>chef-expander-cluster</strong>(8) +<strong>chef-solr</strong>(8)</p> + +<p>Full documentation for Chef and chef-server is located on the Chef +wiki, http://wiki.opscode.com/display/chef/Home.</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p>Chef was written by Adam Jacob <a href="mailto:adam@ospcode.com" data-bare-link="true">adam@ospcode.com</a> of Opscode +(http://www.opscode.com), with contributions from the community. This +manual page was created by Nuo Yan <a href="mailto:nuo@opscode.com" data-bare-link="true">nuo@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 /usr/share/common-licenses/Apache-2.0.</p> + + + <ol class='man-decor man-foot man foot'> + <li class='tl'>Chef 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>chef-expanderctl(8)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/chef-server-webui.8.html b/distro/common/html/chef-server-webui.8.html new file mode 100644 index 0000000000..d28b732448 --- /dev/null +++ b/distro/common/html/chef-server-webui.8.html @@ -0,0 +1,185 @@ +<!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>chef-server-webui(8) - Start the Chef Server merb application slice providing Web User Interface (Management Console).</title> + <style type='text/css' media='all'> + /* style: man */ + body#manpage {margin:0} + .mp {max-width:100ex;padding:0 9ex 1ex 4ex} + .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0} + .mp h2 {margin:10px 0 0 0} + .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex} + .mp h3 {margin:0 0 0 4ex} + .mp dt {margin:0;clear:left} + .mp dt.flush {float:left;width:8ex} + .mp dd {margin:0 0 0 9ex} + .mp h1,.mp h2,.mp h3,.mp h4 {clear:left} + .mp pre {margin-bottom:20px} + .mp pre+h2,.mp pre+h3 {margin-top:22px} + .mp h2+pre,.mp h3+pre {margin-top:5px} + .mp img {display:block;margin:auto} + .mp h1.man-title {display:none} + .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143} + .mp h2 {font-size:16px;line-height:1.25} + .mp h1 {font-size:20px;line-height:2} + .mp {text-align:justify;background:#fff} + .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211} + .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201} + .mp u {text-decoration:underline} + .mp code,.mp strong,.mp b {font-weight:bold;color:#131211} + .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none} + .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff} + .mp b.man-ref {font-weight:normal;color:#434241} + .mp pre {padding:0 4ex} + .mp pre code {font-weight:normal;color:#434241} + .mp h2+pre,h3+pre {padding-left:0} + ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px} + ol.man-decor {width:100%} + ol.man-decor li.tl {text-align:left} + ol.man-decor li.tc {text-align:center;letter-spacing:4px} + ol.man-decor li.tr {text-align:right;float:right} + </style> + <style type='text/css' media='all'> + /* style: toc */ + .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee} + .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none} + .man-navigation a:hover {color:#111;text-decoration:underline} + </style> +</head> +<!-- + The following styles are deprecated and will be removed at some point: + div#man, div#man ol.man, div#man ol.head, div#man ol.man. + + The .man-page, .man-decor, .man-head, .man-foot, .man-title, and + .man-navigation should be used instead. +--> +<body id='manpage'> + <div class='mp' id='man'> + + <div class='man-navigation' style='display:none'> + <a href="#NAME">NAME</a> + <a href="#SYNOPSIS">SYNOPSIS</a> + <a href="#DESCRIPTION">DESCRIPTION</a> + <a href="#SEE-ALSO">SEE ALSO</a> + <a href="#AUTHOR">AUTHOR</a> + </div> + + <ol class='man-decor man-head man head'> + <li class='tl'>chef-server-webui(8)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>chef-server-webui(8)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>chef-server-webui</code> - <span class="man-whatis">Start the Chef Server merb application slice providing Web User Interface (Management Console).</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>chef-server-webui</strong> <em>(options)</em></p> + +<dl> +<dt><code>-u</code>, <code>--user USER</code></dt><dd>This flag is for having chef-server-webui run as a user other than the +one currently logged in. Note: if you set this you must also provide a +--group option for it to take effect.</dd> +<dt><code>-G</code>, <code>--group GROUP</code></dt><dd>This flag is for having chef-server-webui run as a group other than the +one currently logged in. Note: if you set this you must also provide a +--user option for it to take effect.</dd> +<dt><code>-d</code>, <code>--daemonize</code></dt><dd>This will run a single chef-server-webui in the background.</dd> +<dt><code>-N</code>, <code>--no-daemonize</code></dt><dd>This will allow you to run a cluster in console mode.</dd> +<dt><code>-c</code>, <code>--cluster-nodes NUM_MERBS</code></dt><dd>Number of merb daemons to run for chef-server-webui.</dd> +<dt><code>-I</code>, <code>--init-file FILE</code></dt><dd>File to use for initialization on load, defaults to config/init.rb.</dd> +<dt><code>-p</code>, <code>--port PORTNUM</code></dt><dd>Port to run chef-server-webui on, defaults to 4040. Additional nodes (-c) +listen on incrementing port numbers.</dd> +<dt><code>-o</code>, <code>--socket-file FILE</code></dt><dd>Socket file to run chef-server-webui on, defaults to +[Merb.root]/log/merb.sock. This is for web servers, like thin, that use +sockets. Specify this <em>only</em> if you <em>must</em>.</dd> +<dt><code>-s</code>, <code>--socket SOCKNUM</code></dt><dd>Socket number to run chef-server-webui on, defaults to 0.</dd> +<dt><code>-n</code>, <code>--name NAME</code></dt><dd>Set the name of the application. This is used in the process title and +log file names.</dd> +<dt><code>-P</code>, <code>--pid PIDFILE</code></dt><dd>PID file, defaults to [Merb.root]/log/merb.main.pid for the master +process and[Merb.root]/log/merb.[port number].pid for worker processes. +For clusters, use %s to specify where in the file chef-server-webui +should place the port number. For instance: -P myapp.%s.pid.</dd> +<dt><code>-h</code>, <code>--host HOSTNAME</code></dt><dd>Host to bind to (default is 0.0.0.0).</dd> +<dt><code>-m</code>, <code>--merb-root PATH_TO_APP_ROOT</code></dt><dd>The path to the Merb.root for the app you want to run +(default is current working directory).</dd> +<dt><code>-a</code>, <code>--adapter ADAPTER</code></dt><dd>The rack adapter to use to run chef-server-webui (default is mongrel) +[mongrel, emongrel, thin, ebb, fastcgi, webrick].</dd> +<dt><code>-R</code>, <code>--rackup FILE</code></dt><dd>Load an alternate Rack config file (default is config/rack.rb).</dd> +<dt><code>-i</code>, <code>--irb-console</code></dt><dd>This flag will start chef-server-webui in irb console mode. All your models +and other classes will be available for you in an irb session.</dd> +<dt><code>-S</code>, <code>--sandbox</code></dt><dd>This flag will enable a sandboxed irb console. If your ORM supports +transactions, all edits will be rolled back on exit.</dd> +<dt><code>-l</code>, <code>--log-level LEVEL</code></dt><dd>Log levels can be set to any of these options: +debug < info < warn < error < fatal (default is info).</dd> +<dt><code>-L</code>, <code>--log LOGFILE</code></dt><dd>A string representing the logfile to use. Defaults to +[Merb.root]/log/merb.[main].log for the master process and +[Merb.root]/log/merb[port number].logfor worker processes.</dd> +<dt><code>-e</code>, <code>--environment STRING</code></dt><dd>Environment to run Merb under [development, production, testing] +(default is development).</dd> +<dt><code>-r</code>, <code>--script-runner ['RUBY CODE'| FULL_SCRIPT_PATH]</code></dt><dd>Command-line option to run scripts and/or code in the chef-server-webui +app.</dd> +<dt><code>-K</code>, <code>-graceful PORT or all</code></dt><dd>Gracefully kill chef-server-webui proceses by port number. +Use chef-server -K all to gracefully kill all merbs.</dd> +<dt><code>-k</code>, <code>--kill PORT</code></dt><dd>Force kill one merb worker by port number. This will cause the worker +to be respawned.</dd> +<dt><code>--fast-deploy</code></dt><dd>Reload the code, but not yourinit.rb or gems.</dd> +<dt><code>-X</code>, <code>--mutex on/off</code></dt><dd>This flag is for turning the mutex lock on and off.</dd> +<dt><code>-D</code>, <code>--debugger</code></dt><dd>Run chef-server-webui using rDebug.</dd> +<dt><code>-V</code>, <code>--verbose</code></dt><dd>Print extra information.</dd> +<dt><code>-C</code>, <code>--console-trap</code></dt><dd>Enter an irb console on ^C.</dd> +<dt><code>-?</code>, <code>-H</code>, <code>--help</code></dt><dd>Show this help message.</dd> +</dl> + + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>The Chef Server WebUI (Management Console) is a Merb application slice. +The default listen port is 4040.</p> + +<p>The Management Console is Chef Server's web interface. Nodes, roles, +cookbooks, data bags, and API clients can be managed through the Management +Console. Search can also be done on the console.</p> + +<p>In order to start using the Management Console, you need to first create +a user or change the default password on the "admin" user.</p> + +<p>The default credentials are:</p> + +<ul> +<li><code>Username</code>: admin</li> +<li><code>Password</code>: p@ssw0rd1</li> +</ul> + + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p>Full documentation for Chef and chef-server-webui (Management Console) +is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home.</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p>Chef was written by Adam Jacob <a href="mailto:adam@ospcode.com" data-bare-link="true">adam@ospcode.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> with +help2man for the Debian project (but may be used by others). 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 /usr/share/common-licenses/Apache-2.0.</p> + + + <ol class='man-decor man-foot man foot'> + <li class='tl'>Chef 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>chef-server-webui(8)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/chef-server.8.html b/distro/common/html/chef-server.8.html new file mode 100644 index 0000000000..6613b6c90f --- /dev/null +++ b/distro/common/html/chef-server.8.html @@ -0,0 +1,182 @@ +<!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>chef-server(8) - Start the Chef Server merb application slice.</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="#SEE-ALSO">SEE ALSO</a> + <a href="#AUTHOR">AUTHOR</a> + </div> + + <ol class='man-decor man-head man head'> + <li class='tl'>chef-server(8)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>chef-server(8)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>chef-server</code> - <span class="man-whatis">Start the Chef Server merb application slice.</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>chef-server</strong> <em>(options)</em></p> + +<dl> +<dt><code>-u</code>, <code>--user USER</code></dt><dd>This flag is for having chef-server-webui run as a user other than the +one currently logged in. Note: if you set this you must also provide a +--group option for it to take effect.</dd> +<dt><code>-G</code>, <code>--group GROUP</code></dt><dd>This flag is for having chef-server-webui run as a group other than the +one currently logged in. Note: if you set this you must also provide a +--user option for it to take effect.</dd> +<dt><code>-d</code>, <code>--daemonize</code></dt><dd>This will run a single chef-server-webui in the background.</dd> +<dt><code>-N</code>, <code>--no-daemonize</code></dt><dd>This will allow you to run a cluster in console mode.</dd> +<dt><code>-c</code>, <code>--cluster-nodes NUM_MERBS</code></dt><dd>Number of merb daemons to run for chef-server-webui.</dd> +<dt><code>-I</code>, <code>--init-file FILE</code></dt><dd>File to use for initialization on load, defaults to config/init.rb.</dd> +<dt><code>-p</code>, <code>--port PORTNUM</code></dt><dd>Port to run chef-server-webui on, defaults to 4040. Additional nodes (-c) +listen on incrementing port numbers.</dd> +<dt><code>-o</code>, <code>--socket-file FILE</code></dt><dd>Socket file to run chef-server-webui on, defaults to +[Merb.root]/log/merb.sock. This is for web servers, like thin, that use +sockets. Specify this <em>only</em> if you <em>must</em>.</dd> +<dt><code>-s</code>, <code>--socket SOCKNUM</code></dt><dd>Socket number to run chef-server-webui on, defaults to 0.</dd> +<dt><code>-n</code>, <code>--name NAME</code></dt><dd>Set the name of the application. This is used in the process title and +log file names.</dd> +<dt><code>-P</code>, <code>--pid PIDFILE</code></dt><dd>PID file, defaults to [Merb.root]/log/merb.main.pid for the master +process and[Merb.root]/log/merb.[port number].pid for worker processes. +For clusters, use %s to specify where in the file chef-server-webui +should place the port number. For instance: -P myapp.%s.pid.</dd> +<dt><code>-h</code>, <code>--host HOSTNAME</code></dt><dd>Host to bind to (default is 0.0.0.0).</dd> +<dt><code>-m</code>, <code>--merb-root PATH_TO_APP_ROOT</code></dt><dd>The path to the Merb.root for the app you want to run +(default is current working directory).</dd> +<dt><code>-a</code>, <code>--adapter ADAPTER</code></dt><dd>The rack adapter to use to run chef-server-webui (default is mongrel) +[mongrel, emongrel, thin, ebb, fastcgi, webrick].</dd> +<dt><code>-R</code>, <code>--rackup FILE</code></dt><dd>Load an alternate Rack config file (default is config/rack.rb).</dd> +<dt><code>-i</code>, <code>--irb-console</code></dt><dd>This flag will start chef-server-webui in irb console mode. All your models +and other classes will be available for you in an irb session.</dd> +<dt><code>-S</code>, <code>--sandbox</code></dt><dd>This flag will enable a sandboxed irb console. If your ORM supports +transactions, all edits will be rolled back on exit.</dd> +<dt><code>-l</code>, <code>--log-level LEVEL</code></dt><dd>Log levels can be set to any of these options: +debug < info < warn < error < fatal (default is info).</dd> +<dt><code>-L</code>, <code>--log LOGFILE</code></dt><dd>A string representing the logfile to use. Defaults to +[Merb.root]/log/merb.[main].log for the master process and +[Merb.root]/log/merb[port number].logfor worker processes.</dd> +<dt><code>-e</code>, <code>--environment STRING</code></dt><dd>Environment to run Merb under [development, production, testing] +(default is development).</dd> +<dt><code>-r</code>, <code>--script-runner ['RUBY CODE'| FULL_SCRIPT_PATH]</code></dt><dd>Command-line option to run scripts and/or code in the chef-server-webui +app.</dd> +<dt><code>-K</code>, <code>-graceful PORT or all</code></dt><dd>Gracefully kill chef-server-webui proceses by port number. +Use chef-server -K all to gracefully kill all merbs.</dd> +<dt><code>-k</code>, <code>--kill PORT</code></dt><dd>Force kill one merb worker by port number. This will cause the worker +to be respawned.</dd> +<dt><code>--fast-deploy</code></dt><dd>Reload the code, but not yourinit.rb or gems.</dd> +<dt><code>-X</code>, <code>--mutex on/off</code></dt><dd>This flag is for turning the mutex lock on and off.</dd> +<dt><code>-D</code>, <code>--debugger</code></dt><dd>Run chef-server-webui using rDebug.</dd> +<dt><code>-V</code>, <code>--verbose</code></dt><dd>Print extra information.</dd> +<dt><code>-C</code>, <code>--console-trap</code></dt><dd>Enter an irb console on ^C.</dd> +<dt><code>-?</code>, <code>-H</code>, <code>--help</code></dt><dd>Show this help message.</dd> +</dl> + + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>The Chef Server provides a central point for the distribution of Cookbooks, +management and authentication of Nodes, and the use of Search. It provides +a REST API.</p> + +<p>The API service is what clients use to interact with the server to manage +node configuration in Chef. By default, the service is started on port 4000 +as a Merb application slice running with the thin server adapter.</p> + +<p>The two methods of interaction with the API for humans are the command-line +tool Knife and the Management Console. The Chef Client library is used for +interacting with the API for client nodes.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p><strong>chef-client</strong>(8) +<strong>chef-server-webui</strong>(8) +<strong>knife</strong>(1)</p> + +<p>Full documentation for Chef and chef-server is located on the Chef +wiki, http://wiki.opscode.com/display/chef/Home.</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p>Chef was written by Adam Jacob <a href="mailto:adam@ospcode.com" data-bare-link="true">adam@ospcode.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> with +help2man. 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 /usr/share/common-licenses/Apache-2.0.</p> + + + <ol class='man-decor man-foot man foot'> + <li class='tl'>Chef 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>chef-server(8)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/chef-shell.1.html b/distro/common/html/chef-shell.1.html new file mode 100644 index 0000000000..195870cc53 --- /dev/null +++ b/distro/common/html/chef-shell.1.html @@ -0,0 +1,286 @@ +<!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>chef-shell(1) - Interactive Chef Console</title> + <style type='text/css' media='all'> + /* style: man */ + body#manpage {margin:0} + .mp {max-width:100ex;padding:0 9ex 1ex 4ex} + .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0} + .mp h2 {margin:10px 0 0 0} + .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex} + .mp h3 {margin:0 0 0 4ex} + .mp dt {margin:0;clear:left} + .mp dt.flush {float:left;width:8ex} + .mp dd {margin:0 0 0 9ex} + .mp h1,.mp h2,.mp h3,.mp h4 {clear:left} + .mp pre {margin-bottom:20px} + .mp pre+h2,.mp pre+h3 {margin-top:22px} + .mp h2+pre,.mp h3+pre {margin-top:5px} + .mp img {display:block;margin:auto} + .mp h1.man-title {display:none} + .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143} + .mp h2 {font-size:16px;line-height:1.25} + .mp h1 {font-size:20px;line-height:2} + .mp {text-align:justify;background:#fff} + .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211} + .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201} + .mp u {text-decoration:underline} + .mp code,.mp strong,.mp b {font-weight:bold;color:#131211} + .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none} + .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff} + .mp b.man-ref {font-weight:normal;color:#434241} + .mp pre {padding:0 4ex} + .mp pre code {font-weight:normal;color:#434241} + .mp h2+pre,h3+pre {padding-left:0} + ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px} + ol.man-decor {width:100%} + ol.man-decor li.tl {text-align:left} + ol.man-decor li.tc {text-align:center;letter-spacing:4px} + ol.man-decor li.tr {text-align:right;float:right} + </style> + <style type='text/css' media='all'> + /* style: toc */ + .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee} + .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none} + .man-navigation a:hover {color:#111;text-decoration:underline} + </style> +</head> +<!-- + The following styles are deprecated and will be removed at some point: + div#man, div#man ol.man, div#man ol.head, div#man ol.man. + + The .man-page, .man-decor, .man-head, .man-foot, .man-title, and + .man-navigation should be used instead. +--> +<body id='manpage'> + <div class='mp' id='man'> + + <div class='man-navigation' style='display:none'> + <a href="#NAME">NAME</a> + <a href="#SYNOPSIS">SYNOPSIS</a> + <a href="#DESCRIPTION">DESCRIPTION</a> + <a href="#SYNTAX">SYNTAX</a> + <a href="#PRIMARY-MODE">PRIMARY MODE</a> + <a href="#RECIPE-MODE">RECIPE MODE</a> + <a href="#EXAMPLES">EXAMPLES</a> + <a href="#BUGS">BUGS</a> + <a href="#SEE-ALSO">SEE ALSO</a> + <a href="#AUTHOR">AUTHOR</a> + <a href="#DOCUMENTATION">DOCUMENTATION</a> + <a href="#CHEF">CHEF</a> + </div> + + <ol class='man-decor man-head man head'> + <li class='tl'>chef-shell(1)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>chef-shell(1)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>chef-shell</code> - <span class="man-whatis">Interactive Chef Console</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>chef-shell</strong> [<em>named configuration</em>] <em>(options)</em></p> + +<dl> +<dt><code>-S</code>, <code>--server CHEF_SERVER_URL</code></dt><dd>The chef server URL</dd> +<dt><code>-z</code>, <code>--client</code></dt><dd>chef-client mode</dd> +<dt><code>-c</code>, <code>--config CONFIG</code></dt><dd>The configuration file to use</dd> +<dt><code>-j</code>, <code>--json-attributes JSON_ATTRIBS</code></dt><dd>Load attributes from a JSON file or URL</dd> +<dt><code>-l</code>, <code>--log-level LOG_LEVEL</code></dt><dd>Set the logging level</dd> +<dt><code>-s</code>, <code>--solo</code></dt><dd>chef-solo session</dd> +<dt><code>-a</code>, <code>--standalone</code></dt><dd>standalone session</dd> +<dt><code>-v</code>, <code>--version</code></dt><dd>Show chef version</dd> +<dt><code>-h</code>, <code>--help</code></dt><dd>Show command options</dd> +</dl> + + +<p>When no --config option is specified, chef-shell attempts to load a +default configuration file:</p> + +<ul> +<li>If a <em>named configuration</em> is given, chef-shell will load ~/.chef/<em>named +configuration</em>/chef_shell.rb</li> +<li>If no <em>named configuration</em> is given chef-shell will load +~/.chef/chef_shell.rb if it exists</li> +<li>chef-shell falls back to loading /etc/chef/client.rb or +/etc/chef/solo.rb if -z or -s options are given and no chef_shell.rb +can be found.</li> +<li>The --config option takes precedence over implicit configuration +paths.</li> +</ul> + + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p><code>chef-shell</code> is an <span class="man-ref">irb<span class="s">(1)</span></span> (interactive ruby) session customized for Chef. +<code>chef-shell</code> serves two primary functions: it provides a means to +interact with a Chef Server interactively using a convenient DSL; it +allows you to define and run Chef recipes interactively.</p> + +<h2 id="SYNTAX">SYNTAX</h2> + +<p>chef-shell uses irb's subsession feature to provide multiple modes of +interaction. In addition to the primary mode which is entered on start, +<code>recipe</code> and <code>attributes</code> modes are available.</p> + +<h2 id="PRIMARY-MODE">PRIMARY MODE</h2> + +<p>The following commands are available in the primary +session:</p> + +<dl> +<dt class="flush"><code>help</code></dt><dd>Prints a list of available commands</dd> +<dt class="flush"><code>version</code></dt><dd>Prints the Chef version</dd> +<dt class="flush"><code>recipe</code></dt><dd>Switches to <code>recipe</code> mode</dd> +<dt><code>attributes</code></dt><dd>Switches to <code>attributes</code> mode</dd> +<dt><code>run_chef</code></dt><dd>Initiates a chef run</dd> +<dt class="flush"><code>reset</code></dt><dd>reinitializes chef-shell session</dd> +<dt><code>echo :on|:off</code></dt><dd>Turns irb's echo function on or off. Echo is <em>on</em> by default.</dd> +<dt><code>tracing :on|:off</code></dt><dd>Turns irb's function tracing feature on or off. Tracing is extremely +verbose and expected to be of interest primarily to developers.</dd> +<dt class="flush"><code>node</code></dt><dd>Returns the <em>node</em> object for the current host. See <span class="man-ref">knife-node<span class="s">(1)</span></span> +for more information about nodes.</dd> +<dt class="flush"><code>ohai</code></dt><dd>Prints the attributes of <em>node</em></dd> +</dl> + + +<p>In addition to these commands, chef-shell provides a DSL for accessing +data on the Chef Server. When working with remote data in chef-shell, you +chain method calls in the form <em>object type</em>.<em>operation</em>, where +<em>object type</em> is in plural form. The following object types are +available:</p> + +<ul> +<li><code>nodes</code></li> +<li><code>roles</code></li> +<li><code>data_bags</code></li> +<li><code>clients</code></li> +<li><code>cookbooks</code></li> +</ul> + + +<p>For each <em>object type</em> the following operations are available:</p> + +<dl> +<dt><em>object type</em>.all(<em>&block</em>)</dt><dd>Loads all items from the server. If the optional code <em>block</em> is +given, each item will be passed to the block and the results +returned, similar to ruby's <code>Enumerable#map</code> method.</dd> +<dt><em>object type</em>.show(<em>object name</em>)</dt><dd><p>Aliased as <em>object type</em>.load</p> + +<p>Loads the singular item identified by <em>object name</em>.</p></dd> +<dt><em>object type</em>.search(<em>query</em>, <em>&block</em>)</dt><dd><p>Aliased as <em>object type</em>.find</p> + +<p>Runs a search against the server and returns the matching items. If +the optional code <em>block</em> is given each item will be passed to the +block and the results returned.</p> + +<p>The <em>query</em> may be a Solr/Lucene format query given as a String, or +a Hash of conditions. If a Hash is given, the options will be ANDed +together. To join conditions with OR, use negative queries, or any +advanced search syntax, you must provide give the query in String +form.</p></dd> +<dt><em>object type</em>.transform(:all|<em>query</em>, <em>&block</em>)</dt><dd><p>Aliased as <em>object type</em>.bulk_edit</p> + +<p>Bulk edit objects by processing them with the (required) code <em>block</em>. +You can edit all objects of the given type by passing the Symbol +<code>:all</code> as the argument, or only a subset by passing a <em>query</em> as the +argument. The <em>query</em> is evaluated in the same way as with +<strong>search</strong>.</p> + +<p>The return value of the code <em>block</em> is used to alter the behavior +of <code>transform</code>. If the value returned from the block is <code>nil</code> or +<code>false</code>, the object will not be saved. Otherwise, the object is +saved after being passed to the block. This behavior can be +exploited to create a dry run to test a data transformation.</p></dd> +</dl> + + +<h2 id="RECIPE-MODE">RECIPE MODE</h2> + +<p>Recipe mode implements Chef's recipe DSL. Exhaustively documenting this +DSL is outside the scope of this document. See the following pages in +the Chef documentation for more information:</p> + +<ul> +<li><a href="http://wiki.opscode.com/display/chef/Resources" data-bare-link="true">http://wiki.opscode.com/display/chef/Resources</a></li> +<li><a href="http://wiki.opscode.com/display/chef/Recipes" data-bare-link="true">http://wiki.opscode.com/display/chef/Recipes</a></li> +</ul> + + +<p>Once you have defined resources in the recipe, you can trigger a +convergence run via <code>run_chef</code></p> + +<h2 id="EXAMPLES">EXAMPLES</h2> + +<ul> +<li><p>A "Hello World" interactive recipe</p> + +<p>chef > recipe +chef:recipe > echo :off +chef:recipe > file "/tmp/hello_world" +chef:recipe > run_chef +[Sat, 09 Apr 2011 08:56:56 -0700] INFO: Processing file[/tmp/hello_world] action create ((irb#1) line 2) +[Sat, 09 Apr 2011 08:56:56 -0700] INFO: file[/tmp/hello_world] created file /tmp/hello_world +chef:recipe > pp ls '/tmp' +[".", +"..", +"hello_world"]</p></li> +<li><p>Search for <em>nodes</em> by role, and print their IP addresses</p> + +<p>chef > nodes.find(:roles => 'monitoring-server') {|n| n[:ipaddress] } +=> ["10.254.199.5"]</p></li> +<li><p>Remove the role <em>obsolete</em> from every node in the system</p> + +<p>chef > nodes.transform(:all) {|n| n.run_list.delete('role[obsolete]') } + => [node[chef098b2.opschef.com], node[ree-woot], node[graphite-dev], node[fluke.localdomain], node[ghost.local], node[kallistec]]</p></li> +</ul> + + +<h2 id="BUGS">BUGS</h2> + +<p><code>chef-shell</code> often does not perfectly replicate the context in which +<span class="man-ref">chef-client<span class="s">(8)</span></span> configures a host, which may lead to discrepancies in +observed behavior.</p> + +<p><code>chef-shell</code> has to duplicate much code from chef-client's internal +libraries and may become out of sync with the behavior of those +libraries.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <span class="man-ref">chef-client<span class="s">(8)</span></span> <span class="man-ref">knife<span class="s">(1)</span></span> + <a href="http://wiki.opscode.com/display/chef/Chef+Shell" data-bare-link="true">http://wiki.opscode.com/display/chef/Chef+Shell</a></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. chef-shell was written by Daniel + DeLeo.</p> + +<h2 id="DOCUMENTATION">DOCUMENTATION</h2> + +<p> This manual page was written by Daniel DeLeo <a href="mailto:dan@opscode.com" data-bare-link="true">dan@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> chef-shell 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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>chef-shell(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/chef-solo.8.html b/distro/common/html/chef-solo.8.html new file mode 100644 index 0000000000..727df99c9f --- /dev/null +++ b/distro/common/html/chef-solo.8.html @@ -0,0 +1,191 @@ +<!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>chef-solo(8) - Runs chef in solo mode against a specified cookbook location.</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="#SEE-ALSO">SEE ALSO</a> + <a href="#AUTHOR">AUTHOR</a> + </div> + + <ol class='man-decor man-head man head'> + <li class='tl'>chef-solo(8)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>chef-solo(8)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>chef-solo</code> - <span class="man-whatis">Runs chef in solo mode against a specified cookbook location.</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>chef-solo</strong> <em>(options)</em></p> + +<dl> +<dt><code>-c</code>, <code>--config CONFIG</code></dt><dd>The configuration file to use</dd> +<dt><code>-d</code>, <code>--daemonize</code></dt><dd>Daemonize the process</dd> +<dt><code>-g</code>, <code>--group GROUP</code></dt><dd>Group to set privilege to</dd> +<dt><code>-i</code>, <code>--interval SECONDS</code></dt><dd>Run chef-client periodically, in seconds</dd> +<dt><code>-j</code>, <code>--json-attributes JSON_ATTRIBS</code></dt><dd>Load attributes from a JSON file or URL</dd> +<dt><code>-l</code>, <code>--log_level LEVEL</code></dt><dd>Set the log level (debug, info, warn, error, fatal)</dd> +<dt><code>-L</code>, <code>--logfile LOGLOCATION</code></dt><dd>Set the log file location, defaults to STDOUT - recommended for +daemonizing</dd> +<dt><code>-N</code>, <code>--node-name NODE_NAME</code></dt><dd>The node name for this client</dd> +<dt><code>-r</code>, <code>--recipe-url RECIPE_URL</code></dt><dd>Pull down a remote gzipped tarball of recipes and untar it to the +cookbook cache.</dd> +<dt><code>-s</code>, <code>--splay SECONDS</code></dt><dd>The splay time for running at intervals, in seconds</dd> +<dt><code>-u</code>, <code>--user USER</code></dt><dd>User to set privilege to</dd> +<dt><code>-v</code>, <code>--version</code></dt><dd>Show chef version</dd> +<dt><code>-h</code>, <code>--help</code></dt><dd>Show this message</dd> +</dl> + + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>Chef Solo allows you to run Chef Cookbooks in the absence of a Chef Server. +To do this, the complete cookbook needs to be present on disk.</p> + +<p>By default Chef Solo will look in /etc/chef/solo.rb for its configuration. +This configuration file has two required variables: file_cache_path and +cookbook_path.</p> + +<p>For example:</p> + +<pre><code>file_cache_path "/var/chef-solo" +cookbook_path "/var/chef-solo/cookbooks" +</code></pre> + +<p>For your own systems, you can change this to reflect any directory you like, +but you'll need to specify absolute paths and the cookbook_path directory +should be a subdirectory of the file_cache_path.</p> + +<p>You can also specify cookbook_path as an array, passing multiple locations +to search for cookbooks.</p> + +<p>For example:</p> + +<pre><code>file_cache_path "/var/chef-solo" +cookbook_path ["/var/chef-solo/cookbooks", "/var/chef-solo/site-cookbooks"] +</code></pre> + +<p>Note that earlier entries are now overridden by later ones.</p> + +<p>Since chef-solo doesn't have any interaction with a Chef Server, you'll need +to specify node-specifc attributes in a JSON file. This can be located on the +target system itself, or it can be stored on a remote server such as S3, or a +web server on your network.</p> + +<p>Within the JSON file, you'll also specify the recipes that Chef should run in +the "run_list". An example JSON file, which sets a resolv.conf:</p> + +<pre><code>{ + "resolver": { + "nameservers": [ "10.0.0.1" ], + "search":"int.example.com" + }, + "run_list": [ "recipe[resolver]" ] +} +</code></pre> + +<p>Then you can run chef-solo with -j to specify the JSON file. It will look for +cookbooks in the cookbook_path configured in the configuration file, and apply +attributes and use the run_list from the JSON file specified.</p> + +<p>You can use -c to specify the path to the configuration file (if you don't want +chef-solo to use the default). You can also specify -r for a cookbook tarball.</p> + +<p>For example:</p> + +<pre><code>chef-solo -c ~/solo.rb -j ~/node.json -r http://www.example.com/chef-solo.tar.gz +</code></pre> + +<p>In the above case, chef-solo would extract the tarball to your specified +cookbook_path, use ~/solo.rb as the configuration file, and apply attributes +and use the run_list from ~/node.json.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p>Full documentation for Chef and chef-solo is located on the Chef wiki, +http://wiki.opscode.com/display/chef/Home.</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p>Chef was written by Adam Jacob <a href="mailto:adam@ospcode.com" data-bare-link="true">adam@ospcode.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> with +help2man. 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 /usr/share/common-licenses/Apache-2.0.</p> + + + <ol class='man-decor man-foot man foot'> + <li class='tl'>Chef 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>chef-solo(8)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/chef-solr.8.html b/distro/common/html/chef-solr.8.html new file mode 100644 index 0000000000..0e13c25d90 --- /dev/null +++ b/distro/common/html/chef-solr.8.html @@ -0,0 +1,165 @@ +<!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>chef-solr(8) - Runs as Chef's search 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="#SEE-ALSO">SEE ALSO</a> + <a href="#AUTHOR">AUTHOR</a> + </div> + + <ol class='man-decor man-head man head'> + <li class='tl'>chef-solr(8)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>chef-solr(8)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>chef-solr</code> - <span class="man-whatis">Runs as Chef's search server</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>chef-solr</strong> <em>(options)</em></p> + +<dl> +<dt><code>-c</code>, <code>--config CONFIG</code></dt><dd>The configuration file to use</dd> +<dt><code>-d</code>, <code>--daemonize</code></dt><dd>Daemonize the process</dd> +<dt><code>-g</code>, <code>--group GROUP</code></dt><dd>Group to set privilege to</dd> +<dt><code>-l</code>, <code>--log_level LEVEL</code></dt><dd>Set the log level (debug, info, warn, error, fatal)</dd> +<dt><code>-L</code>, <code>--logfile LOGLOCATION</code></dt><dd>Set the log file location, defaults to STDOUT - recommended for daemonizing</dd> +<dt><code>-P</code>, <code>--pid PIDFILE</code></dt><dd>Set the PID file location, defaults to /tmp/chef-solr.pid</dd> +<dt><code>-D</code>, <code>--solr-data-dir PATH</code></dt><dd>Where the Solr data lives</dd> +<dt><code>-x</code>, <code>--solor-heap-size SIZE</code></dt><dd>Set the size of the Java Heap</dd> +<dt><code>-H</code>, <code>--solr-home-dir PATH</code></dt><dd>Solr home directory</dd> +<dt><code>-j</code>, <code>--java-opts OPTS</code></dt><dd>Raw options passed to Java</dd> +<dt><code>-x</code>, <code>--solor-heap-size</code></dt><dd>Set the size of the Java Heap</dd> +<dt><code>-W</code>, <code>--solr-jetty-dir PATH</code></dt><dd>Where to place the Solr Jetty instance</dd> +<dt><code>-u</code>, <code>--user USER</code></dt><dd>User to set privilege to</dd> +<dt><code>-v</code>, <code>--version</code></dt><dd>Show chef-solr version</dd> +<dt><code>-h</code>, <code>--help</code></dt><dd>Show this message</dd> +</dl> + + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>Chef-solr provides search service for Chef. You need to have both +chef-solr and chef-expander-cluster running in order for search to work.</p> + +<p><strong>Installation</strong></p> + +<p>Make sure you backed up your data if you are upgrading from a previous version. +Run chef-solr-installer to upgrade your Chef Solr installation. Answer "yes" +when prompted for confirmation. The process should look like this:</p> + +<pre><code>yourshell> chef-solr-installer +Configuration setting solr_heap_size is unknown and will be ignored + +Chef Solr is already installed in /var/chef/solr +Do you want to overwrite the current install? All existing Solr data will be lost. [y/n] y +Removing the existing Chef Solr installation + rm -rf /var/chef/solr + rm -rf /var/chef/solr-jetty + rm -rf /var/chef/solr/data +Creating Solr Home Directory + mkdir -p /var/chef/solr + entering /var/chef/solr + tar zxvf /Users/ddeleo/opscode/chef/chef-solr/solr/solr-home.tar.gz +Creating Solr Data Directory + mkdir -p /var/chef/solr/data +Unpacking Solr Jetty + mkdir -p /var/chef/solr-jetty + entering /var/chef/solr-jetty + tar zxvf /Users/ddeleo/opscode/chef/chef-solr/solr/solr-jetty.tar.gz + +Successfully installed Chef Solr. +You can restore your search index using `knife index rebuild` +</code></pre> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p><strong>chef-expander-cluster</strong>(8)</p> + +<p>Full documentation for Chef and chef-server is located on the Chef +wiki, http://wiki.opscode.com/display/chef/Home.</p> + +<h2 id="AUTHOR">AUTHOR</h2> + +<p>Chef was written by Adam Jacob <a href="mailto:adam@ospcode.com" data-bare-link="true">adam@ospcode.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> with +help2man. 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 /usr/share/common-licenses/Apache-2.0.</p> + + + <ol class='man-decor man-foot man foot'> + <li class='tl'>Chef 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>chef-solr(8)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-bootstrap.1.html b/distro/common/html/knife-bootstrap.1.html new file mode 100644 index 0000000000..6bc60652ca --- /dev/null +++ b/distro/common/html/knife-bootstrap.1.html @@ -0,0 +1,241 @@ +<!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-bootstrap(1) - Install Chef Client on a remote host</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="#EXAMPLES">EXAMPLES</a> + <a href="#BUGS">BUGS</a> + <a href="#SEE-ALSO">SEE ALSO</a> + <a href="#AUTHOR">AUTHOR</a> + <a href="#DOCUMENTATION">DOCUMENTATION</a> + <a href="#CHEF">CHEF</a> + </div> + + <ol class='man-decor man-head man head'> + <li class='tl'>knife-bootstrap(1)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>knife-bootstrap(1)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>knife-bootstrap</code> - <span class="man-whatis">Install Chef Client on a remote host</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>bootstrap</strong> <em>(options)</em></p> + +<dl> +<dt><code>-i</code>, <code>--identity-file IDENTITY_FILE</code></dt><dd>The SSH identity file used for authentication</dd> +<dt><code>-N</code>, <code>--node-name NAME</code></dt><dd>The Chef node name for your new node</dd> +<dt><code>-P</code>, <code>--ssh-password PASSWORD</code></dt><dd>The ssh password</dd> +<dt><code>-x</code>, <code>--ssh-user USERNAME</code></dt><dd>The ssh username</dd> +<dt><code>-p</code>, <code>--ssh-port PORT</code></dt><dd>The ssh port</dd> +<dt><code>--bootstrap-version VERSION</code></dt><dd>The version of Chef to install</dd> +<dt><code>--bootstrap-proxy PROXY_URL</code></dt><dd><code>The proxy server for the node being bootstrapped</code></dd> +<dt><code>--prerelease</code></dt><dd>Install pre-release Chef gems</dd> +<dt><code>-r</code>, <code>--run-list RUN_LIST</code></dt><dd>Comma separated list of roles/recipes to apply</dd> +<dt><code>--template-file TEMPLATE</code></dt><dd>Full path to location of template to use</dd> +<dt class="flush"><code>--sudo</code></dt><dd>Execute the bootstrap via sudo</dd> +<dt><code>-d</code>, <code>--distro DISTRO</code></dt><dd>Bootstrap a distro using a template</dd> +<dt><code>--[no-]host-key-verify</code></dt><dd>Enable host key verification, which is the default behavior.</dd> +<dt><code>--hint HINT_NAME[=HINT_FILE]</code></dt><dd>Provide the name of a hint (with option JSON file) to set for use by +Ohai plugins.</dd> +</dl> + + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<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 +plugins.</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> +<li><code>bootstrap</code> directory in the <code>$PWD/.chef</code>.</li> +<li><code>bootstrap</code> directory in the users <code>$HOME/.chef</code>.</li> +</ul> + + +<p>The default bootstrap templates are scripts that get copied to the +target node (FQDN). The following distros are supported:</p> + +<ul> +<li>centos5-gems</li> +<li>fedora13-gems</li> +<li>ubuntu10.04-gems</li> +<li>ubuntu10.04-apt</li> +</ul> + + +<p>The gems installations will use RubyGems 1.3.6 and Chef installed as a +gem. The apt installation will use the Opscode APT repository.</p> + +<p>In addition to handling the software installation, these bootstrap +templates do the following:</p> + +<ul> +<li>Write the validation.pem per the local knife configuration.</li> +<li>Write a default config file for Chef (<code>/etc/chef/client.rb</code>) using values from the <code>knife.rb</code>.</li> +<li>Create a JSON attributes file containing the specified run list and run Chef.</li> +</ul> + + +<p>In the case of the RubyGems, the <code>client.rb</code> will be written from +scratch with a minimal set of values; see <strong>EXAMPLES</strong>. In the case of +APT Package installation, <code>client.rb</code> will have the +<code>validation_client_name</code> appended if it is not set to <code>chef-validator</code> +(default config value), and the <code>node_name</code> will be added if +<code>chef_node_name</code> option is specified.</p> + +<p>When this is complete, the bootstrapped node will have:</p> + +<ul> +<li>Latest Chef version installed from RubyGems or APT Packages from Opscode. This may be a later version than the local system.</li> +<li>Be validated with the configured Chef Server.</li> +<li>Have run Chef with its default run list if one is specfied.</li> +</ul> + + +<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="EXAMPLES">EXAMPLES</h2> + +<p>Setting up a custom bootstrap is fairly straightforward. Create a +<code>.chef/bootstrap</code> directory in your Chef Repository 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> + +<pre><code>knife bootstrap mynode.example.com --template-file ~/.chef/bootstrap/debian5.0-apt.erb +</code></pre> + +<p>Or,</p> + +<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>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> + +<h2 id="BUGS">BUGS</h2> + +<p><code>knife bootstrap</code> is not capable of bootstrapping multiple hosts in +parallel.</p> + +<p>The bootstrap script is passed as an argument to <span class="man-ref">sh<span class="s">(1)</span></span> on the remote +system, so sensitive information contained in the script will be visible +to other users via the process list using tools such as <span class="man-ref">ps<span class="s">(1)</span></span>.</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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-bootstrap(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-client.1.html b/distro/common/html/knife-client.1.html new file mode 100644 index 0000000000..bdad3299df --- /dev/null +++ b/distro/common/html/knife-client.1.html @@ -0,0 +1,219 @@ +<!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="#SUB-COMMANDS">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="#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-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="SUB-COMMANDS">SUB-COMMANDS</h2> + +<p>Client subcommands follow a basic create, read, update, delete (CRUD) +pattern. The Following subcommands are available:</p> + +<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="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="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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-client(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-configure.1.html b/distro/common/html/knife-configure.1.html new file mode 100644 index 0000000000..9394f08f0e --- /dev/null +++ b/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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-configure(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-cookbook-site.1.html b/distro/common/html/knife-cookbook-site.1.html new file mode 100644 index 0000000000..ad40a5c1d1 --- /dev/null +++ b/distro/common/html/knife-cookbook-site.1.html @@ -0,0 +1,241 @@ +<!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-cookbook-site(1) - Install and update open source cookbooks</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="#COOKBOOK-SITE-SUB-COMMANDS">COOKBOOK SITE SUB-COMMANDS</a> + <a href="#INSTALL">INSTALL</a> + <a href="#DOWNLOAD">DOWNLOAD</a> + <a href="#LIST">LIST</a> + <a href="#SEARCH">SEARCH</a> + <a href="#SHARE">SHARE</a> + <a href="#UNSHARE">UNSHARE</a> + <a href="#SHOW">SHOW</a> + <a href="#DESCRIPTION">DESCRIPTION</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-cookbook-site(1)</li> + <li class='tc'>Chef Manual</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">Install and update open source cookbooks</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>cookbook site</strong> <em>sub-command</em> <em>(options)</em></p> + +<h2 id="COOKBOOK-SITE-SUB-COMMANDS">COOKBOOK SITE SUB-COMMANDS</h2> + +<p><code>knife cookbook site</code> provides the following subcommands:</p> + +<h2 id="INSTALL">INSTALL</h2> + +<p><strong>cookbook site install COOKBOOK [VERSION]</strong> <em>(options)</em></p> + +<dl> +<dt><code>-D</code>, <code>--skip-dependencies</code></dt><dd>Skip automatic installation of dependencies.</dd> +<dt><code>-o</code>, <code>--cookbook-path PATH</code></dt><dd>Install cookbooks to PATH</dd> +<dt><code>-B</code>, <code>--branch BRANCH</code></dt><dd>Default branch to work with [defaults to master]</dd> +</dl> + + +<p>Uses <span class="man-ref">git<span class="s">(1)</span></span> version control in conjunction with the cookbook site to +install community contributed cookbooks to your local cookbook +repository. Running <code>knife cookbook site install</code> does the following:</p> + +<ol> +<li>A new "pristine copy" branch is created in git for tracking the +upstream;</li> +<li>All existing cookbooks are removed from the branch;</li> +<li>The cookbook is downloaded from the cookbook site in tarball form;</li> +<li>The downloaded cookbook is untarred, and its contents commited via git;</li> +<li>The pristine copy branch is merged into the master branch.</li> +</ol> + + +<p>By installing cookbook with this process, you can locally modify the +upstream cookbook in your master branch and let git maintain your +changes as a separate patch. When an updated upstream version becomes +available, you will be able to merge the upstream changes while +maintaining your local modifications.</p> + +<p>Unless <em>--skip-dependencies</em> is specified, the process is applied recursively to all the +cookbooks <em>COOKBOOK</em> depends on (via metadata <em>dependencies</em>).</p> + +<h2 id="DOWNLOAD">DOWNLOAD</h2> + +<p><strong>knife cookbook site download COOKBOOK [VERSION]</strong> <em>(options)</em></p> + +<dl> +<dt><code>-f</code>, <code>--file FILE</code></dt><dd>The filename to write to</dd> +<dt class="flush"><code>--force</code></dt><dd>Force download deprecated cookbook</dd> +</dl> + + +<p>Downloads a specific cookbook from the Community site, optionally +specifying a certain version.</p> + +<h2 id="LIST">LIST</h2> + +<p><strong>knife cookbook site list</strong> <em>(options)</em></p> + +<dl> +<dt><code>-w</code>, <code>--with-uri</code></dt><dd>Show corresponding URIs</dd> +</dl> + + +<p>Lists available cookbooks from the Community site.</p> + +<h2 id="SEARCH">SEARCH</h2> + +<p><strong>knife cookbook site search QUERY</strong> <em>(options)</em></p> + +<p>Searches for available cookbooks matching the specified query.</p> + +<h2 id="SHARE">SHARE</h2> + +<p><strong>knife cookbook site share COOKBOOK CATEGORY</strong> <em>(options)</em></p> + +<dl> +<dt><code>-k</code>, <code>--key KEY</code></dt><dd>API Client Key</dd> +<dt><code>-u</code>, <code>--user USER</code></dt><dd>API Client Username</dd> +<dt><code>-o</code>, <code>--cookbook-path PATH:PATH</code></dt><dd>A colon-separated path to look for cookbooks in</dd> +</dl> + + +<p>Uploads the specified cookbook using the given category to the Opscode +cookbooks site. Requires a login user and certificate for the Opscode +Cookbooks site. By default, knife will use the username and API key +you've configured in your configuration file; otherwise you must +explicitly set these values on the command line or use an alternate +configuration file.</p> + +<h2 id="UNSHARE">UNSHARE</h2> + +<p><strong>knife cookbook site unshare COOKBOOK</strong></p> + +<p>Stops sharing the specified cookbook on the Opscode cookbooks site.</p> + +<h2 id="SHOW">SHOW</h2> + +<p><strong>knife cookbook site show COOKBOOK [VERSION]</strong> <em>(options)</em></p> + +<p>Shows information from the site about a particular cookbook.</p> + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>The cookbook site, <a href="http://community.opscode.com/" data-bare-link="true">http://community.opscode.com/</a>, is a cookbook +distribution service operated by Opscode. This service provides users +with a central location to publish cookbooks for sharing with other +community members.</p> + +<p><code>knife cookbook site</code> commands provide an interface to the cookbook +site's HTTP API. For commands that read data from the API, no account is +required. In order to upload cookbooks using the <code>knife cookbook site +share</code> command, you must create an account on the cookbook site and +configure your credentials via command line option or in your knife +configuration file.</p> + +<h2 id="EXAMPLES">EXAMPLES</h2> + +<p>Uploading cookbooks to the Opscode cookbooks site:</p> + +<pre><code>knife cookbook site share example Other -k ~/.chef/USERNAME.pem -u USERNAME +</code></pre> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong><span class="man-ref">knife-cookbook<span class="s">(1)</span></span></strong> + <a href="http://community.opscode.com/cookbooks" data-bare-link="true">http://community.opscode.com/cookbooks</a></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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-cookbook-site(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-cookbook.1.html b/distro/common/html/knife-cookbook.1.html new file mode 100644 index 0000000000..b98d9a9382 --- /dev/null +++ b/distro/common/html/knife-cookbook.1.html @@ -0,0 +1,384 @@ +<!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-cookbook(1) - upload and manage chef cookbooks</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="#SUB-COMMANDS">SUB-COMMANDS</a> + <a href="#LIST">LIST</a> + <a href="#SHOW">SHOW</a> + <a href="#UPLOAD">UPLOAD</a> + <a href="#DOWNLOAD">DOWNLOAD</a> + <a href="#DELETE">DELETE</a> + <a href="#BULK-DELETE">BULK DELETE</a> + <a href="#COOKBOOK-CREATE">COOKBOOK CREATE</a> + <a href="#METADATA">METADATA</a> + <a href="#METADATA-FROM-FILE">METADATA FROM FILE</a> + <a href="#TEST">TEST</a> + <a href="#RECIPE-LIST">RECIPE LIST</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-cookbook(1)</li> + <li class='tc'>Chef Manual</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">upload and manage chef cookbooks</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>cookbook</strong> <em>sub-command</em> <em>(options)</em></p> + +<h2 id="SUB-COMMANDS">SUB-COMMANDS</h2> + +<p><code>knife cookbook</code> supports the following sub commands:</p> + +<h2 id="LIST">LIST</h2> + +<p><strong>knife cookbook list</strong> <em>(options)</em></p> + +<dl> +<dt><code>-a</code>, <code>--all</code></dt><dd>show all versions of a cookbook instead of just the most recent</dd> +<dt><code>-w</code>, <code>--with-uri</code></dt><dd>show corresponding uris</dd> +</dl> + + +<p>Lists the cookbooks available on the Chef server.</p> + +<h2 id="SHOW">SHOW</h2> + +<p><strong>knife cookbook show cookbook [version] [part] [filename]</strong> <em>(options)</em></p> + +<dl> +<dt><code>-f</code>, <code>--fqdn fqdn </code></dt><dd>the fqdn of the host to see the file for</dd> +<dt><code>-p</code>, <code>--platform platform </code></dt><dd>the platform to see the file for</dd> +<dt><code>-v</code>, <code>--platform-version version</code></dt><dd>the platform version to see the file for</dd> +<dt><code>-w</code>, <code>--with-uri</code></dt><dd>Show corresponding URIs</dd> +</dl> + + +<p>show a particular part of a <em>cookbook</em> for the specified <em>version</em>. <em>part</em> can be one of:</p> + +<ul> +<li><em>attributes</em></li> +<li><em>definitions</em></li> +<li><em>files</em></li> +<li><em>libraries</em></li> +<li><em>providers</em></li> +<li><em>recipes</em></li> +<li><em>resources</em></li> +<li><em>templates</em></li> +</ul> + + +<h2 id="UPLOAD">UPLOAD</h2> + +<p><strong>knife cookbook upload [cookbooks...]</strong> <em>(options)</em></p> + +<dl> +<dt><code>-a</code>, <code>--all</code></dt><dd>upload all cookbooks, rather than just a single cookbook</dd> +<dt><code>-o</code>, <code>--cookbook-path path:path</code></dt><dd>a colon-separated path to look for cookbooks in</dd> +<dt><code>-d</code>, <code>--upload-dependencies</code></dt><dd>Uploads additional cookbooks that this cookbook lists in as +dependencies in its metadata.</dd> +<dt><code>-E</code>, <code>--environment ENVIRONMENT</code></dt><dd>An <em>ENVIRONMENT</em> to apply the uploaded cookbooks to. Specifying this +option will cause knife to edit the <em>ENVIRONMENT</em> to place a strict +version constraint on the cookbook version(s) uploaded.</dd> +<dt><code>--freeze</code></dt><dd>Sets the frozen flag on the uploaded cookbook(s) Any future attempt +to modify the cookbook without changing the version number will +return an error unless --force is specified.</dd> +<dt class="flush"><code>--force</code></dt><dd>Overrides the frozen flag on a cookbook, allowing you to overwrite a +cookbook version that has previously been uploaded with the --freeze +option.</dd> +</dl> + + +<p>Uploads one or more cookbooks from your local cookbook repository(ies) +to the Chef Server. Only files that don't yet exist on the server will +be uploaded.</p> + +<p>As the command parses the name args as 1..n cookbook names:</p> + +<pre><code>`knife cookbook upload COOKBOOK COOKBOOK ...` +</code></pre> + +<p>works for one to many cookbooks.</p> + +<h2 id="DOWNLOAD">DOWNLOAD</h2> + +<p><strong>knife cookbook download cookbook [version]</strong> <em>(options)</em></p> + +<dl> +<dt><code>-d</code>, <code>--dir download_directory</code></dt><dd>the directory to download the cookbook into</dd> +<dt><code>-f</code>, <code>--force</code></dt><dd>overwrite an existing directory with the download</dd> +<dt><code>-n</code>, <code>--latest</code></dt><dd>download the latest version of the cookbook</dd> +</dl> + + +<p>download a cookbook from the chef server. if no version is specified and +only one version exists on the server, that version will be downloaded. +if no version is specified and multiple versions are available on the +server, you will be prompted for a version to download.</p> + +<h2 id="DELETE">DELETE</h2> + +<p><strong>knife cookbook delete cookbook [version]</strong> <em>(options)</em></p> + +<dl> +<dt><code>-a</code>, <code>--all</code></dt><dd>delete all versions</dd> +<dt><code>-p</code>, <code>--purge</code></dt><dd>purge files from backing store. this will disable any cookbook that contains any of the same files as the cookbook being purged.</dd> +</dl> + + +<p>delete the specified <em>version</em> of the named <em>cookbook</em>. if no version is +specified, and only one version exists on the server, that version will +be deleted. if multiple versions are available on the server, you will +be prompted for a version to delete.</p> + +<h2 id="BULK-DELETE">BULK DELETE</h2> + +<p><strong>knife cookbook bulk delete regex</strong> <em>(options)</em></p> + +<dl> +<dt><code>-p</code>, <code>--purge</code></dt><dd>purge files from backing store. this will disable any cookbook that +contains any of the same files as the cookbook being purged.</dd> +</dl> + + +<p>delete cookbooks on the chef server based on a regular expression. the +regular expression (<em>regex</em>) should be in quotes, not in //'s.</p> + +<h2 id="COOKBOOK-CREATE">COOKBOOK CREATE</h2> + +<p><strong>knife cookbook create cookbook</strong> <em>(options)</em></p> + +<dl> +<dt><code>-o</code>, <code>--cookbook-path path</code></dt><dd>the directory where the cookbook will be created</dd> +<dt><code>-r</code>, <code>--readme-format format</code></dt><dd>format of the readme file md, mkd, txt, rdoc</dd> +<dt><code>-c</code>, <code>--copyright copyright</code></dt><dd>name of copyright holder</dd> +<dt><code>-i</code>, <code>--license license</code></dt><dd>license for cookbook, apachev2 or none</dd> +<dt><code>-e</code>, <code>--email email</code></dt><dd>email address of cookbook maintainer</dd> +</dl> + + +<p>this is a helper command that creates a new cookbook directory in the +<code>cookbook_path</code>. the following directories and files are created for the +named cookbook.</p> + +<ul> +<li>cookbook/attributes</li> +<li>cookbook/definitions</li> +<li>cookbook/files/default</li> +<li>cookbook/libraries</li> +<li>cookbook/metadata.rb</li> +<li>cookbook/providers</li> +<li>cookbook/readme.md</li> +<li>cookbook/recipes/default.rb</li> +<li>cookbook/resources</li> +<li>cookbook/templates/default</li> +</ul> + + +<p>supported readme formats are 'md' (default), 'mkd', 'txt', 'rdoc'. the +readme file will be written with the specified extension and a set of +helpful starting headers.</p> + +<p>specify <code>-c</code> or <code>--copyright</code> with the name of the copyright holder as +your name or your company/organization name in a quoted string. if this +value is not specified an all-caps string <code>your_company_name</code> is used +which can be easily changed with find/replace.</p> + +<p>specify <code>-i</code> or <code>--license</code> with the license that the cookbook is +distributed under for sharing with other people or posting to the +opscode cookbooks site. be aware of the licenses of files you put inside +the cookbook and follow any restrictions they describe. when using +<code>none</code> (default) or <code>apachev2</code>, comment header text and metadata file +are pre-filled. the <code>none</code> license will be treated as +non-redistributable.</p> + +<p>specify <code>-e</code> or <code>--email</code> with the email address of the cookbook's +maintainer. if this value is not specified, an all-caps string +<code>your_email</code> is used which can easily be changed with find/replace.</p> + +<p>the cookbook copyright, license, email and readme_format settings can be filled in the +<code>knife.rb</code>, for example with default values:</p> + +<pre><code>cookbook_copyright "your_company_name" +cookbook_license "none" +cookbook_email "your_email" +readme_format "md" +</code></pre> + +<h2 id="METADATA">METADATA</h2> + +<p><strong>knife cookbook metadata cookbook</strong> <em>(options)</em></p> + +<dl> +<dt><code>-a</code>, <code>--all</code></dt><dd>generate metadata for all cookbooks, rather than just a single cookbook</dd> +<dt><code>-o</code>, <code>--cookbook-path path:path</code></dt><dd>a colon-separated path to look for cookbooks in</dd> +</dl> + + +<p>generate cookbook metadata for the named <em>cookbook</em>. the <em>path</em> used here specifies where the cookbooks directory is located and corresponds to the <code>cookbook_path</code> configuration option.</p> + +<h2 id="METADATA-FROM-FILE">METADATA FROM FILE</h2> + +<p><strong>knife cookbook metadata from file</strong> <em>(options)</em></p> + +<p>load the cookbook metadata from a specified file.</p> + +<h2 id="TEST">TEST</h2> + +<p><strong>knife cookbook test [cookbooks...]</strong> <em>(options)</em></p> + +<dl> +<dt><code>-a</code>, <code>--all</code></dt><dd>test all cookbooks, rather than just a single cookbook</dd> +<dt><code>-o</code>, <code>--cookbook-path path:path</code></dt><dd>a colon-separated path to look for cookbooks in</dd> +</dl> + + +<p>test the specified cookbooks for syntax errors. this uses the built-in +ruby syntax checking option for files in the cookbook ending in <code>.rb</code>, +and the erb syntax check for files ending in <code>.erb</code> (templates).</p> + +<h2 id="RECIPE-LIST">RECIPE LIST</h2> + +<p><strong>knife recipe list [PATTERN]</strong></p> + +<p>List available recipes from the server. Specify <em>PATTERN</em> as a regular +expression to limit the results.</p> + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>Cookbooks are the fundamental unit of distribution in Chef. They +encapsulate all recipes of resources and assets used to configure a +particular aspect of the infrastructure. The following sub-commands can +be used to manipulate the cookbooks stored on the Chef Server.</p> + +<p>On disk, cookbooks are directories with a defined structure. The +following directories may appear within a cookbook:</p> + +<dl> +<dt>COOKBOOK/attributes/</dt><dd>Ruby files that define default parameters to be used in recipes</dd> +<dt>COOKBOOK/definitions/</dt><dd>Ruby files that contain <em>resource definitions</em></dd> +<dt>COOKBOOK/files/SPECIFICITY</dt><dd>Files of arbitrary type. These files may be downloaded by +<span class="man-ref">chef-client<span class="s">(8)</span></span> when configuring a host.</dd> +<dt>COOKBOOK/libraries/</dt><dd>Ruby files that contain library code needed for recipes</dd> +<dt>COOKBOOK/providers/</dt><dd>Ruby files that contain Lightweight Provider definitions</dd> +<dt>COOKBOOK/recipes/</dt><dd>Ruby files that use Chef's recipe DSL to describe the desired +configuration of a system</dd> +<dt>COOKBOOK/resources/</dt><dd>Ruby files that contain Lightweight Resource definitions</dd> +<dt>COOKBOOK/templates/SPECIFICITY</dt><dd>ERuby (ERb) template files. These are referenced by <em>recipes</em> and +evaluated to dynamically generate configuration files.</dd> +</dl> + + +<p><strong>SPECIFICITY</strong> is a feature of <em>files</em> and <em>templates</em> that allow you +to specify alternate files to be used on a specific OS platform or host. +The default specificity setting is <em>default</em>, that is files in +<code>COOKBOOK/files/default</code> will be used when a more specific copy is not +available. Further documentation for this feature is available on the +Chef wiki: <a href="http://wiki.opscode.com/display/chef/File+Distribution#FileDistribution-FileSpecificity" data-bare-link="true">http://wiki.opscode.com/display/chef/File+Distribution#FileDistribution-FileSpecificity</a></p> + +<p>Cookbooks also contain a metadata file that defines various properties +of the cookbook. The most important of these are the <em>version</em> and the +<em>dependencies</em>. The <em>version</em> is used in combination with environments +to select which copy of a given cookbook is distributed to a node. The +<em>dependencies</em> are used by the server to determine which additional +cookbooks must be distributed to a given host when it requires a +cookbook.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong><span class="man-ref">knife-environment<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-cookbook-site<span class="s">(1)</span></span></strong> + <a href="http://wiki.opscode.com/display/chef/Cookbooks" data-bare-link="true">http://wiki.opscode.com/display/chef/Cookbooks</a> + <a href="http://wiki.opscode.com/display/chef/Metadata" data-bare-link="true">http://wiki.opscode.com/display/chef/Metadata</a></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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-cookbook(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-data-bag.1.html b/distro/common/html/knife-data-bag.1.html new file mode 100644 index 0000000000..fb7f9b5646 --- /dev/null +++ b/distro/common/html/knife-data-bag.1.html @@ -0,0 +1,238 @@ +<!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> + +<p><strong>knife data bag from file</strong> <em>bag name</em> <em>file1</em> <em>file2</em> <em>file3</em> <em>(options)</em></p> + +<p><strong>knife data bag from file</strong> <em>bag name</em> <em>folder</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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-data-bag(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-environment.1.html b/distro/common/html/knife-environment.1.html new file mode 100644 index 0000000000..cb4ebced96 --- /dev/null +++ b/distro/common/html/knife-environment.1.html @@ -0,0 +1,267 @@ +<!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-environment(1) - Define cookbook policies for the environments 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="#SUBCOMMANDS">SUBCOMMANDS</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="#DESCRIPTION">DESCRIPTION</a> + <a href="#SYNTAX">SYNTAX</a> + <a href="#FORMAT">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-environment(1)</li> + <li class='tc'>Chef Manual</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">Define cookbook policies for the environments in your infrastructure</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>environment</strong> <em>sub-command</em> <em>(options)</em></p> + +<h2 id="SUBCOMMANDS">SUBCOMMANDS</h2> + +<p>Environment subcommands follow a basic create, read, update, delete +(CRUD) pattern. The following subcommands are available:</p> + +<h2 id="CREATE">CREATE</h2> + +<p><strong>knife environment create</strong> <em>environment</em> <em>(options)</em></p> + +<dl> +<dt><code>-d</code>, <code>--description DESCRIPTION</code></dt><dd>The value of the description field.</dd> +</dl> + + +<p>Create a new environment object on the Chef Server. The envrionment will +be opened in the text editor for editing prior to creation if the -n +option is not present.</p> + +<h2 id="DELETE">DELETE</h2> + +<p><strong>knife environment delete</strong> <em>environment</em> <em>(options)</em></p> + +<p>Destroy an environment on the Chef Server. A prompt for confirmation +will be displayed if the -y options is not given.</p> + +<h2 id="EDIT">EDIT</h2> + +<p><strong>knife environment edit</strong> <em>environment</em> <em>(options)</em></p> + +<p>Fetch <em>environment</em> and display it in the text editor for editing. The +environment will be saved to the Chef Server when the editing session +exits.</p> + +<h2 id="FROM-FILE">FROM FILE</h2> + +<p><strong>knife environment from file</strong> <em>file</em> <em>(options)</em></p> + +<p>Create or update an environment from the JSON or Ruby format <em>file</em>. See +<strong>format</strong> for the proper format of this file.</p> + +<h2 id="LIST">LIST</h2> + +<p><strong>knife environment list</strong> <em>(options)</em> + * <code>-w</code>, <code>--with-uri</code>:</p> + +<pre><code>Show the resource URI for each environment +</code></pre> + +<h2 id="SHOW">SHOW</h2> + +<p><strong>knife environment show</strong> <em>environment</em> <em>(options)</em></p> + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>Environments provide a means to apply policies to hosts in your +infrastructure based on business function. For example, you may have a +separate copy of your infrastructure called "dev" that runs the latest +version of your application and should use the newest versions of your +cookbooks when configuring systems, and a production instance of your +infrastructure where you wish to update code and cookbooks in a more +controlled fashion. In Chef, this function is implemented with +<em>environments</em>.</p> + +<p>Environments contain two major components: a set of cookbook version +constraints and environment attributes.</p> + +<h2 id="SYNTAX">SYNTAX</h2> + +<p>A cookbook version constraint is comprised of a <em>cookbook name</em> and a +<em>version constraint</em>. The <em>cookbook name</em> is the name of a cookbook in +your system, and the <em>version constraint</em> is a String describing the +version(s) of that cookbook allowed in the environment. Only one +<em>version constraint</em> is supported for a given <em>cookbook name</em>.</p> + +<p>The exact syntax used to define a cookbook version constraint varies +depending on whether you use the JSON format or the Ruby format. In the +JSON format, the cookbook version constraints for an environment are +represented as a single JSON object, like this:</p> + +<pre><code>{"apache2": ">= 1.5.0"} +</code></pre> + +<p>In the Ruby format, the cookbook version contraints for an environment +are represented as a Ruby Hash, like this:</p> + +<pre><code>{"apache2" => ">= 1.5.0"} +</code></pre> + +<p>A <em>version number</em> is a String comprised of two or three digits +separated by a dot (.) character, or in other words, strings of the form +"major.minor" or "major.minor.patch". "1.2" and "1.2.3" are examples of +valid version numbers. Version numbers containing more than three digits +or alphabetic characters are not supported.</p> + +<p>A <em>version constraint</em> String is composed of an <em>operator</em> and a +<em>version number</em>. The following operators are available:</p> + +<dl> +<dt><code>= VERSION</code></dt><dd>Equality. Only the exact version specified may be used.</dd> +<dt><code>> VERSION</code></dt><dd>Greater than. Only versions greater than <code>VERSION</code> may be used.</dd> +<dt><code>>= VERSION</code></dt><dd>Greater than or equal to. Only versions equal to VERSION or greater +may be used.</dd> +<dt><code>< VERSION</code></dt><dd>Less than. Only versions less than VERSION may be used.</dd> +<dt><code><= VERSION</code></dt><dd>Less than or equal to. Only versions lesser or equal to VERSION may +be used.</dd> +<dt><code>~> VERSION</code></dt><dd>Pessimistic greater than. Depending on the number of components in +the given VERSION, the constraint will be optimistic about future +minor or patch revisions only. For example, <code>~> 1.1</code> will match any +version less than <code>2.0</code> and greater than or equal to <code>1.1.0</code>, +whereas <code>~> 2.0.5</code> will match any version less than <code>2.1.0</code> and +greater than or equal to <code>2.0.5</code>.</dd> +</dl> + + +<h2 id="FORMAT">FORMAT</h2> + +<p>The JSON format of an envioronment is as follows:</p> + +<pre><code>{ + "name": "dev", + "description": "The development environment", + "cookbook_versions": { + "couchdb": "= 11.0.0" + }, + "json_class": "Chef::Environment", + "chef_type": "environment", + "default_attributes": { + "apache2": { "listen_ports": [ "80", "443" ] } + }, + "override_attributes": { + "aws_s3_bucket": "production" + } +} +</code></pre> + +<p>The Ruby format of an environment is as follows:</p> + +<pre><code>name "dev" +description "The development environment" +cookbook_versions "couchdb" => "= 11.0.0" +default_attributes "apache2" => { "listen_ports" => [ "80", "443" ] } +override_attributes "aws_s3_bucket" => "production" +</code></pre> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong><span class="man-ref">knife-node<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-cookbook<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-role<span class="s">(1)</span></span></strong> + <a href="http://wiki.opscode.com/display/chef/Environments" data-bare-link="true">http://wiki.opscode.com/display/chef/Environments</a> + <a href="http://wiki.opscode.com/display/chef/Version+Constraints" data-bare-link="true">http://wiki.opscode.com/display/chef/Version+Constraints</a></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 Daniel DeLeo <a href="mailto:dan@opscode.com" data-bare-link="true">dan@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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-environment(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-exec.1.html b/distro/common/html/knife-exec.1.html new file mode 100644 index 0000000000..abd81449df --- /dev/null +++ b/distro/common/html/knife-exec.1.html @@ -0,0 +1,134 @@ +<!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-exec(1) - Run user scripts using the Chef API DSL</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="#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-exec(1)</li> + <li class='tc'>Chef Manual</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">Run user scripts using the Chef API DSL</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>exec</strong> <em>(options)</em></p> + +<dl> +<dt><code>-E</code>, <code>--exec CODE</code></dt><dd>Provide a snippet of code to evaluate on the command line</dd> +</dl> + + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p><code>knife exec</code> runs arbitrary ruby scripts in a context similar to that +of the <span class="man-ref">chef-shell<span class="s">(1)</span></span> DSL. See the chef-shell documentation for a +description of the commands available.</p> + +<h2 id="EXAMPLES">EXAMPLES</h2> + +<dl> +<dt>Make an API call against an arbitrary endpoint</dt><dd>knife exec -E 'api.get("nodes/fluke.localdomain/cookbooks")' +=> list of cookbooks for the node <em>fluke.localdomain</em></dd> +<dt>Remove the role <em>obsolete</em> from all nodes</dt><dd>knife exec -E 'nodes.transform(:all){|n| n.run_list.delete("role[obsolete]")}'</dd> +<dt>Generate the expanded run list for hosts in the <code>webserver</code> role</dt><dd>knife exec -E 'nodes.find(:roles => "webserver") {|n| n.expand!; n[:recipes]}'</dd> +</dl> + + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong><span class="man-ref">chef-shell<span class="s">(1)</span></span></strong></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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-exec(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-index.1.html b/distro/common/html/knife-index.1.html new file mode 100644 index 0000000000..d5c6b6b943 --- /dev/null +++ b/distro/common/html/knife-index.1.html @@ -0,0 +1,125 @@ +<!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-index(1) - Rebuild the search index 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="#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-index(1)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>knife-index(1)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>knife-index</code> - <span class="man-whatis">Rebuild the search index on a Chef Server</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>index rebuild</strong> <em>(options)</em></p> + +<dl> +<dt><code>-y</code>, <code>--yes</code></dt><dd>don't bother to ask if I'm sure</dd> +</dl> + + +<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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-index(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-node.1.html b/distro/common/html/knife-node.1.html new file mode 100644 index 0000000000..48b104d458 --- /dev/null +++ b/distro/common/html/knife-node.1.html @@ -0,0 +1,250 @@ +<!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> + +<p>The following <code>node</code> subcommands are available:</p> + +<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 --disable-editing 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.</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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-node(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-recipe.1.html b/distro/common/html/knife-recipe.1.html new file mode 100644 index 0000000000..3f98e026a6 --- /dev/null +++ b/distro/common/html/knife-recipe.1.html @@ -0,0 +1,92 @@ +<!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-recipe(1) - List the recipes available 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> + </div> + + <ol class='man-decor man-head man head'> + <li class='tl'>knife-recipe(1)</li> + <li class='tc'>Chef Manual</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">List the recipes available on a Chef Server</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>recipe list [PATTERN]</strong></p> + +<p>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.</p> + + + <ol class='man-decor man-foot man foot'> + <li class='tl'>Chef 0.10.0</li> + <li class='tc'>April 2011</li> + <li class='tr'>knife-recipe(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-role.1.html b/distro/common/html/knife-role.1.html new file mode 100644 index 0000000000..18449b6269 --- /dev/null +++ b/distro/common/html/knife-role.1.html @@ -0,0 +1,200 @@ +<!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-role(1) - Group common configuration settings</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="#ROLE-SUB-COMMANDS">ROLE SUB-COMMANDS</a> + <a href="#LIST">LIST</a> + <a href="#SHOW">SHOW</a> + <a href="#CREATE">CREATE</a> + <a href="#EDIT">EDIT</a> + <a href="#FROM-FILE">FROM FILE</a> + <a href="#DELETE">DELETE</a> + <a href="#BULK-DELETE">BULK DELETE</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-role(1)</li> + <li class='tc'>Chef Manual</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">Group common configuration settings</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>role</strong> <em>sub-command</em> <em>(options)</em></p> + +<h2 id="ROLE-SUB-COMMANDS">ROLE SUB-COMMANDS</h2> + +<p>The following <code>role</code> subcommands are available:</p> + +<h2 id="LIST">LIST</h2> + +<p><strong>knife role list</strong> <em>(options)</em></p> + +<dl> +<dt><code>-w</code>, <code>--with-uri</code></dt><dd>Show corresponding URIs</dd> +</dl> + + +<p>List roles.</p> + +<h2 id="SHOW">SHOW</h2> + +<p><strong>knife role show ROLE</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 specific role.</p> + +<h2 id="CREATE">CREATE</h2> + +<p><strong>knife role create ROLE</strong> <em>(options)</em></p> + +<dl> +<dt><code>-d</code>, <code>--description</code></dt><dd>The role description</dd> +</dl> + + +<p>Create a new role.</p> + +<h2 id="EDIT">EDIT</h2> + +<p><strong>knife role edit ROLE</strong> <em>(options)</em></p> + +<p>Edit a role.</p> + +<h2 id="FROM-FILE">FROM FILE</h2> + +<p><strong>knife role from file FILE</strong> <em>(options)</em></p> + +<p>Create or update a role from a role Ruby DSL (<code>.rb</code>) or JSON file.</p> + +<h2 id="DELETE">DELETE</h2> + +<p><strong>knife role delete ROLE</strong> <em>(options)</em></p> + +<p>Delete a role.</p> + +<h2 id="BULK-DELETE">BULK DELETE</h2> + +<p><strong>knife role bulk delete REGEX</strong> <em>(options)</em></p> + +<p>Delete roles on the Chef Server based on a regular expression. The regular expression (<em>REGEX</em>) should be in quotes, not in //'s.</p> + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>Roles provide a mechanism to group repeated configuration settings. +Roles are data structures that contain <strong>default_attributes</strong>, and +<strong>override_attributes</strong>, which are nested hashes of configuration +settings, and a <strong>run_list</strong>, which is an ordered list of recipes and +roles that should be applied to a host by chef-client.</p> + +<p><strong>default_attributes</strong> will be overridden if they conflict with a value +on a node that includes the role. Conversely, <strong>override_attributes</strong> +will override any values set on nodes that apply them.</p> + +<p>When <strong>chef-client</strong>(8) configures a host, it will "expand" the +<strong>run_list</strong> 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.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong><span class="man-ref">knife-node<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-environment<span class="s">(1)</span></span></strong> + <a href="http://wiki.opscode.com/display/chef/Roles" data-bare-link="true">http://wiki.opscode.com/display/chef/Roles</a> + <a href="http://wiki.opscode.com/display/chef/Attributes" data-bare-link="true">http://wiki.opscode.com/display/chef/Attributes</a></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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-role(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-search.1.html b/distro/common/html/knife-search.1.html new file mode 100644 index 0000000000..5cb47d344e --- /dev/null +++ b/distro/common/html/knife-search.1.html @@ -0,0 +1,288 @@ +<!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-search(1) - Find objects on a Chef Server by query</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="#INDEXES">INDEXES</a> + <a href="#QUERY-SYNTAX">QUERY SYNTAX</a> + <a href="#EXAMPLES">EXAMPLES</a> + <a href="#KNOWN-BUGS">KNOWN BUGS</a> + <a href="#SEE-ALSO">SEE ALSO</a> + <a href="#AUTHOR">AUTHOR</a> + <a href="#DOCUMENTATION">DOCUMENTATION</a> + <a href="#CHEF">CHEF</a> + </div> + + <ol class='man-decor man-head man head'> + <li class='tl'>knife-search(1)</li> + <li class='tc'>Chef Manual</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">Find objects on a Chef Server by query</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>search INDEX QUERY</strong> <em>(options)</em></p> + +<dl> +<dt><code>-a</code>, <code>--attribute ATTR</code></dt><dd>Show only one attribute</dd> +<dt><code>-i</code>, <code>--id-only</code></dt><dd>Show only the ID of matching objects</dd> +<dt><code>-q</code>, <code>--query QUERY</code></dt><dd>The search query; useful to protect queries starting with -</dd> +<dt><code>-R</code>, <code>--rows INT</code></dt><dd>The number of rows to return</dd> +<dt><code>-r</code>, <code>--run-list</code></dt><dd>Show only the run list</dd> +<dt><code>-o</code>, <code>--sort SORT</code></dt><dd>The order to sort the results in</dd> +<dt><code>-b</code>, <code>--start ROW</code></dt><dd>The row to start returning results at</dd> +<dt><code>-m</code>, <code>--medium</code></dt><dd>Display medium sized output when searching nodes using the default +summary format</dd> +<dt><code>-l</code>, <code>--long</code></dt><dd>Display long output when searching nodes using the default summary +format</dd> +</dl> + + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>Search is a feature of the Chef Server that allows you to use a +full-text search engine to query information about your infrastructure +and applications. You can utilize this service via search calls in a +recipe or the knife search command. The search syntax is based on +Lucene.</p> + +<h2 id="INDEXES">INDEXES</h2> + +<p>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:</p> + +<ul> +<li><em>node</em></li> +<li><em>role</em></li> +<li><em>environment</em></li> +<li><em>clients</em></li> +<li><em>data bag</em></li> +</ul> + + +<p>Data bags are indexed by the data bag's name. For example, to search a +data bag named "admins":</p> + +<pre><code>knife search admins "field:search_pattern" +</code></pre> + +<h2 id="QUERY-SYNTAX">QUERY SYNTAX</h2> + +<p>Queries have the form <code>field:search_pattern</code> where <code>field</code> is a key in +the JSON description of the relevant objects (nodes, roles, +environments, or data bags). Both <code>field</code> and <code>search_pattern</code> are +case-sensitive. <code>search_pattern</code> can be an exact, wildcard, +range, or fuzzy match (see below). The <code>field</code> supports exact +matching and limited wildcard matching.</p> + +<p>Searches will return the relevant objects (nodes, roles, environments, +or data bags) where the <code>search_pattern</code> matches the object's value of +<code>field</code>.</p> + +<h3 id="FIELD-NAMES">FIELD NAMES</h3> + +<p>Field names are the keys within the JSON description of the object +being searched. Nested Keys can be searched by placing an underscore +("_") between key names.</p> + +<h3 id="WILDCARD-MATCHING-FOR-FIELD-NAMES">WILDCARD MATCHING FOR FIELD NAMES</h3> + +<p>The field name also has limited support for wildcard matching. Both +the "*" and "?" wildcards (see below) can be used within a field name; +however, they cannot be the first character of the field name.</p> + +<h3 id="EXACT-MATCHES">EXACT MATCHES</h3> + +<p>Without any search modifiers, a search returns those fields for which +the <code>search_pattern</code> exactly matches the value of <code>field</code> in the JSON +description of the object.</p> + +<h3 id="WILDCARD-MATCHES">WILDCARD MATCHES</h3> + +<p>Search support both single- and multi-character wildcard searches +within a search pattern.</p> + +<p>'?' matches exactly one character.</p> + +<p>'*' matches zero or more characters.</p> + +<h3 id="RANGE-MATCHES">RANGE MATCHES</h3> + +<p>Range searches allows one to match values between two given values. To +match values between X and Y, inclusively, use square brackets:</p> + +<pre><code>knife search INDEX 'field:[X TO Y] +</code></pre> + +<p>To match values between X and Y, exclusively, use curly brackets:</p> + +<pre><code>knife search INDEX 'field:{X TO Y}' +</code></pre> + +<p>Values are sorted in lexicographic order.</p> + +<h3 id="FUZZY-MATCHES">FUZZY MATCHES</h3> + +<p>Fuzzy searches allows one to match values based on the Levenshtein +Distance algorithm. To perform a fuzzy match, append a tilda (~) to +the search term:</p> + +<pre><code>knife search INDEX 'field:term~' +</code></pre> + +<p>This search would return nodes whose <code>field</code> was 'perm' or 'germ'.</p> + +<h3 id="BOOLEAN-OPERATORS">BOOLEAN OPERATORS</h3> + +<p>The boolean operators NOT, AND, and OR are supported. To find values +of <code>field</code> that are not X:</p> + +<pre><code>knife search INDEX 'field:(NOT X)' +</code></pre> + +<p>To find records where <code>field1</code> is X and <code>field2</code> is Y:</p> + +<pre><code>knife search INDEX 'field1:X AND field2:Y' +</code></pre> + +<p>To find records where <code>field</code> is X or Y:</p> + +<pre><code>knife search INDEX 'field:X OR field:Y' +</code></pre> + +<h3 id="QUOTING-AND-SPECIAL-CHARACTERS">QUOTING AND SPECIAL CHARACTERS</h3> + +<p>In order to avoid having special characters and escape sequences +within your search term interpreted by either Ruby or the shell, +enclose them in single quotes.</p> + +<p>Search terms that include spaces should be enclosed in double-quotes:</p> + +<pre><code>knife search INDEX 'field:"term with spaces"' +</code></pre> + +<p>The following characters must be escaped:</p> + +<pre><code>+ - && || ! ( ) { } [ ] ^ " ~ * ? : \ +</code></pre> + +<h2 id="EXAMPLES">EXAMPLES</h2> + +<p>Find the nodes with the fully-qualified domain name (FQDN) +www.example.com:</p> + +<pre><code>knife search node 'fqdn:www.example.com' +</code></pre> + +<p>Find the nodes running a version of Ubuntu:</p> + +<pre><code>knife search node 'platform:ubuntu*' +</code></pre> + +<p>Find all nodes running CentOS in the production environment:</p> + +<pre><code>knife search node 'chef_environment:production AND platform:centos' +</code></pre> + +<h2 id="KNOWN-BUGS">KNOWN BUGS</h2> + +<ul> +<li>Searches against the client index return no results in most cases. (CHEF-2477)</li> +<li>Searches using the fuzzy match operator (~) produce an error. (CHEF-2478)</li> +</ul> + + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong>knife-ssh</strong>(1) + <a href="http://wiki.opscode.com/display/chef/Attributes" data-bare-link="true">http://wiki.opscode.com/display/chef/Attributes</a> + <a href="http://lucene.apache.org/java/2_3_2/queryparsersyntax.html">Lucene Query Parser Syntax</a></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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-search(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-ssh.1.html b/distro/common/html/knife-ssh.1.html new file mode 100644 index 0000000000..693406c43d --- /dev/null +++ b/distro/common/html/knife-ssh.1.html @@ -0,0 +1,156 @@ +<!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-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} + .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="#TERMINAL-MULTIPLEXING-AND-TERMINAL-TAB-SUPPORT">TERMINAL MULTIPLEXING AND TERMINAL TAB 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-ssh(1)</li> + <li class='tc'>Chef Manual</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">Run a command or interactive session on multiple remote hosts</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>ssh QUERY COMMAND</strong> <em>(options)</em></p> + +<dl> +<dt><code>-a</code>, <code>--attribute ATTR </code></dt><dd>The attribute to use for opening the connection - default is fqdn</dd> +<dt><code>-C</code>, <code>--concurrency NUM </code></dt><dd>The number of concurrent connections</dd> +<dt><code>-m</code>, <code>--manual-list </code></dt><dd>QUERY is a space separated list of servers</dd> +<dt><code>-P</code>, <code>--ssh-password PASSWORD</code></dt><dd>The ssh password</dd> +<dt><code>-x</code>, <code>--ssh-user USERNAME </code></dt><dd>The ssh username</dd> +<dt><code>-i</code>, <code>--identity-file IDENTITY_FILE</code></dt><dd>The SSH identity file used for authentication</dd> +<dt><code>-p</code>, <code>--ssh-port PORT</code></dt><dd>The ssh port</dd> +<dt><code>--[no-]host-key-verify</code></dt><dd>Verify host key, enabled by default.</dd> +</dl> + + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>The <em>ssh</em> sub-command opens an ssh session to each of the nodes in the +search results of the <em>QUERY</em>. 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).</p> + +<h2 id="TERMINAL-MULTIPLEXING-AND-TERMINAL-TAB-SUPPORT">TERMINAL MULTIPLEXING AND TERMINAL TAB SUPPORT</h2> + +<p><code>knife ssh</code> integrates with several terminal multiplexer programs to +provide a more convenient means of managing multiple ssh sessions. When +the <em>COMMAND</em> option matches one of these, <code>knife ssh</code> will create +multiple interactive ssh sessions running locally in the terminal +multiplexer instead of invoking the command on the remote host.</p> + +<p>The available multiplexers are:</p> + +<dl> +<dt><code>interactive</code></dt><dd>A built-in multiplexer. <code>interactive</code> supports running commands on a +subset of the connected hosts in parallel</dd> +<dt><strong>screen</strong>(1)</dt><dd>Runs ssh interactively inside <code>screen</code>. ~/.screenrc will be sourced +if it exists.</dd> +<dt class="flush"><strong>tmux</strong>(1)</dt><dd>Runs ssh interactively inside tmux.</dd> +<dt><code>macterm</code> (Mac OS X only)</dt><dd>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.</dd> +</dl> + + +<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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-ssh(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-status.1.html b/distro/common/html/knife-status.1.html new file mode 100644 index 0000000000..33aaafe5c1 --- /dev/null +++ b/distro/common/html/knife-status.1.html @@ -0,0 +1,128 @@ +<!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-status(1) - Display status information for the nodes 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="#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-status(1)</li> + <li class='tc'>Chef Manual</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">Display status information for the nodes in your infrastructure</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>status</strong> <em>(options)</em></p> + +<dl> +<dt><code>-r</code>, <code>--run-list RUN_LIST</code></dt><dd>Show the run list</dd> +</dl> + + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>The <em>status</em> 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 <code>node.save</code>. 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 <code>-r</code> +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.</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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-status(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife-tag.1.html b/distro/common/html/knife-tag.1.html new file mode 100644 index 0000000000..013a296d84 --- /dev/null +++ b/distro/common/html/knife-tag.1.html @@ -0,0 +1,137 @@ +<!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-tag(1) - Apply tags to nodes 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="#TAG-SUBCOMMANDS">TAG SUBCOMMANDS</a> + <a href="#CREATE">CREATE</a> + <a href="#DELETE">DELETE</a> + <a href="#LIST">LIST</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-tag(1)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>knife-tag(1)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>knife-tag</code> - <span class="man-whatis">Apply tags to nodes on a Chef Server</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <strong>tag</strong> <em>subcommand</em> <em>(options)</em></p> + +<h2 id="TAG-SUBCOMMANDS">TAG SUBCOMMANDS</h2> + +<p>The following <code>tag</code> subcommands are available:</p> + +<h2 id="CREATE">CREATE</h2> + +<p><strong>knife tag create</strong> <em>node</em> <em>tag</em> [<em>...</em>]</p> + +<p>Adds one or more tags to <em>node</em></p> + +<h2 id="DELETE">DELETE</h2> + +<p><strong>knife tag delete</strong> <em>node</em> <em>tag</em> [<em>...</em>]</p> + +<p>Removes one or more tags from <em>node</em></p> + +<h2 id="LIST">LIST</h2> + +<p><strong>knife tag list</strong> <em>node</em></p> + +<p>Lists the tags applied to <em>node</em></p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong><span class="man-ref">knife-node<span class="s">(1)</span></span></strong></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 Daniel DeLeo <a href="mailto:dan@opscode.com" data-bare-link="true">dan@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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife-tag(1)</li> + </ol> + + </div> +</body> +</html> diff --git a/distro/common/html/knife.1.html b/distro/common/html/knife.1.html new file mode 100644 index 0000000000..bebaf89a87 --- /dev/null +++ b/distro/common/html/knife.1.html @@ -0,0 +1,320 @@ +<!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(1) - Chef Server API client 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> + <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="#OPTIONS">OPTIONS</a> + <a href="#SUB-COMMANDS">SUB-COMMANDS</a> + <a href="#CONFIGURATION">CONFIGURATION</a> + <a href="#FILES">FILES</a> + <a href="#FORMATS">FORMATS</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> + <a href="#DOCUMENTATION">DOCUMENTATION</a> + <a href="#LICENSE">LICENSE</a> + <a href="#CHEF">CHEF</a> + </div> + + <ol class='man-decor man-head man head'> + <li class='tl'>knife(1)</li> + <li class='tc'>Chef Manual</li> + <li class='tr'>knife(1)</li> + </ol> + + <h2 id="NAME">NAME</h2> +<p class="man-name"> + <code>knife</code> - <span class="man-whatis">Chef Server API client utility</span> +</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<p><strong>knife</strong> <em>sub-command</em> [<em>argument</em>...] <em>(options)</em></p> + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>Knife is a command-line utility used to manage data on a Chef server +through the HTTP(S) API. Knife is organized into groups of subcommands +centered around the various object types in Chef. Each category of +subcommand is documented in its own manual page. Available topics are:</p> + +<ul> +<li>bootstrap</li> +<li>client</li> +<li>configure</li> +<li>cookbook-site</li> +<li>cookbook</li> +<li>data-bag</li> +<li>environment</li> +<li>exec</li> +<li>index</li> +<li>node</li> +<li>recipe</li> +<li>role</li> +<li>search</li> +<li>ssh</li> +<li>status</li> +<li>tag</li> +</ul> + + +<p>If the knife manuals are in your <code>MANPATH</code>, you can access help for the +above topics using <code>man knife-TOPIC</code>; otherwise, you can view the +documentation using <code>knife help TOPIC</code>.</p> + +<h2 id="OPTIONS">OPTIONS</h2> + +<dl> +<dt><code>-s</code>, <code>--server-url</code> URL</dt><dd>Chef Server URL, corresponds to <code>Chef::Config</code> <code>chef_server_url</code>.</dd> +<dt><code>-k</code>, <code>--key</code> KEY</dt><dd>API Client Key, corresponds to <code>Chef::Config</code> <code>client_key</code>.</dd> +<dt><code>-c</code>, <code>--config</code> CONFIG</dt><dd>The configuration file to use</dd> +<dt><code>-E</code>, <code>--environment ENVIRONMENT</code></dt><dd>Set the Chef environment</dd> +<dt><code>-e</code>, <code>--editor</code> EDITOR</dt><dd>Set the editor to use for interactive commands</dd> +<dt><code>-F</code>, <code>--format</code> FORMAT</dt><dd>Which format to use for output. See FORMATS for details.</dd> +<dt><code>-d</code>, <code>--disable-editing</code></dt><dd>Do not open EDITOR, just accept the data as is</dd> +<dt><code>-u</code>, <code>--user</code> USER</dt><dd>API Client Username, corresponds to <code>Chef::Config</code> <code>node_name</code>.</dd> +<dt><code>-p</code>, <code>--print-after</code></dt><dd>Show the data after a destructive operation</dd> +<dt><code>-v</code>, <code>--version</code></dt><dd>Show chef version</dd> +<dt><code>-V</code>, <code>--verbose</code></dt><dd>More verbose output. Use twice for max verbosity.</dd> +<dt><code>-y</code>, <code>--yes</code></dt><dd>Say yes to all prompts for confirmation</dd> +<dt><code>--defaults</code></dt><dd>Accept default values for all questions</dd> +<dt><code>--[no-]color</code></dt><dd>Use colored output. Color enabled by default.</dd> +<dt><code>-h</code>, <code>--help</code></dt><dd>Show the available options for a command.</dd> +</dl> + + +<h2 id="SUB-COMMANDS">SUB-COMMANDS</h2> + +<p>Sub-commands that operate on the basic Chef data types are structured as +<em>NOUN verb NOUN (options)</em>. For all data types, the following commands +are available:</p> + +<ul> +<li>create (create)</li> +<li>list and show (read)</li> +<li>edit (update)</li> +<li>delete (destroy)</li> +</ul> + + +<p>Knife also includes commands that take actions other than displaying or +modifying data on the Chef Server, such as <strong><span class="man-ref">knife-ssh<span class="s">(1)</span></span></strong>.</p> + +<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>If the config file exists, knife uses these settings for <strong>GENERAL OPTIONS</strong> defaults.</p> + +<ul> +<li><code>node_name</code>: +User or client identity (i.e., <em>name</em>) to use for authenticating +requests to the Chef Server.</li> +<li><code>client_key</code>: +Private key file to authenticate to the Chef server. Corresponds to the +<code>-k</code> or <code>--key</code> option.</li> +<li><code>chef_server_url</code>: +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.</li> +<li><code>cache_type</code>: +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.</li> +<li><code>cache_options</code>: +Specifies various options to use for caching. These options are +dependent on the <code>cache_type</code>.</li> +<li><code>validation_client_name</code>: +Specifies the name of the client used to validate new clients.</li> +<li><code>validation_key</code>: +Specifies the private key file to use when bootstrapping new hosts. +See <span class="man-ref">knife-client<span class="s">(1)</span></span> for more information about the validation +client.</li> +<li><code>cookbook_copyright</code>, <code>cookbook_email</code>, <code>cookbook_license</code>, <code>readme_format</code> +Used by <code>knife cookbook create</code> sub-command to specify the copyright +holder, maintainer email, license and readme format (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. Currently supported +readme formats are "md", "mkd", "txt", and "rdoc". Any other value will +result in an unformatted README.</li> +</ul> + + +<h2 id="FILES">FILES</h2> + +<p><em>~/.chef/knife.rb</em></p> + +<p>Ruby DSL configuration file for knife. See <strong>CONFIGURATION</strong>.</p> + +<h2 id="FORMATS">FORMATS</h2> + +<p>The amount of content displayed and the output format are +modified by the <code>--format</code> option. If no alternate format is selected, +the default is summary.</p> + +<p>Valid formats are:</p> + +<dl> +<dt class="flush"><code>summary</code></dt><dd>displays the node in a custom, summarized format (default)</dd> +<dt class="flush"><code>text</code></dt><dd>displays the node data in its entirety using the colorized tree display</dd> +<dt class="flush"><code>json</code></dt><dd>displays the node in JSON format</dd> +<dt class="flush"><code>yaml</code></dt><dd>displays the node in YAML format</dd> +<dt class="flush"><code>pp</code></dt><dd>displays the node using Ruby's pretty printer.</dd> +</dl> + + +<p>For brevity, only the first character of the format is required, for +example, -Fj will produce JSON format output.</p> + +<h2 id="CHEF-WORKFLOW">CHEF WORKFLOW</h2> + +<p>When working with Chef and Knife in the local repository, the recommended workflow outline looks like:</p> + +<ul> +<li>Create repository. A skeleton sample is provided at <em>http://github.com/opscode/chef-repo/</em>.</li> +<li>Configure knife, see <strong>CONFIGURATION</strong>.</li> +<li>Download cookbooks from the Opscode cookbooks site, see <strong>COOKBOOK SITE SUB-COMMANDS</strong>.</li> +<li>Or, create new cookbooks, see <code>cookbook create</code> sub-command.</li> +<li>Commit changes to the version control system. See your tool's documentation.</li> +<li>Upload cookbooks to the Chef Server, see <strong>COOKBOOK SUB-COMMANDS</strong>.</li> +<li>Launch instances in the Cloud, OR provision new hosts; see <strong>CLOUD COMPUTING SUB-COMMANDS</strong> and <strong>BOOTSTRAP SUB-COMMANDS</strong>.</li> +<li>Watch Chef configure systems!</li> +</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> + +<h2 id="EXAMPLES">EXAMPLES</h2> + +<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 --disable-editing option supresses +data editing entirely.</dd> +</dl> + + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<p> <strong><span class="man-ref">chef-client<span class="s">(8)</span></span></strong> <strong><span class="man-ref">chef-server<span class="s">(8)</span></span></strong> <strong><span class="man-ref">chef-shell<span class="s">(1)</span></span></strong></p> + +<p> <strong><span class="man-ref">knife-bootstrap<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-client<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-configure<span class="s">(1)</span></span></strong> + <strong><span class="man-ref">knife-cookbook-site<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-cookbook<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-data-bag<span class="s">(1)</span></span></strong> + <strong><span class="man-ref">knife-environment<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-exec<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-index<span class="s">(1)</span></span></strong> + <strong><span class="man-ref">knife-node<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-recipe<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-role<span class="s">(1)</span></span></strong> + <strong><span class="man-ref">knife-search<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-ssh<span class="s">(1)</span></span></strong> <strong><span class="man-ref">knife-tag<span class="s">(1)</span></span></strong></p> + +<p> Complete Chef documentation is available online: <a href="http://wiki.opscode.com/display/chef/Home/" data-bare-link="true">http://wiki.opscode.com/display/chef/Home/</a></p> + +<p> JSON is JavaScript Object Notation <a href="http://json.org/" data-bare-link="true">http://json.org/</a></p> + +<p> SOLR is an open source search engine. <a href="http://lucene.apache.org/solr/" data-bare-link="true">http://lucene.apache.org/solr/</a></p> + +<p> <strong><span class="man-ref">git<span class="s">(1)</span></span></strong> is a version control system <a href="http://git-scm.com/" data-bare-link="true">http://git-scm.com/</a></p> + +<p> This manual page was generated from Markdown with <strong><span class="man-ref">ronn<span class="s">(1)</span></span></strong> <a href="http://rtomayko.github.com/ronn/ronn.1.html" data-bare-link="true">http://rtomayko.github.com/ronn/ronn.1.html</a></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> of Opscode + (<a href="http://www.opscode.com" data-bare-link="true">http://www.opscode.com</a>), with 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>.</p> + +<h2 id="LICENSE">LICENSE</h2> + +<p> Both Chef and this documentation are released under the terms of the + Apache 2.0 License. You may view the license online: <a href="http://www.apache.org/licenses/LICENSE-2.0.html" data-bare-link="true">http://www.apache.org/licenses/LICENSE-2.0.html</a> + On some systems, the complete text of the Apache 2.0 License may be found in <code>/usr/share/common-licenses/Apache-2.0</code>.</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 11.0.0.alpha</li> + <li class='tc'>September 2012</li> + <li class='tr'>knife(1)</li> + </ol> + + </div> +</body> +</html> |