summaryrefslogtreecommitdiff
path: root/distro/common/man/man8/chef-client.8
blob: 68a3d1ede2e226db9dbdc487c9a712ada6c672f7 (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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "CHEF\-CLIENT" "8" "October 2013" "Chef 11.10.0.alpha.0" "Chef Manual"
.
.SH "NAME"
\fBchef\-client\fR \- Runs a client node connecting to a chef\-server\.
.
.SH "SYNOPSIS"
\fBchef\-client\fR \fI(options)\fR
.
.TP
\fB\-S\fR, \fB\-\-server CHEFSERVERURL\fR
The chef server URL
.
.TP
\fB\-c\fR, \fB\-\-config CONFIG\fR
The configuration file to use
.
.TP
\fB\-d\fR, \fB\-\-daemonize\fR
Daemonize the process
.
.TP
\fB\-g\fR, \fB\-\-group GROUP\fR
Group to set privilege to
.
.TP
\fB\-i\fR, \fB\-\-interval SECONDS\fR
Run chef\-client periodically, in seconds
.
.TP
\fB\-j\fR, \fB\-\-json\-attributes JSON_ATTRIBS\fR
Load attributes from a JSON file or URL
.
.TP
\fB\-E\fR, \fB\-\-environment ENVIRONMENT\fR
Set the Chef Environment on the node
.
.TP
\fB\-l\fR, \fB\-\-log_level LEVEL\fR
Set the log level (debug, info, warn, error, fatal)
.
.TP
\fB\-L\fR, \fB\-\-logfile LOGLOCATION\fR
Set the log file location, defaults to STDOUT \- recommended for daemonizing
.
.TP
\fB\-N\fR, \fB\-\-node\-name NODE_NAME\fR
The node name for this client
.
.TP
\fB\-o\fR, \fB\-\-override\-runlist\fR
Replace current run list with specified items
.
.TP
\fB\-K\fR, \fB\-\-validation_key KEY_FILE\fR
Set the validation key file location, used for registering new clients
.
.TP
\fB\-k\fR, \fB\-\-client_key KEY_FILE\fR
Set the client key file location
.
.TP
\fB\-s\fR, \fB\-\-splay SECONDS\fR
The splay time for running at intervals, in seconds
.
.TP
\fB\-u\fR, \fB\-\-user USER\fR
User to set privilege to
.
.TP
\fB\-P\fR, \fB\-\-pid PIDFILE\fR
Set the PID file location, defaults to /tmp/chef\-client\.pid
.
.TP
\fB\-\-once\fR
Cancel any interval or splay options, run chef once and exit
.
.TP
\fB\-v\fR, \fB\-\-version\fR
Show chef version
.
.TP
\fB\-h\fR, \fB\-\-help\fR
Show this message
.
.SH "DESCRIPTION"
The Chef Client is where almost all of the work in Chef is done\. It communicates with the Chef Server via REST, authenticates via Signed Header Authentication, and compiles and executes Cookbooks\.
.
.P
A Chef Client does work on behalf of a Node\. A single Chef Client can run recipes for multiple Nodes\.
.
.P
Clients are where all the action happens \- the Chef Server and Chef Expander are largely services that exist only to provide the Client with information\.
.
.SH "SEE ALSO"
Full documentation for Chef and chef\-client is located on the Chef wiki, http://wiki\.opscode\.com/display/chef/Home\.
.
.SH "AUTHOR"
Chef was written by Adam Jacob \fIadam@ospcode\.com\fR of Opscode (http://www\.opscode\.com), with contributions from the community\. This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR with help2man\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
.
.P
On Debian systems, the complete text of the Apache 2\.0 License can be found in /usr/share/common\-licenses/Apache\-2\.0\.