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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. data/distro/common/html/knife-bootstrap.1.html +69 -10
  2. data/distro/common/html/knife-client.1.html +25 -22
  3. data/distro/common/html/knife-configure.1.html +1 -1
  4. data/distro/common/html/knife-cookbook-site.1.html +91 -19
  5. data/distro/common/html/knife-cookbook.1.html +216 -76
  6. data/distro/common/html/knife-data-bag.1.html +1 -1
  7. data/distro/common/html/knife-environment.1.html +177 -3
  8. data/distro/common/html/knife-exec.1.html +44 -3
  9. data/distro/common/html/knife-index.1.html +1 -1
  10. data/distro/common/html/knife-node.1.html +5 -3
  11. data/distro/common/html/knife-recipe.1.html +1 -1
  12. data/distro/common/html/knife-role.1.html +83 -19
  13. data/distro/common/html/knife-search.1.html +43 -2
  14. data/distro/common/html/knife-ssh.1.html +57 -2
  15. data/distro/common/html/knife-status.1.html +33 -2
  16. data/distro/common/html/knife-tag.1.html +45 -1
  17. data/distro/common/html/knife.1.html +94 -161
  18. data/distro/common/html/shef.1.html +283 -0
  19. data/distro/common/man/man1/knife-bootstrap.1 +56 -4
  20. data/distro/common/man/man1/knife-client.1 +12 -11
  21. data/distro/common/man/man1/knife-configure.1 +1 -1
  22. data/distro/common/man/man1/knife-cookbook-site.1 +64 -22
  23. data/distro/common/man/man1/knife-cookbook.1 +200 -122
  24. data/distro/common/man/man1/knife-data-bag.1 +1 -1
  25. data/distro/common/man/man1/knife-environment.1 +167 -2
  26. data/distro/common/man/man1/knife-exec.1 +36 -3
  27. data/distro/common/man/man1/knife-index.1 +1 -1
  28. data/distro/common/man/man1/knife-node.1 +2 -1
  29. data/distro/common/man/man1/knife-role.1 +48 -24
  30. data/distro/common/man/man1/knife-search.1 +27 -3
  31. data/distro/common/man/man1/knife-ssh.1 +43 -2
  32. data/distro/common/man/man1/knife-status.1 +14 -2
  33. data/distro/common/man/man1/knife-tag.1 +32 -2
  34. data/distro/common/man/man1/knife.1 +91 -186
  35. data/distro/common/man/man1/shef.1 +237 -26
  36. data/distro/common/markdown/man1/knife-bootstrap.mkd +57 -7
  37. data/distro/common/markdown/man1/knife-client.mkd +19 -17
  38. data/distro/common/markdown/man1/knife-cookbook-site.mkd +63 -15
  39. data/distro/common/markdown/man1/knife-cookbook.mkd +220 -103
  40. data/distro/common/markdown/man1/knife-environment.mkd +144 -1
  41. data/distro/common/markdown/man1/knife-exec.mkd +29 -1
  42. data/distro/common/markdown/man1/knife-node.mkd +1 -1
  43. data/distro/common/markdown/man1/knife-role.mkd +36 -30
  44. data/distro/common/markdown/man1/knife-search.mkd +0 -1
  45. data/distro/common/markdown/man1/knife-ssh.mkd +0 -2
  46. data/distro/common/markdown/man1/knife-status.mkd +0 -2
  47. data/distro/common/markdown/man1/knife-tag.mkd +31 -0
  48. data/distro/common/markdown/man1/knife.mkd +93 -165
  49. data/distro/common/markdown/man1/shef.mkd +189 -0
  50. data/lib/chef/api_client.rb +36 -35
  51. data/lib/chef/application/knife.rb +1 -1
  52. data/lib/chef/client.rb +1 -0
  53. data/lib/chef/cookbook/cookbook_version_loader.rb +29 -7
  54. data/lib/chef/cookbook_uploader.rb +55 -36
  55. data/lib/chef/cookbook_version.rb +3 -1
  56. data/lib/chef/couchdb.rb +0 -1
  57. data/lib/chef/knife/cookbook_list.rb +1 -1
  58. data/lib/chef/knife/cookbook_show.rb +1 -0
  59. data/lib/chef/knife/core/generic_presenter.rb +3 -3
  60. data/lib/chef/knife/help.rb +6 -2
  61. data/lib/chef/knife/tag_create.rb +26 -5
  62. data/lib/chef/knife/tag_delete.rb +34 -5
  63. data/lib/chef/knife/tag_list.rb +24 -6
  64. data/lib/chef/node.rb +1 -0
  65. data/lib/chef/role.rb +1 -0
  66. data/lib/chef/shef.rb +1 -0
  67. data/lib/chef/version.rb +1 -1
  68. metadata +4 -4
  69. data/distro/common/man/man1/knife-recipe.1 +0 -13
  70. data/distro/common/markdown/man1/knife-recipe.mkd +0 -24
@@ -61,6 +61,13 @@
61
61
  <div class='man-navigation' style='display:none'>
62
62
  <a href="#NAME">NAME</a>
63
63
  <a href="#SYNOPSIS">SYNOPSIS</a>
