summaryrefslogtreecommitdiff
path: root/chef/distro/common/html/chef-client.8.html
blob: cdcee9c7fdee8fb49b16ebe4134462aacf31c705 (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
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
<!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>chef-client(8) - Runs a client node connecting to a chef-server.</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="#SEE-ALSO">SEE ALSO</a>
    <a href="#AUTHOR">AUTHOR</a>
  </div>

  <ol class='man-decor man-head man head'>
    <li class='tl'>chef-client(8)</li>
    <li class='tc'>Chef Manual</li>
    <li class='tr'>chef-client(8)</li>
  </ol>

  <h2 id="NAME">NAME</h2>
<p class="man-name">
  <code>chef-client</code> - <span class="man-whatis">Runs a client node connecting to a chef-server.</span>
</p>

<h2 id="SYNOPSIS">SYNOPSIS</h2>

<p><strong>chef-client</strong> <em>(options)</em></p>

<dl>
<dt><code>-S</code>, <code>--server CHEFSERVERURL</code></dt><dd>The chef server URL</dd>
<dt><code>-c</code>, <code>--config CONFIG</code></dt><dd>The configuration file to use</dd>
<dt><code>-d</code>, <code>--daemonize</code></dt><dd>Daemonize the process</dd>
<dt><code>-g</code>, <code>--group GROUP</code></dt><dd>Group to set privilege to</dd>
<dt><code>-i</code>, <code>--interval SECONDS</code></dt><dd>Run chef-client periodically, in seconds</dd>
<dt><code>-j</code>, <code>--json-attributes JSON_ATTRIBS</code></dt><dd>Load attributes from a JSON file or URL</dd>
<dt><code>-E</code>, <code>--environment ENVIRONMENT</code></dt><dd>Set the Chef Environment on the node</dd>
<dt><code>-l</code>, <code>--log_level LEVEL</code></dt><dd>Set the log level (debug, info, warn, error, fatal)</dd>
<dt><code>-L</code>, <code>--logfile LOGLOCATION</code></dt><dd>Set the log file location, defaults to STDOUT - recommended for
daemonizing</dd>
<dt><code>-N</code>, <code>--node-name NODE_NAME</code></dt><dd>The node name for this client</dd>
<dt><code>-o</code>, <code>--override-runlist</code></dt><dd>Replace current run list with specified items</dd>
<dt><code>-K</code>, <code>--validation_key KEY_FILE</code></dt><dd>Set the validation key file location, used for registering new clients</dd>
<dt><code>-k</code>, <code>--client_key KEY_FILE</code></dt><dd>Set the client key file location</dd>
<dt><code>-s</code>, <code>--splay SECONDS</code></dt><dd>The splay time for running at intervals, in seconds</dd>
<dt><code>-u</code>, <code>--user USER</code></dt><dd>User to set privilege to</dd>
<dt><code>-P</code>, <code>--pid PIDFILE</code></dt><dd>Set the PID file location, defaults to /tmp/chef-client.pid</dd>
<dt class="flush"><code>--once</code></dt><dd>Cancel any interval or splay options, run chef once and exit</dd>
<dt><code>-v</code>, <code>--version</code></dt><dd>Show chef version</dd>
<dt><code>-h</code>, <code>--help</code></dt><dd>Show this message</dd>
</dl>


<h2 id="DESCRIPTION">DESCRIPTION</h2>

<p>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>

<p>A Chef Client does work on behalf of a Node. A single Chef Client can
run recipes for multiple Nodes.</p>

<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.</p>

<h2 id="SEE-ALSO">SEE ALSO</h2>

<p>Full  documentation  for  Chef  and  chef-client is located on the Chef
wiki, http://wiki.opscode.com/display/chef/Home.</p>

<h2 id="AUTHOR">AUTHOR</h2>

<p>Chef was written by Adam Jacob <a href="&#109;&#x61;&#105;&#108;&#116;&#x6f;&#x3a;&#x61;&#100;&#x61;&#109;&#x40;&#x6f;&#x73;&#x70;&#x63;&#x6f;&#x64;&#101;&#x2e;&#x63;&#111;&#x6d;" data-bare-link="true">&#x61;&#100;&#97;&#109;&#x40;&#111;&#x73;&#x70;&#99;&#111;&#x64;&#101;&#46;&#x63;&#x6f;&#x6d;</a> of Opscode
(http://www.opscode.com),  with contributions from the community.  This
manual page was written by Joshua Timberman  <a href="&#x6d;&#97;&#105;&#108;&#116;&#x6f;&#x3a;&#x6a;&#x6f;&#115;&#x68;&#117;&#x61;&#64;&#x6f;&#112;&#115;&#x63;&#111;&#x64;&#101;&#46;&#x63;&#111;&#109;" data-bare-link="true">&#106;&#x6f;&#x73;&#x68;&#117;&#97;&#64;&#x6f;&#112;&#x73;&#x63;&#111;&#100;&#101;&#x2e;&#x63;&#x6f;&#x6d;</a>  with
help2man.  Permission  is  granted  to copy, distribute and / or modify
this document under the terms of the Apache 2.0 License.</p>

<p>On Debian systems, the complete text of the Apache 2.0 License  can  be
found in /usr/share/common-licenses/Apache-2.0.</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'>chef-client(8)</li>
  </ol>

  </div>
</body>
</html>