chef 11.14.0.alpha.4-x86-mingw32 → 11.14.0.rc.2-x86-mingw32

Sign up to get free protection for your applications and to get access to all the features.
Files changed (145) hide show
  1. data/CONTRIBUTING.md +0 -4
  2. data/README.md +1 -1
  3. data/distro/common/man/man1/chef-shell.1 +4 -4
  4. data/distro/common/man/man1/knife-bootstrap.1 +14 -11
  5. data/distro/common/man/man1/knife-client.1 +14 -11
  6. data/distro/common/man/man1/knife-configure.1 +7 -7
  7. data/distro/common/man/man1/knife-cookbook-site.1 +23 -23
  8. data/distro/common/man/man1/knife-cookbook.1 +23 -23
  9. data/distro/common/man/man1/knife-data-bag.1 +13 -13
  10. data/distro/common/man/man1/knife-delete.1 +9 -9
  11. data/distro/common/man/man1/knife-deps.1 +9 -9
  12. data/distro/common/man/man1/knife-diff.1 +10 -10
  13. data/distro/common/man/man1/knife-download.1 +9 -9
  14. data/distro/common/man/man1/knife-edit.1 +7 -7
  15. data/distro/common/man/man1/knife-environment.1 +10 -10
  16. data/distro/common/man/man1/knife-exec.1 +7 -7
  17. data/distro/common/man/man1/knife-index-rebuild.1 +1 -1
  18. data/distro/common/man/man1/knife-list.1 +12 -12
  19. data/distro/common/man/man1/knife-node.1 +12 -9
  20. data/distro/common/man/man1/knife-raw.1 +7 -7
  21. data/distro/common/man/man1/knife-recipe-list.1 +1 -1
  22. data/distro/common/man/man1/knife-role.1 +8 -8
  23. data/distro/common/man/man1/knife-search.1 +9 -9
  24. data/distro/common/man/man1/knife-serve.1 +109 -0
  25. data/distro/common/man/man1/knife-show.1 +8 -8
  26. data/distro/common/man/man1/knife-ssh.1 +9 -9
  27. data/distro/common/man/man1/knife-ssl-check.1 +9 -9
  28. data/distro/common/man/man1/knife-ssl-fetch.1 +10 -10
  29. data/distro/common/man/man1/knife-status.1 +9 -9
  30. data/distro/common/man/man1/knife-tag.1 +7 -7
  31. data/distro/common/man/man1/knife-upload.1 +10 -10
  32. data/distro/common/man/man1/knife-user.1 +9 -9
  33. data/distro/common/man/man1/knife-xargs.1 +7 -7
  34. data/distro/common/man/man1/knife.1 +118 -14
  35. data/distro/common/man/man8/chef-client.8 +13 -10
  36. data/distro/common/man/man8/chef-solo.8 +13 -14
  37. data/distro/common/markdown/man1/knife.mkd +1 -1
  38. data/lib/chef/application/knife.rb +1 -1
  39. data/lib/chef/application/windows_service.rb +0 -1
  40. data/lib/chef/chef_fs/file_system.rb +6 -2
  41. data/lib/chef/config.rb +3 -2
  42. data/lib/chef/config_fetcher.rb +1 -1
  43. data/lib/chef/cookbook/metadata.rb +20 -14
  44. data/lib/chef/cookbook/synchronizer.rb +24 -13
  45. data/lib/chef/encrypted_data_bag_item/decryptor.rb +3 -3
  46. data/lib/chef/encrypted_data_bag_item/encryptor.rb +2 -2
  47. data/lib/chef/exceptions.rb +1 -0
  48. data/lib/chef/file_content_management/deploy/mv_windows.rb +1 -1
  49. data/lib/chef/formatters/error_inspectors/resource_failure_inspector.rb +1 -1
  50. data/lib/chef/http.rb +6 -1
  51. data/lib/chef/http/http_request.rb +9 -1
  52. data/lib/chef/http/simple.rb +2 -1
  53. data/lib/chef/json_compat.rb +5 -16
  54. data/lib/chef/knife/bootstrap.rb +2 -0
  55. data/lib/chef/knife/bootstrap/archlinux-gems.erb +2 -2
  56. data/lib/chef/knife/core/object_loader.rb +3 -1
  57. data/lib/chef/knife/ssh.rb +14 -7
  58. data/lib/chef/mixin/convert_to_class_name.rb +1 -0
  59. data/lib/chef/mixin/windows_architecture_helper.rb +24 -4
  60. data/lib/chef/platform/provider_mapping.rb +13 -0
  61. data/lib/chef/provider/env/windows.rb +3 -6
  62. data/lib/chef/provider/git.rb +1 -2
  63. data/lib/chef/provider/log.rb +15 -1
  64. data/lib/chef/provider/package/apt.rb +3 -3
  65. data/lib/chef/provider/package/dpkg.rb +35 -16
  66. data/lib/chef/provider/package/paludis.rb +91 -0
  67. data/lib/chef/provider/package/rpm.rb +3 -2
  68. data/lib/chef/provider/package/yum-dump.py +6 -6
  69. data/lib/chef/provider/package/yum.rb +2 -0
  70. data/lib/chef/provider/registry_key.rb +4 -5
  71. data/lib/chef/provider/remote_file/cache_control_data.rb +1 -1
  72. data/lib/chef/provider/service/solaris.rb +1 -1
  73. data/lib/chef/provider/service/upstart.rb +2 -1
  74. data/lib/chef/provider/service/windows.rb +37 -9
  75. data/lib/chef/provider/user/pw.rb +1 -1
  76. data/lib/chef/provider/user/useradd.rb +1 -1
  77. data/lib/chef/provider/windows_script.rb +2 -1
  78. data/lib/chef/providers.rb +1 -0
  79. data/lib/chef/resource.rb +10 -0
  80. data/lib/chef/resource/file.rb +0 -9
  81. data/lib/chef/resource/package.rb +14 -4
  82. data/lib/chef/resource/paludis_package.rb +33 -0
  83. data/lib/chef/resource/registry_key.rb +62 -3
  84. data/lib/chef/resource/service.rb +21 -4
  85. data/lib/chef/resource_reporter.rb +10 -0
  86. data/lib/chef/resources.rb +1 -0
  87. data/lib/chef/role.rb +14 -10
  88. data/lib/chef/shell.rb +8 -0
  89. data/lib/chef/shell/shell_session.rb +3 -3
  90. data/lib/chef/user.rb +12 -11
  91. data/lib/chef/util/selinux.rb +1 -1
  92. data/lib/chef/version.rb +1 -1
  93. data/lib/chef/version_constraint.rb +6 -5
  94. data/lib/chef/win32/api/process.rb +1 -0
  95. data/lib/chef/win32/api/system.rb +14 -0
  96. data/lib/chef/win32/error.rb +1 -1
  97. data/lib/chef/win32/security.rb +5 -5
  98. data/lib/chef/win32/version.rb +6 -2
  99. data/spec/data/trusted_certs/opscode.pem +57 -35
  100. data/spec/functional/application_spec.rb +2 -2
  101. data/spec/functional/resource/mount_spec.rb +3 -1
  102. data/spec/functional/shell_spec.rb +10 -0
  103. data/spec/functional/tiny_server_spec.rb +2 -2
  104. data/spec/support/chef_helpers.rb +1 -1
  105. data/spec/support/shared/functional/securable_resource.rb +11 -2
  106. data/spec/support/shared/functional/securable_resource_with_reporting.rb +13 -2
  107. data/spec/tiny_server.rb +1 -1
  108. data/spec/unit/config_spec.rb +5 -0
  109. data/spec/unit/cookbook/metadata_spec.rb +24 -0
  110. data/spec/unit/environment_spec.rb +6 -0
  111. data/spec/unit/http/http_request_spec.rb +91 -0
  112. data/spec/unit/http_spec.rb +23 -0
  113. data/spec/unit/knife/bootstrap_spec.rb +2 -2
  114. data/spec/unit/knife/ssh_spec.rb +7 -13
  115. data/spec/unit/knife_spec.rb +1 -1
  116. data/spec/unit/mixin/convert_to_class_name_spec.rb +4 -0
  117. data/spec/unit/provider/git_spec.rb +2 -2
  118. data/spec/unit/provider/log_spec.rb +18 -0
  119. data/spec/unit/provider/mount/solaris_spec.rb +3 -1
  120. data/spec/unit/provider/package/apt_spec.rb +85 -40
  121. data/spec/unit/provider/package/dpkg_spec.rb +24 -48
  122. data/spec/unit/provider/package/paludis_spec.rb +135 -0
  123. data/spec/unit/provider/package/rpm_spec.rb +40 -32
  124. data/spec/unit/provider/package/yum_spec.rb +11 -4
  125. data/spec/unit/provider/registry_key_spec.rb +67 -53
  126. data/spec/unit/provider/remote_file/cache_control_data_spec.rb +10 -1
  127. data/spec/unit/provider/service/solaris_smf_service_spec.rb +23 -2
  128. data/spec/unit/provider/service/upstart_service_spec.rb +7 -0
  129. data/spec/unit/provider/service/windows_spec.rb +72 -0
  130. data/spec/unit/provider/user/pw_spec.rb +21 -4
  131. data/spec/unit/provider/user/useradd_spec.rb +10 -0
  132. data/spec/unit/resource/package_spec.rb +26 -18
  133. data/spec/unit/resource/registry_key_spec.rb +28 -0
  134. data/spec/unit/resource/service_spec.rb +14 -0
  135. data/spec/unit/resource_reporter_spec.rb +37 -12
  136. data/spec/unit/resource_spec.rb +41 -6
  137. data/spec/unit/rest_spec.rb +2 -2
  138. data/spec/unit/role_spec.rb +46 -28
  139. data/spec/unit/shell/shell_session_spec.rb +42 -2
  140. data/spec/unit/shell_spec.rb +1 -1
  141. data/spec/unit/user_spec.rb +12 -0
  142. data/spec/unit/util/selinux_spec.rb +4 -4
  143. data/spec/unit/version_constraint_spec.rb +14 -2
  144. metadata +223 -167
  145. checksums.yaml +0 -7