64
+ <a href="#DESCRIPTION">DESCRIPTION</a>
65
+ <a href="#SYNTAX">SYNTAX</a>
66
+ <a href="#EXAMPLES">EXAMPLES</a>
67
+ <a href="#SEE-ALSO">SEE ALSO</a>
68
+ <a href="#AUTHOR">AUTHOR</a>
69
+ <a href="#DOCUMENTATION">DOCUMENTATION</a>
70
+ <a href="#CHEF">CHEF</a>
64
71
  </div>
65
72
 
66
73
  <ol class='man-decor man-head man head'>
@@ -85,14 +92,48 @@
85
92
  <dt><code>-r</code>, <code>--run-list</code></dt><dd>Show only the run list</dd>
86
93
  <dt><code>-o</code>, <code>--sort SORT</code></dt><dd>The order to sort the results in</dd>
87
94
  <dt><code>-b</code>, <code>--start ROW</code></dt><dd>The row to start returning results at</dd>
95
+ <dt><code>-m</code>, <code>--medium</code></dt><dd>Display medium sized output when searching nodes using the default
96
+ summary format</dd>
97
+ <dt><code>-l</code>, <code>--long</code></dt><dd>Display long output when searching nodes using the default summary
98
+ format</dd>
88
99
  </dl>
89
100
 
90
101
 
91
- <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: <em>node</em>, <em>role</em>, <em>client</em>, <em>data bag</em>.</p>
102
+ <h2 id="DESCRIPTION">DESCRIPTION</h2>
103
+
104
+ <p>Search indexes are a feature of the Chef Server and the search
105
+ sub-command allows querying any of the available indexes using SOLR
106
+ query syntax. The following data types are indexed for search:
107
+ * <em>node</em>
108
+ * <em>role</em>
109
+ * <em>environment</em>
110
+ * <em>data bag</em></p>
111
+
112
+ <h2 id="SYNTAX">SYNTAX</h2>
113
+
114
+ <h2 id="EXAMPLES">EXAMPLES</h2>
115
+
116
+ <h2 id="SEE-ALSO">SEE ALSO</h2>
117
+
118
+ <p> <strong>knife-ssh</strong>(1)
119
+ <a href="http://wiki.opscode.com/display/chef/Attributes" data-bare-link="true">http://wiki.opscode.com/display/chef/Attributes</a></p>
120
+
121
+ <h2 id="AUTHOR">AUTHOR</h2>
122
+
123
+ <p> Chef was written by Adam Jacob <a href="&#x6d;&#x61;&#105;&#108;&#116;&#x6f;&#x3a;&#x61;&#100;&#x61;&#109;&#x40;&#x6f;&#112;&#x73;&#99;&#111;&#100;&#101;&#x2e;&#x63;&#x6f;&#x6d;" data-bare-link="true">&#x61;&#x64;&#x61;&#109;&#64;&#111;&#x70;&#x73;&#x63;&#x6f;&#x64;&#x65;&#x2e;&#99;&#111;&#109;</a> with many contributions from the community.</p>
124
+
125
+ <h2 id="DOCUMENTATION">DOCUMENTATION</h2>
126
+
127
+ <p> This manual page was written by Joshua Timberman <a href="&#109;&#97;&#105;&#x6c;&#x74;&#111;&#58;&#x6a;&#x6f;&#x73;&#104;&#117;&#97;&#x40;&#x6f;&#x70;&#x73;&#99;&#111;&#x64;&#101;&#x2e;&#99;&#x6f;&#109;" data-bare-link="true">&#x6a;&#x6f;&#115;&#x68;&#x75;&#97;&#x40;&#x6f;&#x70;&#115;&#x63;&#x6f;&#100;&#101;&#46;&#x63;&#111;&#109;</a>.
128
+ Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
129
+
130
+ <h2 id="CHEF">CHEF</h2>
131
+
132
+ <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>
92
133
 
93
134
 
94
135
  <ol class='man-decor man-foot man foot'>
95
- <li class='tl'>Chef 0.10.0.beta.8</li>
136
+ <li class='tl'>Chef 0.10.0.beta.9</li>
96
137
  <li class='tc'>April 2011</li>
97
138
  <li class='tr'>knife-search(1)</li>
98
139
  </ol>
@@ -61,6 +61,12 @@
61
61
  <div class='man-navigation' style='display:none'>
62
62
  <a href="#NAME">NAME</a>
63
63
  <a href="#SYNOPSIS">SYNOPSIS</a>
64
+ <a href="#DESCRIPTION">DESCRIPTION</a>
65
+ <a href="#TERMINAL-MULTIPLEXING-AND-TERMINAL-TAB-SUPPORT">TERMINAL MULTIPLEXING AND TERMINAL TAB SUPPORT</a>
66
+ <a href="#SEE-ALSO">SEE ALSO</a>
67
+ <a href="#AUTHOR">AUTHOR</a>
68
+ <a href="#DOCUMENTATION">DOCUMENTATION</a>
69
+ <a href="#CHEF">CHEF</a>
64
70
  </div>
65
71
 
66
72
  <ol class='man-decor man-head man head'>
@@ -87,11 +93,60 @@
87
93
  </dl>
88
94
 
89
95
 
