chef 0.10.0.beta.7 → 0.10.0.beta.8
Sign up to get free protection for your applications and to get access to all the features.
- data/distro/common/html/knife-bootstrap.1.html +182 -0
- data/distro/common/html/knife-client.1.html +216 -0
- data/distro/common/html/knife-configure.1.html +170 -0
- data/distro/common/html/knife-cookbook-site.1.html +166 -0
- data/distro/common/html/knife-cookbook.1.html +233 -0
- data/distro/common/html/knife-data-bag.1.html +234 -0
- data/distro/common/html/knife-environment.1.html +93 -0
- data/distro/common/html/knife-exec.1.html +93 -0
- data/distro/common/html/knife-index.1.html +125 -0
- data/distro/common/html/knife-node.1.html +268 -0
- data/distro/common/html/knife-recipe.1.html +92 -0
- data/distro/common/html/knife-role.1.html +136 -0
- data/distro/common/html/knife-search.1.html +102 -0
- data/distro/common/html/knife-ssh.1.html +101 -0
- data/distro/common/html/knife-status.1.html +97 -0
- data/distro/common/html/knife-tag.1.html +93 -0
- data/distro/common/html/knife.1.html +362 -0
- data/distro/common/man/man1/knife-bootstrap.1 +137 -0
- data/distro/common/man/man1/knife-client.1 +98 -0
- data/distro/common/man/man1/knife-configure.1 +88 -0
- data/distro/common/man/man1/knife-cookbook-site.1 +91 -0
- data/distro/common/man/man1/knife-cookbook.1 +242 -0
- data/distro/common/man/man1/knife-data-bag.1 +130 -0
- data/distro/common/man/man1/knife-environment.1 +13 -0
- data/distro/common/man/man1/knife-exec.1 +13 -0
- data/distro/common/man/man1/knife-index.1 +29 -0
- data/distro/common/man/man1/knife-node.1 +153 -0
- data/distro/common/man/man1/knife-recipe.1 +13 -0
- data/distro/common/man/man1/knife-role.1 +64 -0
- data/distro/common/man/man1/knife-search.1 +37 -0
- data/distro/common/man/man1/knife-ssh.1 +33 -0
- data/distro/common/man/man1/knife-status.1 +17 -0
- data/distro/common/man/man1/knife-tag.1 +13 -0
- data/distro/common/man/man1/knife.1 +346 -0
- data/distro/common/man/{man8/shef.8 → man1/shef.1} +0 -0
- data/distro/common/man/{man1/chef-server-webui.1 → man8/chef-server-webui.8} +0 -0
- data/distro/common/man/{man1/chef-server.1 → man8/chef-server.8} +0 -0
- data/distro/common/man/{man1/chef-solr.1 → man8/chef-solr.8} +0 -0
- data/distro/common/markdown/man1/knife-bootstrap.mkd +88 -0
- data/distro/common/markdown/man1/knife-client.mkd +101 -0
- data/distro/common/markdown/man1/knife-configure.mkd +70 -0
- data/distro/common/markdown/man1/knife-cookbook-site.mkd +69 -0
- data/distro/common/markdown/man1/knife-cookbook.mkd +136 -0
- data/distro/common/markdown/man1/knife-data-bag.mkd +117 -0
- data/distro/common/markdown/man1/knife-environment.mkd +8 -0
- data/distro/common/markdown/man1/knife-exec.mkd +9 -0
- data/distro/common/markdown/man1/knife-index.mkd +30 -0
- data/distro/common/markdown/man1/knife-node.mkd +147 -0
- data/distro/common/markdown/man1/knife-recipe.mkd +24 -0
- data/distro/common/markdown/man1/knife-role.mkd +79 -0
- data/distro/common/markdown/man1/knife-search.mkd +56 -0
- data/distro/common/markdown/man1/knife-ssh.mkd +64 -0
- data/distro/common/markdown/man1/knife-status.mkd +38 -0
- data/distro/common/markdown/man1/knife-tag.mkd +8 -0
- data/distro/common/markdown/man1/knife.mkd +261 -0
- data/lib/chef/cookbook/metadata.rb +76 -40
- data/lib/chef/cookbook_version.rb +86 -2
- data/lib/chef/cookbook_version_selector.rb +7 -2
- data/lib/chef/environment.rb +41 -0
- data/lib/chef/knife/configure.rb +4 -0
- data/lib/chef/knife/cookbook_upload.rb +4 -1
- data/lib/chef/knife/help.rb +98 -0
- data/lib/chef/rest.rb +1 -0
- data/lib/chef/version.rb +1 -1
- metadata +58 -11
- data/distro/common/man/man1/chef-indexer.1 +0 -42
- data/distro/common/man/man1/chef-solr-indexer.1 +0 -55
- data/distro/common/man/man8/chef-solr-rebuild.8 +0 -37
- data/distro/common/man/man8/knife.8 +0 -1349
- data/distro/common/markdown/knife.mkd +0 -865
@@ -0,0 +1,93 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta http-equiv='content-type' value='text/html;charset=utf8'>
|
5
|
+
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
|
6
|
+
<title>knife-tag(1) - Apply tags to nodes on a Chef Server</title>
|
7
|
+
<style type='text/css' media='all'>
|
8
|
+
/* style: man */
|
9
|
+
body#manpage {margin:0}
|
10
|
+
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
|
11
|
+
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
|
12
|
+
.mp h2 {margin:10px 0 0 0}
|
13
|
+
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
|
14
|
+
.mp h3 {margin:0 0 0 4ex}
|
15
|
+
.mp dt {margin:0;clear:left}
|
16
|
+
.mp dt.flush {float:left;width:8ex}
|
17
|
+
.mp dd {margin:0 0 0 9ex}
|
18
|
+
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
|
19
|
+
.mp pre {margin-bottom:20px}
|
20
|
+
.mp pre+h2,.mp pre+h3 {margin-top:22px}
|
21
|
+
.mp h2+pre,.mp h3+pre {margin-top:5px}
|
22
|
+
.mp img {display:block;margin:auto}
|
23
|
+
.mp h1.man-title {display:none}
|
24
|
+
.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}
|
25
|
+
.mp h2 {font-size:16px;line-height:1.25}
|
26
|
+
.mp h1 {font-size:20px;line-height:2}
|
27
|
+
.mp {text-align:justify;background:#fff}
|
28
|
+
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
|
29
|
+
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
|
30
|
+
.mp u {text-decoration:underline}
|
31
|
+
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
|
32
|
+
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
|
33
|
+
.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}
|
34
|
+
.mp b.man-ref {font-weight:normal;color:#434241}
|
35
|
+
.mp pre {padding:0 4ex}
|
36
|
+
.mp pre code {font-weight:normal;color:#434241}
|
37
|
+
.mp h2+pre,h3+pre {padding-left:0}
|
38
|
+
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}
|
39
|
+
ol.man-decor {width:100%}
|
40
|
+
ol.man-decor li.tl {text-align:left}
|
41
|
+
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
|
42
|
+
ol.man-decor li.tr {text-align:right;float:right}
|
43
|
+
</style>
|
44
|
+
<style type='text/css' media='all'>
|
45
|
+
/* style: toc */
|
46
|
+
.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}
|
47
|
+
.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}
|
48
|
+
.man-navigation a:hover {color:#111;text-decoration:underline}
|
49
|
+
</style>
|
50
|
+
</head>
|
51
|
+
<!--
|
52
|
+
The following styles are deprecated and will be removed at some point:
|
53
|
+
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
|
54
|
+
|
55
|
+
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
|
56
|
+
.man-navigation should be used instead.
|
57
|
+
-->
|
58
|
+
<body id='manpage'>
|
59
|
+
<div class='mp' id='man'>
|
60
|
+
|
61
|
+
<div class='man-navigation' style='display:none'>
|
62
|
+
<a href="#NAME">NAME</a>
|
63
|
+
<a href="#SYNOPSIS">SYNOPSIS</a>
|
64
|
+
<a href="#TAG-SUBCOMMANDS">TAG SUBCOMMANDS</a>
|
65
|
+
</div>
|
66
|
+
|
67
|
+
<ol class='man-decor man-head man head'>
|
68
|
+
<li class='tl'>knife-tag(1)</li>
|
69
|
+
<li class='tc'>Chef Manual</li>
|
70
|
+
<li class='tr'>knife-tag(1)</li>
|
71
|
+
</ol>
|
72
|
+
|
73
|
+
<h2 id="NAME">NAME</h2>
|
74
|
+
<p class="man-name">
|
75
|
+
<code>knife-tag</code> - <span class="man-whatis">Apply tags to nodes on a Chef Server</span>
|
76
|
+
</p>
|
77
|
+
|
78
|
+
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
79
|
+
|
80
|
+
<p><strong>knife</strong> <strong>tag</strong> <em>subcommand</em> <em>(options)</em></p>
|
81
|
+
|
82
|
+
<h2 id="TAG-SUBCOMMANDS">TAG SUBCOMMANDS</h2>
|
83
|
+
|
84
|
+
|
85
|
+
<ol class='man-decor man-foot man foot'>
|
86
|
+
<li class='tl'>Chef 0.10.0.beta.8</li>
|
87
|
+
<li class='tc'>April 2011</li>
|
88
|
+
<li class='tr'>knife-tag(1)</li>
|
89
|
+
</ol>
|
90
|
+
|
91
|
+
</div>
|
92
|
+
</body>
|
93
|
+
</html>
|
@@ -0,0 +1,362 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta http-equiv='content-type' value='text/html;charset=utf8'>
|
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>
|
7
|
+
<style type='text/css' media='all'>
|
8
|
+
/* style: man */
|
9
|
+
body#manpage {margin:0}
|
10
|
+
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
|
11
|
+
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
|
12
|
+
.mp h2 {margin:10px 0 0 0}
|
13
|
+
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
|
14
|
+
.mp h3 {margin:0 0 0 4ex}
|
15
|
+
.mp dt {margin:0;clear:left}
|
16
|
+
.mp dt.flush {float:left;width:8ex}
|
17
|
+
.mp dd {margin:0 0 0 9ex}
|
18
|
+
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
|
19
|
+
.mp pre {margin-bottom:20px}
|
20
|
+
.mp pre+h2,.mp pre+h3 {margin-top:22px}
|
21
|
+
.mp h2+pre,.mp h3+pre {margin-top:5px}
|
22
|
+
.mp img {display:block;margin:auto}
|
23
|
+
.mp h1.man-title {display:none}
|
24
|
+
.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}
|
25
|
+
.mp h2 {font-size:16px;line-height:1.25}
|
26
|
+
.mp h1 {font-size:20px;line-height:2}
|
27
|
+
.mp {text-align:justify;background:#fff}
|
28
|
+
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
|
29
|
+
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
|
30
|
+
.mp u {text-decoration:underline}
|
31
|
+
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
|
32
|
+
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
|
33
|
+
.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}
|
34
|
+
.mp b.man-ref {font-weight:normal;color:#434241}
|
35
|
+
.mp pre {padding:0 4ex}
|
36
|
+
.mp pre code {font-weight:normal;color:#434241}
|
37
|
+
.mp h2+pre,h3+pre {padding-left:0}
|
38
|
+
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}
|
39
|
+
ol.man-decor {width:100%}
|
40
|
+
ol.man-decor li.tl {text-align:left}
|
41
|
+
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
|
42
|
+
ol.man-decor li.tr {text-align:right;float:right}
|
43
|
+
</style>
|
44
|
+
<style type='text/css' media='all'>
|
45
|
+
/* style: toc */
|
46
|
+
.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}
|
47
|
+
.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}
|
48
|
+
.man-navigation a:hover {color:#111;text-decoration:underline}
|
49
|
+
</style>
|
50
|
+
</head>
|
51
|
+
<!--
|
52
|
+
The following styles are deprecated and will be removed at some point:
|
53
|
+
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
|
54
|
+
|
55
|
+
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
|
56
|
+
.man-navigation should be used instead.
|
57
|
+
-->
|
58
|
+
<body id='manpage'>
|
59
|
+
<div class='mp' id='man'>
|
60
|
+
|
61
|
+
<div class='man-navigation' style='display:none'>
|
62
|
+
<a href="#NAME">NAME</a>
|
63
|
+
<a href="#SYNOPSIS">SYNOPSIS</a>
|
64
|
+
<a href="#DESCRIPTION">DESCRIPTION</a>
|
65
|
+
<a href="#GENERAL-OPTIONS">GENERAL OPTIONS</a>
|
66
|
+
<a href="#SUB-COMMANDS">SUB-COMMANDS</a>
|
67
|
+
<a href="#GENERAL-SUB-COMMANDS">GENERAL SUB-COMMANDS</a>
|
68
|
+
<a href="#CONFIGURATION">CONFIGURATION</a>
|
69
|
+
<a href="#FILES">FILES</a>
|
70
|
+
<a href="#CHEF-WORKFLOW">CHEF WORKFLOW</a>
|
71
|
+
<a href="#EXAMPLES">EXAMPLES</a>
|
72
|
+
<a href="#ENVIRONMENT">ENVIRONMENT</a>
|
73
|
+
<a href="#SEE-ALSO">SEE ALSO</a>
|
74
|
+
<a href="#AUTHOR">AUTHOR</a>
|
75
|
+
</div>
|
76
|
+
|
77
|
+
<ol class='man-decor man-head man head'>
|
78
|
+
<li class='tl'>knife(1)</li>
|
79
|
+
<li class='tc'>Chef Manual</li>
|
80
|
+
<li class='tr'>knife(1)</li>
|
81
|
+
</ol>
|
82
|
+
|
83
|
+
<h2 id="NAME">NAME</h2>
|
84
|
+
<p class="man-name">
|
85
|
+
<code>knife</code> - <span class="man-whatis">Chef Server REST API utility</span>
|
86
|
+
</p>
|
87
|
+
|
88
|
+
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
89
|
+
|
90
|
+
<p><strong>knife</strong> <em>sub-command</em> <em>(options)</em></p>
|
91
|
+
|
92
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
93
|
+
|
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>
|
100
|
+
|
101
|
+
<p>Unless otherwise specified, output is in JSON format, and input files
|
102
|
+
are also JSON format.</p>
|
103
|
+
|
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
|
+
|
108
|
+
<h2 id="GENERAL-OPTIONS">GENERAL OPTIONS</h2>
|
109
|
+
|
110
|
+
<dl>
|
111
|
+
<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>
|
112
|
+
<dt><code>-k</code>, <code>--key</code> KEY</dt><dd>API Client Key, corresponds to <code>Chef::Config</code> <code>client_key</code>.</dd>
|
113
|
+
<dt><code>-c</code>, <code>--config</code> CONFIG</dt><dd>The configuration file to use</dd>
|
114
|
+
<dt><code>-e</code>, <code>--editor</code> EDITOR</dt><dd>Set the editor to use for interactive commands</dd>
|
115
|
+
<dt><code>-F</code>, <code>--format</code> FORMAT</dt><dd>Which format to use for output</dd>
|
116
|
+
<dt><code>-l</code>, <code>--log_level</code> LEVEL</dt><dd>Set the log level (debug, info, warn, error, fatal), corresponds to <code>Chef::Config</code> <code>log_level</code>.</dd>
|
117
|
+
<dt><code>-L</code>, <code>--logfile</code> LOGLOCATION</dt><dd>Set the log file location, defaults to STDOUT, corresponds to <code>Chef::Config</code> <code>log_location</code>.</dd>
|
118
|
+
<dt><code>-n</code>, <code>--no-editor</code></dt><dd>Do not open EDITOR, just accept the data as is</dd>
|
119
|
+
<dt><code>-u</code>, <code>--user</code> USER</dt><dd>API Client Username, corresponds to <code>Chef::Config</code> <code>node_name</code>.</dd>
|
120
|
+
<dt><code>-p</code>, <code>--print-after</code></dt><dd>Show the data after a destructive operation</dd>
|
121
|
+
<dt><code>-v</code>, <code>--version</code></dt><dd>Show chef version</dd>
|
122
|
+
<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>
|
124
|
+
</dl>
|
125
|
+
|
126
|
+
|
127
|
+
<p>Usage information for sub-commands can be displayed with <code>knife SUB-COMMAND --help</code>.</p>
|
128
|
+
|
129
|
+
<h2 id="SUB-COMMANDS">SUB-COMMANDS</h2>
|
130
|
+
|
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>
|
134
|
+
|
135
|
+
<ul>
|
136
|
+
<li>create (create)</li>
|
137
|
+
<li>list and show (read)</li>
|
138
|
+
<li>edit (update)</li>
|
139
|
+
<li>delete (destroy)</li>
|
140
|
+
</ul>
|
141
|
+
|
142
|
+
|
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>
|
150
|
+
|
151
|
+
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
152
|
+
|
153
|
+
<p>The knife configuration file is a Ruby DSL to set configuration
|
154
|
+
parameters for Knife's <strong>GENERAL OPTIONS</strong>. The default location for the
|
155
|
+
config file is <code>~/.chef/knife.rb</code>. If managing multiple Chef
|
156
|
+
repositories, per-repository config files can be created. The file must
|
157
|
+
be <code>.chef/knife.rb</code> in the current directory of the repository.</p>
|
158
|
+
|
159
|
+
<p>If the config file exists, knife uses these settings for <strong>GENERAL OPTIONS</strong> defaults.</p>
|
160
|
+
|
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
|
+
<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
|
198
|
+
Cache that moneta supports: BasicFile, Berkeley, Couch, DataMapper,
|
199
|
+
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
|
223
|
+
holder, maintainer email and license (respectively) for new cookbooks.
|
224
|
+
The copyright holder is listed as the maintainer in the cookbook's
|
225
|
+
metadata and as the Copyright in the comments of the default recipe. The
|
226
|
+
maintainer email is used in the cookbook metadata. The license
|
227
|
+
determines what preamble to put in the comment of the default recipe,
|
228
|
+
and is listed as the license in the cookbook metadata. Currently
|
229
|
+
supported licenses are "apachev2" and "none". Any other values will
|
230
|
+
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>
|
250
|
+
|
251
|
+
<p>Specifies the Slicehost password to use when running the slicdehost sub-commands.</p>
|
252
|
+
|
253
|
+
<h2 id="FILES">FILES</h2>
|
254
|
+
|
255
|
+
<p><em>~/.chef/knife.rb</em></p>
|
256
|
+
|
257
|
+
<p>Ruby DSL configuration file for knife. See <strong>CONFIGURATION</strong>.</p>
|
258
|
+
|
259
|
+
<h2 id="CHEF-WORKFLOW">CHEF WORKFLOW</h2>
|
260
|
+
|
261
|
+
<p>When working with Chef and Knife in the local repository, the recommended workflow outline looks like:</p>
|
262
|
+
|
263
|
+
<ul>
|
264
|
+
<li>Create repository. A skeleton sample is provided at <em>http://github.com/opscode/chef-repo/</em>.</li>
|
265
|
+
<li>Configure knife, see <strong>CONFIGURATION</strong>.</li>
|
266
|
+
<li>Download cookbooks from the Opscode cookbooks site, see <strong>COOKBOOK SITE SUB-COMMANDS</strong>.</li>
|
267
|
+
<li>Or, create new cookbooks, see <code>cookbook create</code> sub-command.</li>
|
268
|
+
<li>Commit changes to the version control system. See your tool's documentation.</li>
|
269
|
+
<li>Upload cookbooks to the Chef Server, see <strong>COOKBOOK SUB-COMMANDS</strong>.</li>
|
270
|
+
<li>Launch instances in the Cloud, OR provision new hosts; see <strong>CLOUD COMPUTING SUB-COMMANDS</strong> and <strong>BOOTSTRAP SUB-COMMANDS</strong>.</li>
|
271
|
+
<li>Watch Chef configure systems!</li>
|
272
|
+
</ul>
|
273
|
+
|
274
|
+
|
275
|
+
<p>A note about git: Opscode and many folks in the Chef community use git,
|
276
|
+
but it is not required, except in the case of the <code>cookbook site vendor</code>
|
277
|
+
sub-command, as it uses git directly. Version control is strongly
|
278
|
+
recommended though, and git fits with a lot of the workflow paradigms.</p>
|
279
|
+
|
280
|
+
<h2 id="EXAMPLES">EXAMPLES</h2>
|
281
|
+
|
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
|
+
<h2 id="ENVIRONMENT">ENVIRONMENT</h2>
|
327
|
+
|
328
|
+
<dl>
|
329
|
+
<dt class="flush"><code>EDITOR</code></dt><dd>The text editor to use for editing data. The --editor option takes
|
330
|
+
precedence over this value, and the --no-editor option supresses
|
331
|
+
data editing entirely.</dd>
|
332
|
+
</dl>
|
333
|
+
|
334
|
+
|
335
|
+
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
336
|
+
|
337
|
+
<p>Full documentation for Chef is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home/.</p>
|
338
|
+
|
339
|
+
<p>JSON is JavaScript Object Notation and more information can be found at http://json.org/.</p>
|
340
|
+
|
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>
|
342
|
+
|
343
|
+
<p>Git is a version control system and documented at http://git-scm.com/.</p>
|
344
|
+
|
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>
|
346
|
+
|
347
|
+
<h2 id="AUTHOR">AUTHOR</h2>
|
348
|
+
|
349
|
+
<p>Chef was written by Adam Jacob <a href="mailto:adam@opscode.com" data-bare-link="true">adam@opscode.com</a> of Opscode (<a href="http://www.opscode.com" data-bare-link="true">http://www.opscode.com</a>), with contributions from the community. This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</a>. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
|
350
|
+
|
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>
|
352
|
+
|
353
|
+
|
354
|
+
<ol class='man-decor man-foot man foot'>
|
355
|
+
<li class='tl'>Chef 0.10.0.beta.8</li>
|
356
|
+
<li class='tc'>April 2011</li>
|
357
|
+
<li class='tr'>knife(1)</li>
|
358
|
+
</ol>
|
359
|
+
|
360
|
+
</div>
|
361
|
+
</body>
|
362
|
+
</html>
|