@@ -1,6 +1,6 @@
1
1
  .\" Man page generated from reStructuredText.
2
2
  .
3
- .TH "KNIFE-XARGS" "1" "Chef 11.12.0" "" "knife xargs"
3
+ .TH "KNIFE-XARGS" "1" "Chef 11.14" "" "knife xargs"
4
4
  .SH NAME
5
5
  knife-xargs \- The man page for the knife xargs subcommand.
6
6
  .
@@ -101,10 +101,10 @@ The configuration file to use.
101
101
  The port on which chef\-zero will listen.
102
102
  .TP
103
103
  .B \fB\-d\fP, \fB\-\-disable\-editing\fP
104
- Indicates that $EDITOR will not be opened; data will be accepted as\-is.
104
+ Use to prevent the $EDITOR from being opened and to accept data as\-is.
105
105
  .TP
106
106
  .B \fB\-\-defaults\fP
107
- Indicates that Knife will use the default value, instead of asking a user to provide one.
107
+ Use to have Knife use the default value instead of asking a user to provide one.
108
108
  .TP
109
109
  .B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP
110
110
  The $EDITOR that is used for all interactive commands.
@@ -122,10 +122,10 @@ Shows help for the command.
122
122
  The private key that Knife will use to sign requests made by the API client to the Chef server\&.