90
- <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>
96
+ <h2 id="DESCRIPTION">DESCRIPTION</h2>
97
+
98
+ <p>The <em>ssh</em> sub-command opens an ssh session to each of the nodes in the
99
+ search results of the <em>QUERY</em>. This sub-command requires that the
100
+ net-ssh-multi and highline Ruby libraries are installed. On Debian
101
+ systems, these are the libnet-ssh-multi-ruby and libhighline-ruby
102
+ packages. They can also be installed as RubyGems (net-ssh-multi and
103
+ highline, respectively).</p>
104
+
105
+ <h2 id="TERMINAL-MULTIPLEXING-AND-TERMINAL-TAB-SUPPORT">TERMINAL MULTIPLEXING AND TERMINAL TAB SUPPORT</h2>
106
+
107
+ <p><code>knife ssh</code> integrates with several terminal multiplexer programs to
108
+ provide a more convenient means of managing multiple ssh sessions. When
109
+ the <em>COMMAND</em> option matches one of these, <code>knife ssh</code> will create
110
+ multiple interactive ssh sessions running locally in the terminal
111
+ multiplexer instead of invoking the command on the remote host.</p>
112
+
113
+ <p>The available multiplexers are:
114
+ * <code>interactive</code>:</p>
115
+
116
+ <pre><code>A built-in multiplexer. `interactive` supports running commands on a
117
+ subset of the connected hosts in parallel
118
+ </code></pre>
119
+
120
+ <dl>
121
+ <dt><strong>screen</strong>(1)</dt><dd>Runs ssh interactively inside <code>screen</code>. ~/.screenrc will be sourced
122
+ if it exists.</dd>
123
+ <dt class="flush"><strong>tmux</strong>(1)</dt><dd>Runs ssh interactively inside tmux.</dd>
124
+ <dt><code>macterm</code> (Mac OS X only)</dt><dd>Opens a Terminal.app window and creates a tab for each ssh session.
125
+ You must install the rb-appscript gem before you can use this
126
+ option.</dd>
127
+ </dl>
128
+
129
+
130
+ <h2 id="SEE-ALSO">SEE ALSO</h2>
131
+
132
+ <p> <strong>knife-search</strong>(1)</p>
133
+
134
+ <h2 id="AUTHOR">AUTHOR</h2>
135
+
136
+ <p> Chef was written by Adam Jacob <a href="&#x6d;&#x61;&#105;&#108;&#116;&#x6f;&#x3a;&#x61;&#100;&#x61;&#109;&#x40;&#x6f;&#112;&#x73;&#99;&#111;&#100;&#101;&#x2e;&#x63;&#x6f;&#x6d;" data-bare-link="true">&#x61;&#x64;&#x61;&#109;&#64;&#111;&#x70;&#x73;&#x63;&#x6f;&#x64;&#x65;&#x2e;&#99;&#111;&#109;</a> with many contributions from the community.</p>
137
+
138
+ <h2 id="DOCUMENTATION">DOCUMENTATION</h2>
139
+
140
+ <p> This manual page was written by Joshua Timberman <a href="&#109;&#97;&#105;&#x6c;&#x74;&#111;&#58;&#x6a;&#x6f;&#x73;&#104;&#117;&#97;&#x40;&#x6f;&#x70;&#x73;&#99;&#111;&#x64;&#101;&#x2e;&#99;&#x6f;&#109;" data-bare-link="true">&#x6a;&#x6f;&#115;&#x68;&#x75;&#97;&#x40;&#x6f;&#x70;&#115;&#x63;&#x6f;&#100;&#101;&#46;&#x63;&#111;&#109;</a>.
141
+ Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
142
+
143
+ <h2 id="CHEF">CHEF</h2>
144
+
145
+ <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>
91
146
 
92
147
 
93
148
  <ol class='man-decor man-foot man foot'>
94
- <li class='tl'>Chef 0.10.0.beta.8</li>
149
+ <li class='tl'>Chef 0.10.0.beta.9</li>
95
150
  <li class='tc'>April 2011</li>
96
151
  <li class='tr'>knife-ssh(1)</li>
97
152
  </ol>
@@ -61,6 +61,11 @@
61
61
  <div class='man-navigation' style='display:none'>
62
62
  <a href="#NAME">NAME</a>
63
63
  <a href="#SYNOPSIS">SYNOPSIS</a>
64
+ <a href="#DESCRIPTION">DESCRIPTION</a>
65
+ <a href="#SEE-ALSO">SEE ALSO</a>
66
+ <a href="#AUTHOR">AUTHOR</a>
67
+ <a href="#DOCUMENTATION">DOCUMENTATION</a>
68
+ <a href="#CHEF">CHEF</a>
64
69
  </div>
65
70
 
66
71
  <ol class='man-decor man-head man head'>
@@ -83,11 +88,37 @@
83
88
  </dl>
84
89
 
85
90
 
