chef 13.11.3 → 13.12.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (261) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +4 -3
  3. data/README.md +35 -40
  4. data/Rakefile +18 -22
  5. data/chef-universal-mingw32.gemspec +1 -1
  6. data/chef.gemspec +3 -3
  7. data/lib/chef/client.rb +1 -1
  8. data/lib/chef/mixin/params_validate.rb +3 -1
  9. data/lib/chef/provider/script.rb +2 -2
  10. data/lib/chef/version.rb +1 -1
  11. data/spec/functional/http/simple_spec.rb +12 -6
  12. data/spec/functional/resource/remote_file_spec.rb +19 -15
  13. data/spec/support/platform_helpers.rb +2 -1
  14. data/tasks/announce.rb +1 -1
  15. data/tasks/dependencies.rb +5 -39
  16. data/tasks/maintainers.rb +10 -10
  17. data/tasks/rspec.rb +2 -2
  18. data/tasks/templates/prerelease.md.erb +11 -2
  19. data/tasks/templates/release.md.erb +9 -1
  20. metadata +6 -248
  21. data/CONTRIBUTING.md +0 -151
  22. data/VERSION +0 -1
  23. data/acceptance/.gitignore +0 -3
  24. data/acceptance/.shared/kitchen_acceptance/.kitchen.digitalocean.yml +0 -33
  25. data/acceptance/.shared/kitchen_acceptance/.kitchen.ec2.yml +0 -283
  26. data/acceptance/.shared/kitchen_acceptance/.kitchen.vagrant.yml +0 -59
  27. data/acceptance/.shared/kitchen_acceptance/libraries/kitchen.rb +0 -68
  28. data/acceptance/.shared/kitchen_acceptance/metadata.rb +0 -1
  29. data/acceptance/Gemfile +0 -19
  30. data/acceptance/Gemfile.lock +0 -266
  31. data/acceptance/README.md +0 -137
  32. data/acceptance/basics/.acceptance/acceptance-cookbook/.gitignore +0 -2
  33. data/acceptance/basics/.acceptance/acceptance-cookbook/metadata.rb +0 -3
  34. data/acceptance/basics/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
  35. data/acceptance/basics/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
  36. data/acceptance/basics/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
  37. data/acceptance/basics/.kitchen.yml +0 -4
  38. data/acceptance/basics/test/integration/chef-current-install/serverspec/chef_client_spec.rb +0 -19
  39. data/acceptance/basics/test/integration/chef-current-install/serverspec/spec_helper.rb +0 -6
  40. data/acceptance/basics/test/integration/helpers/serverspec/Gemfile +0 -8
  41. data/acceptance/data-collector/.acceptance/acceptance-cookbook/.gitignore +0 -2
  42. data/acceptance/data-collector/.acceptance/acceptance-cookbook/metadata.rb +0 -3
  43. data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -2
  44. data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -2
  45. data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -2
  46. data/acceptance/data-collector/.acceptance/data-collector-test/.gitignore +0 -16
  47. data/acceptance/data-collector/.acceptance/data-collector-test/Berksfile +0 -3
  48. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/api.rb +0 -101
  49. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/apigemfile +0 -3
  50. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-both-mode.rb +0 -4
  51. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-client-mode.rb +0 -4
  52. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-no-endpoint.rb +0 -2
  53. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-solo-mode.rb +0 -4
  54. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/config.ru +0 -2
  55. data/acceptance/data-collector/.acceptance/data-collector-test/metadata.rb +0 -7
  56. data/acceptance/data-collector/.acceptance/data-collector-test/recipes/default.rb +0 -44
  57. data/acceptance/data-collector/.kitchen.yml +0 -9
  58. data/acceptance/data-collector/Berksfile +0 -3
  59. data/acceptance/data-collector/test/integration/default/serverspec/default_spec.rb +0 -208
  60. data/acceptance/data-collector/test/integration/helpers/serverspec/Gemfile +0 -8
  61. data/acceptance/omnitruck/.acceptance/acceptance-cookbook/.gitignore +0 -2
  62. data/acceptance/omnitruck/.acceptance/acceptance-cookbook/metadata.rb +0 -1
  63. data/acceptance/omnitruck/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
  64. data/acceptance/omnitruck/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
  65. data/acceptance/omnitruck/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -61
  66. data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/.gitignore +0 -2
  67. data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/libraries/cookbook_kitchen.rb +0 -43
  68. data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/libraries/top_cookbooks.rb +0 -41
  69. data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/metadata.rb +0 -3
  70. data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
  71. data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
  72. data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
  73. data/acceptance/top-cookbooks/.gitignore +0 -1
  74. data/acceptance/top-cookbooks/.kitchen.chocolatey.yml +0 -6
  75. data/acceptance/top-cookbooks/.kitchen.iis.yml +0 -4
  76. data/acceptance/top-cookbooks/.kitchen.learn-the-basics-rhel.yml +0 -7
  77. data/acceptance/top-cookbooks/.kitchen.learn-the-basics-ubuntu.yml +0 -7
  78. data/acceptance/top-cookbooks/.kitchen.learn-the-basics-windows.yml +0 -7
  79. data/acceptance/top-cookbooks/.kitchen.powershell.yml +0 -4
  80. data/acceptance/top-cookbooks/.kitchen.sql_server.yml +0 -5
  81. data/acceptance/top-cookbooks/.kitchen.winbox.yml +0 -8
  82. data/acceptance/top-cookbooks/.kitchen.windows.yml +0 -38
  83. data/acceptance/trivial/.acceptance/acceptance-cookbook/.gitignore +0 -2
  84. data/acceptance/trivial/.acceptance/acceptance-cookbook/metadata.rb +0 -2
  85. data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
  86. data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
  87. data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
  88. data/acceptance/trivial/.kitchen.yml +0 -7
  89. data/acceptance/trivial/test/integration/chef-current-install/inspec/chef_client_spec.rb +0 -5
  90. data/acceptance/windows-service/.acceptance/acceptance-cookbook/.gitignore +0 -2
  91. data/acceptance/windows-service/.acceptance/acceptance-cookbook/metadata.rb +0 -2
  92. data/acceptance/windows-service/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
  93. data/acceptance/windows-service/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
  94. data/acceptance/windows-service/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
  95. data/acceptance/windows-service/.kitchen.yml +0 -7
  96. data/acceptance/windows-service/test/integration/chef-windows-service/inspec/chef_windows_service_spec.rb +0 -58
  97. data/distro/common/html/_sources/ctl_chef_client.txt +0 -36
  98. data/distro/common/html/_sources/ctl_chef_server.txt +0 -341
  99. data/distro/common/html/_sources/ctl_chef_shell.txt +0 -15
  100. data/distro/common/html/_sources/ctl_chef_solo.txt +0 -25
  101. data/distro/common/html/_sources/index.txt +0 -135
  102. data/distro/common/html/_sources/knife.txt +0 -74
  103. data/distro/common/html/_sources/knife_bootstrap.txt +0 -56
  104. data/distro/common/html/_sources/knife_client.txt +0 -151
  105. data/distro/common/html/_sources/knife_common_options.txt +0 -6
  106. data/distro/common/html/_sources/knife_configure.txt +0 -29
  107. data/distro/common/html/_sources/knife_cookbook.txt +0 -236
  108. data/distro/common/html/_sources/knife_cookbook_site.txt +0 -157
  109. data/distro/common/html/_sources/knife_data_bag.txt +0 -160
  110. data/distro/common/html/_sources/knife_delete.txt +0 -26
  111. data/distro/common/html/_sources/knife_deps.txt +0 -61
  112. data/distro/common/html/_sources/knife_diff.txt +0 -34
  113. data/distro/common/html/_sources/knife_download.txt +0 -44
  114. data/distro/common/html/_sources/knife_edit.txt +0 -26
  115. data/distro/common/html/_sources/knife_environment.txt +0 -158
  116. data/distro/common/html/_sources/knife_exec.txt +0 -47
  117. data/distro/common/html/_sources/knife_index_rebuild.txt +0 -21
  118. data/distro/common/html/_sources/knife_list.txt +0 -33
  119. data/distro/common/html/_sources/knife_node.txt +0 -250
  120. data/distro/common/html/_sources/knife_raw.txt +0 -35
  121. data/distro/common/html/_sources/knife_recipe_list.txt +0 -23
  122. data/distro/common/html/_sources/knife_role.txt +0 -157
  123. data/distro/common/html/_sources/knife_search.txt +0 -53
  124. data/distro/common/html/_sources/knife_serve.txt +0 -19
  125. data/distro/common/html/_sources/knife_show.txt +0 -27
  126. data/distro/common/html/_sources/knife_ssh.txt +0 -43
  127. data/distro/common/html/_sources/knife_ssl_check.txt +0 -41
  128. data/distro/common/html/_sources/knife_ssl_fetch.txt +0 -41
  129. data/distro/common/html/_sources/knife_status.txt +0 -37
  130. data/distro/common/html/_sources/knife_tag.txt +0 -69
  131. data/distro/common/html/_sources/knife_upload.txt +0 -49
  132. data/distro/common/html/_sources/knife_user.txt +0 -127
  133. data/distro/common/html/_sources/knife_using.txt +0 -43
  134. data/distro/common/html/_sources/knife_xargs.txt +0 -30
  135. data/distro/common/html/_static/ajax-loader.gif +0 -0
  136. data/distro/common/html/_static/basic.css +0 -537
  137. data/distro/common/html/_static/chef.ico +0 -0
  138. data/distro/common/html/_static/chef_html_logo.png +0 -0
  139. data/distro/common/html/_static/comment-bright.png +0 -0
  140. data/distro/common/html/_static/comment-close.png +0 -0
  141. data/distro/common/html/_static/comment.png +0 -0
  142. data/distro/common/html/_static/contents.png +0 -0
  143. data/distro/common/html/_static/doctools.js +0 -238
  144. data/distro/common/html/_static/down-pressed.png +0 -0
  145. data/distro/common/html/_static/down.png +0 -0
  146. data/distro/common/html/_static/file.png +0 -0
  147. data/distro/common/html/_static/guide.css +0 -505
  148. data/distro/common/html/_static/jquery.js +0 -2
  149. data/distro/common/html/_static/minus.png +0 -0
  150. data/distro/common/html/_static/navigation.png +0 -0
  151. data/distro/common/html/_static/plus.png +0 -0
  152. data/distro/common/html/_static/pygments.css +0 -62
  153. data/distro/common/html/_static/searchtools.js +0 -622
  154. data/distro/common/html/_static/underscore.js +0 -31
  155. data/distro/common/html/_static/up-pressed.png +0 -0
  156. data/distro/common/html/_static/up.png +0 -0
  157. data/distro/common/html/_static/websupport.js +0 -808
  158. data/distro/common/html/ctl_chef_client.html +0 -270
  159. data/distro/common/html/ctl_chef_server.html +0 -728
  160. data/distro/common/html/ctl_chef_shell.html +0 -163
  161. data/distro/common/html/ctl_chef_solo.html +0 -194
  162. data/distro/common/html/index.html +0 -202
  163. data/distro/common/html/knife.html +0 -170
  164. data/distro/common/html/knife_bootstrap.html +0 -285
  165. data/distro/common/html/knife_client.html +0 -285
  166. data/distro/common/html/knife_common_options.html +0 -96
  167. data/distro/common/html/knife_configure.html +0 -105
  168. data/distro/common/html/knife_cookbook.html +0 -487
  169. data/distro/common/html/knife_cookbook_site.html +0 -375
  170. data/distro/common/html/knife_data_bag.html +0 -374
  171. data/distro/common/html/knife_delete.html +0 -93
  172. data/distro/common/html/knife_deps.html +0 -143
  173. data/distro/common/html/knife_diff.html +0 -123
  174. data/distro/common/html/knife_download.html +0 -145
  175. data/distro/common/html/knife_edit.html +0 -89
  176. data/distro/common/html/knife_environment.html +0 -322
  177. data/distro/common/html/knife_exec.html +0 -220
  178. data/distro/common/html/knife_index_rebuild.html +0 -83
  179. data/distro/common/html/knife_list.html +0 -114
  180. data/distro/common/html/knife_node.html +0 -458
  181. data/distro/common/html/knife_raw.html +0 -110
  182. data/distro/common/html/knife_recipe_list.html +0 -91
  183. data/distro/common/html/knife_role.html +0 -295
  184. data/distro/common/html/knife_search.html +0 -203
  185. data/distro/common/html/knife_serve.html +0 -79
  186. data/distro/common/html/knife_show.html +0 -104
  187. data/distro/common/html/knife_ssh.html +0 -177
  188. data/distro/common/html/knife_ssl_check.html +0 -151
  189. data/distro/common/html/knife_ssl_fetch.html +0 -151
  190. data/distro/common/html/knife_status.html +0 -144
  191. data/distro/common/html/knife_tag.html +0 -138
  192. data/distro/common/html/knife_upload.html +0 -153
  193. data/distro/common/html/knife_user.html +0 -242
  194. data/distro/common/html/knife_using.html +0 -210
  195. data/distro/common/html/knife_xargs.html +0 -122
  196. data/distro/common/html/objects.inv +0 -0
  197. data/distro/common/html/search.html +0 -82
  198. data/distro/common/html/searchindex.js +0 -1
  199. data/distro/common/man/man1/README.md +0 -58
  200. data/distro/common/man/man1/chef-shell.1 +0 -194
  201. data/distro/common/man/man1/knife-bootstrap.1 +0 -215
  202. data/distro/common/man/man1/knife-client.1 +0 -443
  203. data/distro/common/man/man1/knife-configure.1 +0 -161
  204. data/distro/common/man/man1/knife-cookbook-site.1 +0 -552
  205. data/distro/common/man/man1/knife-cookbook.1 +0 -770
  206. data/distro/common/man/man1/knife-data-bag.1 +0 -617
  207. data/distro/common/man/man1/knife-delete.1 +0 -127
  208. data/distro/common/man/man1/knife-deps.1 +0 -246
  209. data/distro/common/man/man1/knife-diff.1 +0 -226
  210. data/distro/common/man/man1/knife-download.1 +0 -258
  211. data/distro/common/man/man1/knife-edit.1 +0 -121
  212. data/distro/common/man/man1/knife-environment.1 +0 -496
  213. data/distro/common/man/man1/knife-exec.1 +0 -362
  214. data/distro/common/man/man1/knife-index-rebuild.1 +0 -63
  215. data/distro/common/man/man1/knife-list.1 +0 -174
  216. data/distro/common/man/man1/knife-node.1 +0 -716
  217. data/distro/common/man/man1/knife-raw.1 +0 -172
  218. data/distro/common/man/man1/knife-recipe-list.1 +0 -85
  219. data/distro/common/man/man1/knife-role.1 +0 -426
  220. data/distro/common/man/man1/knife-search.1 +0 -359
  221. data/distro/common/man/man1/knife-serve.1 +0 -109
  222. data/distro/common/man/man1/knife-show.1 +0 -160
  223. data/distro/common/man/man1/knife-ssh.1 +0 -284
  224. data/distro/common/man/man1/knife-ssl-check.1 +0 -207
  225. data/distro/common/man/man1/knife-ssl-fetch.1 +0 -207
  226. data/distro/common/man/man1/knife-status.1 +0 -234
  227. data/distro/common/man/man1/knife-tag.1 +0 -189
  228. data/distro/common/man/man1/knife-upload.1 +0 -280
  229. data/distro/common/man/man1/knife-user.1 +0 -356
  230. data/distro/common/man/man1/knife-xargs.1 +0 -189
  231. data/distro/common/man/man1/knife.1 +0 -332
  232. data/distro/common/man/man8/chef-apply.8 +0 -86
  233. data/distro/common/man/man8/chef-client.8 +0 -398
  234. data/distro/common/man/man8/chef-solo.8 +0 -260
  235. data/distro/common/markdown/README +0 -3
  236. data/distro/common/markdown/man1/chef-shell.mkd +0 -195
  237. data/distro/common/markdown/man1/knife-bootstrap.mkd +0 -141
  238. data/distro/common/markdown/man1/knife-client.mkd +0 -103
  239. data/distro/common/markdown/man1/knife-configure.mkd +0 -71
  240. data/distro/common/markdown/man1/knife-cookbook-site.mkd +0 -123
  241. data/distro/common/markdown/man1/knife-cookbook.mkd +0 -263
  242. data/distro/common/markdown/man1/knife-data-bag.mkd +0 -121
  243. data/distro/common/markdown/man1/knife-environment.mkd +0 -151
  244. data/distro/common/markdown/man1/knife-exec.mkd +0 -42
  245. data/distro/common/markdown/man1/knife-index.mkd +0 -30
  246. data/distro/common/markdown/man1/knife-node.mkd +0 -130
  247. data/distro/common/markdown/man1/knife-role.mkd +0 -85
  248. data/distro/common/markdown/man1/knife-search.mkd +0 -180
  249. data/distro/common/markdown/man1/knife-ssh.mkd +0 -69
  250. data/distro/common/markdown/man1/knife-status.mkd +0 -36
  251. data/distro/common/markdown/man1/knife-tag.mkd +0 -39
  252. data/distro/common/markdown/man1/knife.mkd +0 -213
  253. data/distro/common/markdown/man8/chef-client.mkd +0 -75
  254. data/distro/common/markdown/man8/chef-expander.mkd +0 -81
  255. data/distro/common/markdown/man8/chef-expanderctl.mkd +0 -57
  256. data/distro/common/markdown/man8/chef-server-webui.mkd +0 -121
  257. data/distro/common/markdown/man8/chef-server.mkd +0 -120
  258. data/distro/common/markdown/man8/chef-solo.mkd +0 -107
  259. data/distro/common/markdown/man8/chef-solr.mkd +0 -89
  260. data/distro/powershell/chef/chef.psm1 +0 -459
  261. data/tasks/cbgb.rb +0 -84