123
123
  .TP
124
124
  .B \fB\-\-[no\-]color\fP
125
- Indicates whether colored output will be used.
125
+ Use to view colored output.
126
126
  .TP
127
127
  .B \fB\-\-print\-after\fP
128
- Indicates that data will be shown after a destructive operation.
128
+ Use to show data after a destructive operation.
129
129
  .TP
130
130
  .B \fB\-\-server\-url URL\fP
131
131
  The URL for the Chef server\&.
@@ -140,10 +140,10 @@ The version of the chef\-client\&.
140
140
  Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
141
141
  .TP
142
142
  .B \fB\-y\fP, \fB\-\-yes\fP
143
- Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation).
143
+ Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation.
144
144
  .TP
145
145
  .B \fB\-z\fP, \fB\-\-local\-mode\fP
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\&.
146
+ Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&.
147
147
  .UNINDENT
148
148
  .sp
149
149
  \fBExamples\fP
@@ -1,4 +1,6 @@
1
- .TH "KNIFE" "1" "Chef 11.8.0" "" "knife"
1
+ .\" Man page generated from reStructuredText.
2
+ .
3
+ .TH "KNIFE" "1" "Chef 11.14" "" "knife"
2
4
  .SH NAME
3
5
  knife \- The man page for the knife command line tool.
4
6
  .
@@ -28,10 +30,8 @@ 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
- Knife is a command\-line tool that provides an interface between a local chef\-repo and the server. Knife helps users to manage:
34
+ Knife is a command\-line tool that provides an interface between a local chef\-repo and the Chef server\&. Knife helps users to manage:
35
35
  .INDENT 0.0