86
- <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>
91
+ <h2 id="DESCRIPTION">DESCRIPTION</h2>
92
+
93
+ <p>The <em>status</em> sub-command searches the Chef Server for all nodes and
94
+ displays information about the last time the node checked into the
95
+ server and executed a <code>node.save</code>. The fields displayed are the relative
96
+ checkin time, the node name, it's operating system platform and version,
97
+ the fully-qualified domain name and the default IP address. If the <code>-r</code>
98
+ option is given, the node's run list will also be displayed. Note that
99
+ depending on the configuration of the nodes, the FQDN and IP displayed
100
+ may not be publicly reachable.</p>
101
+
102
+ <h2 id="SEE-ALSO">SEE ALSO</h2>
103
+
104
+ <p> <strong>knife-search</strong>(1)</p>
105
+
106
+ <h2 id="AUTHOR">AUTHOR</h2>
107
+
108
+ <p> Chef was written by Adam Jacob <a href="&#x6d;&#x61;&#105;&#108;&#116;&#x6f;&#x3a;&#x61;&#100;&#x61;&#109;&#x40;&#x6f;&#112;&#x73;&#99;&#111;&#100;&#101;&#x2e;&#x63;&#x6f;&#x6d;" data-bare-link="true">&#x61;&#x64;&#x61;&#109;&#64;&#111;&#x70;&#x73;&#x63;&#x6f;&#x64;&#x65;&#x2e;&#99;&#111;&#109;</a> with many contributions from the community.</p>
109
+
110
+ <h2 id="DOCUMENTATION">DOCUMENTATION</h2>
111
+
112
+ <p> This manual page was written by Joshua Timberman <a href="&#109;&#97;&#105;&#x6c;&#x74;&#111;&#58;&#x6a;&#x6f;&#x73;&#104;&#117;&#97;&#x40;&#x6f;&#x70;&#x73;&#99;&#111;&#x64;&#101;&#x2e;&#99;&#x6f;&#109;" data-bare-link="true">&#x6a;&#x6f;&#115;&#x68;&#x75;&#97;&#x40;&#x6f;&#x70;&#115;&#x63;&#x6f;&#100;&#101;&#46;&#x63;&#111;&#109;</a>.
113
+ Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
114
+
115
+ <h2 id="CHEF">CHEF</h2>
116
+
117
+ <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>
87
118
 
88
119
 
89
120
  <ol class='man-decor man-foot man foot'>
90
- <li class='tl'>Chef 0.10.0.beta.8</li>
121
+ <li class='tl'>Chef 0.10.0.beta.9</li>
91
122
  <li class='tc'>April 2011</li>
92
123
  <li class='tr'>knife-status(1)</li>
93
124
  </ol>
@@ -62,6 +62,13 @@
62
62
  <a href="#NAME">NAME</a>
63
63
  <a href="#SYNOPSIS">SYNOPSIS</a>
64
64
  <a href="#TAG-SUBCOMMANDS">TAG SUBCOMMANDS</a>
65
+ <a href="#CREATE">CREATE</a>
66
+ <a href="#DELETE">DELETE</a>
67
+ <a href="#LIST">LIST</a>
68
+ <a href="#SEE-ALSO">SEE ALSO</a>
69
+ <a href="#AUTHOR">AUTHOR</a>
70
+ <a href="#DOCUMENTATION">DOCUMENTATION</a>
71
+ <a href="#CHEF">CHEF</a>
65
72
  </div>
66
73
 
67
74
  <ol class='man-decor man-head man head'>
@@ -81,9 +88,46 @@
81
88
 
82
89
  <h2 id="TAG-SUBCOMMANDS">TAG SUBCOMMANDS</h2>
83
90
 
91
+ <p>The following <code>tag</code> subcommands are available:</p>
92
+
93
+ <h2 id="CREATE">CREATE</h2>
94
+
95
+ <p><strong>knife tag create</strong> <em>node</em> <em>tag</em> [<em>...</em>]</p>
96
+
97
+ <p>Adds one or more tags to <em>node</em></p>
98
+
99
+ <h2 id="DELETE">DELETE</h2>
100
+
101
+ <p><strong>knife tag delete</strong> <em>node</em> <em>tag</em> [<em>...</em>]</p>
102
+
103
+ <p>Removes one or more tags from <em>node</em></p>
104
+
105
+ <h2 id="LIST">LIST</h2>
106
+
107
+ <p><strong>knife tag list</strong> <em>node</em></p>
108
+
109
+ <p>Lists the tags applied to <em>node</em></p>
110
+
111
+ <h2 id="SEE-ALSO">SEE ALSO</h2>
112
+
113
+ <p> <strong><span class="man-ref">knife-node<span class="s">(1)</span></span></strong></p>
114
+
115
+ <h2 id="AUTHOR">AUTHOR</h2>
116
+
117
+ <p> Chef was written by Adam Jacob <a href="&#109;&#97;&#x69;&#108;&#x74;&#x6f;&#x3a;&#97;&#100;&#x61;&#109;&#64;&#x6f;&#112;&#x73;&#x63;&#x6f;&#x64;&#x65;&#x2e;&#x63;&#x6f;&#x6d;" data-bare-link="true">&#x61;&#100;&#97;&#109;&#x40;&#111;&#x70;&#115;&#x63;&#x6f;&#x64;&#x65;&#x2e;&#x63;&#111;&#x6d;</a> with many contributions from the community.</p>
118
+
119
+ <h2 id="DOCUMENTATION">DOCUMENTATION</h2>
120
+
121
+ <p> This manual page was written by Daniel DeLeo <a href="&#x6d;&#x61;&#105;&#x6c;&#116;&#111;&#x3a;&#100;&#x61;&#110;&#x40;&#111;&#112;&#115;&#x63;&#x6f;&#100;&#x65;&#x2e;&#99;&#111;&#109;" data-bare-link="true">&#100;&#x61;&#x6e;&#x40;&#111;&#112;&#115;&#99;&#111;&#100;&#x65;&#46;&#x63;&#x6f;&#109;</a>.
122
+ Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
123
+
124
+ <h2 id="CHEF">CHEF</h2>
125
+
126
+ <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>
127
+
84
128
 
