summaryrefslogtreecommitdiff
path: root/distro/common/html/knife-node.1.html
diff options
context:
space:
mode:
authorSeth Chisamore <schisamo@opscode.com>2012-10-30 10:39:35 -0400
committerSeth Chisamore <schisamo@opscode.com>2012-10-30 10:39:35 -0400
commit24dc69a9a97e82a6e4207de68d6dcc664178249b (patch)
tree19bb289c9f88b4bbab066bc56b95d6d222fd5c35 /distro/common/html/knife-node.1.html
parent9348c1c9c80ee757354d624b7dc1b78ebc7605c4 (diff)
downloadchef-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/knife-node.1.html')
-rw-r--r--distro/common/html/knife-node.1.html250
1 files changed, 250 insertions, 0 deletions
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="&#109;&#x61;&#x69;&#x6c;&#116;&#x6f;&#58;&#x61;&#100;&#97;&#109;&#64;&#x6f;&#x70;&#115;&#99;&#x6f;&#100;&#101;&#46;&#99;&#111;&#x6d;" data-bare-link="true">&#x61;&#x64;&#x61;&#x6d;&#64;&#x6f;&#x70;&#x73;&#x63;&#x6f;&#x64;&#x65;&#x2e;&#99;&#x6f;&#x6d;</a> with many contributions from the community.</p>
+
+<h2 id="DOCUMENTATION">DOCUMENTATION</h2>
+
+<p> This manual page was written by Joshua Timberman <a href="&#109;&#x61;&#x69;&#108;&#x74;&#111;&#58;&#x6a;&#x6f;&#115;&#x68;&#117;&#x61;&#x40;&#x6f;&#112;&#x73;&#99;&#x6f;&#x64;&#101;&#46;&#x63;&#x6f;&#x6d;" data-bare-link="true">&#106;&#111;&#x73;&#104;&#x75;&#97;&#64;&#x6f;&#x70;&#115;&#99;&#111;&#100;&#x65;&#x2e;&#x63;&#x6f;&#x6d;</a>.
+ Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
+
+<h2 id="CHEF">CHEF</h2>
+
+<p> 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>