36
36
  .IP \(bu 2
37
37
  Nodes
@@ -48,7 +48,7 @@ Cloud resources, including provisioning
48
48
  .IP \(bu 2
49
49
  The installation of the chef\-client on management workstations
50
50
  .IP \(bu 2
51
- Searching of indexed data on the server
51
+ Searching of indexed data on the Chef server
52
52
  .UNINDENT
53
53
  .sp
54
54
  Knife subcommands:
@@ -108,21 +108,83 @@ knife xargs
108
108
  .UNINDENT
109
109
  .SH WORKING WITH KNIFE
110
110
  .sp
111
- Knife runs from a management workstation and sits in\-between a server and an organization\(aqs infrastructure. Knife interacts with a server by using the same REST API that is used by a chef\-client. Role\-based authentication controls (RBAC) can be used to authorize changes when Knife is run with Hosted Chef or Private Chef. Knife is configured during workstation setup, but subsequent modifications can be made using the knife.rb configuration file.
111
+ Knife runs from a management workstation and sits in\-between a Chef server and an organization\(aqs infrastructure. Knife interacts with a Chef server by using the same REST API that is used by a chef\-client\&. Role\-based authentication controls (RBAC) can be used to authorize changes when Knife is run with Enterprise Chef\&. Knife is configured during workstation setup, but subsequent modifications can be made using the knife.rb configuration file.
112
+ .SS Common Options
113
+ .sp
114
+ The following options can be run with all Knife sub\-commands and plug\-ins:
115
+ .INDENT 0.0
116
+ .TP
117
+ .B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP
118
+ The configuration file to use. For example, when Knife is run from a node that is configured to be managed by the Chef server, this option is used to allow Knife to use the same credentials as the chef\-client when communicating with the Chef server\&.
119
+ .TP
120
+ .B \fB\-\-chef\-zero\-port PORT\fP
121
+ The port on which chef\-zero will listen.
122
+ .TP
123
+ .B \fB\-d\fP, \fB\-\-disable\-editing\fP
124
+ Use to prevent the $EDITOR from being opened and to accept data as\-is.
125
+ .TP
126
+ .B \fB\-\-defaults\fP
127
+ Use to have Knife use the default value instead of asking a user to provide one.
128
+ .TP
129
+ .B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP
130
+ The $EDITOR that is used for all interactive commands.
131
+ .TP
132
+ .B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP
133
+ The name of the environment. When this option is added to a command, the command will run only against the named environment. This option is ignored during search queries made using the \fBknife search\fP subcommand.
134
+ .TP
135
+ .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
136
+ The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&.
137
+ .TP
138
+ .B \fB\-h\fP, \fB\-\-help\fP
139
+ Shows help for the command.
140
+ .TP
141
+ .B \fB\-k KEY\fP, \fB\-\-key KEY\fP
142
+ The private key that Knife will use to sign requests made by the API client to the Chef server\&.
143
+ .TP
144
+ .B \fB\-\-[no\-]color\fP
145
+ Use to view colored output.
146
+ .TP
147
+ .B \fB\-\-print\-after\fP
148
+ Use to show data after a destructive operation.
149
+ .TP
150
+ .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
151
+ The URL for the Chef server\&.
152
+ .TP
153
+ .B \fB\-u USER\fP, \fB\-\-user USER\fP
154
+ 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.
155
+ .TP
156
+ .B \fB\-v\fP, \fB\-\-version\fP
157
+ The version of the chef\-client\&.
158
+ .TP
159
+ .B \fB\-V\fP, \fB\-\-verbose\fP
160
+ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
161
+ .TP
162
+ .B \fB\-y\fP, \fB\-\-yes\fP
163
+ Use to respond to all confirmation prompts with "Yes". Knife will not ask for confirmation.
164
+ .TP
165
+ .B \fB\-z\fP, \fB\-\-local\-mode\fP
166
+ Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&.
167
+ .UNINDENT
112
168
  .SS JSON Data Format
113
169
  .sp
114
- Most data is entered using a text editor in JSON format, unless the \fB\-\-disable\-editing\fP option is entered as part of a command. (Encrypted data bags use YAML, which is a superset of JSON.) JSON is a common, language\-independent data format that provides a simple text representation of arbitrary data structures. For more information about JSON, see \fI\%http://www.json.org/\fP or \fI\%http://en.wikipedia.org/wiki/JSON\fP.
170
+ Most data is entered using a text editor in JSON format, unless the \fB\-\-disable\-editing\fP option is entered as part of a command. (Encrypted data bags use YAML, which is a superset of JSON\&.) JSON is a common, language\-independent data format that provides a simple text representation of arbitrary data structures. For more information about JSON, see \fI\%http://www.json.org/\fP or \fI\%http://en.wikipedia.org/wiki/JSON\fP\&.
115
171
  .SS Set the Text Editor
116
172
  .sp
117
173
  Some Knife commands, such as \fBknife data bag edit\fP, require that information be edited as JSON data using a text editor. For example, the following command:
174
+ .INDENT 0.0
175
+ .INDENT 3.5
118
176
  .sp
119
177
  .nf
120
178
  .ft C
121
179
  $ knife data bag edit admins admin_name
122
180
  .ft P
123
181
  .fi
182
+ .UNINDENT
183
+ .UNINDENT
124
184
  .sp
125
185
  will open up the text editor with data similar to:
186
+ .INDENT 0.0
187
+ .INDENT 3.5
126
188
  .sp
127
189
  .nf
128
190
  .ft C
@@ -131,8 +193,12 @@ will open up the text editor with data similar to:
131
193
  }
132
194
  .ft P
133
195
  .fi
196
+ .UNINDENT
197
+ .UNINDENT
134
198
  .sp
135
199
  Changes to that file can then be made:
200
+ .INDENT 0.0
201
+ .INDENT 3.5
136
202
  .sp
137
203
  .nf
138
204
  .ft C
@@ -142,62 +208,92 @@ Changes to that file can then be made:
142
208
  }
143
209
  .ft P
144
210
  .fi
211
+ .UNINDENT
212
+ .UNINDENT
145
213
  .sp
146
214
  The type of text editor that is used by Knife can be configured by adding an entry to the knife.rb file or by setting an \fBEDITOR\fP environment variable. For example, to configure the text editor to always open with vim, add the following to the knife.rb file:
215
+ .INDENT 0.0
216
+ .INDENT 3.5
147
217
  .sp
148
218
  .nf
149
219
  .ft C
150
220
  knife[:editor] = "/usr/bin/vim"
151
221
  .ft P
152
222
  .fi
223
+ .UNINDENT
224
+ .UNINDENT
153
225
  .sp
154
226
  When a Microsoft Windows file path is enclosed in a double\-quoted string (" "), the same backslash character (\fB\e\fP) that is used to define the file path separator is also used in Ruby to define an escape character. The knife.rb file is a Ruby file; therefore, file path separators must be escaped. In addition, spaces in the file path must be replaced with \fB~1\fP so that the length of each section within the file path is not more than 8 characters. For example, if EditPad Pro is the text editor of choice and is located at the following path:
227
+ .INDENT 0.0
228
+ .INDENT 3.5
155
229
  .sp
156
230
  .nf
157
231
  .ft C
158
232
  C:\e\eProgram Files (x86)\eEditPad Pro\eEditPad.exe
159
233
  .ft P
160
234
  .fi
235
+ .UNINDENT
236
+ .UNINDENT
161
237
  .sp
162
238
  the setting in the knife.rb file would be similar to:
239
+ .INDENT 0.0
240
+ .INDENT 3.5
163
241
  .sp
164
242
  .nf
165
243
  .ft C
166
244
  knife[:editor] = "C:\e\eProgra~1\e\eEditPa~1\e\eEditPad.exe"
167
245
  .ft P
168
246
  .fi
247
+ .UNINDENT
248
+ .UNINDENT
169
249
  .sp
170
250
  One approach to working around the double\- vs. single\-quote issue is to put the single\-quotes outside of the double\-quotes. For example, for Notepad++:
251
+ .INDENT 0.0
252
+ .INDENT 3.5
171
253
  .sp
172
254
  .nf
173
255
  .ft C
174
256
  knife[:editor] = \(aq"C:\eProgram Files (x86)\eNotepad++\enotepad++.exe \-nosession \-multiInst"\(aq
175
257
  .ft P
176
258
  .fi
259
+ .UNINDENT
260
+ .UNINDENT
177
261
  .sp
178
262
  for Sublime Text:
263
+ .INDENT 0.0
264
+ .INDENT 3.5
179
265
  .sp
180
266
  .nf
181
267
  .ft C
182
268
  knife[:editor] = \(aq"C:\eProgram Files\eSublime Text 2\esublime_text.exe \-\-wait"\(aq
183
269
  .ft P
184
270
  .fi
271
+ .UNINDENT
272
+ .UNINDENT
185
273
  .sp
186
274
  for TextPad:
275
+ .INDENT 0.0
276
+ .INDENT 3.5
187
277
  .sp
188
278
  .nf
189
279
  .ft C
190
280
  knife[:editor] = \(aq"C:\eProgram Files (x86)\eTextPad 7\eTextPad.exe"\(aq
191
281
  .ft P
192
282
  .fi
283
+ .UNINDENT
284
+ .UNINDENT
193
285
  .sp
194
286
  and for vim:
287
+ .INDENT 0.0
288
+ .INDENT 3.5
195
289
  .sp
196
290
  .nf
197
291
  .ft C
198
292
  knife[:editor] = \(aq"C:\eProgram Files (x86)\evim\evim74\egvim.exe"\(aq
199
293
  .ft P
200
294
  .fi
295
+ .UNINDENT
296
+ .UNINDENT
201
297
  .SS Using Quotes
202
298
  .sp
203
299
  Values can be entered with double quotes (" ") or single quotes (\(aq \(aq), but this should be done consistently.
@@ -205,10 +301,14 @@ Values can be entered with double quotes (" ") or single quotes (\(aq \(aq), but
205
301
  .sp
206
302
  Knife comes with a collection of built in subcommands that work together to provide all of the functionality required to take specific actions against any object in an organization, including cookbooks, nodes, roles, data bags, environments, and users. A Knife plugin extends the functionality beyond built\-in subcommands.
207
303
  .sp
208
- Knife has the following subcommands: \fBbootstrap\fP, \fBclient\fP, \fBconfigure\fP, \fBcookbook\fP, \fBcookbook site\fP, \fBdata bag\fP, \fBdelete\fP, \fBdeps\fP, \fBdiff\fP, \fBdownload\fP, \fBedit\fP, \fBenvironment\fP, \fBexec\fP, \fBindex rebuild\fP, \fBlist\fP, \fBnode\fP, \fBrecipe list\fP, \fBrole\fP, \fBsearch\fP, \fBshow\fP, \fBssh\fP, \fBstatus\fP, \fBtag\fP, \fBupload\fP, \fBuser\fP, and \fBxargs\fP.
209
- .IP Note
210
- The following subcommands run only against the open source server: \fBindex rebuild\fP and \fBuser\fP.
211
- .RE
304
+ Knife has the following subcommands: \fBbootstrap\fP, \fBclient\fP, \fBconfigure\fP, \fBcookbook\fP, \fBcookbook site\fP, \fBdata bag\fP, \fBdelete\fP, \fBdeps\fP, \fBdiff\fP, \fBdownload\fP, \fBedit\fP, \fBenvironment\fP, \fBexec\fP, \fBindex rebuild\fP, \fBlist\fP, \fBnode\fP, \fBrecipe list\fP, \fBrole\fP, \fBsearch\fP, \fBshow\fP, \fBssh\fP, \fBstatus\fP, \fBtag\fP, \fBupload\fP, \fBuser\fP, and \fBxargs\fP\&.
305
+ .sp
306
+ \fBNOTE:\fP
307
+ .INDENT 0.0
308
+ .INDENT 3.5
309
+ The following subcommands run only against the open source Chef server: \fBindex rebuild\fP and \fBuser\fP\&.
310
+ .UNINDENT
311
+ .UNINDENT
212
312
  .SS Syntax
213
313
  .sp
214
314
  All Knife subcommands have the following syntax:
@@ -219,10 +319,14 @@ knife subcommand [ARGUMENT] (options)
219
319
  .UNINDENT
220
320
  .sp
221
321
  Each subcommand has its own set of arguments and options.
222
- .IP Note
322
+ .sp
323
+ \fBNOTE:\fP
324
+ .INDENT 0.0
325
+ .INDENT 3.5
223
326
  All syntax examples in this document show variables in ALL_CAPS. For example \fB\-u PORT_LIST\fP (where PORT_LIST is a comma\-separated list of local and public UDP ports) or \fB\-F FORMAT\fP (where FORMAT determines the output format, either \fBsummary\fP, \fBtext\fP, \fBjson\fP, \fByaml\fP, or \fBpp\fP). These variables often require specific values that are unique to each organization.
224
- .RE
327
+ .UNINDENT
328
+ .UNINDENT
225
329
  .SH AUTHOR
226
- Opscode
330
+ Chef
227
331
  .\" Generated by docutils manpage writer.
228
332
  .
@@ -1,6 +1,6 @@
1
1
  .\" Man page generated from reStructuredText.
2
2
  .
3
- .TH "CHEF-CLIENT" "8" "Chef 11.12.0" "" "chef-client"
3
+ .TH "CHEF-CLIENT" "8" "Chef 11.14" "" "chef-client"
4
4
  .SH NAME
5
5
  chef-client \- The man page for the chef-client command line tool.
6
6
  .
@@ -92,9 +92,6 @@ This command has the following options:
92
92
  .B \fB\-A\fP, \fB\-\-fatal\-windows\-admin\-check\fP
93
93
  Use to cause a chef\-client run to fail when the chef\-client does not have administrator privileges in Microsoft Windows\&.
94
94
  .TP
95
- .B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP
96
- The configuration file to use.
97
- .TP
98
95
  .B \fB\-\-chef\-zero\-port PORT\fP
99
96
  The port on which chef\-zero will listen.
100
97
  .TP
@@ -108,10 +105,10 @@ Use \fBmin\fP to print the progress of the chef\-client run using single charact
108
105
  Other formatting options are available when those formatters are configured in the client.rb file using the \fBadd_formatter\fP option.
109
106
  .TP
110
107
  .B \fB\-\-force\-formatter\fP
111
- Indicates that formatter output will be used instead of logger output.
108
+ Use to show formatter output instead of logger output.
112
109
  .TP
113
110
  .B \fB\-\-force\-logger\fP
114
- Indicates that logger output will be used instead of formatter output.
111
+ Use to show logger output instead of formatter output.
115
112
  .TP
116
113
  .B \fB\-g GROUP\fP, \fB\-\-group GROUP\fP
117
114
  The name of the group that owns a process. This is required when starting any executable as a daemon.
@@ -138,7 +135,7 @@ The level of logging that will be stored in a log file.
138
135
  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\&.
139
136
  .TP
140
137
  .B \fB\-\-[no\-]color\fP
141
- Indicates whether colored output will be used. Default setting: \fB\-\-color\fP\&.
138
+ Use to view colored output. Default setting: \fB\-\-color\fP\&.
142
139
  .TP
143
140
  .B \fB\-N NODE_NAME\fP, \fB\-\-node\-name NODE_NAME\fP
144
141
  The name of the node.
@@ -147,17 +144,23 @@ The name of the node.
147
144
  Replace the current run list with the specified items.
148
145
  .TP
149
146
  .B \fB\-\-once\fP
150
- Indicates that the chef\-client is run once and that interval and splay options are cancelled.
147
+ Use to run the chef\-client only once and to cancel \fBinterval\fP and \fBsplay\fP options.
151
148
  .TP
152
149
  .B \fB\-P PID_FILE\fP, \fB\-\-pid PID_FILE\fP
153
150
  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\&.
154
151
  .TP
152
+ .B \fB\-r RUN_LIST_ITEM\fP, \fB\-\-runlist RUN_LIST_ITEM\fP
153
+ Use to permanently replace the current run\-list with the specified run\-list items.
154
+ .TP
155
155
  .B \fB\-R\fP, \fB\-\-enable\-reporting\fP
156
156
  Use to enable data collection reporting during a chef\-client run.
157
157
  .TP
158
158
  .B \fBRECIPE_FILE\fP
159
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.
160
160
  .TP
161
+ .B \fB\-\-run\-lock\-timeout SECONDS\fP
162
+ 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.
163
+ .TP
161
164
  .B \fB\-s SECONDS\fP, \fB\-\-splay SECONDS\fP
162
165
  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.
163
166
  .TP
@@ -171,10 +174,10 @@ The user that owns a process. This is required when starting any executable as a
171
174
  The version of the chef\-client\&.
172
175
  .TP
173
176
  .B \fB\-W\fP, \fB\-\-why\-run\fP
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.
177
+ Use to run the executable 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.
175
178
  .TP
176
179
  .B \fB\-z\fP, \fB\-\-local\-mode\fP
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\&.
180
+ Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&.
178
181
  .UNINDENT
179
182
  .SH RUN WITH ELEVATED PRIVILEGES
180
183
  .sp
@@ -1,6 +1,6 @@
1
1
  .\" Man page generated from reStructuredText.
2
2
  .
3
- .TH "CHEF-SOLO" "8" "Chef 11.12.0" "" "chef-solo"
3
+ .TH "CHEF-SOLO" "8" "Chef 11.14" "" "chef-solo"
4
4
  .SH NAME
5
5
  chef-solo \- The man page for the chef-solo command line tool.
6
6
  .
@@ -55,7 +55,8 @@ chef\-solo can be run as a daemon.
55
55
  .UNINDENT
56
56
  .sp
57
57
  The chef\-solo executable is run as a command\-line tool.
58
- .SH OPTIONS
58
+ .sp
59
+ \fBOptions\fP
59
60
  .sp
60
61
  This command has the following syntax:
61
62
  .INDENT 0.0
@@ -76,13 +77,13 @@ This command has the following options:
76
77
  The configuration file to use.
77
78
  .TP
78
79
  .B \fB\-d\fP, \fB\-\-daemonize\fP
79
- Indicates that the executable will be run as a daemon. This option is only available on machines that run in UNIX or Linux environments. For machines that are running Microsoft Windows that require similar functionality, use the \fBchef\-client::service\fP recipe in the \fBchef\-client\fP cookbook: \fI\%http://community.opscode.com/cookbooks/chef\-client\fP\&. This will install a chef\-client service under Microsoft Windows using the Windows Service Wrapper\&.
80
+ Use to run the executable as a daemon. This option is only available on machines that run in UNIX or Linux environments. For machines that are running Microsoft Windows that require similar functionality, use the \fBchef\-client::service\fP recipe in the \fBchef\-client\fP cookbook: \fI\%http://community.opscode.com/cookbooks/chef\-client\fP\&. This will install a chef\-client service under Microsoft Windows using the Windows Service Wrapper\&.
80
81
  .TP
81
82
  .B \fB\-E ENVIRONMENT_NAME\fP, \fB\-\-environment ENVIRONMENT_NAME\fP
82
83
  The name of the environment.
83
84
  .TP
84
85
  .B \fB\-f\fP, \fB\-\-[no\-]fork\fP
85
- Indicates that a chef\-client run will be contained in a secondary process with dedicated RAM. When the chef\-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef\-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use \fB\-\-no\-fork\fP to disable running the chef\-client in fork node. Default value: \fB\-\-fork\fP\&.
86
+ Use to contain the chef\-client run in a secondary process with dedicated RAM. When the chef\-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef\-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use \fB\-\-no\-fork\fP to disable running the chef\-client in fork node. Default value: \fB\-\-fork\fP\&.
86
87
  .TP
87
88
  .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
88
89
  The output format: \fBdoc\fP (default) or \fBmin\fP\&.
@@ -94,10 +95,10 @@ Use \fBmin\fP to print the progress of the chef\-client run using single charact
94
95
  Other formatting options are available when those formatters are configured in the client.rb file using the \fBadd_formatter\fP option.
95
96
  .TP
96
97
  .B \fB\-\-force\-formatter\fP
97
- Indicates that formatter output will be used instead of logger output.
98
+ Use to show formatter output instead of logger output.
98
99
  .TP
99
100
  .B \fB\-\-force\-logger\fP
100
- Indicates that logger output will be used instead of formatter output.
101
+ Use to show logger output instead of formatter output.
101
102
  .TP
102
103
  .B \fB\-g GROUP\fP, \fB\-\-group GROUP\fP
103
104
  The name of the group that owns a process. This is required when starting any executable as a daemon.
@@ -118,7 +119,7 @@ The level of logging that will be stored in a log file.
118
119
  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.
119
120
  .TP
120
121
  .B \fB\-\-[no\-]color\fP
121
- Indicates whether colored output will be used. Default setting: \fB\-\-color\fP\&.
122
+ Use to view colored output. Default setting: \fB\-\-color\fP\&.
122
123
  .TP
123
124
  .B \fB\-N NODE_NAME\fP, \fB\-\-node\-name NODE_NAME\fP
124
125
  The name of the node.
@@ -129,6 +130,9 @@ Replace the current run list with the specified items.
129
130
  .B \fB\-r RECIPE_URL\fP, \fB\-\-recipe\-url RECIPE_URL\fP
130
131
  The URL location from which a remote cookbook tar.gz will be downloaded.
131
132
  .TP
133
+ .B \fB\-\-run\-lock\-timeout SECONDS\fP
134
+ 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.
135
+ .TP
132
136
  .B \fB\-s SECONDS\fP, \fB\-\-splay SECONDS\fP
133
137
  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.
134
138
  .TP
@@ -139,11 +143,10 @@ The user that owns a process. This is required when starting any executable as a
139
143
  The version of the chef\-client\&.
140
144
  .TP
141
145
  .B \fB\-W\fP, \fB\-\-why\-run\fP
142
- 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.
146
+ Use to run the executable 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.
143
147
  .UNINDENT
144
- .SH EXAMPLES
145
148
  .sp
146
- \fBUse a URL\fP
149
+ \fBExamples\fP
147
150
  .INDENT 0.0
148
151
  .INDENT 3.5
149
152
  .sp
@@ -156,8 +159,6 @@ $ chef\-solo \-c ~/solo.rb \-j ~/node.json \-r http://www.example.com/chef\-solo
156
159
  .UNINDENT
157
160
  .sp
158
161
  The tar.gz archived into the \fBfile_cache_path\fP, and then extracted to \fBcookbooks_path\fP\&.
159
- .sp
160
- \fBUse a directory\fP
161
162
  .INDENT 0.0
162
163
  .INDENT 3.5
163
164
  .sp
@@ -170,8 +171,6 @@ $ chef\-solo \-c ~/solo.rb \-j ~/node.json
170
171
  .UNINDENT
171
172
  .sp
172
173
  chef\-solo will look in the solo.rb file to determine the directory in which cookbooks are located.
173
- .sp
174
- \fBUse a URL for cookbook and JSON data\fP
175
174
  .INDENT 0.0
176
175
  .INDENT 3.5
177
176
  .sp