85
129
  <ol class='man-decor man-foot man foot'>
86
- <li class='tl'>Chef 0.10.0.beta.8</li>
130
+ <li class='tl'>Chef 0.10.0.beta.9</li>
87
131
  <li class='tc'>April 2011</li>
88
132
  <li class='tr'>knife-tag(1)</li>
89
133
  </ol>
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta http-equiv='content-type' value='text/html;charset=utf8'>
5
5
  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
6
- <title>knife(1) - Chef Server REST API utility</title>
6
+ <title>knife(1) - Chef Server API client utility</title>
7
7
  <style type='text/css' media='all'>
8
8
  /* style: man */
9
9
  body#manpage {margin:0}
@@ -62,9 +62,8 @@
62
62
  <a href="#NAME">NAME</a>
63
63
  <a href="#SYNOPSIS">SYNOPSIS</a>
64
64
  <a href="#DESCRIPTION">DESCRIPTION</a>
65
- <a href="#GENERAL-OPTIONS">GENERAL OPTIONS</a>
65
+ <a href="#OPTIONS">OPTIONS</a>
66
66
  <a href="#SUB-COMMANDS">SUB-COMMANDS</a>
67
- <a href="#GENERAL-SUB-COMMANDS">GENERAL SUB-COMMANDS</a>
68
67
  <a href="#CONFIGURATION">CONFIGURATION</a>
69
68
  <a href="#FILES">FILES</a>
70
69
  <a href="#CHEF-WORKFLOW">CHEF WORKFLOW</a>
@@ -72,6 +71,9 @@
72
71
  <a href="#ENVIRONMENT">ENVIRONMENT</a>
73
72
  <a href="#SEE-ALSO">SEE ALSO</a>
74
73
  <a href="#AUTHOR">AUTHOR</a>
74
+ <a href="#DOCUMENTATION">DOCUMENTATION</a>
75
+ <a href="#LICENSE">LICENSE</a>
76
+ <a href="#CHEF">CHEF</a>
75
77
  </div>
76
78
 
77
79
  <ol class='man-decor man-head man head'>
@@ -82,30 +84,45 @@
82
84
 
83
85
  <h2 id="NAME">NAME</h2>
84
86
  <p class="man-name">
85
- <code>knife</code> - <span class="man-whatis">Chef Server REST API utility</span>
87
+ <code>knife</code> - <span class="man-whatis">Chef Server API client utility</span>
86
88
  </p>
87
89
 
88
90
  <h2 id="SYNOPSIS">SYNOPSIS</h2>
89
91
 
90
- <p><strong>knife</strong> <em>sub-command</em> <em>(options)</em></p>
92
+ <p><strong>knife</strong> <em>sub-command</em> [<em>argument</em>...] <em>(options)</em></p>
91
93
 
92
94
  <h2 id="DESCRIPTION">DESCRIPTION</h2>
93
95
 
94
- <p>This manual page documents knife, a command-line utility used to
95
- interact with a Chef server directly through the RESTful API. Knife uses
96
- sub-commands to take various actions on different types of Chef objects.
97
- Some sub-commands take additional options. General options follow
98
- sub-commands and their options. A configuration file can be created for
99
- common defaults.</p>
96
+ <p>Knife is a command-line utility used to manage data on a Chef server
97
+ through the HTTP(S) API. Knife is organized into groups of subcommands
98
+ centered around the various object types in Chef. Each category of
99
+ subcommand is documented in its own manual page. Available topics are:</p>
100
100
 
101
- <p>Unless otherwise specified, output is in JSON format, and input files
102
- are also JSON format.</p>
101
+ <ul>
102
+ <li>bootstrap</li>
103
+ <li>client</li>
104
+ <li>configure</li>
105
+ <li>cookbook-site</li>
106
+ <li>cookbook</li>
107
+ <li>data-bag</li>
108
+ <li>environment</li>
109
+ <li>exec</li>
110
+ <li>index</li>
111
+ <li>node</li>
112
+ <li>recipe</li>
113
+ <li>role</li>
114
+ <li>search</li>
115
+ <li>ssh</li>
116
+ <li>status</li>
117
+ <li>tag</li>
118
+ </ul>
103
119
 
104
- <p>The Chef class <code>Chef::Config</code> that configures the behavior of how knife
105
- runs has options that correspond to command-line options. These are
106
- noted as <code>Chef::Config</code> values.</p>
107
120
 
108
- <h2 id="GENERAL-OPTIONS">GENERAL OPTIONS</h2>
121
+ <p>If the knife manuals are in your <code>MANPATH</code>, you can access help for the
122
+ above topics using <code>man knife-TOPIC</code>; otherwise, you can view the
123
+ documentation using <code>knife help TOPIC</code>.</p>
124
+
125
+ <h2 id="OPTIONS">OPTIONS</h2>
109
126
 
110
127
  <dl>
111
128
  <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>
