summaryrefslogtreecommitdiff
path: root/distro/common/man/man8/chef-client.8
diff options
context:
space:
mode:
Diffstat (limited to 'distro/common/man/man8/chef-client.8')
-rw-r--r--distro/common/man/man8/chef-client.881
1 files changed, 76 insertions, 5 deletions
diff --git a/distro/common/man/man8/chef-client.8 b/distro/common/man/man8/chef-client.8
index 6a8de44e27..4c8a1f7b8f 100644
--- a/distro/common/man/man8/chef-client.8
+++ b/distro/common/man/man8/chef-client.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "CHEF-CLIENT" "8" "Chef 11.16" "" "chef-client"
+.TH "CHEF-CLIENT" "8" "Chef 12.0" "" "chef-client"
.SH NAME
chef-client \- The man page for the chef-client command line tool.
.
@@ -86,7 +86,7 @@ This command has the following options:
Use to cause a chef\-client run to fail when the chef\-client does not have administrator privileges in Microsoft Windows\&.
.TP
.B \fB\-\-chef\-zero\-port PORT\fP
-The port on which chef\-zero will listen.
+The port on which chef\-zero will listen. If a port is not specified\-\-\-individually, as range of ports, or from the \fBchef_zero.port\fP setting in the client.rb file\-\-\-the chef\-client will scan for ports between 8889\-9999 and will pick the first port that is available.
.TP
.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
The output format: \fBdoc\fP (default) or \fBmin\fP\&.
@@ -110,10 +110,81 @@ The name of the group that owns a process. This is required when starting any ex
Shows help for the command.
.TP
.B \fB\-i SECONDS\fP, \fB\-\-interval SECONDS\fP
-The frequency (in seconds) at which the chef\-client runs. Default value: \fB1800\fP\&.
+The frequency (in seconds) at which the chef\-client runs. When the chef\-client is run at intervals, \fB\-\-splay\fP and \fB\-\-interval\fP values are applied before the chef\-client run. Default value: \fB1800\fP\&.
.TP
.B \fB\-j PATH\fP, \fB\-\-json\-attributes PATH\fP
The path to a file that contains JSON data.
+.sp
+Use this option to define a \fBrun_list\fP object. For example, a JSON file similar to:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+"run_list": [
+ "recipe[base]",
+ "recipe[foo]",
+ "recipe[bar]",
+ "role[webserver]"
+],
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+may be used by running \fBchef\-client \-j path/to/file.json\fP\&.
+.sp
+In certain situations this option may be used to update \fBnormal\fP attributes.
+.sp
+\fBWARNING:\fP
+.INDENT 7.0
+.INDENT 3.5
+Any other attribute type that is contained in this JSON file will be treated as a \fBnormal\fP attribute. For example, attempting to update \fBoverride\fP attributes using the \fB\-j\fP option:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+ "name": "dev\-99",
+ "description": "Install some stuff",
+ "override_attributes": {
+ "apptastic": {
+ "enable_apptastic": "false",
+ "apptastic_tier_name": "dev\-99.bomb.com"
+ }
+ }
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+will result in a node object similar to:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+ "name": "maybe\-dev\-99",
+ "normal": {
+ "name": "dev\-99",
+ "description": "Install some stuff",
+ "override_attributes": {
+ "apptastic": {
+ "enable_apptastic": "false",
+ "apptastic_tier_name": "dev\-99.bomb.com"
+ }
+ }
+ }
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.UNINDENT
.TP
.B \fB\-k KEY_FILE\fP, \fB\-\-client_key KEY_FILE\fP
The location of the file which contains the client key. Default value: \fB/etc/chef/client.pem\fP\&.
@@ -134,7 +205,7 @@ Use to view colored output. Default setting: \fB\-\-color\fP\&.
The name of the node.
.TP
.B \fB\-o RUN_LIST_ITEM\fP, \fB\-\-override\-runlist RUN_LIST_ITEM\fP
-Replace the current run list with the specified items.
+Replace the current run list with the specified items. This option will not clear the list of cookbooks (and related files) that is cached on the node.
.TP
.B \fB\-\-once\fP
Use to run the chef\-client only once and to cancel \fBinterval\fP and \fBsplay\fP options.
@@ -155,7 +226,7 @@ The path to a recipe. For example, if a recipe file is in the current directory,
The amount of time (in seconds) to wait for a chef\-client run to finish. Default value: not set (indefinite). Set to \fB0\fP to cause a second chef\-client to exit immediately.
.TP
.B \fB\-s SECONDS\fP, \fB\-\-splay SECONDS\fP
-A number (in seconds) to add to the \fBinterval\fP that is used to determine the frequency of chef\-client runs. This number can help prevent server load when there are many clients running at the same time.
+A number (in seconds) to add to the \fBinterval\fP that is used to determine the frequency of chef\-client runs. This number can help prevent server load when there are many clients running at the same time. When the chef\-client is run at intervals, \fB\-\-splay\fP and \fB\-\-interval\fP values are applied before the chef\-client run.
.TP
.B \fB\-S CHEF_SERVER_URL\fP, \fB\-\-server CHEF_SERVER_URL\fP
The URL for the Chef server\&.