chef 13.11.3-universal-mingw32 → 13.12.3-universal-mingw32

Sign up to get free protection for your applications and to get access to all the features.
Files changed (260) 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 -247
  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/tasks/cbgb.rb +0 -84
@@ -1,770 +0,0 @@
1
- .\" Man page generated from reStructuredText.
2
- .
3
- .TH "KNIFE-COOKBOOK" "1" "Chef 12.0" "" "knife cookbook"
4
- .SH NAME
5
- knife-cookbook \- The man page for the knife cookbook 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
- A cookbook is the fundamental unit of configuration and policy distribution. Each cookbook defines a scenario, such as everything needed to install and configure MySQL, and then it contains all of the components that are required to support that scenario, including:
35
- .INDENT 0.0
36
- .IP \(bu 2
37
- Attribute values that are set on nodes
38
- .IP \(bu 2
39
- Definitions that allow the creation of reusable collections of resources
40
- .IP \(bu 2
41
- File distributions
42
- .IP \(bu 2
43
- Libraries that extend the chef\-client and/or provide helpers to Ruby code
44
- .IP \(bu 2
45
- Recipes that specify which resources to manage and the order in which those resources will be applied
46
- .IP \(bu 2
47
- Custom resources and providers
48
- .IP \(bu 2
49
- Templates
50
- .IP \(bu 2
51
- Versions
52
- .IP \(bu 2
53
- Metadata about recipes (including dependencies), version constraints, supported platforms, and so on
54
- .UNINDENT
55
- .sp
56
- The \fBknife cookbook\fP subcommand is used to interact with cookbooks that are located on the Chef server or the local chef\-repo\&.
57
- .SH COMMON OPTIONS
58
- .sp
59
- The following options may be used with any of the arguments available to the \fBknife cookbook\fP subcommand:
60
- .INDENT 0.0
61
- .TP
62
- .B \fB\-\-chef\-zero\-port PORT\fP
63
- The port on which chef\-zero will listen.
64
- .TP
65
- .B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP
66
- The configuration file to use.
67
- .TP
68
- .B \fB\-d\fP, \fB\-\-disable\-editing\fP
69
- Use to prevent the $EDITOR from being opened and to accept data as\-is.
70
- .TP
71
- .B \fB\-\-defaults\fP
72
- Use to have knife use the default value instead of asking a user to provide one.
73
- .TP
74
- .B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP
75
- The $EDITOR that is used for all interactive commands.
76
- .TP
77
- .B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP
78
- The name of the environment. When this option is added to a command, the command will run only against the named environment.
79
- .TP
80
- .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
81
- The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&.
82
- .TP
83
- .B \fB\-h\fP, \fB\-\-help\fP
84
- Shows help for the command.
85
- .TP
86
- .B \fB\-k KEY\fP, \fB\-\-key KEY\fP
87
- The private key that knife will use to sign requests made by the API client to the Chef server\&.
88
- .TP
89
- .B \fB\-\-[no\-]color\fP
90
- Use to view colored output.
91
- .TP
92
- .B \fB\-\-print\-after\fP
93
- Use to show data after a destructive operation.
94
- .TP
95
- .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
96
- The URL for the Chef server\&.
97
- .TP
98
- .B \fB\-u USER\fP, \fB\-\-user USER\fP
99
- 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.
100
- .TP
101
- .B \fB\-V\fP, \fB\-\-verbose\fP
102
- Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
103
- .TP
104
- .B \fB\-v\fP, \fB\-\-version\fP
105
- The version of the chef\-client\&.
106
- .TP
107
- .B \fB\-y\fP, \fB\-\-yes\fP
108
- Use to respond to all confirmation prompts with "Yes". knife will not ask for confirmation.
109
- .TP
110
- .B \fB\-z\fP, \fB\-\-local\-mode\fP
111
- 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\&.
112
- .UNINDENT
113
- .SH BULK DELETE
114
- .sp
115
- The \fBbulk delete\fP argument is used to delete cookbook files that match a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (/).
116
- .sp
117
- \fBSyntax\fP
118
- .sp
119
- This argument has the following syntax:
120
- .INDENT 0.0
121
- .INDENT 3.5
122
- .sp
123
- .nf
124
- .ft C
125
- $ knife cookbook bulk delete REGEX (options)
126
- .ft P
127
- .fi
128
- .UNINDENT
129
- .UNINDENT
130
- .sp
131
- \fBOptions\fP
132
- .sp
133
- This argument has the following options:
134
- .INDENT 0.0
135
- .TP
136
- .B \fB\-p\fP, \fB\-\-purge\fP
137
- Use to entirely remove a cookbook (or cookbook version) from the Chef server\&. This action should be used carefully because only one copy of any single file is stored on the Chef server\&. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged.
138
- .UNINDENT
139
- .sp
140
- \fBExamples\fP
141
- .sp
142
- Use a regular expression to define the pattern used to bulk delete cookbooks:
143
- .INDENT 0.0
144
- .INDENT 3.5
145
- .sp
146
- .nf
147
- .ft C
148
- $ knife cookbook bulk delete "^[0\-9]{3}$" \-p
149
- .ft P
150
- .fi
151
- .UNINDENT
152
- .UNINDENT
153
- .SH CREATE
154
- .sp
155
- The \fBcreate\fP argument is used to create a new cookbook directory on the local machine, including the following directories and files:
156
- .INDENT 0.0
157
- .INDENT 3.5
158
- .INDENT 0.0
159
- .IP \(bu 2
160
- cookbook/attributes
161
- .IP \(bu 2
162
- cookbook/CHANGELOG.md
163
- .IP \(bu 2
164
- cookbook/definitions
165
- .IP \(bu 2
166
- cookbook/files/default
167
- .IP \(bu 2
168
- cookbook/libraries
169
- .IP \(bu 2
170
- cookbook/metadata.rb
171
- .IP \(bu 2
172
- cookbook/providers
173
- .IP \(bu 2
174
- cookbook/README.md (or .rdoc)
175
- .IP \(bu 2
176
- cookbook/recipes/default.rb
177
- .IP \(bu 2
178
- cookbook/resources
179
- .IP \(bu 2
180
- cookbook/templates/default
181
- .UNINDENT
182
- .UNINDENT
183
- .UNINDENT
184
- .sp
185
- After the cookbook is created, it can be uploaded to the Chef server using the \fBknife upload\fP argument.
186
- .sp
187
- \fBSyntax\fP
188
- .sp
189
- This argument has the following syntax:
190
- .INDENT 0.0
191
- .INDENT 3.5
192
- .sp
193
- .nf
194
- .ft C
195
- $ knife cookbook create COOKBOOK_NAME (options)
196
- .ft P
197
- .fi
198
- .UNINDENT
199
- .UNINDENT
200
- .sp
201
- \fBOptions\fP
202
- .sp
203
- This argument has the following options:
204
- .INDENT 0.0
205
- .TP
206
- .B \fB\-C COPYRIGHT_HOLDER\fP, \fB\-\-copyright COPYRIGHT_HOLDER\fP
207
- The name of the copyright holder. This option will place a copyright notice that contains the name of the copyright holder in each of the pre\-created files. If this option is not specified, a copyright name of "your_company_name" will be used instead; it can be easily modified later.
208
- .TP
209
- .B \fB\-I LICENSE\fP, \fB\-\-license LICENSE\fP
210
- The type of license under which a cookbook is distributed: \fBapachev2\fP, \fBgplv2\fP, \fBgplv3\fP, \fBmit\fP, or \fBnone\fP (default). This option will place the appropriate license notice in the pre\-created files: \fBApache v2.0\fP (for \fBapachev2\fP), \fBGPL v2\fP (for \fBgplv2\fP), \fBGPL v3\fP (for \fBgplv3\fP), \fBMIT\fP (for \fBmit\fP), or \fBlicense \(aqProprietary \- All Rights Reserved\fP (for \fBnone\fP). Be aware of the licenses for files inside of a cookbook and be sure to follow any restrictions they describe.
211
- .TP
212
- .B \fB\-m EMAIL\fP, \fB\-\-email EMAIL\fP
213
- The email address for the individual who maintains the cookbook. This option will place an email address in each of the pre\-created files. If this option is not specified, an email name of "your_email" will be used instead; it can be easily modified later.
214
- .TP
215
- .B \fB\-o PATH\fP, \fB\-\-cookbook\-path PATH\fP
216
- The directory in which cookbooks are created. This can be a colon\-separated path.
217
- .TP
218
- .B \fB\-r FORMAT\fP, \fB\-\-readme\-format FORMAT\fP
219
- The document format of the readme file: \fBmd\fP (markdown) and \fBrdoc\fP (Ruby docs).
220
- .UNINDENT
221
- .sp
222
- \fBExamples\fP
223
- .sp
224
- To create a cookbook named "my_cookbook" with copyright, email, license, and readme format options specified, enter:
225
- .INDENT 0.0
226
- .INDENT 3.5
227
- .sp
228
- .nf
229
- .ft C
230
- $ knife cookbook create my_cookbook \-C "My Name" \-m "my@email.com" \-I apachev2 \-r md
231
- .ft P
232
- .fi
233
- .UNINDENT
234
- .UNINDENT
235
- .sp
236
- to return something like:
237
- .INDENT 0.0
238
- .INDENT 3.5
239
- .sp
240
- .nf
241
- .ft C
242
- ** Creating cookbook my_cookbook
243
- ** Creating README for cookbook: my_cookbook
244
- ** Creating metadata for cookbook: my_cookbook
245
- .ft P
246
- .fi
247
- .UNINDENT
248
- .UNINDENT
249
- .SH DELETE
250
- .sp
251
- The \fBdelete\fP argument is used to delete a specified cookbook or cookbook version on the Chef server (and not locally).
252
- .sp
253
- \fBSyntax\fP
254
- .sp
255
- This argument has the following syntax:
256
- .INDENT 0.0
257
- .INDENT 3.5
258
- .sp
259
- .nf
260
- .ft C
261
- $ knife cookbook delete COOKBOOK_NAME [COOKBOOK_VERSION] (options)
262
- .ft P
263
- .fi
264
- .UNINDENT
265
- .UNINDENT
266
- .sp
267
- \fBOptions\fP
268
- .sp
269
- This argument has the following options:
270
- .INDENT 0.0
271
- .TP
272
- .B \fB\-a\fP, \fB\-\-all\fP
273
- Use to delete all cookbooks (and cookbook versions).
274
- .TP
275
- .B \fBCOOKBOOK_VERSION\fP
276
- The version of a cookbook to be deleted. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, knife will prompt for a version.
277
- .TP
278
- .B \fB\-p\fP, \fB\-\-purge\fP
279
- Use to entirely remove a cookbook (or cookbook version) from the Chef server\&. This action should be used carefully because only one copy of any single file is stored on the Chef server\&. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged.
280
- .UNINDENT
281
- .sp
282
- \fBExamples\fP
283
- .INDENT 0.0
284
- .INDENT 3.5
285
- .sp
286
- .nf
287
- .ft C
288
- $ knife cookbook delete cookbook_name version
289
- .ft P
290
- .fi
291
- .UNINDENT
292
- .UNINDENT
293
- .sp
294
- For example:
295
- .INDENT 0.0
296
- .INDENT 3.5
297
- .sp
298
- .nf
299
- .ft C
300
- $ knife cookbook delete smartmon 0.8
301
- .ft P
302
- .fi
303
- .UNINDENT
304
- .UNINDENT
305
- .sp
306
- Type \fBY\fP to confirm a deletion.
307
- .SH DOWNLOAD
308
- .sp
309
- The \fBdownload\fP argument is used to download a cookbook from the Chef server to the current working directory.
310
- .sp
311
- \fBSyntax\fP
312
- .sp
313
- This argument has the following syntax:
314
- .INDENT 0.0
315
- .INDENT 3.5
316
- .sp
317
- .nf
318
- .ft C
319
- $ knife cookbook download COOKBOOK_NAME [COOKBOOK_VERSION] (options)
320
- .ft P
321
- .fi
322
- .UNINDENT
323
- .UNINDENT
324
- .sp
325
- \fBOptions\fP
326
- .sp
327
- This argument has the following options:
328
- .INDENT 0.0
329
- .TP
330
- .B \fB\-d DOWNLOAD_DIRECTORY\fP, \fB\-\-dir DOWNLOAD_DIRECTORY\fP
331
- The directory in which cookbooks are located.
332
- .TP
333
- .B \fB\-f\fP, \fB\-\-force\fP
334
- Use to overwrite an existing directory.
335
- .TP
336
- .B \fB\-N\fP, \fB\-\-latest\fP
337
- Use to download the most recent version of a cookbook.
338
- .UNINDENT
339
- .sp
340
- \fBExamples\fP
341
- .sp
342
- To download a cookbook named "smartmon", enter:
343
- .INDENT 0.0
344
- .INDENT 3.5
345
- .sp
346
- .nf
347
- .ft C
348
- $ knife cookbook download smartmon
349
- .ft P
350
- .fi
351
- .UNINDENT
352
- .UNINDENT
353
- .SH LIST
354
- .sp
355
- The \fBlist\fP argument is used to view a list of cookbooks that are currently available on the Chef server\&. The list will contain only the most recent version for each cookbook by default.
356
- .sp
357
- \fBSyntax\fP
358
- .sp
359
- This argument has the following syntax:
360
- .INDENT 0.0
361
- .INDENT 3.5
362
- .sp
363
- .nf
364
- .ft C
365
- $ knife cookbook list (options)
366
- .ft P
367
- .fi
368
- .UNINDENT
369
- .UNINDENT
370
- .sp
371
- \fBOptions\fP
372
- .sp
373
- This argument has the following options:
374
- .INDENT 0.0
375
- .TP
376
- .B \fB\-a\fP, \fB\-\-all\fP
377
- Use to return all available versions for every cookbook.
378
- .TP
379
- .B \fB\-w\fP, \fB\-\-with\-uri\fP
380
- Use to show the corresponding URIs.
381
- .UNINDENT
382
- .sp
383
- \fBExamples\fP
384
- .sp
385
- To view a list of cookbooks:
386
- .INDENT 0.0
387
- .INDENT 3.5
388
- .sp
389
- .nf
390
- .ft C
391
- $ knife cookbook list
392
- .ft P
393
- .fi
394
- .UNINDENT
395
- .UNINDENT
396
- .SH METADATA
397
- .sp
398
- The \fBmetadata\fP argument is used to generate the metadata for one or more cookbooks.
399
- .sp
400
- \fBSyntax\fP
401
- .sp
402
- This argument has the following syntax:
403
- .INDENT 0.0
404
- .INDENT 3.5
405
- .sp
406
- .nf
407
- .ft C
408
- $ knife cookbook metadata (options)
409
- .ft P
410
- .fi
411
- .UNINDENT
412
- .UNINDENT
413
- .sp
414
- \fBOptions\fP
415
- .sp
416
- This argument has the following options:
417
- .INDENT 0.0
418
- .TP
419
- .B \fB\-a\fP, \fB\-\-all\fP
420
- Use to generate metadata for all cookbooks.
421
- .TP
422
- .B \fB\-o PATH:PATH\fP, \fB\-\-cookbook\-path PATH:PATH\fP
423
- The directory in which cookbooks are created. This can be a colon\-separated path.
424
- .UNINDENT
425
- .sp
426
- \fBExamples\fP
427
- .INDENT 0.0
428
- .INDENT 3.5
429
- .sp
430
- .nf
431
- .ft C
432
- $ knife cookbook metadata \-a
433
- .ft P
434
- .fi
435
- .UNINDENT
436
- .UNINDENT
437
- .SH METADATA FROM FILE
438
- .sp
439
- The \fBmetadata from file\fP argument is used to load the metadata for a cookbook from a file.
440
- .sp
441
- \fBSyntax\fP
442
- .sp
443
- This argument has the following syntax:
444
- .INDENT 0.0
445
- .INDENT 3.5
446
- .sp
447
- .nf
448
- .ft C
449
- $ knife cookbook metadata from file FILE
450
- .ft P
451
- .fi
452
- .UNINDENT
453
- .UNINDENT
454
- .sp
455
- \fBOptions\fP
456
- .sp
457
- This command does not have any specific options.
458
- .sp
459
- \fBExamples\fP
460
- .INDENT 0.0
461
- .INDENT 3.5
462
- .sp
463
- .nf
464
- .ft C
465
- $ knife cookbook metadata from file /path/to/file
466
- .ft P
467
- .fi
468
- .UNINDENT
469
- .UNINDENT
470
- .SH SHOW
471
- .sp
472
- The \fBshow\fP argument is used to view information about a cookbook, parts of a cookbook (attributes, definitions, files, libraries, providers, recipes, resources, and templates), or a file that is associated with a cookbook (including attributes such as checksum or specificity).
473
- .sp
474
- \fBSyntax\fP
475
- .sp
476
- This argument has the following syntax:
477
- .INDENT 0.0
478
- .INDENT 3.5
479
- .sp
480
- .nf
481
- .ft C
482
- $ knife cookbook show COOKBOOK_NAME [COOKBOOK_VERSION] [PART...] [FILE_NAME] (options)
483
- .ft P
484
- .fi
485
- .UNINDENT
486
- .UNINDENT
487
- .sp
488
- \fBOptions\fP
489
- .sp
490
- This argument has the following options:
491
- .INDENT 0.0
492
- .TP
493
- .B \fBCOOKBOOK_VERSION\fP
494
- The version of a cookbook to be shown. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, a list of cookbook versions will be returned.
495
- .TP
496
- .B \fB\-f FQDN\fP, \fB\-\-fqdn FQDN\fP
497
- The FQDN of the host.
498
- .TP
499
- .B \fBFILE_NAME\fP
500
- The name of a file that is associated with a cookbook.
501
- .TP
502
- .B \fB\-p PLATFORM\fP, \fB\-\-platform PLATFORM\fP
503
- The platform for which a cookbook is designed.
504
- .TP
505
- .B \fBPART\fP
506
- The part of the cookbook to show: \fBattributes\fP, \fBdefinitions\fP, \fBfiles\fP, \fBlibraries\fP, \fBproviders\fP, \fBrecipes\fP, \fBresources\fP, or \fBtemplates\fP\&. More than one part can be specified.
507
- .TP
508
- .B \fB\-V PLATFORM_VERSION\fP, \fB\-\-platform\-version PLATFORM_VERSION\fP
509
- The version of the platform.
510
- .TP
511
- .B \fB\-w\fP, \fB\-\-with\-uri\fP
512
- Use to show the corresponding URIs.
513
- .UNINDENT
514
- .sp
515
- \fBExamples\fP
516
- .sp
517
- To get the list of available versions of a cookbook named "getting\-started", enter:
518
- .INDENT 0.0
519
- .INDENT 3.5
520
- .sp
521
- .nf
522
- .ft C
523
- $ knife cookbook show getting\-started
524
- .ft P
525
- .fi
526
- .UNINDENT
527
- .UNINDENT
528
- .sp
529
- to return something like:
530
- .INDENT 0.0
531
- .INDENT 3.5
532
- .sp
533
- .nf
534
- .ft C
535
- getting\-started 0.3.0 0.2.0
536
- .ft P
537
- .fi
538
- .UNINDENT
539
- .UNINDENT
540
- .sp
541
- To show a list of data about a cookbook using the name of the cookbook and the version, enter:
542
- .INDENT 0.0
543
- .INDENT 3.5
544
- .sp
545
- .nf
546
- .ft C
547
- $ knife cookbook show getting\-started 0.3.0
548
- .ft P
549
- .fi
550
- .UNINDENT
551
- .UNINDENT
552
- .sp
553
- to return something like:
554
- .INDENT 0.0
555
- .INDENT 3.5
556
- .sp
557
- .nf
558
- .ft C
559
- attributes:
560
- checksum: fa0fc4abf3f6787aeb5c3c5c35de667c
561
- name: default.rb
562
- path: attributes/default.rb
563
- specificity: default
564
- url: https://somelongurlhere.com
565
- chef_type: cookbook_version
566
- cookbook_name: getting\-started
567
- definitions: []
568
- files: []
569
- frozen?: false
570
- json_class: Chef::CookbookVersion
571
- libraries: []
572
- .ft P
573
- .fi
574
- .UNINDENT
575
- .UNINDENT
576
- .sp
577
- To only view data about "templates", enter:
578
- .INDENT 0.0
579
- .INDENT 3.5
580
- .sp
581
- .nf
582
- .ft C
583
- $ knife cookbook show getting\-started 0.3.0 templates
584
- .ft P
585
- .fi
586
- .UNINDENT
587
- .UNINDENT
588
- .sp
589
- to return something like:
590
- .INDENT 0.0
591
- .INDENT 3.5
592
- .sp
593
- .nf
594
- .ft C
595
- checksum: a29d6f254577b830091f140c3a78b1fe
596
- name: chef\-getting\-started.txt.erb
597
- path: templates/default/chef\-getting\-started.txt.erb
598
- specificity: default
599
- url: https://someurlhere.com
600
- .ft P
601
- .fi
602
- .UNINDENT
603
- .UNINDENT
604
- .sp
605
- To view information in JSON format, use the \fB\-F\fP common option as part of the command like this:
606
- .INDENT 0.0
607
- .INDENT 3.5
608
- .sp
609
- .nf
610
- .ft C
611
- $ knife role show devops \-F json
612
- .ft P
613
- .fi
614
- .UNINDENT
615
- .UNINDENT
616
- .sp
617
- Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&.
618
- .SH TEST
619
- .sp
620
- The \fBtest\fP argument is used to test a cookbook for syntax errors. This argument uses Ruby syntax checking to verify every file in a cookbook that ends in .rb and Embedded Ruby (ERB)\&. This argument will respect \&.chefignore files when determining which cookbooks to test for syntax errors.
621
- .sp
622
- \fBSyntax\fP
623
- .sp
624
- This argument has the following syntax:
625
- .INDENT 0.0
626
- .INDENT 3.5
627
- .sp
628
- .nf
629
- .ft C
630
- $ knife cookbook test COOKBOOK_NAME (options)
631
- .ft P
632
- .fi
633
- .UNINDENT
634
- .UNINDENT
635
- .sp
636
- \fBOptions\fP
637
- .sp
638
- This argument has the following options:
639
- .INDENT 0.0
640
- .TP
641
- .B \fB\-a\fP, \fB\-\-all\fP
642
- Use to test all cookbooks.
643
- .TP
644
- .B \fB\-o PATH:PATH\fP, \fB\-\-cookbook\-path PATH:PATH\fP
645
- The directory in which cookbooks are created. This can be a colon\-separated path.
646
- .UNINDENT
647
- .sp
648
- \fBExamples\fP
649
- .INDENT 0.0
650
- .INDENT 3.5
651
- .sp
652
- .nf
653
- .ft C
654
- $ knife cookbook test cookbook_name
655
- .ft P
656
- .fi
657
- .UNINDENT
658
- .UNINDENT
659
- .SH UPLOAD
660
- .sp
661
- The \fBupload\fP argument is used to upload one or more cookbooks (and any files that are associated with those cookbooks) from a local repository to the Chef server\&. Only files that do not already exist on the Chef server will be uploaded.
662
- .sp
663
- \fBNOTE:\fP
664
- .INDENT 0.0
665
- .INDENT 3.5
666
- Use a \&.chefignore file to prevent the upload of specific files and file types, such as temporary files or files placed in folders by version control systems. The \&.chefignore file must be located in the root of the cookbook repository and must use rules similar to filename globbing (as defined by the Ruby \fBFile.fnmatch\fP syntax).
667
- .UNINDENT
668
- .UNINDENT
669
- .sp
670
- \fBNOTE:\fP
671
- .INDENT 0.0
672
- .INDENT 3.5
673
- Empty directories are not uploaded to the Chef server\&. To upload an empty directory, create a "dot" file\-\-\-e.g. \fB\&.keep\fP\-\-\-in that directory to ensure that the directory itself is not empty.
674
- .UNINDENT
675
- .UNINDENT
676
- .sp
677
- \fBSyntax\fP
678
- .sp
679
- This argument has the following syntax:
680
- .INDENT 0.0
681
- .INDENT 3.5
682
- .sp
683
- .nf
684
- .ft C
685
- $ knife cookbook upload [COOKBOOK_NAME...] (options)
686
- .ft P
687
- .fi
688
- .UNINDENT
689
- .UNINDENT
690
- .sp
691
- \fBOptions\fP
692
- .sp
693
- This argument has the following options:
694
- .INDENT 0.0
695
- .TP
696
- .B \fB\-a\fP, \fB\-\-all\fP
697
- Use to upload all cookbooks.
698
- .TP
699
- .B \fB\-\-concurrency\fP
700
- The number of allowed concurrent connections. Default: \fB10\fP\&.
701
- .TP
702
- .B \fB\-d\fP, \fB\-\-include\-dependencies\fP
703
- Use to ensure that when a cookbook has a dependency on one (or more) cookbooks, those cookbooks will also be uploaded.
704
- .TP
705
- .B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP
706
- Use to set the environment version dependency to the cookbook version being uploaded.
707
- .TP
708
- .B \fB\-\-force\fP
709
- Use to update a cookbook even if the \fB\-\-freeze\fP flag has been set.
710
- .TP
711
- .B \fB\-\-freeze\fP
712
- Use to require changes to a cookbook be included as a new version. Only the \fB\-\-force\fP option can override this setting.
713
- .TP
714
- .B \fB\-o PATH:PATH\fP, \fB\-\-cookbook\-path PATH:PATH\fP
715
- The directory in which cookbooks are created. This can be a colon\-separated path.
716
- .UNINDENT
717
- .sp
718
- \fBExamples\fP
719
- .INDENT 0.0
720
- .INDENT 3.5
721
- .sp
722
- .nf
723
- .ft C
724
- $ knife cookbook upload cookbook_name
725
- .ft P
726
- .fi
727
- .UNINDENT
728
- .UNINDENT
729
- .sp
730
- To upload a cookbook, and then prevent other users from being able to make changes to it, enter:
731
- .INDENT 0.0
732
- .INDENT 3.5
733
- .sp
734
- .nf
735
- .ft C
736
- $ knife cookbook upload redis \-\-freeze
737
- .ft P
738
- .fi
739
- .UNINDENT
740
- .UNINDENT
741
- .sp
742
- to return something like:
743
- .INDENT 0.0
744
- .INDENT 3.5
745
- .sp
746
- .nf
747
- .ft C
748
- Uploading redis...
749
- Upload completed
750
- .ft P
751
- .fi
752
- .UNINDENT
753
- .UNINDENT
754
- .sp
755
- If a cookbook is frozen and the \fB\-\-force\fP option is not specified, knife will return an error message similar to the following:
756
- .INDENT 0.0
757
- .INDENT 3.5
758
- .sp
759
- .nf
760
- .ft C
761
- Uploading redis...
762
- ERROR: Version 0.1.6 of cookbook redis is frozen. Use \-\-force to override.
763
- .ft P
764
- .fi
765
- .UNINDENT
766
- .UNINDENT
767
- .SH AUTHOR
768
- Chef
769
- .\" Generated by docutils manpage writer.
770
- .