@@ -120,17 +137,15 @@ noted as <code>Chef::Config</code> values.</p>
120
137
  <dt><code>-p</code>, <code>--print-after</code></dt><dd>Show the data after a destructive operation</dd>
121
138
  <dt><code>-v</code>, <code>--version</code></dt><dd>Show chef version</dd>
122
139
  <dt><code>-y</code>, <code>--yes</code></dt><dd>Say yes to all prompts for confirmation</dd>
123
- <dt><code>-h</code>, <code>--help</code></dt><dd>Show this message</dd>
140
+ <dt><code>-h</code>, <code>--help</code></dt><dd>Show the available options for a command.</dd>
124
141
  </dl>
125
142
 
126
143
 
127
- <p>Usage information for sub-commands can be displayed with <code>knife SUB-COMMAND --help</code>.</p>
128
-
129
144
  <h2 id="SUB-COMMANDS">SUB-COMMANDS</h2>
130
145
 
131
- <p>Knife sub-commands are structured as <em>NOUN verb NOUN (options)</em>. The
132
- sub-commands are meant to be intuitively named. Because the Chef Server
133
- API is RESTful, sub-commands generally utilize CRUD operations.</p>
146
+ <p>Sub-commands that operate on the basic Chef data types are structured as
147
+ <em>NOUN verb NOUN (options)</em>. For all data types, the following commands
148
+ are available:</p>
134
149
 
135
150
  <ul>
136
151
  <li>create (create)</li>
@@ -140,13 +155,8 @@ API is RESTful, sub-commands generally utilize CRUD operations.</p>
140
155
  </ul>
141
156
 
142
157
 
143
- <p>Objects stored on the server support these, as described below.</p>
144
-
145
- <h2 id="GENERAL-SUB-COMMANDS">GENERAL SUB-COMMANDS</h2>
146
-
147
- <p><strong>recipe list [PATTERN]</strong></p>
148
-
149
- <p>List available recipes from the server. Specify <em>PATTERN</em> as a regular expression to limit the results.</p>
158
+ <p>Knife also includes commands that take actions other than displaying or
159
+ modifying data on the Chef Server, such as <strong><span class="man-ref">knife-ssh<span class="s">(1)</span></span></strong>.</p>
150
160
 
151
161
  <h2 id="CONFIGURATION">CONFIGURATION</h2>
152
162
 
@@ -158,68 +168,32 @@ be <code>.chef/knife.rb</code> in the current directory of the repository.</p>
158
168
 
159
169
  <p>If the config file exists, knife uses these settings for <strong>GENERAL OPTIONS</strong> defaults.</p>
160
170
 
161
- <p><code>log_level</code></p>
162
-
163
- <p>A Ruby symbol specifying the log level. Corresponds to <code>-l</code> or <code>--log_level</code> option. Default is <em>:info</em>. Valid values are:</p>
164
-
165
171
  <ul>
166
- <li>:info</li>
167
- <li>:debug</li>
168
- <li>:warn</li>
169
- <li>:fatal</li>
170
- </ul>
171
-
172
-
173
- <p><code>log_location</code></p>
174
-
175
- <p>Corresponds to the <code>-L</code> or <code>--log-file</code> option. Defaults is <strong>STDOUT</strong>.
176
- Valid values are <strong>STDOUT</strong> or a filename.</p>
177
-
178
- <p><code>node_name</code></p>
179
-
180
- <p>User to authenticate to the Chef server. Corresponds to the <code>-u</code> or
181
- <code>--user</code> option. This is requested from the user when running this
182
- sub-command.</p>
183
-
184
- <p><code>client_key</code></p>
185
-
186
- <p>Private key file to authenticate to the Chef server. Corresponds to the
187
- <code>-k</code> or <code>--key</code> option. This is requested from the user when running
188
- this sub-command.</p>
189
-
190
- <p><code>chef_server_url</code></p>
191
-
192
- <p>URL of the Chef server. Corresponds to the <code>-s</code> or <code>--server-url</code>
193
- option. This is requested from the user when running this sub-command.</p>
194
-
195
- <p><code>cache_type</code></p>
196
-
197
- <p>The type of cache to use. Default is BasicFile. This can be any type of
172
+ <li><code>node_name</code>:
173
+ User or client identity (i.e., <em>name</em>) to use for authenticating
174
+ requests to the Chef Server.</li>
175
+ <li><code>client_key</code>:
176
+ Private key file to authenticate to the Chef server. Corresponds to the
177
+ <code>-k</code> or <code>--key</code> option.</li>
178
+ <li><code>chef_server_url</code>:
179
+ URL of the Chef server. Corresponds to the <code>-s</code> or <code>--server-url</code>
180
+ option. This is requested from the user when running this sub-command.</li>
181
+ <li><code>cache_type</code>:
182
+ The type of cache to use. Default is BasicFile. This can be any type of
198
183
  Cache that moneta supports: BasicFile, Berkeley, Couch, DataMapper,
199
184
  File, LMC, Memcache, Memory, MongoDB, Redis, Rufus, S3, SDBM, Tyrant,
