summaryrefslogtreecommitdiff
path: root/distro/common/man/man1/knife-configure.1
blob: f8dbdab7569aac164cb34d03dd960f2da1e778a7 (plain)
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
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "KNIFE\-CONFIGURE" "1" "January 2013" "Chef 11.0.0.beta.2" "Chef Manual"
.
.SH "NAME"
\fBknife\-configure\fR \- Generate configuration files for knife or Chef Client
.
.SH "SYNOPSIS"
\fBknife\fR \fBconfigure\fR [client] \fI(options)\fR
.
.SH "DESCRIPTION"
Generates a knife\.rb configuration file interactively\. When given the \-\-initial option, also creates a new administrative user\.
.
.SH "CONFIGURE SUBCOMMANDS"
\fBknife configure\fR \fI(options)\fR
.
.TP
\fB\-i\fR, \fB\-\-initial\fR
Create an initial API Client
.
.TP
\fB\-r\fR, \fB\-\-repository REPO\fR
The path to your chef\-repo
.
.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 \fBknife\fR(1) for a description of configuration options\.
.
.P
\fBknife configure client\fR \fIdirectory\fR
.
.P
Read the \fIknife\.rb\fR config file and generate a config file suitable for use in \fI/etc/chef/client\.rb\fR and copy the validation certificate into the specified \fIdirectory\fR\.
.
.SH "EXAMPLES"
.
.IP "\(bu" 4
On a freshly installed Chef Server, use \fIknife configure \-i\fR 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\.
.
.IP
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
.
.IP
This creates a new administrator client named \fIusername\fR, writes a configuration file to \fI/home/username/\.chef/knife\.rb\fR, and the private key to \fI/home/username/\.chef/username\.pem\fR\. 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\.
.
.IP "" 0
.
.SH "SEE ALSO"
\fBknife\fR(1) \fBknife\-client\fR(1)
.
.SH "AUTHOR"
Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\.
.
.SH "DOCUMENTATION"
This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
.
.SH "CHEF"
Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR