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,182 @@
|
|
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-bootrap(1) - Install Chef Client on a remote host</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="#SEE-ALSO">SEE ALSO</a>
|
65
|
+
<a href="#AUTHOR">AUTHOR</a>
|
66
|
+
<a href="#DOCUMENTATION">DOCUMENTATION</a>
|
67
|
+
<a href="#CHEF">CHEF</a>
|
68
|
+
</div>
|
69
|
+
|
70
|
+
<ol class='man-decor man-head man head'>
|
71
|
+
<li class='tl'>knife-bootrap(1)</li>
|
72
|
+
<li class='tc'>Chef Manual</li>
|
73
|
+
<li class='tr'>knife-bootrap(1)</li>
|
74
|
+
</ol>
|
75
|
+
|
76
|
+
<h2 id="NAME">NAME</h2>
|
77
|
+
<p class="man-name">
|
78
|
+
<code>knife-bootrap</code> - <span class="man-whatis">Install Chef Client on a remote host</span>
|
79
|
+
</p>
|
80
|
+
|
81
|
+
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
82
|
+
|
83
|
+
<p><strong>knife</strong> <strong>bootstrap</strong> <em>(options)</em></p>
|
84
|
+
|
85
|
+
<dl>
|
86
|
+
<dt><code>-i</code>, <code>--identity-file IDENTITY_FILE</code></dt><dd>The SSH identity file used for authentication</dd>
|
87
|
+
<dt><code>-N</code>, <code>--node-name NAME</code></dt><dd>The Chef node name for your new node</dd>
|
88
|
+
<dt><code>-P</code>, <code>--ssh-password PASSWORD</code></dt><dd>The ssh password</dd>
|
89
|
+
<dt><code>-x</code>, <code>--ssh-user USERNAME</code></dt><dd>The ssh username</dd>
|
90
|
+
<dt><code>--prerelease</code></dt><dd>Install pre-release Chef gems</dd>
|
91
|
+
<dt><code>-r</code>, <code>--run-list RUN_LIST</code></dt><dd>Comma separated list of roles/recipes to apply</dd>
|
92
|
+
<dt><code>-P</code>, <code>--ssh-password PASSWORD</code></dt><dd>The ssh password</dd>
|
93
|
+
<dt><code>-x</code>, <code>--ssh-user USERNAME</code></dt><dd>The ssh username</dd>
|
94
|
+
<dt><code>--template-file TEMPLATE</code></dt><dd>Full path to location of template to use</dd>
|
95
|
+
<dt class="flush"><code>--sudo</code></dt><dd>Execute the bootstrap via sudo</dd>
|
96
|
+
<dt><code>-d</code>, <code>--distro DISTRO</code></dt><dd>Bootstrap a distro using a template</dd>
|
97
|
+
</dl>
|
98
|
+
|
99
|
+
|
100
|
+
<p>Performs a Chef Bootstrap on the target node. The goal of the bootstrap
|
101
|
+
is to get Chef installed on the target system so it can run Chef Client
|
102
|
+
with a Chef Server. The main assumption is a baseline OS installation
|
103
|
+
exists. This sub-command is used internally by some cloud computing
|
104
|
+
server create commands and the others will be migrated in a future
|
105
|
+
version of Chef.</p>
|
106
|
+
|
107
|
+
<p>The bootstrap sub-command supports supplying a template to perform the
|
108
|
+
bootstrap steps. If the distro is not specified (via <code>-d</code> or <code>--distro</code>
|
109
|
+
option), an Ubuntu 10.04 host bootstrapped with RubyGems is assumed. The
|
110
|
+
<strong>DISTRO</strong> value corresponds to the base filename of the template, in
|
111
|
+
other words <code>DISTRO</code>.erb. A template file can be specified with the
|
112
|
+
<code>--template-file</code> option in which case the <strong>DISTRO</strong> is not used. The
|
113
|
+
sub-command looks in the following locations for the template to use:</p>
|
114
|
+
|
115
|
+
<ul>
|
116
|
+
<li><code>bootstrap</code> directory in the installed Chef Knife library.</li>
|
117
|
+
<li><code>bootstrap</code> directory in the <code>$PWD/.chef</code>.</li>
|
118
|
+
<li><code>bootstrap</code> directory in the users <code>$HOME/.chef</code>.</li>
|
119
|
+
</ul>
|
120
|
+
|
121
|
+
|
122
|
+
<p>The default bootstrap templates are scripts that get copied to the target node (FQDN). As of Chef 0.9.8, the following distros are supported:</p>
|
123
|
+
|
124
|
+
<ul>
|
125
|
+
<li>centos5-gems</li>
|
126
|
+
<li>fedora13-gems</li>
|
127
|
+
<li>ubuntu10.04-gems</li>
|
128
|
+
<li>ubuntu10.04-apt</li>
|
129
|
+
</ul>
|
130
|
+
|
131
|
+
|
132
|
+
<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. The RubyGems installation requires installing gems with native extensions, so development related packages (ruby-dev, build-essential) are installed. These are not installed with the apt installation, as native extensions are already compiled in the required packages.</p>
|
133
|
+
|
134
|
+
<p>In addition to handling the software installation, these bootstrap templates do the following:</p>
|
135
|
+
|
136
|
+
<ul>
|
137
|
+
<li>Write the validation.pem per the local knife configuration.</li>
|
138
|
+
<li>Write a default config file for Chef (<code>/etc/chef/client.rb</code>) using values from the <code>knife.rb</code>.</li>
|
139
|
+
<li>Create a JSON attributes file containing the specified run list and run Chef.</li>
|
140
|
+
</ul>
|
141
|
+
|
142
|
+
|
143
|
+
<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>
|
144
|
+
|
145
|
+
<p>When this is complete, the bootstrapped node will have:</p>
|
146
|
+
|
147
|
+
<ul>
|
148
|
+
<li>Latest Chef version installed from RubyGems or APT Packages from Opscode. This may be a later version than the local system.</li>
|
149
|
+
<li>Be validated with the configured Chef Server.</li>
|
150
|
+
<li>Have run Chef with its default run list if one is specfied.</li>
|
151
|
+
</ul>
|
152
|
+
|
153
|
+
|
154
|
+
<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>
|
155
|
+
|
156
|
+
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
157
|
+
|
158
|
+
<p> <strong>knife-ssh</strong>(1)</p>
|
159
|
+
|
160
|
+
<h2 id="AUTHOR">AUTHOR</h2>
|
161
|
+
|
162
|
+
<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>
|
163
|
+
|
164
|
+
<h2 id="DOCUMENTATION">DOCUMENTATION</h2>
|
165
|
+
|
166
|
+
<p> This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</a>.
|
167
|
+
Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
|
168
|
+
|
169
|
+
<h2 id="CHEF">CHEF</h2>
|
170
|
+
|
171
|
+
<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>
|
172
|
+
|
173
|
+
|
174
|
+
<ol class='man-decor man-foot man foot'>
|
175
|
+
<li class='tl'>Chef 0.10.0.beta.8</li>
|
176
|
+
<li class='tc'>April 2011</li>
|
177
|
+
<li class='tr'>knife-bootrap(1)</li>
|
178
|
+
</ol>
|
179
|
+
|
180
|
+
</div>
|
181
|
+
</body>
|
182
|
+
</html>
|
@@ -0,0 +1,216 @@
|
|
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-client(1) - Manage Chef API Clients</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="#CLIENT-SUB-COMMANDS">CLIENT SUB-COMMANDS</a>
|
66
|
+
<a href="#BULK-DELETE">BULK DELETE</a>
|
67
|
+
<a href="#CREATE">CREATE</a>
|
68
|
+
<a href="#DELETE">DELETE</a>
|
69
|
+
<a href="#EDIT">EDIT</a>
|
70
|
+
<a href="#LIST">LIST</a>
|
71
|
+
<a href="#REREGISTER">REREGISTER</a>
|
72
|
+
<a href="#SHOW">SHOW</a>
|
73
|
+
<a href="#SEE-ALSO">SEE ALSO</a>
|
74
|
+
<a href="#AUTHOR">AUTHOR</a>
|
75
|
+
<a href="#DOCUMENTATION">DOCUMENTATION</a>
|
76
|
+
<a href="#CHEF">CHEF</a>
|
77
|
+
</div>
|
78
|
+
|
79
|
+
<ol class='man-decor man-head man head'>
|
80
|
+
<li class='tl'>knife-client(1)</li>
|
81
|
+
<li class='tc'>Chef Manual</li>
|
82
|
+
<li class='tr'>knife-client(1)</li>
|
83
|
+
</ol>
|
84
|
+
|
85
|
+
<h2 id="NAME">NAME</h2>
|
86
|
+
<p class="man-name">
|
87
|
+
<code>knife-client</code> - <span class="man-whatis">Manage Chef API Clients</span>
|
88
|
+
</p>
|
89
|
+
|
90
|
+
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
91
|
+
|
92
|
+
<p><strong>knife</strong> <strong>client</strong> <em>sub-command</em> <em>(options)</em></p>
|
93
|
+
|
94
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
95
|
+
|
96
|
+
<p>Clients are identities used for communication with the Chef Server API,
|
97
|
+
roughly equivalent to user accounts on the Chef Server, except that
|
98
|
+
clients only communicate with the Chef Server API and are authenticated
|
99
|
+
via request signatures.</p>
|
100
|
+
|
101
|
+
<p>In the typical case, there will be one client object on the server for
|
102
|
+
each node, and the corresponding client and node will have identical
|
103
|
+
names.</p>
|
104
|
+
|
105
|
+
<p>In the Chef authorization model, there is one special client, the
|
106
|
+
"validator", which is authorized to create new non-administrative
|
107
|
+
clients but has minimal privileges otherwise. This identity is used as a
|
108
|
+
sort of "guest account" to create a client identity when initially
|
109
|
+
setting up a host for management with Chef.</p>
|
110
|
+
|
111
|
+
<h2 id="CLIENT-SUB-COMMANDS">CLIENT SUB-COMMANDS</h2>
|
112
|
+
|
113
|
+
<h2 id="BULK-DELETE">BULK DELETE</h2>
|
114
|
+
|
115
|
+
<p><strong>knife client bulk delete</strong> <em>regex</em> <em>(options)</em></p>
|
116
|
+
|
117
|
+
<p>Delete clients where the client name matches the regular expression
|
118
|
+
<em>regex</em> on the Chef Server. The regular expression should be given as a
|
119
|
+
quoted string, and not surrounded by forward slashes.</p>
|
120
|
+
|
121
|
+
<h2 id="CREATE">CREATE</h2>
|
122
|
+
|
123
|
+
<p><strong>knife client create</strong> <em>client name</em> <em>(options)</em></p>
|
124
|
+
|
125
|
+
<dl>
|
126
|
+
<dt><code>-a</code>, <code>--admin </code></dt><dd>Create the client as an admin</dd>
|
127
|
+
<dt><code>-f</code>, <code>--file FILE</code></dt><dd>Write the key to a file</dd>
|
128
|
+
</dl>
|
129
|
+
|
130
|
+
|
131
|
+
<p>Create a new client. This generates an RSA keypair. The private key will
|
132
|
+
be displayed on <em>STDOUT</em> or written to the named file. The public half
|
133
|
+
will be stored on the Server. For <em>chef-client</em> systems, the private key
|
134
|
+
should be copied to the system as <code>/etc/chef/client.pem</code>.</p>
|
135
|
+
|
136
|
+
<p>Admin clients should be created for users that will use <em>knife</em> to
|
137
|
+
access the API as an administrator. The private key will generally be
|
138
|
+
copied to <code>~/.chef/client\_name.pem</code> and referenced in the <code>knife.rb</code>
|
139
|
+
configuration file.</p>
|
140
|
+
|
141
|
+
<h2 id="DELETE">DELETE</h2>
|
142
|
+
|
143
|
+
<p><strong>knife client delete</strong> <em>client name</em> <em>(options)</em></p>
|
144
|
+
|
145
|
+
<p>Deletes a registered client.</p>
|
146
|
+
|
147
|
+
<h2 id="EDIT">EDIT</h2>
|
148
|
+
|
149
|
+
<p><strong>client edit</strong> <em>client name</em> <em>(options)</em></p>
|
150
|
+
|
151
|
+
<p>Edit a registered client.</p>
|
152
|
+
|
153
|
+
<h2 id="LIST">LIST</h2>
|
154
|
+
|
155
|
+
<p><strong>client list</strong> <em>(options)</em></p>
|
156
|
+
|
157
|
+
<dl>
|
158
|
+
<dt><code>-w</code>, <code>--with-uri</code></dt><dd> Show corresponding URIs</dd>
|
159
|
+
</dl>
|
160
|
+
|
161
|
+
|
162
|
+
<p>List all registered clients.</p>
|
163
|
+
|
164
|
+
<h2 id="REREGISTER">REREGISTER</h2>
|
165
|
+
|
166
|
+
<p><strong>client reregister</strong> <em>client name</em> <em>(options)</em></p>
|
167
|
+
|
168
|
+
<dl>
|
169
|
+
<dt><code>-f</code>, <code>--file FILE</code></dt><dd>Write the key to a file</dd>
|
170
|
+
</dl>
|
171
|
+
|
172
|
+
|
173
|
+
<p>Regenerate the RSA keypair for a client. The public half will be stored
|
174
|
+
on the server and the private key displayed on <em>STDOUT</em> or written to
|
175
|
+
the named file. This operation will invalidate the previous keypair used
|
176
|
+
by the client, preventing it from authenticating with the Chef Server.
|
177
|
+
Use care when reregistering the validator client.</p>
|
178
|
+
|
179
|
+
<h2 id="SHOW">SHOW</h2>
|
180
|
+
|
181
|
+
<p><strong>client show</strong> <em>client name</em> <em>(options)</em></p>
|
182
|
+
|
183
|
+
<dl>
|
184
|
+
<dt><code>-a</code>, <code>--attribute ATTR</code></dt><dd>Show only one attribute</dd>
|
185
|
+
</dl>
|
186
|
+
|
187
|
+
|
188
|
+
<p>Show a client. Output format is determined by the --format option.</p>
|
189
|
+
|
190
|
+
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
191
|
+
|
192
|
+
<p> <strong>knife-node</strong>(1)</p>
|
193
|
+
|
194
|
+
<h2 id="AUTHOR">AUTHOR</h2>
|
195
|
+
|
196
|
+
<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>
|
197
|
+
|
198
|
+
<h2 id="DOCUMENTATION">DOCUMENTATION</h2>
|
199
|
+
|
200
|
+
<p> This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</a>.
|
201
|
+
Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
|
202
|
+
|
203
|
+
<h2 id="CHEF">CHEF</h2>
|
204
|
+
|
205
|
+
<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>
|
206
|
+
|
207
|
+
|
208
|
+
<ol class='man-decor man-foot man foot'>
|
209
|
+
<li class='tl'>Chef 0.10.0.beta.8</li>
|
210
|
+
<li class='tc'>April 2011</li>
|
211
|
+
<li class='tr'>knife-client(1)</li>
|
212
|
+
</ol>
|
213
|
+
|
214
|
+
</div>
|
215
|
+
</body>
|
216
|
+
</html>
|
@@ -0,0 +1,170 @@
|
|
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-configure(1) - Generate configuration files for knife or Chef Client</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="#CONFIGURE-SUBCOMMANDS">CONFIGURE SUBCOMMANDS</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>
|
71
|
+
</div>
|
72
|
+
|
73
|
+
<ol class='man-decor man-head man head'>
|
74
|
+
<li class='tl'>knife-configure(1)</li>
|
75
|
+
<li class='tc'>Chef Manual</li>
|
76
|
+
<li class='tr'>knife-configure(1)</li>
|
77
|
+
</ol>
|
78
|
+
|
79
|
+
<h2 id="NAME">NAME</h2>
|
80
|
+
<p class="man-name">
|
81
|
+
<code>knife-configure</code> - <span class="man-whatis">Generate configuration files for knife or Chef Client</span>
|
82
|
+
</p>
|
83
|
+
|
84
|
+
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
85
|
+
|
86
|
+
<p><strong>knife</strong> <strong>configure</strong> [client] <em>(options)</em></p>
|
87
|
+
|
88
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
89
|
+
|
90
|
+
<p>Generates a knife.rb configuration file interactively. When given the
|
91
|
+
--initial option, also creates a new administrative user.</p>
|
92
|
+
|
93
|
+
<h2 id="CONFIGURE-SUBCOMMANDS">CONFIGURE SUBCOMMANDS</h2>
|
94
|
+
|
95
|
+
<p><strong>knife configure</strong> <em>(options)</em></p>
|
96
|
+
|
97
|
+
<dl>
|
98
|
+
<dt><code>-i</code>, <code>--initial</code></dt><dd>Create an initial API Client</dd>
|
99
|
+
<dt><code>-r</code>, <code>--repository REPO</code></dt><dd>The path to your chef-repo</dd>
|
100
|
+
</dl>
|
101
|
+
|
102
|
+
|
103
|
+
<p>Create a configuration file for knife. This will prompt for values to
|
104
|
+
enter into the file. Default values are listed in square brackets if no
|
105
|
+
other entry is typed. See <strong>knife</strong>(1) for a description of
|
106
|
+
configuration options.</p>
|
107
|
+
|
108
|
+
<p><strong>knife configure client</strong> <em>directory</em></p>
|
109
|
+
|
110
|
+
<p>Read the <em>knife.rb</em> config file and generate a config file suitable for
|
111
|
+
use in <em>/etc/chef/client.rb</em> and copy the validation certificate into
|
112
|
+
the specified <em>directory</em>.</p>
|
113
|
+
|
114
|
+
<h2 id="EXAMPLES">EXAMPLES</h2>
|
115
|
+
|
116
|
+
<ul>
|
117
|
+
<li><p>On a freshly installed Chef Server, use <em>knife configure -i</em> to
|
118
|
+
create an administrator and knife configuration file. Leave the
|
119
|
+
field blank to accept the default value. On most systems, the
|
120
|
+
default values are acceptable.</p>
|
121
|
+
|
122
|
+
<p>user@host$ knife configure -i<br />
|
123
|
+
Please enter the chef server URL: [http://localhost:4000]<br />
|
124
|
+
Please enter a clientname for the new client: [username]<br />
|
125
|
+
Please enter the existing admin clientname: [chef-webui]<br />
|
126
|
+
Please enter the location of the existing admin client's private key: [/etc/chef/webui.pem]<br />
|
127
|
+
Please enter the validation clientname: [chef-validator]<br />
|
128
|
+
Please enter the location of the validation key: [/etc/chef/validation.pem]<br />
|
129
|
+
Please enter the path to a chef repository (or leave blank):<br />
|
130
|
+
Creating initial API user...<br />
|
131
|
+
Created (or updated) client[username]<br />
|
132
|
+
Configuration file written to /home/username/.chef/knife.rb</p>
|
133
|
+
|
134
|
+
<p>This creates a new administrator client named <em>username</em>, writes
|
135
|
+
a configuration file to <em>/home/username/.chef/knife.rb</em>, and the
|
136
|
+
private key to <em>/home/username/.chef/username.pem</em>. The
|
137
|
+
configuration file and private key may be copied to another system
|
138
|
+
to facilitate administration of the Chef Server from a remote
|
139
|
+
system. Depending on the value given for the Chef Server URL, you
|
140
|
+
may need to modify that setting after copying to a remote host.</p></li>
|
141
|
+
</ul>
|
142
|
+
|
143
|
+
|
144
|
+
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
145
|
+
|
146
|
+
<p> <strong>knife</strong>(1) <strong>knife-client</strong>(1)</p>
|
147
|
+
|
148
|
+
<h2 id="AUTHOR">AUTHOR</h2>
|
149
|
+
|
150
|
+
<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>
|
151
|
+
|
152
|
+
<h2 id="DOCUMENTATION">DOCUMENTATION</h2>
|
153
|
+
|
154
|
+
<p> This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</a>.
|
155
|
+
Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
|
156
|
+
|
157
|
+
<h2 id="CHEF">CHEF</h2>
|
158
|
+
|
159
|
+
<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>
|
160
|
+
|
161
|
+
|
162
|
+
<ol class='man-decor man-foot man foot'>
|
163
|
+
<li class='tl'>Chef 0.10.0.beta.8</li>
|
164
|
+
<li class='tc'>April 2011</li>
|
165
|
+
<li class='tr'>knife-configure(1)</li>
|
166
|
+
</ol>
|
167
|
+
|
168
|
+
</div>
|
169
|
+
</body>
|
170
|
+
</html>
|