200
- Xattr, YAML.</p>
201
-
202
- <p><code>cache_options</code></p>
203
-
204
- <p>Specifies various options to use for caching. Default reads the Chef
205
- client configuration (/etc/chef/checksums).</p>
206
-
207
- <p><code>validation_client_name</code></p>
208
-
209
- <p>Specifies the name of the client used to validate new clients. This is
210
- requested from the user when running the configuration sub-command.</p>
211
-
212
- <p><code>validation_key</code></p>
213
-
214
- <p>Specifies the private key file to use for generating ec2 instance data
215
- for validating new clients. This is implied from the
216
- <code>validation_client_name</code>.</p>
217
-
218
- <p><code>cookbook_copyright</code>
219
- <code>cookbook_email</code>
220
- <code>cookbook_license</code></p>
221
-
222
- <p>Used by <code>knife cookbook create</code> sub-command to specify the copyright
185
+ Xattr, YAML.</li>
186
+ <li><code>cache_options</code>:
187
+ Specifies various options to use for caching. These options are
188
+ dependent on the <code>cache_type</code>.</li>
189
+ <li><code>validation_client_name</code>:
190
+ Specifies the name of the client used to validate new clients.</li>
191
+ <li><code>validation_key</code>:
192
+ Specifies the private key file to use when bootstrapping new hosts.
193
+ See <span class="man-ref">knife-client<span class="s">(1)</span></span> for more information about the validation
194
+ client.</li>
195
+ <li><code>cookbook_copyright</code>, <code>cookbook_email</code>, <code>cookbook_license</code>
196
+ Used by <code>knife cookbook create</code> sub-command to specify the copyright
223
197
  holder, maintainer email and license (respectively) for new cookbooks.
224
198
  The copyright holder is listed as the maintainer in the cookbook's
225
199
  metadata and as the Copyright in the comments of the default recipe. The
@@ -228,27 +202,9 @@ determines what preamble to put in the comment of the default recipe,
228
202
  and is listed as the license in the cookbook metadata. Currently
229
203
  supported licenses are "apachev2" and "none". Any other values will
230
204
  result in an empty license in the metadata (needs to be filled in by the
231
- author), and no comment preamble in the default recipe.</p>
232
-
233
- <p><code>knife[:aws_access_key_id]</code>
234
- <code>knife[:aws_secret_access_key]</code></p>
235
-
236
- <p>Specifies the Amazon AWS EC2 credentials to use when running the ec2 sub-commands.</p>
237
-
238
- <p><code>knife[:rackspace_api_username]</code>
239
- <code>knife[:rackspace_api_key]</code></p>
240
-
241
- <p>Specifies the Rackspace Cloud credentials to use when running the rackspace sub-commands.</p>
242
-
243
- <p><code>knife[:terremark_username]</code>
244
- <code>knife[:terremark_password]</code>
245
- <code>knife[:terremark_service]</code></p>
246
-
247
- <p>Specifies the Terremark vCloud credentials to use when running the terremark sub-commands.</p>
248
-
249
- <p><code>knife[:slicehost_password]</code></p>
205
+ author), and no comment preamble in the default recipe.</li>
206
+ </ul>
250
207
 
251
- <p>Specifies the Slicehost password to use when running the slicdehost sub-commands.</p>
252
208
 
253
209
  <h2 id="FILES">FILES</h2>
254
210
 
@@ -279,50 +235,6 @@ recommended though, and git fits with a lot of the workflow paradigms.</p>
279
235
 
280
236
  <h2 id="EXAMPLES">EXAMPLES</h2>
281
237
 
