/
knife-configure.1.html
170 lines (139 loc) · 7.38 KB
/
knife-configure.1.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<!DOCTYPE html>
<html>
<head>
<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
<title>knife-configure(1) - Generate configuration files for knife or Chef Client</title>
<style type='text/css' media='all'>
/* style: man */
body#manpage {margin:0}
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
.mp h2 {margin:10px 0 0 0}
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
.mp h3 {margin:0 0 0 4ex}
.mp dt {margin:0;clear:left}
.mp dt.flush {float:left;width:8ex}
.mp dd {margin:0 0 0 9ex}
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
.mp pre {margin-bottom:20px}
.mp pre+h2,.mp pre+h3 {margin-top:22px}
.mp h2+pre,.mp h3+pre {margin-top:5px}
.mp img {display:block;margin:auto}
.mp h1.man-title {display:none}
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
.mp h2 {font-size:16px;line-height:1.25}
.mp h1 {font-size:20px;line-height:2}
.mp {text-align:justify;background:#fff}
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
.mp u {text-decoration:underline}
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
.mp b.man-ref {font-weight:normal;color:#434241}
.mp pre {padding:0 4ex}
.mp pre code {font-weight:normal;color:#434241}
.mp h2+pre,h3+pre {padding-left:0}
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
ol.man-decor {width:100%}
ol.man-decor li.tl {text-align:left}
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
ol.man-decor li.tr {text-align:right;float:right}
</style>
<style type='text/css' media='all'>
/* style: toc */
.man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
.man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
.man-navigation a:hover {color:#111;text-decoration:underline}
</style>
</head>
<!--
The following styles are deprecated and will be removed at some point:
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
.man-navigation should be used instead.
-->
<body id='manpage'>
<div class='mp' id='man'>
<div class='man-navigation' style='display:none'>
<a href="#NAME">NAME</a>
<a href="#SYNOPSIS">SYNOPSIS</a>
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#CONFIGURE-SUBCOMMANDS">CONFIGURE SUBCOMMANDS</a>
<a href="#EXAMPLES">EXAMPLES</a>
<a href="#SEE-ALSO">SEE ALSO</a>
<a href="#AUTHOR">AUTHOR</a>
<a href="#DOCUMENTATION">DOCUMENTATION</a>
<a href="#CHEF">CHEF</a>
</div>
<ol class='man-decor man-head man head'>
<li class='tl'>knife-configure(1)</li>
<li class='tc'>Chef Manual</li>
<li class='tr'>knife-configure(1)</li>
</ol>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>knife-configure</code> - <span class="man-whatis">Generate configuration files for knife or Chef Client</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><strong>knife</strong> <strong>configure</strong> [client] <em>(options)</em></p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>Generates a knife.rb configuration file interactively. When given the
--initial option, also creates a new administrative user.</p>
<h2 id="CONFIGURE-SUBCOMMANDS">CONFIGURE SUBCOMMANDS</h2>
<p><strong>knife configure</strong> <em>(options)</em></p>
<dl>
<dt><code>-i</code>, <code>--initial</code></dt><dd>Create an initial API Client</dd>
<dt><code>-r</code>, <code>--repository REPO</code></dt><dd>The path to your chef-repo</dd>
</dl>
<p>Create a configuration file for knife. This will prompt for values to
enter into the file. Default values are listed in square brackets if no
other entry is typed. See <strong>knife</strong>(1) for a description of
configuration options.</p>
<p><strong>knife configure client</strong> <em>directory</em></p>
<p>Read the <em>knife.rb</em> config file and generate a config file suitable for
use in <em>/etc/chef/client.rb</em> and copy the validation certificate into
the specified <em>directory</em>.</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
<ul>
<li><p>On a freshly installed Chef Server, use <em>knife configure -i</em> to
create an administrator and knife configuration file. Leave the
field blank to accept the default value. On most systems, the
default values are acceptable.</p>
<p>user@host$ knife configure -i<br />
Please enter the chef server URL: [http://localhost:4000]<br />
Please enter a clientname for the new client: [username]<br />
Please enter the existing admin clientname: [chef-webui]<br />
Please enter the location of the existing admin client's private key: [/etc/chef/webui.pem]<br />
Please enter the validation clientname: [chef-validator]<br />
Please enter the location of the validation key: [/etc/chef/validation.pem]<br />
Please enter the path to a chef repository (or leave blank):<br />
Creating initial API user...<br />
Created (or updated) client[username]<br />
Configuration file written to /home/username/.chef/knife.rb</p>
<p>This creates a new administrator client named <em>username</em>, writes
a configuration file to <em>/home/username/.chef/knife.rb</em>, and the
private key to <em>/home/username/.chef/username.pem</em>. The
configuration file and private key may be copied to another system
to facilitate administration of the Chef Server from a remote
system. Depending on the value given for the Chef Server URL, you
may need to modify that setting after copying to a remote host.</p></li>
</ul>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<p> <strong>knife</strong>(1) <strong>knife-client</strong>(1)</p>
<h2 id="AUTHOR">AUTHOR</h2>
<p> Chef was written by Adam Jacob <a href="mailto:adam@opscode.com" data-bare-link="true">adam@opscode.com</a> with many contributions from the community.</p>
<h2 id="DOCUMENTATION">DOCUMENTATION</h2>
<p> This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</a>.
Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
<h2 id="CHEF">CHEF</h2>
<p> Knife is distributed with Chef. <a href="http://wiki.opscode.com/display/chef/Home" data-bare-link="true">http://wiki.opscode.com/display/chef/Home</a></p>
<ol class='man-decor man-foot man foot'>
<li class='tl'>Chef 11.0.0.alpha</li>
<li class='tc'>September 2012</li>
<li class='tr'>knife-configure(1)</li>
</ol>
</div>
</body>
</html>