chef 11.12.8-x86-mingw32 → 11.14.0.alpha.2-x86-mingw32
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Rakefile +4 -2
- data/distro/common/html/_sources/index.txt +6 -0
- data/distro/common/html/_sources/knife_ssl_check.txt +41 -0
- data/distro/common/html/_sources/knife_ssl_fetch.txt +41 -0
- data/distro/common/html/_static/basic.css +2 -5
- data/distro/common/html/_static/doctools.js +5 -14
- data/distro/common/html/_static/jquery.js +2 -154
- data/distro/common/html/_static/pygments.css +2 -2
- data/distro/common/html/_static/searchtools.js +212 -150
- data/distro/common/html/_static/underscore.js +29 -21
- data/distro/common/html/_static/websupport.js +1 -1
- data/distro/common/html/ctl_chef_client.html +15 -18
- data/distro/common/html/ctl_chef_server.html +7 -7
- data/distro/common/html/ctl_chef_shell.html +6 -6
- data/distro/common/html/ctl_chef_solo.html +7 -8
- data/distro/common/html/index.html +34 -24
- data/distro/common/html/knife.html +23 -24
- data/distro/common/html/knife_bootstrap.html +13 -9
- data/distro/common/html/knife_client.html +10 -11
- data/distro/common/html/knife_common_options.html +6 -7
- data/distro/common/html/knife_configure.html +3 -4
- data/distro/common/html/knife_cookbook.html +18 -11
- data/distro/common/html/knife_cookbook_site.html +14 -14
- data/distro/common/html/knife_data_bag.html +24 -23
- data/distro/common/html/knife_delete.html +4 -5
- data/distro/common/html/knife_deps.html +4 -5
- data/distro/common/html/knife_diff.html +6 -7
- data/distro/common/html/knife_download.html +12 -13
- data/distro/common/html/knife_edit.html +4 -5
- data/distro/common/html/knife_environment.html +8 -9
- data/distro/common/html/knife_exec.html +9 -10
- data/distro/common/html/knife_index_rebuild.html +4 -5
- data/distro/common/html/knife_list.html +8 -9
- data/distro/common/html/knife_node.html +34 -33
- data/distro/common/html/knife_raw.html +2 -3
- data/distro/common/html/knife_recipe_list.html +3 -4
- data/distro/common/html/knife_role.html +30 -29
- data/distro/common/html/knife_search.html +7 -7
- data/distro/common/html/knife_show.html +4 -5
- data/distro/common/html/knife_ssh.html +2 -3
- data/distro/common/html/knife_ssl_check.html +148 -0
- data/distro/common/html/knife_ssl_fetch.html +152 -0
- data/distro/common/html/knife_status.html +4 -5
- data/distro/common/html/knife_tag.html +2 -3
- data/distro/common/html/knife_upload.html +5 -6
- data/distro/common/html/knife_user.html +9 -10
- data/distro/common/html/knife_using.html +12 -12
- data/distro/common/html/knife_xargs.html +11 -12
- data/distro/common/html/search.html +1 -2
- data/distro/common/html/searchindex.js +1 -1
- data/distro/common/man/man1/chef-shell.1 +19 -11
- data/distro/common/man/man1/knife-bootstrap.1 +35 -19
- data/distro/common/man/man1/knife-client.1 +111 -28
- data/distro/common/man/man1/knife-configure.1 +30 -14
- data/distro/common/man/man1/knife-cookbook-site.1 +105 -22
- data/distro/common/man/man1/knife-cookbook.1 +164 -23
- data/distro/common/man/man1/knife-data-bag.1 +157 -33
- data/distro/common/man/man1/knife-delete.1 +21 -17
- data/distro/common/man/man1/knife-deps.1 +60 -16
- data/distro/common/man/man1/knife-diff.1 +37 -17
- data/distro/common/man/man1/knife-download.1 +68 -24
- data/distro/common/man/man1/knife-edit.1 +19 -15
- data/distro/common/man/man1/knife-environment.1 +105 -17
- data/distro/common/man/man1/knife-exec.1 +78 -18
- data/distro/common/man/man1/knife-index-rebuild.1 +16 -8
- data/distro/common/man/man1/knife-list.1 +39 -23
- data/distro/common/man/man1/knife-node.1 +170 -22
- data/distro/common/man/man1/knife-raw.1 +33 -13
- data/distro/common/man/man1/knife-recipe-list.1 +17 -5
- data/distro/common/man/man1/knife-role.1 +86 -18
- data/distro/common/man/man1/knife-search.1 +80 -16
- data/distro/common/man/man1/knife-show.1 +30 -14
- data/distro/common/man/man1/knife-ssh.1 +54 -14
- data/distro/common/man/man1/knife-ssl-check.1 +207 -0
- data/distro/common/man/man1/knife-ssl-fetch.1 +207 -0
- data/distro/common/man/man1/knife-status.1 +48 -12
- data/distro/common/man/man1/knife-tag.1 +30 -10
- data/distro/common/man/man1/knife-upload.1 +72 -20
- data/distro/common/man/man1/knife-user.1 +79 -23
- data/distro/common/man/man1/knife-xargs.1 +61 -53
- data/distro/common/man/man8/chef-client.8 +87 -29
- data/distro/common/man/man8/chef-solo.8 +36 -15
- data/lib/chef/application.rb +19 -14
- data/lib/chef/application/client.rb +5 -0
- data/lib/chef/application/solo.rb +5 -0
- data/lib/chef/application/windows_service_manager.rb +3 -0
- data/lib/chef/chef_fs/chef_fs_data_store.rb +72 -24
- data/lib/chef/chef_fs/file_system/chef_repository_file_system_cookbook_dir.rb +20 -4
- data/lib/chef/chef_fs/file_system/chef_repository_file_system_cookbooks_dir.rb +20 -1
- data/lib/chef/chef_fs/file_system/file_system_entry.rb +10 -2
- data/lib/chef/client.rb +2 -3
- data/lib/chef/config.rb +34 -8
- data/lib/chef/cookbook/cookbook_version_loader.rb +45 -4
- data/lib/chef/cookbook_version.rb +38 -30
- data/lib/chef/dsl/recipe.rb +4 -1
- data/lib/chef/event_dispatch/base.rb +14 -0
- data/lib/chef/event_dispatch/events_output_stream.rb +29 -0
- data/lib/chef/exceptions.rb +8 -0
- data/lib/chef/formatters/base.rb +16 -45
- data/lib/chef/formatters/doc.rb +51 -26
- data/lib/chef/formatters/indentable_output_stream.rb +165 -0
- data/lib/chef/knife/node_environment_set.rb +54 -0
- data/lib/chef/knife/user_create.rb +1 -1
- data/lib/chef/monkey_patches/pathname.rb +32 -0
- data/lib/chef/node.rb +1 -1
- data/lib/chef/platform/provider_mapping.rb +345 -338
- data/lib/chef/policy_builder/expand_node_object.rb +1 -1
- data/lib/chef/policy_builder/policyfile.rb +1 -1
- data/lib/chef/provider.rb +1 -0
- data/lib/chef/provider/git.rb +1 -1
- data/lib/chef/provider/link.rb +2 -2
- data/lib/chef/provider/remote_file/content.rb +1 -1
- data/lib/chef/provider/remote_file/local_file.rb +8 -2
- data/lib/chef/provider/service/arch.rb +0 -1
- data/lib/chef/provider/service/debian.rb +0 -2
- data/lib/chef/provider/service/freebsd.rb +2 -1
- data/lib/chef/provider/service/gentoo.rb +1 -1
- data/lib/chef/provider/service/init.rb +0 -1
- data/lib/chef/provider/service/insserv.rb +0 -2
- data/lib/chef/provider/service/invokercd.rb +0 -2
- data/lib/chef/provider/service/macosx.rb +2 -1
- data/lib/chef/provider/service/redhat.rb +0 -1
- data/lib/chef/provider/service/simple.rb +1 -0
- data/lib/chef/provider/service/solaris.rb +1 -0
- data/lib/chef/provider/service/systemd.rb +1 -1
- data/lib/chef/provider/service/upstart.rb +1 -1
- data/lib/chef/provider/user.rb +9 -9
- data/lib/chef/provider/user/solaris.rb +2 -0
- data/lib/chef/resource.rb +1 -0
- data/lib/chef/resource/remote_file.rb +32 -6
- data/lib/chef/run_context.rb +22 -0
- data/lib/chef/run_lock.rb +43 -4
- data/lib/chef/version.rb +2 -2
- data/spec/functional/http/simple_spec.rb +84 -0
- data/spec/functional/resource/remote_file_spec.rb +107 -43
- data/spec/functional/rest_spec.rb +94 -0
- data/spec/functional/run_lock_spec.rb +1 -1
- data/spec/functional/win32/service_manager_spec.rb +6 -0
- data/spec/integration/knife/chef_fs_data_store_spec.rb +2 -0
- data/spec/integration/recipes/lwrp_inline_resources_spec.rb +76 -0
- data/spec/spec_helper.rb +2 -0
- data/spec/support/mock/platform.rb +7 -0
- data/spec/support/pedant/pedant_config.rb +121 -0
- data/spec/support/pedant/run_pedant.rb +63 -0
- data/spec/support/pedant/stickywicket.pem +27 -0
- data/spec/support/shared/functional/http.rb +242 -0
- data/spec/support/shared/unit/api_error_inspector.rb +2 -2
- data/spec/unit/api_client_spec.rb +2 -2
- data/spec/unit/application/client_spec.rb +6 -1
- data/spec/unit/application/knife_spec.rb +4 -0
- data/spec/unit/application/solo_spec.rb +2 -0
- data/spec/unit/application_spec.rb +7 -0
- data/spec/unit/client_spec.rb +16 -0
- data/spec/unit/config_spec.rb +3 -20
- data/spec/unit/cookbook_version_spec.rb +224 -122
- data/spec/unit/formatters/error_inspectors/compile_error_inspector_spec.rb +2 -2
- data/spec/unit/formatters/error_inspectors/cookbook_resolve_error_inspector_spec.rb +2 -2
- data/spec/unit/formatters/error_inspectors/cookbook_sync_error_inspector_spec.rb +2 -2
- data/spec/unit/formatters/error_inspectors/resource_failure_inspector_spec.rb +2 -2
- data/spec/unit/formatters/error_inspectors/run_list_expansion_error_inspector_spec.rb +2 -2
- data/spec/unit/handler_spec.rb +0 -1
- data/spec/unit/knife/client_bulk_delete_spec.rb +3 -0
- data/spec/unit/knife/cookbook_bulk_delete_spec.rb +2 -0
- data/spec/unit/knife/cookbook_metadata_spec.rb +2 -2
- data/spec/unit/knife/cookbook_site_install_spec.rb +3 -1
- data/spec/unit/knife/cookbook_upload_spec.rb +10 -10
- data/spec/unit/knife/node_environment_set_spec.rb +80 -0
- data/spec/unit/knife/user_create_spec.rb +6 -4
- data/spec/unit/knife/user_edit_spec.rb +5 -0
- data/spec/unit/knife_spec.rb +3 -0
- data/spec/unit/mixin/securable_spec.rb +18 -20
- data/spec/unit/node/attribute_spec.rb +15 -2
- data/spec/unit/node/immutable_collections_spec.rb +4 -4
- data/spec/unit/provider/cron_spec.rb +14 -14
- data/spec/unit/provider/git_spec.rb +4 -4
- data/spec/unit/provider/group_spec.rb +1 -1
- data/spec/unit/provider/ohai_spec.rb +2 -2
- data/spec/unit/provider/remote_file/content_spec.rb +58 -35
- data/spec/unit/provider/remote_file/local_file_spec.rb +23 -0
- data/spec/unit/provider/service/solaris_smf_service_spec.rb +13 -13
- data/spec/unit/resource/mount_spec.rb +0 -1
- data/spec/unit/resource/remote_file_spec.rb +29 -0
- data/spec/unit/resource_spec.rb +1 -1
- data/spec/unit/run_context_spec.rb +7 -0
- data/spec/unit/run_lock_spec.rb +98 -0
- data/spec/unit/version_constraint_spec.rb +1 -1
- metadata +166 -153
- data/distro/common/html/_static/chef.css +0 -507
- data/distro/common/html/_static/chef_logo.png +0 -0
- data/lib/chef/checksum/storage.rb +0 -18
- data/lib/chef/checksum/storage/filesystem.rb +0 -56
- data/spec/unit/checksum/storage/filesystem_spec.rb +0 -70
@@ -1,4 +1,6 @@
|
|
1
|
-
|
1
|
+
.\" Man page generated from reStructuredText.
|
2
|
+
.
|
3
|
+
.TH "KNIFE-XARGS" "1" "Chef 11.12.0" "" "knife xargs"
|
2
4
|
.SH NAME
|
3
5
|
knife-xargs \- The man page for the knife xargs subcommand.
|
4
6
|
.
|
@@ -28,20 +30,22 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
28
30
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
29
31
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
30
32
|
..
|
31
|
-
.\" Man page generated from reStructuredText.
|
32
|
-
.
|
33
33
|
.sp
|
34
|
-
The \fBknife xargs\fP subcommand is used to build and execute command lines against objects on a server using standard input.
|
34
|
+
The \fBknife xargs\fP subcommand is used to build and execute command lines against objects on a Chef server using standard input.
|
35
35
|
.sp
|
36
36
|
\fBSyntax\fP
|
37
37
|
.sp
|
38
|
-
This
|
38
|
+
This subcommand has the following syntax:
|
39
|
+
.INDENT 0.0
|
40
|
+
.INDENT 3.5
|
39
41
|
.sp
|
40
42
|
.nf
|
41
43
|
.ft C
|
42
44
|
$ knife xargs [PATTERN...] (options)
|
43
45
|
.ft P
|
44
46
|
.fi
|
47
|
+
.UNINDENT
|
48
|
+
.UNINDENT
|
45
49
|
.sp
|
46
50
|
\fBOptions\fP
|
47
51
|
.sp
|
@@ -49,35 +53,59 @@ This subcommand has the following options:
|
|
49
53
|
.INDENT 0.0
|
50
54
|
.TP
|
51
55
|
.B \fB\-0\fP
|
52
|
-
Indicates that a \fBNULL\fP character (\fB\e0\fP) will be used as a separator, instead of white space. Default: \fBfalse\fP
|
56
|
+
Indicates that a \fBNULL\fP character (\fB\e0\fP) will be used as a separator, instead of white space. Default: \fBfalse\fP\&.
|
57
|
+
.TP
|
58
|
+
.B \fB\-\-chef\-repo\-path PATH\fP
|
59
|
+
The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb.
|
60
|
+
.TP
|
61
|
+
.B \fB\-\-concurrency\fP
|
62
|
+
The number of allowed concurrent connections. Default: \fB10\fP\&.
|
63
|
+
.TP
|
64
|
+
.B \fB\-\-[no\-]diff\fP
|
65
|
+
Use to show a diff when a file changes. Default: \fB\-\-diff\fP\&.
|
66
|
+
.TP
|
67
|
+
.B \fB\-\-dry\-run\fP
|
68
|
+
Use to prevent changes from being uploaded to the Chef server\&. Default: \fBfalse\fP\&.
|
69
|
+
.TP
|
70
|
+
.B \fB\-\-[no\-]force\fP
|
71
|
+
Use to force the upload of files even if they haven\(aqt been changed. Default: \fB\-\-no\-force\fP\&.
|
72
|
+
.TP
|
73
|
+
.B \fB\-I REPLACE_STRING\fP, \fB\-\-replace REPLACE_STRING\fP
|
74
|
+
Use to define a string that will be used to replace all occurrences of a file name. Default: \fBnil\fP\&.
|
75
|
+
.TP
|
76
|
+
.B \fB\-J REPLACE_STRING\fP, \fB\-\-replace\-first REPLACE_STRING\fP
|
77
|
+
Use to define a string that will be used to replace the first occurrence of a file name. Default: \fBnil\fP\&.
|
78
|
+
.TP
|
79
|
+
.B \fB\-\-local\fP
|
80
|
+
Indicates that a command line will be built or executed against a local file. Set to \fBfalse\fP to build or execute against a remote file. Default: \fBfalse\fP\&.
|
81
|
+
.TP
|
82
|
+
.B \fB\-n MAX_ARGS\fP, \fB\-\-max\-args MAX_ARGS\fP
|
83
|
+
The maximum number of arguments per command line. Default: \fBnil\fP\&.
|
84
|
+
.TP
|
85
|
+
.B \fB\-p [PATTERN...]\fP, \fB\-\-pattern [PATTERN...]\fP
|
86
|
+
One (or more) patterns for a command line. If this option is not specified, a list of patterns may be expected on standard input. Default: \fBnil\fP\&.
|
87
|
+
.TP
|
88
|
+
.B \fB\-\-repo\-mode MODE\fP
|
89
|
+
The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default value: \fBdefault\fP\&.
|
90
|
+
.TP
|
91
|
+
.B \fB\-s LENGTH\fP, \fB\-\-max\-chars LENGTH\fP
|
92
|
+
The maximum size (in characters) for a command line. Default: \fBnil\fP\&.
|
93
|
+
.TP
|
94
|
+
.B \fB\-t\fP
|
95
|
+
Indicates that the print command will be run on the command line. Default: \fBnil\fP\&.
|
53
96
|
.TP
|
54
97
|
.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP
|
55
98
|
The configuration file to use.
|
56
99
|
.TP
|
57
|
-
.B \fB\-\-chef\-repo\-path PATH\fP
|
58
|
-
The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb.
|
59
|
-
.TP
|
60
100
|
.B \fB\-\-chef\-zero\-port PORT\fP
|
61
101
|
The port on which chef\-zero will listen.
|
62
102
|
.TP
|
63
|
-
.B \fB\-\-[no\-]color\fP
|
64
|
-
Indicates whether colored output will be used.
|
65
|
-
.TP
|
66
|
-
.B \fB\-\-concurrency\fP
|
67
|
-
The number of allowed concurrent connections. Default: \fB10\fP.
|
68
|
-
.TP
|
69
103
|
.B \fB\-d\fP, \fB\-\-disable\-editing\fP
|
70
104
|
Indicates that $EDITOR will not be opened; data will be accepted as\-is.
|
71
105
|
.TP
|
72
106
|
.B \fB\-\-defaults\fP
|
73
107
|
Indicates that Knife will use the default value, instead of asking a user to provide one.
|
74
108
|
.TP
|
75
|
-
.B \fB\-\-[no\-]diff\fP
|
76
|
-
Use to show a diff when a file changes. Default: \fB\-\-diff\fP.
|
77
|
-
.TP
|
78
|
-
.B \fB\-\-dry\-run\fP
|
79
|
-
Use to prevent changes from being uploaded to the server. Default: \fBfalse\fP.
|
80
|
-
.TP
|
81
109
|
.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP
|
82
110
|
The $EDITOR that is used for all interactive commands.
|
83
111
|
.TP
|
@@ -85,52 +113,28 @@ The $EDITOR that is used for all interactive commands.
|
|
85
113
|
The name of the environment. When this option is added to a command, the command will run only against the named environment.
|
86
114
|
.TP
|
87
115
|
.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
|
88
|
-
The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP
|
89
|
-
.TP
|
90
|
-
.B \fB\-\-[no\-]force\fP
|
91
|
-
Use to force the upload of files even if they haven\(aqt been changed. Default: \fB\-\-no\-force\fP.
|
116
|
+
The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&.
|
92
117
|
.TP
|
93
118
|
.B \fB\-h\fP, \fB\-\-help\fP
|
94
119
|
Shows help for the command.
|
95
120
|
.TP
|
96
|
-
.B \fB\-I REPLACE_STRING\fP, \fB\-\-replace REPLACE_STRING\fP
|
97
|
-
Use to define a string that will be used to replace all occurrences of a file name. Default: \fBnil\fP.
|
98
|
-
.TP
|
99
|
-
.B \fB\-J REPLACE_STRING\fP, \fB\-\-replace\-first REPLACE_STRING\fP
|
100
|
-
Use to define a string that will be used to replace the first occurrence of a file name. Default: \fBnil\fP.
|
101
|
-
.TP
|
102
121
|
.B \fB\-k KEY\fP, \fB\-\-key KEY\fP
|
103
|
-
The private key that Knife will use to sign requests made by the API client to the server
|
122
|
+
The private key that Knife will use to sign requests made by the API client to the Chef server\&.
|
104
123
|
.TP
|
105
|
-
.B \fB\-\-
|
106
|
-
Indicates
|
107
|
-
.TP
|
108
|
-
.B \fB\-n MAX_ARGS\fP, \fB\-\-max\-args MAX_ARGS\fP
|
109
|
-
The maximum number of arguments per command line. Default: \fBnil\fP.
|
110
|
-
.TP
|
111
|
-
.B \fB\-p [PATTERN...]\fP, \fB\-\-pattern [PATTERN...]\fP
|
112
|
-
One (or more) patterns for a command line. If this option is not specified, a list of patterns may be expected on standard input. Default: \fBnil\fP.
|
124
|
+
.B \fB\-\-[no\-]color\fP
|
125
|
+
Indicates whether colored output will be used.
|
113
126
|
.TP
|
114
127
|
.B \fB\-\-print\-after\fP
|
115
128
|
Indicates that data will be shown after a destructive operation.
|
116
129
|
.TP
|
117
|
-
.B \fB\-\-repo\-mode MODE\fP
|
118
|
-
The layout of the local chef\-repo. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default value: \fBdefault\fP.
|
119
|
-
.TP
|
120
|
-
.B \fB\-s LENGTH\fP, \fB\-\-max\-chars LENGTH\fP
|
121
|
-
The maximum size (in characters) for a command line. Default: \fBnil\fP.
|
122
|
-
.TP
|
123
130
|
.B \fB\-\-server\-url URL\fP
|
124
|
-
The URL for the server
|
125
|
-
.TP
|
126
|
-
.B \fB\-t\fP
|
127
|
-
Indicates that the print command will be run on the command line. Default: \fBnil\fP.
|
131
|
+
The URL for the Chef server\&.
|
128
132
|
.TP
|
129
133
|
.B \fB\-u USER\fP, \fB\-\-user USER\fP
|
130
|
-
The user name used by Knife to sign requests made by the API client to the server
|
134
|
+
The user name used by Knife to sign requests made by the API client to the Chef server\&. Authentication will fail if the user name does not match the private key.
|
131
135
|
.TP
|
132
136
|
.B \fB\-v\fP, \fB\-\-version\fP
|
133
|
-
The version of the chef\-client
|
137
|
+
The version of the chef\-client\&.
|
134
138
|
.TP
|
135
139
|
.B \fB\-V\fP, \fB\-\-verbose\fP
|
136
140
|
Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
|
@@ -139,16 +143,20 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
|
|
139
143
|
Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
|
140
144
|
.TP
|
141
145
|
.B \fB\-z\fP, \fB\-\-local\-mode\fP
|
142
|
-
Indicates that the chef\-client will be run in local mode, which allows all commands that work against the server to also work against the local chef\-repo
|
146
|
+
Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&.
|
143
147
|
.UNINDENT
|
144
148
|
.sp
|
145
149
|
\fBExamples\fP
|
150
|
+
.INDENT 0.0
|
151
|
+
.INDENT 3.5
|
146
152
|
.sp
|
147
153
|
.nf
|
148
154
|
.ft C
|
149
155
|
$ knife deps nodes/*.json | xargs knife upload
|
150
156
|
.ft P
|
151
157
|
.fi
|
158
|
+
.UNINDENT
|
159
|
+
.UNINDENT
|
152
160
|
.SH AUTHOR
|
153
161
|
Chef
|
154
162
|
.\" Generated by docutils manpage writer.
|
@@ -1,4 +1,6 @@
|
|
1
|
-
|
1
|
+
.\" Man page generated from reStructuredText.
|
2
|
+
.
|
3
|
+
.TH "CHEF-CLIENT" "8" "Chef 11.12.0" "" "chef-client"
|
2
4
|
.SH NAME
|
3
5
|
chef-client \- The man page for the chef-client command line tool.
|
4
6
|
.
|
@@ -28,13 +30,11 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
28
30
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
29
31
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
30
32
|
..
|
31
|
-
.\" Man page generated from reStructuredText.
|
32
|
-
.
|
33
33
|
.sp
|
34
|
-
A chef\-client is an agent that runs locally on every node that is registered with the server
|
34
|
+
A chef\-client is an agent that runs locally on every node that is registered with the Chef server\&. When a chef\-client is run, it will perform all of the steps that are required to bring the node into the expected state, including:
|
35
35
|
.INDENT 0.0
|
36
36
|
.IP \(bu 2
|
37
|
-
Registering and authenticating the node with the server
|
37
|
+
Registering and authenticating the node with the Chef server
|
38
38
|
.IP \(bu 2
|
39
39
|
Building the node object
|
40
40
|
.IP \(bu 2
|
@@ -47,35 +47,63 @@ Taking the appropriate and required actions to configure the node
|
|
47
47
|
Looking for exceptions and notifications, handling each as required
|
48
48
|
.UNINDENT
|
49
49
|
.sp
|
50
|
-
|
51
|
-
.
|
52
|
-
|
53
|
-
.
|
50
|
+
\fBNOTE:\fP
|
51
|
+
.INDENT 0.0
|
52
|
+
.INDENT 3.5
|
53
|
+
The chef\-client executable can be run as a daemon.
|
54
|
+
.UNINDENT
|
55
|
+
.UNINDENT
|
56
|
+
.sp
|
57
|
+
The chef\-client executable is run as a command\-line tool.
|
58
|
+
.sp
|
59
|
+
\fBNOTE:\fP
|
60
|
+
.INDENT 0.0
|
61
|
+
.INDENT 3.5
|
62
|
+
A client.rb file is used to specify the configuration details for the chef\-client\&.
|
63
|
+
.INDENT 0.0
|
64
|
+
.IP \(bu 2
|
65
|
+
This file is loaded every time this executable is run
|
66
|
+
.IP \(bu 2
|
67
|
+
On UNIX\- and Linux\-based machines, the default location for this file is \fB/etc/chef/client.rb\fP; on Microsoft Windows machines, the default location for this file is \fBC:\echef\eclient.rb\fP; use the \fB\-\-config\fP option from the command line to change this location
|
68
|
+
.IP \(bu 2
|
69
|
+
This file is not created by default
|
70
|
+
.IP \(bu 2
|
71
|
+
When a client.rb file is present in this directory, the settings contained within that file will override the default configuration settings
|
72
|
+
.UNINDENT
|
73
|
+
.UNINDENT
|
74
|
+
.UNINDENT
|
54
75
|
.SH OPTIONS
|
55
76
|
.sp
|
56
77
|
This command has the following syntax:
|
78
|
+
.INDENT 0.0
|
79
|
+
.INDENT 3.5
|
57
80
|
.sp
|
58
81
|
.nf
|
59
82
|
.ft C
|
60
83
|
chef\-client OPTION VALUE OPTION VALUE ...
|
61
84
|
.ft P
|
62
85
|
.fi
|
86
|
+
.UNINDENT
|
87
|
+
.UNINDENT
|
63
88
|
.sp
|
64
89
|
This command has the following options:
|
65
90
|
.INDENT 0.0
|
66
91
|
.TP
|
67
92
|
.B \fB\-A\fP, \fB\-\-fatal\-windows\-admin\-check\fP
|
68
|
-
|
93
|
+
Use to cause a chef\-client run to fail when the chef\-client does not have administrator privileges in Microsoft Windows\&.
|
94
|
+
.TP
|
95
|
+
.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP
|
96
|
+
The configuration file to use.
|
69
97
|
.TP
|
70
98
|
.B \fB\-\-chef\-zero\-port PORT\fP
|
71
99
|
The port on which chef\-zero will listen.
|
72
100
|
.TP
|
73
101
|
.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
|
74
|
-
The output format: \fBdoc\fP (default) or \fBmin\fP
|
102
|
+
The output format: \fBdoc\fP (default) or \fBmin\fP\&.
|
75
103
|
.sp
|
76
104
|
Use \fBdoc\fP to print the progress of the chef\-client run using full strings that display a summary of updates as they occur.
|
77
105
|
.sp
|
78
|
-
Use \fBmin\fP to print the progress of the chef\-client run using single characters. A summary of updates is printed at the end of the chef\-client run. A dot (\fB
|
106
|
+
Use \fBmin\fP to print the progress of the chef\-client run using single characters. A summary of updates is printed at the end of the chef\-client run. A dot (\fB\&.\fP) is printed for events that do not have meaningful status information, such as loading a file or synchronizing a cookbook. For resources, a dot (\fB\&.\fP) is printed when the resource is up to date, an \fBS\fP is printed when the resource is skipped by \fBnot_if\fP or \fBonly_if\fP, and a \fBU\fP is printed when the resource is updated.
|
79
107
|
.sp
|
80
108
|
Other formatting options are available when those formatters are configured in the client.rb file using the \fBadd_formatter\fP option.
|
81
109
|
.TP
|
@@ -92,25 +120,25 @@ The name of the group that owns a process. This is required when starting any ex
|
|
92
120
|
Shows help for the command.
|
93
121
|
.TP
|
94
122
|
.B \fB\-i SECONDS\fP, \fB\-\-interval SECONDS\fP
|
95
|
-
The frequency (in seconds) at which the chef\-client runs. Default value: \fB1800\fP
|
123
|
+
The frequency (in seconds) at which the chef\-client runs. Default value: \fB1800\fP\&.
|
96
124
|
.TP
|
97
125
|
.B \fB\-j PATH\fP, \fB\-\-json\-attributes PATH\fP
|
98
126
|
The path to a file that contains JSON data.
|
99
127
|
.TP
|
100
128
|
.B \fB\-k KEY_FILE\fP, \fB\-\-client_key KEY_FILE\fP
|
101
|
-
The location of the file which contains the client key. Default value: \fB/etc/chef/client.pem\fP
|
129
|
+
The location of the file which contains the client key. Default value: \fB/etc/chef/client.pem\fP\&.
|
102
130
|
.TP
|
103
131
|
.B \fB\-K KEY_FILE\fP, \fB\-\-validation_key KEY_FILE\fP
|
104
|
-
The location of the file which contains the key used when a chef\-client is registered with a server
|
132
|
+
The location of the file which contains the key used when a chef\-client is registered with a Chef server\&. A validation key is signed using the \fBvalidation_client_name\fP for authentication. Default value: \fB/etc/chef/validation.pem\fP\&.
|
105
133
|
.TP
|
106
134
|
.B \fB\-l LEVEL\fP, \fB\-\-log_level LEVEL\fP
|
107
135
|
The level of logging that will be stored in a log file.
|
108
136
|
.TP
|
109
137
|
.B \fB\-L LOGLOCATION\fP, \fB\-\-logfile c\fP
|
110
|
-
The location in which log file output files will be saved. If this location is set to something other than \fBSTDOUT\fP, standard output logging will still be performed (otherwise there would be no output other than to a file). This is recommended when starting any executable as a daemon. Default value: \fBSTDOUT\fP
|
138
|
+
The location in which log file output files will be saved. If this location is set to something other than \fBSTDOUT\fP, standard output logging will still be performed (otherwise there would be no output other than to a file). This is recommended when starting any executable as a daemon. Default value: \fBSTDOUT\fP\&.
|
111
139
|
.TP
|
112
140
|
.B \fB\-\-[no\-]color\fP
|
113
|
-
Indicates whether colored output will be used. Default setting: \fB\-\-color\fP
|
141
|
+
Indicates whether colored output will be used. Default setting: \fB\-\-color\fP\&.
|
114
142
|
.TP
|
115
143
|
.B \fB\-N NODE_NAME\fP, \fB\-\-node\-name NODE_NAME\fP
|
116
144
|
The name of the node.
|
@@ -122,31 +150,31 @@ Replace the current run list with the specified items.
|
|
122
150
|
Indicates that the chef\-client is run once and that interval and splay options are cancelled.
|
123
151
|
.TP
|
124
152
|
.B \fB\-P PID_FILE\fP, \fB\-\-pid PID_FILE\fP
|
125
|
-
The location in which a process identification number (pid) is saved. An executable, when started as a daemon, will write the pid to the specified file. Default value: \fB/tmp/name\-of\-executable.pid\fP
|
153
|
+
The location in which a process identification number (pid) is saved. An executable, when started as a daemon, will write the pid to the specified file. Default value: \fB/tmp/name\-of\-executable.pid\fP\&.
|
126
154
|
.TP
|
127
155
|
.B \fB\-R\fP, \fB\-\-enable\-reporting\fP
|
128
|
-
|
156
|
+
Use to enable data collection reporting during a chef\-client run.
|
129
157
|
.TP
|
130
158
|
.B \fBRECIPE_FILE\fP
|
131
|
-
The path to a recipe. For example, if a recipe file is in the current directory, use \fBrecipe_file.rb\fP
|
159
|
+
The path to a recipe. For example, if a recipe file is in the current directory, use \fBrecipe_file.rb\fP\&. This is typically used with the \fB\-\-local\-mode\fP option.
|
132
160
|
.TP
|
133
161
|
.B \fB\-s SECONDS\fP, \fB\-\-splay SECONDS\fP
|
134
162
|
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.
|
135
163
|
.TP
|
136
164
|
.B \fB\-S CHEF_SERVER_URL\fP, \fB\-\-server CHEF_SERVER_URL\fP
|
137
|
-
The URL for the server
|
165
|
+
The URL for the Chef server\&.
|
138
166
|
.TP
|
139
167
|
.B \fB\-u USER\fP, \fB\-\-user USER\fP
|
140
168
|
The user that owns a process. This is required when starting any executable as a daemon.
|
141
169
|
.TP
|
142
170
|
.B \fB\-v\fP, \fB\-\-version\fP
|
143
|
-
The version of the chef\-client
|
171
|
+
The version of the chef\-client\&.
|
144
172
|
.TP
|
145
173
|
.B \fB\-W\fP, \fB\-\-why\-run\fP
|
146
174
|
Indicates that the executable will be run in why\-run mode, which is a type of chef\-client run that does everything except modify the system. Use why\-run mode to understand why the chef\-client makes the decisions that it makes and to learn more about the current and proposed state of the system.
|
147
175
|
.TP
|
148
176
|
.B \fB\-z\fP, \fB\-\-local\-mode\fP
|
149
|
-
Indicates that the chef\-client will be run in local mode, which allows all commands that work against the server to also work against the local chef\-repo
|
177
|
+
Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&.
|
150
178
|
.UNINDENT
|
151
179
|
.SH RUN WITH ELEVATED PRIVILEGES
|
152
180
|
.sp
|
@@ -154,6 +182,8 @@ The chef\-client may need to be run with elevated privileges in order to get a r
|
|
154
182
|
.SS Linux
|
155
183
|
.sp
|
156
184
|
On Linux, the following error sometimes occurs when the permissions used to run the chef\-client are incorrect:
|
185
|
+
.INDENT 0.0
|
186
|
+
.INDENT 3.5
|
157
187
|
.sp
|
158
188
|
.nf
|
159
189
|
.ft C
|
@@ -162,15 +192,19 @@ $ chef\-client
|
|
162
192
|
[Tue, 29 Nov 2011 19:46:18 \-0800] WARN: Failed to read the private key /etc/chef/client.pem: #<Errno::EACCES: Permission denied \- /etc/chef/client.pem>
|
163
193
|
.ft P
|
164
194
|
.fi
|
195
|
+
.UNINDENT
|
196
|
+
.UNINDENT
|
165
197
|
.sp
|
166
198
|
This can be resolved by running the command as root. There are a few ways this can be done:
|
167
199
|
.INDENT 0.0
|
168
200
|
.IP \(bu 2
|
169
201
|
Log in as root and then run the chef\-client
|
170
202
|
.IP \(bu 2
|
171
|
-
Use \fBsu\fP to become the root user, and then run the chef\-client
|
203
|
+
Use \fBsu\fP to become the root user, and then run the chef\-client\&. For example:
|
172
204
|
.INDENT 2.0
|
173
205
|
.INDENT 3.5
|
206
|
+
.INDENT 0.0
|
207
|
+
.INDENT 3.5
|
174
208
|
.sp
|
175
209
|
.nf
|
176
210
|
.ft C
|
@@ -179,7 +213,6 @@ $ su
|
|
179
213
|
.fi
|
180
214
|
.UNINDENT
|
181
215
|
.UNINDENT
|
182
|
-
.UNINDENT
|
183
216
|
.sp
|
184
217
|
and then:
|
185
218
|
.INDENT 0.0
|
@@ -192,11 +225,14 @@ $ chef\-client
|
|
192
225
|
.fi
|
193
226
|
.UNINDENT
|
194
227
|
.UNINDENT
|
195
|
-
.
|
228
|
+
.UNINDENT
|
229
|
+
.UNINDENT
|
196
230
|
.IP \(bu 2
|
197
231
|
Use the sudo utility
|
198
232
|
.INDENT 2.0
|
199
233
|
.INDENT 3.5
|
234
|
+
.INDENT 0.0
|
235
|
+
.INDENT 3.5
|
200
236
|
.sp
|
201
237
|
.nf
|
202
238
|
.ft C
|
@@ -205,8 +241,10 @@ $ sudo chef\-client
|
|
205
241
|
.fi
|
206
242
|
.UNINDENT
|
207
243
|
.UNINDENT
|
244
|
+
.UNINDENT
|
245
|
+
.UNINDENT
|
208
246
|
.IP \(bu 2
|
209
|
-
Give a user access to read \fB/etc/chef\fP and also the files accessed by the chef\-client
|
247
|
+
Give a user access to read \fB/etc/chef\fP and also the files accessed by the chef\-client\&. This requires super user privileges and, as such, is not a recommended approach
|
210
248
|
.UNINDENT
|
211
249
|
.SS Windows
|
212
250
|
.sp
|
@@ -218,40 +256,54 @@ Log in to the administrator account. (This is not the same as an account in the
|
|
218
256
|
Run the chef\-client process from the administrator account while being logged into another account. Run the following command:
|
219
257
|
.INDENT 2.0
|
220
258
|
.INDENT 3.5
|
259
|
+
.INDENT 0.0
|
260
|
+
.INDENT 3.5
|
221
261
|
.sp
|
222
262
|
.nf
|
223
263
|
.ft C
|
224
264
|
$ runas /user:Administrator "cmd /C chef\-client"
|
225
265
|
.ft P
|
226
266
|
.fi
|
267
|
+
.UNINDENT
|
268
|
+
.UNINDENT
|
227
269
|
.sp
|
228
270
|
This will prompt for the administrator account password.
|
229
271
|
.UNINDENT
|
230
272
|
.UNINDENT
|
231
273
|
.IP \(bu 2
|
232
|
-
Open a command prompt by right\-clicking on the command prompt application, and then selecting \fBRun as administrator\fP
|
274
|
+
Open a command prompt by right\-clicking on the command prompt application, and then selecting \fBRun as administrator\fP\&. After the command window opens, the chef\-client can be run as the administrator
|
233
275
|
.UNINDENT
|
234
276
|
.SH EXAMPLES
|
235
277
|
.sp
|
236
278
|
\fBStart a Chef run when the chef\-client is running as a daemon\fP
|
237
279
|
.sp
|
238
|
-
A chef\-client that is running as a daemon can be woken up and started by sending the process a \fBSIGUSR1\fP
|
280
|
+
A chef\-client that is running as a daemon can be woken up and started by sending the process a \fBSIGUSR1\fP\&. For example, to trigger a chef\-client run on a machine running Linux:
|
281
|
+
.INDENT 0.0
|
282
|
+
.INDENT 3.5
|
239
283
|
.sp
|
240
284
|
.nf
|
241
285
|
.ft C
|
242
286
|
$ sudo killall \-USR1 chef\-client
|
243
287
|
.ft P
|
244
288
|
.fi
|
289
|
+
.UNINDENT
|
290
|
+
.UNINDENT
|
245
291
|
.sp
|
246
292
|
\fBStart a Chef run manually\fP
|
293
|
+
.INDENT 0.0
|
294
|
+
.INDENT 3.5
|
247
295
|
.sp
|
248
296
|
.nf
|
249
297
|
.ft C
|
250
298
|
$ ps auxw|grep chef\-client
|
251
299
|
.ft P
|
252
300
|
.fi
|
301
|
+
.UNINDENT
|
302
|
+
.UNINDENT
|
253
303
|
.sp
|
254
304
|
to return something like:
|
305
|
+
.INDENT 0.0
|
306
|
+
.INDENT 3.5
|
255
307
|
.sp
|
256
308
|
.nf
|
257
309
|
.ft C
|
@@ -259,14 +311,20 @@ root 66066 0.9 0.0 2488880 264 s001 S+ 10:26AM 0:03.05
|
|
259
311
|
/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby /usr/bin/chef\-client \-i 3600 \-s 20
|
260
312
|
.ft P
|
261
313
|
.fi
|
314
|
+
.UNINDENT
|
315
|
+
.UNINDENT
|
262
316
|
.sp
|
263
317
|
and then enter:
|
318
|
+
.INDENT 0.0
|
319
|
+
.INDENT 3.5
|
264
320
|
.sp
|
265
321
|
.nf
|
266
322
|
.ft C
|
267
323
|
$ sudo kill \-USR1 66066
|
268
324
|
.ft P
|
269
325
|
.fi
|
326
|
+
.UNINDENT
|
327
|
+
.UNINDENT
|
270
328
|
.SH AUTHOR
|
271
329
|
Chef
|
272
330
|
.\" Generated by docutils manpage writer.
|