282
- <p>Example client config (<code>/etc/chef/client.rb</code>) from <code>knife configure
283
- client</code>. The same configuration is used when using the <code>knife bootstrap</code>
284
- command with the default <code>gem</code> templates that come with Chef.</p>
285
-
286
- <pre><code>log_level :info
287
- log_location STDOUT
288
- chef_server_url 'https://api.opscode.com/organizations/ORGNAME'
289
- validation_client_name 'ORGNAME-validator'
290
- </code></pre>
291
-
292
- <p>Setting up a custom bootstrap is fairly straightforward. Create
293
- <code>.chef/bootstrap</code> in your Chef Repository directory or in
294
- <code>$HOME/.chef/bootstrap</code>. Then create the ERB template file.</p>
295
-
296
- <pre><code>mkdir ~/.chef/bootstrap
297
- vi ~/.chef/bootstrap/debian5.0-apt.erb
298
- </code></pre>
299
-
300
- <p>For example, to create a new bootstrap template that should be used when
301
- setting up a new Debian node. Edit the template to run the commands, set
302
- up the validation certificate and the client configuration file, and
303
- finally to run chef-client on completion. The bootstrap template can be
304
- called with:</p>
305
-
306
- <pre><code>knife bootstrap mynode.example.com --template-file ~/.chef/bootstrap/debian5.0-apt.erb
307
- </code></pre>
308
-
309
- <p>Or,</p>
310
-
311
- <pre><code>knife bootstrap mynode.example.com --distro debian5.0-apt
312
- </code></pre>
313
-
314
- <p>The <code>--distro</code> parameter will automatically look in the
315
- <code>~/.chef/bootstrap</code> directory for a file named <code>debian5.0-apt.erb</code>.</p>
316
-
317
- <p>Templates provided by the Chef installation are located in
318
- <code>BASEDIR/lib/chef/knife/bootstrap/*.erb</code>, where <em>BASEDIR</em> is the
319
- location where the package or Gem installed the Chef client libraries.</p>
320
-
321
- <p>Uploading cookbooks to the Opscode cookbooks site using the user/certificate specifically:</p>
322
-
323
- <pre><code>knife cookbook site share example Other -k ~/.chef/USERNAME.pem -u USERNAME
324
- </code></pre>
325
-
326
238
  <h2 id="ENVIRONMENT">ENVIRONMENT</h2>
327
239
 
328
240
  <dl>
@@ -334,25 +246,46 @@ data editing entirely.</dd>
334
246
 
335
247
  <h2 id="SEE-ALSO">SEE ALSO</h2>
336
248
 
337
- <p>Full documentation for Chef is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home/.</p>
249
+ <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">shef<span class="s">(1)</span></span></strong></p>
338
250
 
339
- <p>JSON is JavaScript Object Notation and more information can be found at http://json.org/.</p>
251
+ <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>
252
+ <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>
253
+ <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>
254
+ <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>
255
+ <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>
340
256
 
341
- <p>SOLR is an open source search engine. The Chef Server includes a SOLR installation. More information about SOLR, including the search query syntax, can be found at http://lucene.apache.org/solr/.</p>
257
+ <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>
342
258
 
343
- <p>Git is a version control system and documented at http://git-scm.com/.</p>
259
+ <p> JSON is JavaScript Object Notation <a href="http://json.org/" data-bare-link="true">http://json.org/</a></p>
344
260
 
345
- <p>This manual page was generated in nroff from Markdown with ronn. Ryan Tomayko wrote ronn and more information can be found at http://rtomayko.github.com/ronn/ronn.5.html.</p>
261
+ <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>
262
+
263
+ <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>
264
+
265
+ <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>
346
266
 
347
267
  <h2 id="AUTHOR">AUTHOR</h2>
348
268
 
349
- <p>Chef was written by Adam Jacob <a href="&#109;&#97;&#105;&#108;&#x74;&#111;&#x3a;&#x61;&#100;&#97;&#109;&#x40;&#x6f;&#x70;&#115;&#x63;&#x6f;&#100;&#101;&#x2e;&#99;&#111;&#x6d;" data-bare-link="true">&#x61;&#x64;&#97;&#x6d;&#x40;&#x6f;&#x70;&#115;&#x63;&#x6f;&#100;&#x65;&#46;&#x63;&#x6f;&#x6d;</a> of Opscode (<a href="http://www.opscode.com" data-bare-link="true">http://www.opscode.com</a>), with contributions from the community. This manual page was written by Joshua Timberman <a href="&#x6d;&#x61;&#x69;&#108;&#116;&#x6f;&#58;&#106;&#111;&#115;&#104;&#117;&#x61;&#64;&#x6f;&#112;&#x73;&#x63;&#111;&#100;&#x65;&#x2e;&#99;&#111;&#x6d;" data-bare-link="true">&#x6a;&#111;&#x73;&#104;&#x75;&#x61;&#x40;&#111;&#112;&#x73;&#x63;&#x6f;&#x64;&#x65;&#46;&#99;&#x6f;&#109;</a>. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
269
+ <p> Chef was written by Adam Jacob <a href="&#109;&#x61;&#105;&#108;&#x74;&#x6f;&#x3a;&#97;&#100;&#x61;&#x6d;&#x40;&#x6f;&#112;&#x73;&#x63;&#111;&#100;&#x65;&#46;&#x63;&#x6f;&#x6d;" data-bare-link="true">&#x61;&#100;&#97;&#x6d;&#x40;&#111;&#112;&#115;&#x63;&#x6f;&#100;&#x65;&#x2e;&#x63;&#111;&#x6d;</a> of Opscode
270
+ (<a href="http://www.opscode.com" data-bare-link="true">http://www.opscode.com</a>), with contributions from the community.</p>
271
+
272
+ <h2 id="DOCUMENTATION">DOCUMENTATION</h2>
273
+
274
+ <p> This manual page was written by Joshua Timberman <a href="&#x6d;&#x61;&#105;&#108;&#x74;&#x6f;&#x3a;&#106;&#x6f;&#x73;&#x68;&#x75;&#x61;&#64;&#111;&#112;&#x73;&#x63;&#x6f;&#100;&#x65;&#x2e;&#99;&#111;&#x6d;" data-bare-link="true">&#106;&#111;&#115;&#x68;&#117;&#x61;&#x40;&#111;&#x70;&#x73;&#x63;&#111;&#x64;&#x65;&#x2e;&#99;&#111;&#x6d;</a>.</p>
275
+
276
+ <h2 id="LICENSE">LICENSE</h2>
277
+
278
+ <p> Both Chef and this documentation are released under the terms of the
279
+ 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>
280
+ 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>
281
+
282
+ <h2 id="CHEF">CHEF</h2>
350
283
 
351
- <p>On Debian systems, the complete text of the Apache 2.0 License can be found in <code>/usr/share/common-licenses/Apache-2.0</code>.</p>
284
+ <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>
352
285
 
353
286
 
354
287
  <ol class='man-decor man-foot man foot'>
355
- <li class='tl'>Chef 0.10.0.beta.8</li>
288
+ <li class='tl'>Chef 0.10.0.beta.9</li>
356
289
  <li class='tc'>April 2011</li>
357
290
  <li class='tr'>knife(1)</li>
358
291
  </ol>