@@ -1,189 +0,0 @@
1
- .\" Man page generated from reStructuredText.
2
- .
3
- .TH "KNIFE-XARGS" "1" "Chef 12.0" "" "knife xargs"
4
- .SH NAME
5
- knife-xargs \- The man page for the knife xargs subcommand.
6
- .
7
- .nr rst2man-indent-level 0
8
- .
9
- .de1 rstReportMargin
10
- \\$1 \\n[an-margin]
11
- level \\n[rst2man-indent-level]
12
- level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
13
- -
14
- \\n[rst2man-indent0]
15
- \\n[rst2man-indent1]
16
- \\n[rst2man-indent2]
17
- ..
18
- .de1 INDENT
19
- .\" .rstReportMargin pre:
20
- . RS \\$1
21
- . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
22
- . nr rst2man-indent-level +1
23
- .\" .rstReportMargin post:
24
- ..
25
- .de UNINDENT
26
- . RE
27
- .\" indent \\n[an-margin]
28
- .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
29
- .nr rst2man-indent-level -1
30
- .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
31
- .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
32
- ..
33
- .sp
34
- The \fBknife xargs\fP subcommand is used to take patterns from standard input, download as JSON, run a command against the downloaded JSON, and then upload any changes.
35
- .sp
36
- \fBSyntax\fP
37
- .sp
38
- This subcommand has the following syntax:
39
- .INDENT 0.0
40
- .INDENT 3.5
41
- .sp
42
- .nf
43
- .ft C
44
- $ knife xargs [PATTERN...] (options)
45
- .ft P
46
- .fi
47
- .UNINDENT
48
- .UNINDENT
49
- .sp
50
- \fBOptions\fP
51
- .sp
52
- This subcommand has the following options:
53
- .INDENT 0.0
54
- .TP
55
- .B \fB\-0\fP
56
- Use to show a \fBNULL\fP character (\fB\e0\fP) instead of white space as the separator. 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
- Use to build or execute a command line 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
- Use to run the print command on the command line. Default: \fBnil\fP\&.
96
- .TP
97
- .B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP
98
- The configuration file to use.
99
- .TP
100
- .B \fB\-\-chef\-zero\-port PORT\fP
101
- The port on which chef\-zero will listen.
102
- .TP
103
- .B \fB\-d\fP, \fB\-\-disable\-editing\fP
104
- Use to prevent the $EDITOR from being opened and to accept data as\-is.
105
- .TP
106
- .B \fB\-\-defaults\fP
107
- Use to have knife use the default value instead of asking a user to provide one.
108
- .TP
109
- .B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP
110
- The $EDITOR that is used for all interactive commands.
111
- .TP
112
- .B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP
113
- The name of the environment. When this option is added to a command, the command will run only against the named environment.
114
- .TP
115
- .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
116
- The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&.
117
- .TP
118
- .B \fB\-h\fP, \fB\-\-help\fP
119
- Shows help for the command.
120
- .TP
121
- .B \fB\-k KEY\fP, \fB\-\-key KEY\fP
122
- The private key that knife will use to sign requests made by the API client to the Chef server\&.
123
- .TP
124
- .B \fB\-\-[no\-]color\fP
125
- Use to view colored output.
126
- .TP
127
- .B \fB\-\-print\-after\fP
128
- Use to show data after a destructive operation.
129
- .TP
130
- .B \fB\-\-server\-url URL\fP
131
- The URL for the Chef server\&.
132
- .TP
133
- .B \fB\-u USER\fP, \fB\-\-user USER\fP
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.
135
- .TP
136
- .B \fB\-v\fP, \fB\-\-version\fP
137
- The version of the chef\-client\&.
138
- .TP
139
- .B \fB\-V\fP, \fB\-\-verbose\fP
140
- Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
141
- .TP
142
- .B \fB\-y\fP, \fB\-\-yes\fP
143
- Use to respond to all confirmation prompts with "Yes". knife will not ask for confirmation.
144
- .TP
145
- .B \fB\-z\fP, \fB\-\-local\-mode\fP
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
- .UNINDENT
148
- .sp
149
- \fBExamples\fP
150
- .sp
151
- The following examples show various ways of listing all nodes on the server, and then using Perl to replace \fBgrantmc\fP with \fBgmc\fP:
152
- .INDENT 0.0
153
- .INDENT 3.5
154
- .sp
155
- .nf
156
- .ft C
157
- $ knife list \(aqnodes/*\(aq | knife xargs "perl \-i \-pe \(aqs/grantmc/gmc\(aq"
158
- .ft P
159
- .fi
160
- .UNINDENT
161
- .UNINDENT
162
- .sp
163
- or without quotes and the backslash escaped:
164
- .INDENT 0.0
165
- .INDENT 3.5
166
- .sp
167
- .nf
168
- .ft C
169
- $ knife list /nodes/\e* | knife xargs "perl \-i \-pe \(aqs/grantmc/gmc\(aq"
170
- .ft P
171
- .fi
172
- .UNINDENT
173
- .UNINDENT
174
- .sp
175
- or by using the \fB\-\-pattern\fP option:
176
- .INDENT 0.0
177
- .INDENT 3.5
178
- .sp
179
- .nf
180
- .ft C
181
- $ knife xargs \-\-pattern \(aq/nodes.*\(aq "perl \-i \-pe \(aqs/grantmc/gmc\(aq"
182
- .ft P
183
- .fi
184
- .UNINDENT
185
- .UNINDENT
186
- .SH AUTHOR
187
- Chef
188
- .\" Generated by docutils manpage writer.
189
- .
@@ -1,332 +0,0 @@
1
- .\" Man page generated from reStructuredText.
2
- .
3
- .TH "KNIFE" "1" "Chef 12.0" "" "knife"
4
- .SH NAME
5
- knife \- The man page for the knife command line tool.
6
- .
7
- .nr rst2man-indent-level 0
8
- .
9
- .de1 rstReportMargin
10
- \\$1 \\n[an-margin]
11
- level \\n[rst2man-indent-level]
12
- level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
13
- -
14
- \\n[rst2man-indent0]
15
- \\n[rst2man-indent1]
16
- \\n[rst2man-indent2]
17
- ..
18
- .de1 INDENT
19
- .\" .rstReportMargin pre:
20
- . RS \\$1
21
- . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
22
- . nr rst2man-indent-level +1
23
- .\" .rstReportMargin post:
24
- ..
25
- .de UNINDENT
26
- . RE
27
- .\" indent \\n[an-margin]
28
- .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
29
- .nr rst2man-indent-level -1
30
- .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
31
- .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
32
- ..
33
- .sp
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
- .INDENT 0.0
36
- .IP \(bu 2
37
- Nodes
38
- .IP \(bu 2
39
- Cookbooks and recipes
40
- .IP \(bu 2
41
- Roles
42
- .IP \(bu 2
43
- Stores of JSON data (data bags), including encrypted data
44
- .IP \(bu 2
45
- Environments
46
- .IP \(bu 2
47
- Cloud resources, including provisioning
48
- .IP \(bu 2
49
- The installation of the chef\-client on management workstations
50
- .IP \(bu 2
51
- Searching of indexed data on the Chef server
52
- .UNINDENT
53
- .sp
54
- Knife subcommands:
55
- .INDENT 0.0
56
- .IP \(bu 2
57
- knife bootstrap
58
- .IP \(bu 2
59
- knife client
60
- .IP \(bu 2
61
- knife configure
62
- .IP \(bu 2
63
- knife cookbook
64
- .IP \(bu 2
65
- knife cookbook site
66
- .IP \(bu 2
67
- knife data bag
68
- .IP \(bu 2
69
- knife delete
70
- .IP \(bu 2
71
- knife deps
72
- .IP \(bu 2
73
- knife diff
74
- .IP \(bu 2
75
- knife download
76
- .IP \(bu 2
77
- knife edit
78
- .IP \(bu 2
79
- knife environment
80
- .IP \(bu 2
81
- knife exec
82
- .IP \(bu 2
83
- knife list
84
- .IP \(bu 2
85
- knife node
86
- .IP \(bu 2
87
- knife raw
88
- .IP \(bu 2
89
- knife recipe list
90
- .IP \(bu 2
91
- knife role
92
- .IP \(bu 2
93
- knife search
94
- .IP \(bu 2
95
- knife show
96
- .IP \(bu 2
97
- knife ssh
98
- .IP \(bu 2
99
- knife status
100
- .IP \(bu 2
101
- knife tag
102
- .IP \(bu 2
103
- knife upload
104
- .IP \(bu 2
105
- knife user
106
- .IP \(bu 2
107
- knife xargs
108
- .UNINDENT
109
- .SH WORKING WITH KNIFE
110
- .sp
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
168
- .SS JSON Data Format
169
- .sp
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\&.
171
- .SS Set the Text Editor
172
- .sp
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
176
- .sp
177
- .nf
178
- .ft C
179
- $ knife data bag edit admins admin_name
180
- .ft P
181
- .fi
182
- .UNINDENT
183
- .UNINDENT
184
- .sp
185
- will open up the text editor with data similar to:
186
- .INDENT 0.0
187
- .INDENT 3.5
188
- .sp
189
- .nf
190
- .ft C
191
- {
192
- "id": "admin_name"
193
- }
194
- .ft P
195
- .fi
196
- .UNINDENT
197
- .UNINDENT
198
- .sp
199
- Changes to that file can then be made:
200
- .INDENT 0.0
201
- .INDENT 3.5
202
- .sp
203
- .nf
204
- .ft C
205
- {
206
- "id": "Justin C."
207
- "description": "I am passing the time by letting time pass over me ..."
208
- }
209
- .ft P
210
- .fi
211
- .UNINDENT
212
- .UNINDENT
213
- .sp
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
217
- .sp
218
- .nf
219
- .ft C
220
- knife[:editor] = "/usr/bin/vim"
221
- .ft P
222
- .fi
223
- .UNINDENT
224
- .UNINDENT
225
- .sp
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
229
- .sp
230
- .nf
231
- .ft C
232
- C:\e\eProgram Files (x86)\eEditPad Pro\eEditPad.exe
233
- .ft P
234
- .fi
235
- .UNINDENT
236
- .UNINDENT
237
- .sp
238
- the setting in the knife.rb file would be similar to:
239
- .INDENT 0.0
240
- .INDENT 3.5
241
- .sp
242
- .nf
243
- .ft C
244
- knife[:editor] = "C:\e\eProgra~1\e\eEditPa~1\e\eEditPad.exe"
245
- .ft P
246
- .fi
247
- .UNINDENT
248
- .UNINDENT
249
- .sp
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
253
- .sp
254
- .nf
255
- .ft C
256
- knife[:editor] = \(aq"C:\eProgram Files (x86)\eNotepad++\enotepad++.exe \-nosession \-multiInst"\(aq
257
- .ft P
258
- .fi
259
- .UNINDENT
260
- .UNINDENT
261
- .sp
262
- for Sublime Text:
263
- .INDENT 0.0
264
- .INDENT 3.5
265
- .sp
266
- .nf
267
- .ft C
268
- knife[:editor] = \(aq"C:\eProgram Files\eSublime Text 2\esublime_text.exe \-\-wait"\(aq
269
- .ft P
270
- .fi
271
- .UNINDENT
272
- .UNINDENT
273
- .sp
274
- for TextPad:
275
- .INDENT 0.0
276
- .INDENT 3.5
277
- .sp
278
- .nf
279
- .ft C
280
- knife[:editor] = \(aq"C:\eProgram Files (x86)\eTextPad 7\eTextPad.exe"\(aq
281
- .ft P
282
- .fi
283
- .UNINDENT
284
- .UNINDENT
285
- .sp
286
- and for vim:
287
- .INDENT 0.0
288
- .INDENT 3.5
289
- .sp
290
- .nf
291
- .ft C
292
- knife[:editor] = \(aq"C:\eProgram Files (x86)\evim\evim74\egvim.exe"\(aq
293
- .ft P
294
- .fi
295
- .UNINDENT
296
- .UNINDENT
297
- .SS Using Quotes
298
- .sp
299
- Values can be entered with double quotes (" ") or single quotes (\(aq \(aq), but this should be done consistently.
300
- .SS Sub\-commands
301
- .sp
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.
303
- .sp
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
312
- .SS Syntax
313
- .sp
314
- All knife subcommands have the following syntax:
315
- .INDENT 0.0
316
- .INDENT 3.5
317
- knife subcommand [ARGUMENT] (options)
318
- .UNINDENT
319
- .UNINDENT
320
- .sp
321
- Each subcommand has its own set of arguments and options.
322
- .sp
323
- \fBNOTE:\fP
324
- .INDENT 0.0
325
- .INDENT 3.5
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.
327
- .UNINDENT
328
- .UNINDENT
329
- .SH AUTHOR
330
- Chef
331
- .\" Generated by docutils manpage writer.
332
- .