chef 12.10.24 → 12.11.18

Sign up to get free protection for your applications and to get access to all the features.
Files changed (523) hide show
  1. checksums.yaml +4 -4
  2. data/CONTRIBUTING.md +3 -38
  3. data/Gemfile +6 -11
  4. data/LICENSE +201 -201
  5. data/README.md +11 -1
  6. data/VERSION +1 -1
  7. data/acceptance/.bundle/config +2 -0
  8. data/acceptance/Gemfile.lock +27 -26
  9. data/acceptance/basics/.kitchen/logs/chef-current-install-ubuntu-1404.log +2 -0
  10. data/acceptance/basics/.kitchen/logs/kitchen.log +3 -0
  11. data/acceptance/data-collector/.acceptance/acceptance-cookbook/.gitignore +2 -0
  12. data/acceptance/data-collector/.acceptance/acceptance-cookbook/metadata.rb +3 -0
  13. data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/destroy.rb +2 -0
  14. data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/provision.rb +2 -0
  15. data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/verify.rb +2 -0
  16. data/acceptance/data-collector/.acceptance/data-collector-test/.gitignore +16 -0
  17. data/acceptance/data-collector/.acceptance/data-collector-test/Berksfile +3 -0
  18. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/api.rb +85 -0
  19. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/apigemfile +3 -0
  20. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-both-mode.rb +4 -0
  21. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-client-mode.rb +4 -0
  22. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-no-endpoint.rb +2 -0
  23. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-solo-mode.rb +4 -0
  24. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/config.ru +2 -0
  25. data/acceptance/data-collector/.acceptance/data-collector-test/metadata.rb +7 -0
  26. data/acceptance/data-collector/.acceptance/data-collector-test/recipes/default.rb +38 -0
  27. data/acceptance/data-collector/.kitchen.yml +9 -0
  28. data/acceptance/data-collector/Berksfile +3 -0
  29. data/acceptance/data-collector/Berksfile.lock +6 -0
  30. data/acceptance/data-collector/test/integration/default/serverspec/default_spec.rb +251 -0
  31. data/acceptance/fips/.kitchen/logs/fips-integration-centos-6.log +3 -0
  32. data/acceptance/fips/.kitchen/logs/fips-integration-windows-2012r2.log +3 -0
  33. data/acceptance/fips/.kitchen/logs/fips-unit-functional-centos-6.log +3 -0
  34. data/acceptance/fips/.kitchen/logs/fips-unit-functional-windows-2012r2.log +3 -0
  35. data/acceptance/fips/.kitchen/logs/kitchen.log +6 -0
  36. data/acceptance/fips/test/integration/fips-integration/serverspec/fips-integration_spec.rb +2 -1
  37. data/acceptance/top-cookbooks/.kitchen.docker.yml +1 -4
  38. data/acceptance/trivial/.kitchen/logs/chef-current-install-windows-2012r2.log +2 -0
  39. data/acceptance/trivial/.kitchen/logs/kitchen.log +3 -0
  40. data/acceptance/windows-service/.kitchen/logs/chef-windows-service-windows-2012r2.log +2 -0
  41. data/acceptance/windows-service/.kitchen/logs/kitchen.log +3 -0
  42. data/bin/chef-apply +0 -0
  43. data/bin/chef-client +0 -0
  44. data/bin/chef-shell +0 -0
  45. data/bin/chef-solo +0 -0
  46. data/bin/knife +0 -0
  47. data/chef.gemspec +1 -0
  48. data/distro/common/html/_sources/ctl_chef_client.txt +35 -35
  49. data/distro/common/html/_sources/ctl_chef_server.txt +341 -341
  50. data/distro/common/html/_sources/ctl_chef_shell.txt +15 -15
  51. data/distro/common/html/_sources/ctl_chef_solo.txt +25 -25
  52. data/distro/common/html/_sources/index.txt +135 -135
  53. data/distro/common/html/_sources/knife.txt +74 -74
  54. data/distro/common/html/_sources/knife_bootstrap.txt +56 -56
  55. data/distro/common/html/_sources/knife_client.txt +150 -150
  56. data/distro/common/html/_sources/knife_common_options.txt +6 -6
  57. data/distro/common/html/_sources/knife_configure.txt +29 -29
  58. data/distro/common/html/_sources/knife_cookbook.txt +236 -236
  59. data/distro/common/html/_sources/knife_cookbook_site.txt +157 -157
  60. data/distro/common/html/_sources/knife_data_bag.txt +159 -159
  61. data/distro/common/html/_sources/knife_delete.txt +26 -26
  62. data/distro/common/html/_sources/knife_deps.txt +61 -61
  63. data/distro/common/html/_sources/knife_diff.txt +34 -34
  64. data/distro/common/html/_sources/knife_download.txt +44 -44
  65. data/distro/common/html/_sources/knife_edit.txt +26 -26
  66. data/distro/common/html/_sources/knife_environment.txt +158 -158
  67. data/distro/common/html/_sources/knife_exec.txt +47 -47
  68. data/distro/common/html/_sources/knife_index_rebuild.txt +20 -20
  69. data/distro/common/html/_sources/knife_list.txt +33 -33
  70. data/distro/common/html/_sources/knife_node.txt +250 -250
  71. data/distro/common/html/_sources/knife_raw.txt +35 -35
  72. data/distro/common/html/_sources/knife_recipe_list.txt +23 -23
  73. data/distro/common/html/_sources/knife_role.txt +157 -157
  74. data/distro/common/html/_sources/knife_search.txt +53 -53
  75. data/distro/common/html/_sources/knife_serve.txt +18 -18
  76. data/distro/common/html/_sources/knife_show.txt +26 -26
  77. data/distro/common/html/_sources/knife_ssh.txt +43 -43
  78. data/distro/common/html/_sources/knife_ssl_check.txt +41 -41
  79. data/distro/common/html/_sources/knife_ssl_fetch.txt +41 -41
  80. data/distro/common/html/_sources/knife_status.txt +37 -37
  81. data/distro/common/html/_sources/knife_tag.txt +69 -69
  82. data/distro/common/html/_sources/knife_upload.txt +49 -49
  83. data/distro/common/html/_sources/knife_user.txt +127 -127
  84. data/distro/common/html/_sources/knife_using.txt +43 -43
  85. data/distro/common/html/_sources/knife_xargs.txt +30 -30
  86. data/distro/common/html/_static/guide.css +504 -504
  87. data/distro/common/html/_static/pygments.css +61 -61
  88. data/distro/common/html/_static/underscore.js +31 -31
  89. data/distro/common/html/ctl_chef_client.html +269 -269
  90. data/distro/common/html/ctl_chef_server.html +727 -727
  91. data/distro/common/html/ctl_chef_shell.html +162 -162
  92. data/distro/common/html/ctl_chef_solo.html +193 -193
  93. data/distro/common/html/index.html +201 -201
  94. data/distro/common/html/knife.html +169 -169
  95. data/distro/common/html/knife_bootstrap.html +284 -284
  96. data/distro/common/html/knife_client.html +284 -284
  97. data/distro/common/html/knife_common_options.html +95 -95
  98. data/distro/common/html/knife_configure.html +104 -104
  99. data/distro/common/html/knife_cookbook.html +486 -486
  100. data/distro/common/html/knife_data_bag.html +373 -373
  101. data/distro/common/html/knife_delete.html +92 -92
  102. data/distro/common/html/knife_deps.html +142 -142
  103. data/distro/common/html/knife_diff.html +122 -122
  104. data/distro/common/html/knife_download.html +144 -144
  105. data/distro/common/html/knife_edit.html +88 -88
  106. data/distro/common/html/knife_environment.html +325 -325
  107. data/distro/common/html/knife_exec.html +219 -219
  108. data/distro/common/html/knife_index_rebuild.html +82 -82
  109. data/distro/common/html/knife_list.html +113 -113
  110. data/distro/common/html/knife_node.html +457 -457
  111. data/distro/common/html/knife_raw.html +109 -109
  112. data/distro/common/html/knife_recipe_list.html +90 -90
  113. data/distro/common/html/knife_role.html +294 -294
  114. data/distro/common/html/knife_search.html +202 -202
  115. data/distro/common/html/knife_serve.html +78 -78
  116. data/distro/common/html/knife_show.html +103 -103
  117. data/distro/common/html/knife_ssh.html +176 -176
  118. data/distro/common/html/knife_ssl_check.html +150 -150
  119. data/distro/common/html/knife_ssl_fetch.html +150 -150
  120. data/distro/common/html/knife_status.html +143 -143
  121. data/distro/common/html/knife_tag.html +137 -137
  122. data/distro/common/html/knife_upload.html +152 -152
  123. data/distro/common/html/knife_user.html +241 -241
  124. data/distro/common/html/knife_using.html +209 -209
  125. data/distro/common/html/knife_xargs.html +121 -121
  126. data/distro/common/html/search.html +81 -81
  127. data/distro/common/man/man1/README.md +58 -58
  128. data/distro/common/man/man1/chef-shell.1 +194 -194
  129. data/distro/common/man/man1/knife-bootstrap.1 +215 -215
  130. data/distro/common/man/man1/knife-client.1 +443 -443
  131. data/distro/common/man/man1/knife-configure.1 +161 -161
  132. data/distro/common/man/man1/knife-cookbook.1 +770 -770
  133. data/distro/common/man/man1/knife-data-bag.1 +617 -617
  134. data/distro/common/man/man1/knife-delete.1 +127 -127
  135. data/distro/common/man/man1/knife-deps.1 +246 -246
  136. data/distro/common/man/man1/knife-diff.1 +226 -226
  137. data/distro/common/man/man1/knife-download.1 +258 -258
  138. data/distro/common/man/man1/knife-edit.1 +121 -121
  139. data/distro/common/man/man1/knife-environment.1 +508 -508
  140. data/distro/common/man/man1/knife-exec.1 +362 -362
  141. data/distro/common/man/man1/knife-index-rebuild.1 +63 -63
  142. data/distro/common/man/man1/knife-list.1 +174 -174
  143. data/distro/common/man/man1/knife-node.1 +716 -716
  144. data/distro/common/man/man1/knife-raw.1 +172 -172
  145. data/distro/common/man/man1/knife-recipe-list.1 +85 -85
  146. data/distro/common/man/man1/knife-role.1 +426 -426
  147. data/distro/common/man/man1/knife-search.1 +359 -359
  148. data/distro/common/man/man1/knife-serve.1 +109 -109
  149. data/distro/common/man/man1/knife-show.1 +160 -160
  150. data/distro/common/man/man1/knife-ssh.1 +284 -284
  151. data/distro/common/man/man1/knife-ssl-check.1 +207 -207
  152. data/distro/common/man/man1/knife-ssl-fetch.1 +207 -207
  153. data/distro/common/man/man1/knife-status.1 +234 -234
  154. data/distro/common/man/man1/knife-tag.1 +189 -189
  155. data/distro/common/man/man1/knife-upload.1 +280 -280
  156. data/distro/common/man/man1/knife-user.1 +356 -356
  157. data/distro/common/man/man1/knife-xargs.1 +189 -189
  158. data/distro/common/man/man1/knife.1 +332 -332
  159. data/distro/common/man/man8/chef-apply.8 +86 -86
  160. data/distro/common/man/man8/chef-client.8 +398 -398
  161. data/distro/common/man/man8/chef-solo.8 +260 -260
  162. data/distro/common/markdown/README +3 -3
  163. data/lib/chef/application.rb +14 -9
  164. data/lib/chef/application/apply.rb +5 -5
  165. data/lib/chef/application/client.rb +3 -3
  166. data/lib/chef/application/exit_code.rb +226 -0
  167. data/lib/chef/application/solo.rb +37 -7
  168. data/lib/chef/application/windows_service.rb +3 -3
  169. data/lib/chef/chef_fs/command_line.rb +7 -0
  170. data/lib/chef/chef_fs/config.rb +1 -1
  171. data/lib/chef/chef_fs/data_handler/data_handler_base.rb +11 -10
  172. data/lib/chef/chef_fs/data_handler/environment_data_handler.rb +1 -1
  173. data/lib/chef/chef_fs/data_handler/role_data_handler.rb +1 -1
  174. data/lib/chef/chef_fs/file_system.rb +15 -13
  175. data/lib/chef/chef_fs/file_system/base_fs_object.rb +4 -0
  176. data/lib/chef/chef_fs/file_system/chef_server/acl_dir.rb +1 -1
  177. data/lib/chef/chef_fs/file_system/chef_server/acl_entry.rb +9 -0
  178. data/lib/chef/chef_fs/file_system/chef_server/data_bag_dir.rb +6 -0
  179. data/lib/chef/chef_fs/file_system/chef_server/data_bag_entry.rb +19 -0
  180. data/lib/chef/chef_fs/file_system/chef_server/environments_dir.rb +1 -1
  181. data/lib/chef/chef_fs/file_system/chef_server/nodes_dir.rb +1 -1
  182. data/lib/chef/chef_fs/file_system/chef_server/org_entry.rb +4 -0
  183. data/lib/chef/chef_fs/file_system/chef_server/organization_invites_entry.rb +4 -0
  184. data/lib/chef/chef_fs/file_system/chef_server/organization_members_entry.rb +4 -0
  185. data/lib/chef/chef_fs/file_system/chef_server/policy_revision_entry.rb +4 -0
  186. data/lib/chef/chef_fs/file_system/chef_server/rest_list_dir.rb +3 -3
  187. data/lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb +15 -4
  188. data/lib/chef/chef_fs/file_system/exceptions.rb +7 -0
  189. data/lib/chef/chef_fs/file_system/multiplexed_dir.rb +2 -2
  190. data/lib/chef/chef_fs/file_system/nonexistent_fs_object.rb +0 -4
  191. data/lib/chef/chef_fs/file_system/repository/acl.rb +7 -0
  192. data/lib/chef/chef_fs/file_system/repository/acls_sub_dir.rb +0 -4
  193. data/lib/chef/chef_fs/file_system/repository/base_file.rb +36 -4
  194. data/lib/chef/chef_fs/file_system/repository/chef_repository_file_system_cookbook_entry.rb +4 -0
  195. data/lib/chef/chef_fs/file_system/repository/client_keys_sub_dir.rb +0 -4
  196. data/lib/chef/chef_fs/file_system/repository/clients_dir.rb +0 -3
  197. data/lib/chef/chef_fs/file_system/repository/containers_dir.rb +0 -4
  198. data/lib/chef/chef_fs/file_system/repository/directory.rb +4 -0
  199. data/lib/chef/chef_fs/file_system/repository/environments_dir.rb +0 -4
  200. data/lib/chef/chef_fs/file_system/repository/groups_dir.rb +0 -4
  201. data/lib/chef/chef_fs/file_system/repository/nodes_dir.rb +0 -4
  202. data/lib/chef/chef_fs/file_system/repository/policy_groups_dir.rb +0 -4
  203. data/lib/chef/chef_fs/file_system/repository/roles_dir.rb +0 -4
  204. data/lib/chef/chef_fs/file_system/repository/users_dir.rb +0 -4
  205. data/lib/chef/client.rb +11 -3
  206. data/lib/chef/config_fetcher.rb +4 -4
  207. data/lib/chef/cookbook/gem_installer.rb +1 -0
  208. data/lib/chef/cookbook/synchronizer.rb +1 -1
  209. data/lib/chef/data_bag.rb +2 -2
  210. data/lib/chef/data_bag_item.rb +1 -1
  211. data/lib/chef/data_collector.rb +345 -0
  212. data/lib/chef/data_collector/messages.rb +125 -0
  213. data/lib/chef/data_collector/messages/helpers.rb +161 -0
  214. data/lib/chef/data_collector/resource_report.rb +84 -0
  215. data/lib/chef/decorator.rb +81 -0
  216. data/lib/chef/decorator/lazy.rb +60 -0
  217. data/lib/chef/decorator/lazy_array.rb +59 -0
  218. data/lib/chef/deprecation/provider/remote_file.rb +1 -1
  219. data/lib/chef/dsl/core.rb +19 -11
  220. data/lib/chef/dsl/platform_introspection.rb +16 -0
  221. data/lib/chef/dsl/recipe.rb +15 -9
  222. data/lib/chef/dsl/universal.rb +50 -0
  223. data/lib/chef/environment.rb +2 -2
  224. data/lib/chef/exceptions.rb +19 -4
  225. data/lib/chef/handler.rb +33 -0
  226. data/lib/chef/knife/cookbook_show.rb +6 -10
  227. data/lib/chef/knife/cookbook_site_install.rb +7 -2
  228. data/lib/chef/knife/help_topics.rb +4 -4
  229. data/lib/chef/knife/list.rb +1 -2
  230. data/lib/chef/knife/ssl_check.rb +2 -1
  231. data/lib/chef/monkey_patches/win32/registry.rb +11 -0
  232. data/lib/chef/nil_argument.rb +3 -3
  233. data/lib/chef/node.rb +2 -2
  234. data/lib/chef/platform/rebooter.rb +13 -2
  235. data/lib/chef/policy_builder/dynamic.rb +1 -1
  236. data/lib/chef/policy_builder/expand_node_object.rb +3 -3
  237. data/lib/chef/policy_builder/policyfile.rb +1 -1
  238. data/lib/chef/provider/git.rb +43 -41
  239. data/lib/chef/provider/lwrp_base.rb +0 -1
  240. data/lib/chef/provider/osx_profile.rb +2 -3
  241. data/lib/chef/provider/package.rb +51 -13
  242. data/lib/chef/provider/package/apt.rb +97 -103
  243. data/lib/chef/provider/package/chocolatey.rb +9 -10
  244. data/lib/chef/provider/package/dpkg.rb +2 -2
  245. data/lib/chef/provider/package/portage.rb +1 -1
  246. data/lib/chef/provider/package/rubygems.rb +8 -12
  247. data/lib/chef/provider/package/yum.rb +4 -959
  248. data/lib/chef/provider/package/yum/rpm_utils.rb +642 -0
  249. data/lib/chef/provider/package/{yum-dump.py → yum/yum-dump.py} +0 -0
  250. data/lib/chef/provider/package/yum/yum_cache.rb +376 -0
  251. data/lib/chef/provider/resource_update.rb +52 -52
  252. data/lib/chef/provider/systemd_unit.rb +238 -0
  253. data/lib/chef/providers.rb +1 -0
  254. data/lib/chef/reserved_names.rb +9 -9
  255. data/lib/chef/resource.rb +2 -7
  256. data/lib/chef/resource/file.rb +6 -1
  257. data/lib/chef/resource/systemd_unit.rb +63 -0
  258. data/lib/chef/resources.rb +1 -0
  259. data/lib/chef/sandbox.rb +20 -20
  260. data/lib/chef/shell/shell_session.rb +3 -3
  261. data/lib/chef/version.rb +1 -1
  262. data/lib/chef/win32/system.rb +0 -0
  263. data/spec/data/apt/chef-integration-test-1.0/debian/changelog +5 -5
  264. data/spec/data/apt/chef-integration-test-1.0/debian/compat +1 -1
  265. data/spec/data/apt/chef-integration-test-1.0/debian/control +13 -13
  266. data/spec/data/apt/chef-integration-test-1.0/debian/files +1 -1
  267. data/spec/data/apt/chef-integration-test-1.0/debian/rules +13 -13
  268. data/spec/data/apt/chef-integration-test-1.0/debian/source/format +1 -1
  269. data/spec/data/apt/chef-integration-test-1.1/debian/changelog +11 -11
  270. data/spec/data/apt/chef-integration-test-1.1/debian/compat +1 -1
  271. data/spec/data/apt/chef-integration-test-1.1/debian/control +13 -13
  272. data/spec/data/apt/chef-integration-test-1.1/debian/files +1 -1
  273. data/spec/data/apt/chef-integration-test-1.1/debian/rules +13 -13
  274. data/spec/data/apt/chef-integration-test-1.1/debian/source/format +1 -1
  275. data/spec/data/apt/chef-integration-test2-1.0/debian/rules +0 -0
  276. data/spec/data/apt/chef-integration-test_1.0-1_amd64.changes +22 -22
  277. data/spec/data/apt/chef-integration-test_1.1-1_amd64.changes +22 -22
  278. data/spec/data/apt/var/www/apt/conf/distributions +7 -7
  279. data/spec/data/apt/var/www/apt/conf/incoming +4 -4
  280. data/spec/data/apt/var/www/apt/conf/pulls +3 -3
  281. data/spec/data/apt/var/www/apt/db/version +4 -4
  282. data/spec/data/apt/var/www/apt/dists/sid/Release +19 -19
  283. data/spec/data/apt/var/www/apt/dists/sid/main/binary-amd64/Packages +16 -16
  284. data/spec/data/apt/var/www/apt/dists/sid/main/binary-amd64/Release +5 -5
  285. data/spec/data/bootstrap/encrypted_data_bag_secret +1 -1
  286. data/spec/data/bootstrap/no_proxy.erb +2 -2
  287. data/spec/data/bootstrap/secret.erb +9 -9
  288. data/spec/data/bootstrap/test-hints.erb +12 -12
  289. data/spec/data/bootstrap/test.erb +1 -1
  290. data/spec/data/cb_version_cookbooks/tatft/README.rdoc +2 -2
  291. data/spec/data/cb_version_cookbooks/tatft/attributes/default.rb +1 -1
  292. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-600hhz-0 +1 -1
  293. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-ahd2gq-0 +1 -1
  294. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-api8ux-0 +1 -1
  295. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-b0r1m1-0 +1 -1
  296. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-bfygsi-0 +1 -1
  297. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-el14l6-0 +1 -1
  298. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-ivrl3y-0 +1 -1
  299. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-kkbs85-0 +1 -1
  300. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-ory1ux-0 +1 -1
  301. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-pgsq76-0 +1 -1
  302. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-ra8uim-0 +1 -1
  303. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-t7k1g-0 +1 -1
  304. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-t8g0sv-0 +1 -1
  305. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-ufy6g3-0 +1 -1
  306. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-x2d6j9-0 +1 -1
  307. data/spec/data/checksum_cache/chef-file--tmp-chef-rendered-template20100929-10863-xi0l6h-0 +1 -1
  308. data/spec/data/config.rb +6 -6
  309. data/spec/data/cookbooks/angrybash/metadata.rb +2 -2
  310. data/spec/data/cookbooks/angrybash/recipes/default.rb +8 -8
  311. data/spec/data/cookbooks/apache2/files/default/apache2_module_conf_generate.pl +2 -2
  312. data/spec/data/cookbooks/apache2/metadata.rb +2 -2
  313. data/spec/data/cookbooks/apache2/recipes/default.rb +2 -2
  314. data/spec/data/cookbooks/borken/metadata.rb +2 -2
  315. data/spec/data/cookbooks/borken/recipes/default.rb +1 -1
  316. data/spec/data/cookbooks/borken/templates/default/borken.erb +1 -1
  317. data/spec/data/cookbooks/chefignore +8 -8
  318. data/spec/data/cookbooks/ignorken/files/default/not_me.rb +2 -2
  319. data/spec/data/cookbooks/ignorken/metadata.rb +2 -2
  320. data/spec/data/cookbooks/ignorken/recipes/ignoreme.rb +1 -1
  321. data/spec/data/cookbooks/ignorken/templates/ubuntu-12.10/not_me.rb +2 -2
  322. data/spec/data/cookbooks/java/files/default/java.response +1 -1
  323. data/spec/data/cookbooks/java/metadata.rb +2 -2
  324. data/spec/data/cookbooks/name-mismatch-versionnumber/README.md +4 -4
  325. data/spec/data/cookbooks/name-mismatch-versionnumber/metadata.rb +8 -8
  326. data/spec/data/cookbooks/openldap/attributes/default.rb +16 -16
  327. data/spec/data/cookbooks/openldap/attributes/smokey.rb +1 -1
  328. data/spec/data/cookbooks/openldap/definitions/client.rb +5 -5
  329. data/spec/data/cookbooks/openldap/definitions/server.rb +5 -5
  330. data/spec/data/cookbooks/openldap/files/default/.dotfile +1 -1
  331. data/spec/data/cookbooks/openldap/files/default/remotedir/.a_dotdir/.a_dotfile_in_a_dotdir +1 -1
  332. data/spec/data/cookbooks/openldap/files/default/remotedir/not_a_template.erb +2 -2
  333. data/spec/data/cookbooks/openldap/files/default/remotedir/remote_dir_file1.txt +2 -2
  334. data/spec/data/cookbooks/openldap/files/default/remotedir/remote_dir_file2.txt +2 -2
  335. data/spec/data/cookbooks/openldap/files/default/remotedir/remotesubdir/.a_dotfile +1 -1
  336. data/spec/data/cookbooks/openldap/files/default/remotedir/remotesubdir/remote_subdir_file1.txt +2 -2
  337. data/spec/data/cookbooks/openldap/files/default/remotedir/remotesubdir/remote_subdir_file2.txt +2 -2
  338. data/spec/data/cookbooks/openldap/files/default/remotedir/subdir_with_no_file_just_a_subsubdir/the_subsubdir/some_file.txt +3 -3
  339. data/spec/data/cookbooks/openldap/libraries/openldap.rb +4 -4
  340. data/spec/data/cookbooks/openldap/libraries/openldap/version.rb +3 -3
  341. data/spec/data/cookbooks/openldap/metadata.rb +8 -8
  342. data/spec/data/cookbooks/openldap/recipes/default.rb +4 -4
  343. data/spec/data/cookbooks/openldap/recipes/gigantor.rb +3 -3
  344. data/spec/data/cookbooks/openldap/recipes/one.rb +15 -15
  345. data/spec/data/cookbooks/openldap/recipes/return.rb +2 -2
  346. data/spec/data/cookbooks/openldap/templates/default/helper_test.erb +1 -1
  347. data/spec/data/cookbooks/openldap/templates/default/helpers_via_partial_test.erb +1 -1
  348. data/spec/data/cookbooks/openldap/templates/default/no_windows_line_endings.erb +4 -4
  349. data/spec/data/cookbooks/openldap/templates/default/openldap_variable_stuff.conf.erb +1 -1
  350. data/spec/data/cookbooks/openldap/templates/default/test.erb +1 -1
  351. data/spec/data/cookbooks/preseed/files/default/preseed-file.seed +1 -1
  352. data/spec/data/cookbooks/preseed/files/default/preseed-template.seed +4 -4
  353. data/spec/data/cookbooks/preseed/metadata.rb +2 -2
  354. data/spec/data/cookbooks/preseed/templates/default/preseed-template-variables.seed +1 -1
  355. data/spec/data/cookbooks/preseed/templates/default/preseed-template.seed +1 -1
  356. data/spec/data/definitions/test.rb +4 -4
  357. data/spec/data/environment-config.rb +4 -4
  358. data/spec/data/file-providers-method-snapshot-chef-11-4.json +127 -127
  359. data/spec/data/fileedit/hosts +4 -4
  360. data/spec/data/incomplete-metadata-chef-repo/incomplete-metadata/README.md +4 -4
  361. data/spec/data/incomplete-metadata-chef-repo/incomplete-metadata/metadata.rb +13 -13
  362. data/spec/data/invalid-metadata-chef-repo/invalid-metadata/README.md +4 -4
  363. data/spec/data/kitchen/chefignore +6 -6
  364. data/spec/data/kitchen/openldap/attributes/default.rb +3 -3
  365. data/spec/data/kitchen/openldap/attributes/robinson.rb +2 -2
  366. data/spec/data/kitchen/openldap/definitions/client.rb +3 -3
  367. data/spec/data/kitchen/openldap/definitions/drewbarrymore.rb +2 -2
  368. data/spec/data/kitchen/openldap/recipes/gigantor.rb +2 -2
  369. data/spec/data/kitchen/openldap/recipes/ignoreme.rb +2 -2
  370. data/spec/data/kitchen/openldap/recipes/woot.rb +3 -3
  371. data/spec/data/knife_subcommand/test_explicit_category.rb +6 -6
  372. data/spec/data/knife_subcommand/test_name_mapping.rb +4 -4
  373. data/spec/data/knife_subcommand/test_yourself.rb +21 -21
  374. data/spec/data/lwrp/providers/inline_compiler.rb +26 -26
  375. data/spec/data/lwrp/providers/monkey_name_printer.rb +5 -5
  376. data/spec/data/lwrp/providers/paint_drying_watcher.rb +7 -7
  377. data/spec/data/lwrp/providers/thumb_twiddler.rb +7 -7
  378. data/spec/data/lwrp/resources/foo.rb +4 -4
  379. data/spec/data/lwrp/resources_with_default_attributes/nodeattr.rb +1 -1
  380. data/spec/data/lwrp_override/providers/buck_passer.rb +5 -5
  381. data/spec/data/mac_users/10.7-8.plist.xml +559 -559
  382. data/spec/data/mac_users/10.7-8.shadow.xml +11 -11
  383. data/spec/data/mac_users/10.7.plist.xml +559 -559
  384. data/spec/data/mac_users/10.7.shadow.xml +11 -11
  385. data/spec/data/mac_users/10.8.plist.xml +559 -559
  386. data/spec/data/mac_users/10.8.shadow.xml +21 -21
  387. data/spec/data/mac_users/10.9.plist.xml +560 -560
  388. data/spec/data/mac_users/10.9.shadow.xml +21 -21
  389. data/spec/data/metadata/quick_start/metadata.rb +19 -19
  390. data/spec/data/nodes/default.rb +15 -15
  391. data/spec/data/nodes/test.example.com.rb +17 -17
  392. data/spec/data/nodes/test.rb +15 -15
  393. data/spec/data/null_config.rb +1 -1
  394. data/spec/data/object_loader/environments/test.json +7 -7
  395. data/spec/data/object_loader/environments/test.rb +2 -2
  396. data/spec/data/object_loader/environments/test_json_class.json +8 -8
  397. data/spec/data/object_loader/nodes/test.json +7 -7
  398. data/spec/data/object_loader/nodes/test.rb +2 -2
  399. data/spec/data/object_loader/nodes/test_json_class.json +8 -8
  400. data/spec/data/object_loader/roles/test.json +7 -7
  401. data/spec/data/object_loader/roles/test.rb +2 -2
  402. data/spec/data/object_loader/roles/test_json_class.json +8 -8
  403. data/spec/data/partial_one.erb +1 -1
  404. data/spec/data/recipes/test.rb +7 -7
  405. data/spec/data/run_context/cookbooks/circular-dep1/attributes/default.rb +4 -4
  406. data/spec/data/run_context/cookbooks/circular-dep1/definitions/circular_dep1_res.rb +1 -1
  407. data/spec/data/run_context/cookbooks/circular-dep1/libraries/lib.rb +2 -2
  408. data/spec/data/run_context/cookbooks/circular-dep1/metadata.rb +2 -2
  409. data/spec/data/run_context/cookbooks/circular-dep1/providers/provider.rb +1 -1
  410. data/spec/data/run_context/cookbooks/circular-dep1/resources/resource.rb +1 -1
  411. data/spec/data/run_context/cookbooks/circular-dep2/attributes/default.rb +3 -3
  412. data/spec/data/run_context/cookbooks/circular-dep2/definitions/circular_dep2_res.rb +1 -1
  413. data/spec/data/run_context/cookbooks/circular-dep2/libraries/lib.rb +2 -2
  414. data/spec/data/run_context/cookbooks/circular-dep2/metadata.rb +2 -2
  415. data/spec/data/run_context/cookbooks/circular-dep2/providers/provider.rb +1 -1
  416. data/spec/data/run_context/cookbooks/circular-dep2/resources/resource.rb +1 -1
  417. data/spec/data/run_context/cookbooks/dependency1/attributes/aa_first.rb +2 -2
  418. data/spec/data/run_context/cookbooks/dependency1/attributes/default.rb +2 -2
  419. data/spec/data/run_context/cookbooks/dependency1/attributes/zz_last.rb +3 -3
  420. data/spec/data/run_context/cookbooks/dependency1/definitions/dependency1_res.rb +1 -1
  421. data/spec/data/run_context/cookbooks/dependency1/libraries/lib.rb +2 -2
  422. data/spec/data/run_context/cookbooks/dependency1/providers/provider.rb +1 -1
  423. data/spec/data/run_context/cookbooks/dependency1/resources/resource.rb +1 -1
  424. data/spec/data/run_context/cookbooks/dependency2/attributes/default.rb +3 -3
  425. data/spec/data/run_context/cookbooks/dependency2/definitions/dependency2_res.rb +1 -1
  426. data/spec/data/run_context/cookbooks/dependency2/libraries/lib.rb +2 -2
  427. data/spec/data/run_context/cookbooks/dependency2/providers/provider.rb +1 -1
  428. data/spec/data/run_context/cookbooks/dependency2/resources/resource.rb +1 -1
  429. data/spec/data/run_context/cookbooks/no-default-attr/attributes/server.rb +3 -3
  430. data/spec/data/run_context/cookbooks/no-default-attr/definitions/no_default-attr_res.rb +1 -1
  431. data/spec/data/run_context/cookbooks/no-default-attr/providers/provider.rb +1 -1
  432. data/spec/data/run_context/cookbooks/no-default-attr/resources/resource.rb +1 -1
  433. data/spec/data/run_context/cookbooks/test-with-circular-deps/attributes/default.rb +3 -3
  434. data/spec/data/run_context/cookbooks/test-with-circular-deps/definitions/test_with-circular-deps_res.rb +1 -1
  435. data/spec/data/run_context/cookbooks/test-with-circular-deps/libraries/lib.rb +2 -2
  436. data/spec/data/run_context/cookbooks/test-with-circular-deps/metadata.rb +2 -2
  437. data/spec/data/run_context/cookbooks/test-with-circular-deps/providers/provider.rb +1 -1
  438. data/spec/data/run_context/cookbooks/test-with-circular-deps/resources/resource.rb +1 -1
  439. data/spec/data/run_context/cookbooks/test-with-deps/attributes/default.rb +3 -3
  440. data/spec/data/run_context/cookbooks/test-with-deps/definitions/test_with-deps_res.rb +1 -1
  441. data/spec/data/run_context/cookbooks/test-with-deps/libraries/lib.rb +1 -1
  442. data/spec/data/run_context/cookbooks/test-with-deps/metadata.rb +3 -3
  443. data/spec/data/run_context/cookbooks/test-with-deps/providers/provider.rb +1 -1
  444. data/spec/data/run_context/cookbooks/test-with-deps/resources/resource.rb +1 -1
  445. data/spec/data/run_context/cookbooks/test/attributes/george.rb +1 -1
  446. data/spec/data/run_context/cookbooks/test/definitions/new_animals.rb +9 -9
  447. data/spec/data/run_context/cookbooks/test/definitions/new_cat.rb +5 -5
  448. data/spec/data/run_context/cookbooks/test/definitions/test_res.rb +1 -1
  449. data/spec/data/run_context/cookbooks/test/providers/provider.rb +1 -1
  450. data/spec/data/run_context/cookbooks/test/recipes/default.rb +5 -5
  451. data/spec/data/run_context/cookbooks/test/recipes/one.rb +7 -7
  452. data/spec/data/run_context/cookbooks/test/recipes/two.rb +7 -7
  453. data/spec/data/run_context/cookbooks/test/resources/resource.rb +1 -1
  454. data/spec/data/run_context/nodes/run_context.rb +5 -5
  455. data/spec/data/search_queries_to_transform.txt +98 -98
  456. data/spec/data/shef-config.rb +10 -10
  457. data/spec/data/ssl/5e707473.0 +18 -18
  458. data/spec/data/ssl/chef-rspec.cert +27 -27
  459. data/spec/data/ssl/chef-rspec.key +27 -27
  460. data/spec/data/ssl/key.pem +15 -15
  461. data/spec/data/ssl/private_key.pem +27 -27
  462. data/spec/data/ssl/private_key_with_whitespace.pem +32 -32
  463. data/spec/data/standalone_cookbook/chefignore +9 -9
  464. data/spec/data/standalone_cookbook/recipes/default.rb +2 -2
  465. data/spec/data/trusted_certs/example.crt +22 -22
  466. data/spec/data/trusted_certs/intermediate.pem +27 -27
  467. data/spec/data/trusted_certs/root.pem +22 -22
  468. data/spec/functional/assets/chefinittest +34 -34
  469. data/spec/functional/assets/testchefsubsys +10 -10
  470. data/spec/functional/provider/remote_file/cache_control_data_spec.rb +0 -0
  471. data/spec/functional/resource/aix_service_spec.rb +0 -0
  472. data/spec/functional/resource/aixinit_service_spec.rb +0 -0
  473. data/spec/functional/resource/chocolatey_package_spec.rb +0 -5
  474. data/spec/functional/resource/env_spec.rb +0 -0
  475. data/spec/functional/win32/registry_spec.rb +1 -0
  476. data/spec/integration/client/exit_code_spec.rb +245 -0
  477. data/spec/integration/knife/deps_spec.rb +7 -7
  478. data/spec/integration/knife/download_spec.rb +19 -0
  479. data/spec/integration/knife/list_spec.rb +0 -8
  480. data/spec/integration/knife/upload_spec.rb +21 -2
  481. data/spec/integration/solo/solo_spec.rb +1 -1
  482. data/spec/rcov.opts +2 -2
  483. data/spec/unit/application/apply_spec.rb +6 -4
  484. data/spec/unit/application/exit_code_spec.rb +231 -0
  485. data/spec/unit/application/solo_spec.rb +143 -88
  486. data/spec/unit/chef_fs/config_spec.rb +129 -0
  487. data/spec/unit/chef_fs/file_system/repository/base_file_spec.rb +8 -10
  488. data/spec/unit/client_spec.rb +1 -1
  489. data/spec/unit/config_fetcher_spec.rb +2 -2
  490. data/spec/unit/cookbook/synchronizer_spec.rb +1 -1
  491. data/spec/unit/data_bag_item_spec.rb +2 -2
  492. data/spec/unit/data_bag_spec.rb +2 -2
  493. data/spec/unit/data_collector/messages/helpers_spec.rb +190 -0
  494. data/spec/unit/data_collector/messages_spec.rb +207 -0
  495. data/spec/unit/data_collector_spec.rb +525 -0
  496. data/spec/unit/decorator/lazy_array_spec.rb +58 -0
  497. data/spec/unit/decorator/lazy_spec.rb +39 -0
  498. data/spec/unit/decorator_spec.rb +142 -0
  499. data/spec/unit/environment_spec.rb +4 -4
  500. data/spec/unit/handler_spec.rb +87 -0
  501. data/spec/unit/knife/cookbook_show_spec.rb +89 -90
  502. data/spec/unit/knife/ssl_check_spec.rb +16 -0
  503. data/spec/unit/policy_builder/dynamic_spec.rb +1 -1
  504. data/spec/unit/policy_builder/policyfile_spec.rb +1 -1
  505. data/spec/unit/provider/git_spec.rb +77 -18
  506. data/spec/unit/provider/package/apt_spec.rb +97 -34
  507. data/spec/unit/provider/package/chocolatey_spec.rb +3 -15
  508. data/spec/unit/provider/package/portage_spec.rb +6 -0
  509. data/spec/unit/provider/package/rubygems_spec.rb +38 -4
  510. data/spec/unit/provider/package/yum/yum_cache_spec.rb +27 -0
  511. data/spec/unit/provider/package_spec.rb +20 -7
  512. data/spec/unit/provider/systemd_unit_spec.rb +885 -0
  513. data/spec/unit/resource/systemd_unit_spec.rb +133 -0
  514. data/spec/unit/resource_builder_spec.rb +1 -1
  515. data/tasks/bin/bundle-platform +6 -2
  516. data/tasks/bin/bundle-platform.bat +0 -0
  517. data/tasks/bin/create-override-gemfile +0 -0
  518. data/tasks/bin/run_external_test +0 -0
  519. data/tasks/bundle_util.rb +18 -2
  520. data/tasks/changelog.rb +1 -0
  521. data/tasks/dependencies.rb +47 -57
  522. metadata +847 -7
  523. data/tasks/bin/run_chef_tests +0 -17
data/distro/common/html/knife_common_options.html CHANGED
@@ -1,96 +1,96 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
-
4
-
5
- <html xmlns="http://www.w3.org/1999/xhtml">
6
- <head>
7
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
-
9
- <title>Common Options &mdash; chef-client Man Pages</title>
10
-
11
- <link rel="stylesheet" href="_static/guide.css" type="text/css" />
12
- <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
-
14
- <script type="text/javascript">
15
- var DOCUMENTATION_OPTIONS = {
16
- URL_ROOT: './',
17
- VERSION: '',
18
- COLLAPSE_INDEX: false,
19
- FILE_SUFFIX: '.html',
20
- HAS_SOURCE: true
21
- };
22
- </script>
23
- <script type="text/javascript" src="_static/jquery.js"></script>
24
- <script type="text/javascript" src="_static/underscore.js"></script>
25
- <script type="text/javascript" src="_static/doctools.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px">
31
- <a href="http://docs.getchef.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a>
32
- </div>
33
-
34
-
35
-
36
-
37
- <div class="document">
38
- <div class="documentwrapper">
39
-
40
- <div class="body">
41
-
42
- <div class="section" id="common-options">
43
- <h1>Common Options<a class="headerlink" href="#common-options" title="Permalink to this headline">¶</a></h1>
44
- <p>The following options can be run with all knife sub-commands and plug-ins:</p>
45
- <dl class="docutils">
46
- <dt><tt class="docutils literal"><span class="pre">-c</span> <span class="pre">CONFIG_FILE</span></tt>, <tt class="docutils literal"><span class="pre">--config</span> <span class="pre">CONFIG_FILE</span></tt></dt>
47
- <dd>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.</dd>
48
- <dt><tt class="docutils literal"><span class="pre">--chef-zero-port</span> <span class="pre">PORT</span></tt></dt>
49
- <dd>The port on which chef-zero will listen.</dd>
50
- <dt><tt class="docutils literal"><span class="pre">-d</span></tt>, <tt class="docutils literal"><span class="pre">--disable-editing</span></tt></dt>
51
- <dd>Use to prevent the $EDITOR from being opened and to accept data as-is.</dd>
52
- <dt><tt class="docutils literal"><span class="pre">--defaults</span></tt></dt>
53
- <dd>Use to have knife use the default value instead of asking a user to provide one.</dd>
54
- <dt><tt class="docutils literal"><span class="pre">-e</span> <span class="pre">EDITOR</span></tt>, <tt class="docutils literal"><span class="pre">--editor</span> <span class="pre">EDITOR</span></tt></dt>
55
- <dd>The $EDITOR that is used for all interactive commands.</dd>
56
- <dt><tt class="docutils literal"><span class="pre">-E</span> <span class="pre">ENVIRONMENT</span></tt>, <tt class="docutils literal"><span class="pre">--environment</span> <span class="pre">ENVIRONMENT</span></tt></dt>
57
- <dd>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 <strong>knife search</strong> subcommand.</dd>
58
- <dt><tt class="docutils literal"><span class="pre">-F</span> <span class="pre">FORMAT</span></tt>, <tt class="docutils literal"><span class="pre">--format</span> <span class="pre">FORMAT</span></tt></dt>
59
- <dd>The output format: <tt class="docutils literal"><span class="pre">summary</span></tt> (default), <tt class="docutils literal"><span class="pre">text</span></tt>, <tt class="docutils literal"><span class="pre">json</span></tt>, <tt class="docutils literal"><span class="pre">yaml</span></tt>, and <tt class="docutils literal"><span class="pre">pp</span></tt>.</dd>
60
- <dt><tt class="docutils literal"><span class="pre">-h</span></tt>, <tt class="docutils literal"><span class="pre">--help</span></tt></dt>
61
- <dd>Shows help for the command.</dd>
62
- <dt><tt class="docutils literal"><span class="pre">-k</span> <span class="pre">KEY</span></tt>, <tt class="docutils literal"><span class="pre">--key</span> <span class="pre">KEY</span></tt></dt>
63
- <dd>The private key that knife will use to sign requests made by the API client to the Chef server.</dd>
64
- <dt><tt class="docutils literal"><span class="pre">--[no-]color</span></tt></dt>
65
- <dd>Use to view colored output.</dd>
66
- <dt><tt class="docutils literal"><span class="pre">--print-after</span></tt></dt>
67
- <dd>Use to show data after a destructive operation.</dd>
68
- <dt><tt class="docutils literal"><span class="pre">-s</span> <span class="pre">URL</span></tt>, <tt class="docutils literal"><span class="pre">--server-url</span> <span class="pre">URL</span></tt></dt>
69
- <dd>The URL for the Chef server.</dd>
70
- <dt><tt class="docutils literal"><span class="pre">-u</span> <span class="pre">USER</span></tt>, <tt class="docutils literal"><span class="pre">--user</span> <span class="pre">USER</span></tt></dt>
71
- <dd>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.</dd>
72
- <dt><tt class="docutils literal"><span class="pre">-v</span></tt>, <tt class="docutils literal"><span class="pre">--version</span></tt></dt>
73
- <dd>The version of the chef-client.</dd>
74
- <dt><tt class="docutils literal"><span class="pre">-V</span></tt>, <tt class="docutils literal"><span class="pre">--verbose</span></tt></dt>
75
- <dd>Set for more verbose outputs. Use <tt class="docutils literal"><span class="pre">-VV</span></tt> for maximum verbosity.</dd>
76
- <dt><tt class="docutils literal"><span class="pre">-y</span></tt>, <tt class="docutils literal"><span class="pre">--yes</span></tt></dt>
77
- <dd>Use to respond to all confirmation prompts with &#8220;Yes&#8221;. knife will not ask for confirmation.</dd>
78
- <dt><tt class="docutils literal"><span class="pre">-z</span></tt>, <tt class="docutils literal"><span class="pre">--local-mode</span></tt></dt>
79
- <dd>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.</dd>
80
- </dl>
81
- </div>
82
-
83
-
84
- </div>
85
-
86
- </div>
87
-
88
-
89
- <div class="clearer"></div>
90
- </div>
91
-
92
-
93
-
94
-
95
- </body>
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml">
6
+ <head>
7
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
+
9
+ <title>Common Options &mdash; chef-client Man Pages</title>
10
+
11
+ <link rel="stylesheet" href="_static/guide.css" type="text/css" />
12
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
+
14
+ <script type="text/javascript">
15
+ var DOCUMENTATION_OPTIONS = {
16
+ URL_ROOT: './',
17
+ VERSION: '',
18
+ COLLAPSE_INDEX: false,
19
+ FILE_SUFFIX: '.html',
20
+ HAS_SOURCE: true
21
+ };
22
+ </script>
23
+ <script type="text/javascript" src="_static/jquery.js"></script>
24
+ <script type="text/javascript" src="_static/underscore.js"></script>
25
+ <script type="text/javascript" src="_static/doctools.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px">
31
+ <a href="http://docs.getchef.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a>
32
+ </div>
33
+
34
+
35
+
36
+
37
+ <div class="document">
38
+ <div class="documentwrapper">
39
+
40
+ <div class="body">
41
+
42
+ <div class="section" id="common-options">
43
+ <h1>Common Options<a class="headerlink" href="#common-options" title="Permalink to this headline">¶</a></h1>
44
+ <p>The following options can be run with all knife sub-commands and plug-ins:</p>
45
+ <dl class="docutils">
46
+ <dt><tt class="docutils literal"><span class="pre">-c</span> <span class="pre">CONFIG_FILE</span></tt>, <tt class="docutils literal"><span class="pre">--config</span> <span class="pre">CONFIG_FILE</span></tt></dt>
47
+ <dd>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.</dd>
48
+ <dt><tt class="docutils literal"><span class="pre">--chef-zero-port</span> <span class="pre">PORT</span></tt></dt>
49
+ <dd>The port on which chef-zero will listen.</dd>
50
+ <dt><tt class="docutils literal"><span class="pre">-d</span></tt>, <tt class="docutils literal"><span class="pre">--disable-editing</span></tt></dt>
51
+ <dd>Use to prevent the $EDITOR from being opened and to accept data as-is.</dd>
52
+ <dt><tt class="docutils literal"><span class="pre">--defaults</span></tt></dt>
53
+ <dd>Use to have knife use the default value instead of asking a user to provide one.</dd>
54
+ <dt><tt class="docutils literal"><span class="pre">-e</span> <span class="pre">EDITOR</span></tt>, <tt class="docutils literal"><span class="pre">--editor</span> <span class="pre">EDITOR</span></tt></dt>
55
+ <dd>The $EDITOR that is used for all interactive commands.</dd>
56
+ <dt><tt class="docutils literal"><span class="pre">-E</span> <span class="pre">ENVIRONMENT</span></tt>, <tt class="docutils literal"><span class="pre">--environment</span> <span class="pre">ENVIRONMENT</span></tt></dt>
57
+ <dd>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 <strong>knife search</strong> subcommand.</dd>
58
+ <dt><tt class="docutils literal"><span class="pre">-F</span> <span class="pre">FORMAT</span></tt>, <tt class="docutils literal"><span class="pre">--format</span> <span class="pre">FORMAT</span></tt></dt>
59
+ <dd>The output format: <tt class="docutils literal"><span class="pre">summary</span></tt> (default), <tt class="docutils literal"><span class="pre">text</span></tt>, <tt class="docutils literal"><span class="pre">json</span></tt>, <tt class="docutils literal"><span class="pre">yaml</span></tt>, and <tt class="docutils literal"><span class="pre">pp</span></tt>.</dd>
60
+ <dt><tt class="docutils literal"><span class="pre">-h</span></tt>, <tt class="docutils literal"><span class="pre">--help</span></tt></dt>
61
+ <dd>Shows help for the command.</dd>
62
+ <dt><tt class="docutils literal"><span class="pre">-k</span> <span class="pre">KEY</span></tt>, <tt class="docutils literal"><span class="pre">--key</span> <span class="pre">KEY</span></tt></dt>
63
+ <dd>The private key that knife will use to sign requests made by the API client to the Chef server.</dd>
64
+ <dt><tt class="docutils literal"><span class="pre">--[no-]color</span></tt></dt>
65
+ <dd>Use to view colored output.</dd>
66
+ <dt><tt class="docutils literal"><span class="pre">--print-after</span></tt></dt>
67
+ <dd>Use to show data after a destructive operation.</dd>
68
+ <dt><tt class="docutils literal"><span class="pre">-s</span> <span class="pre">URL</span></tt>, <tt class="docutils literal"><span class="pre">--server-url</span> <span class="pre">URL</span></tt></dt>
69
+ <dd>The URL for the Chef server.</dd>
70
+ <dt><tt class="docutils literal"><span class="pre">-u</span> <span class="pre">USER</span></tt>, <tt class="docutils literal"><span class="pre">--user</span> <span class="pre">USER</span></tt></dt>
71
+ <dd>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.</dd>
72
+ <dt><tt class="docutils literal"><span class="pre">-v</span></tt>, <tt class="docutils literal"><span class="pre">--version</span></tt></dt>
73
+ <dd>The version of the chef-client.</dd>
74
+ <dt><tt class="docutils literal"><span class="pre">-V</span></tt>, <tt class="docutils literal"><span class="pre">--verbose</span></tt></dt>
75
+ <dd>Set for more verbose outputs. Use <tt class="docutils literal"><span class="pre">-VV</span></tt> for maximum verbosity.</dd>
76
+ <dt><tt class="docutils literal"><span class="pre">-y</span></tt>, <tt class="docutils literal"><span class="pre">--yes</span></tt></dt>
77
+ <dd>Use to respond to all confirmation prompts with &#8220;Yes&#8221;. knife will not ask for confirmation.</dd>
78
+ <dt><tt class="docutils literal"><span class="pre">-z</span></tt>, <tt class="docutils literal"><span class="pre">--local-mode</span></tt></dt>
79
+ <dd>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.</dd>
80
+ </dl>
81
+ </div>
82
+
83
+
84
+ </div>
85
+
86
+ </div>
87
+
88
+
89
+ <div class="clearer"></div>
90
+ </div>
91
+
92
+
93
+
94
+
95
+ </body>
96
96
  </html>
data/distro/common/html/knife_configure.html CHANGED
@@ -1,105 +1,105 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
-
4
-
5
- <html xmlns="http://www.w3.org/1999/xhtml">
6
- <head>
7
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
-
9
- <title>knife configure &mdash; chef-client Man Pages</title>
10
-
11
- <link rel="stylesheet" href="_static/guide.css" type="text/css" />
12
- <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
-
14
- <script type="text/javascript">
15
- var DOCUMENTATION_OPTIONS = {
16
- URL_ROOT: './',
17
- VERSION: '',
18
- COLLAPSE_INDEX: false,
19
- FILE_SUFFIX: '.html',
20
- HAS_SOURCE: true
21
- };
22
- </script>
23
- <script type="text/javascript" src="_static/jquery.js"></script>
24
- <script type="text/javascript" src="_static/underscore.js"></script>
25
- <script type="text/javascript" src="_static/doctools.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px">
31
- <a href="http://docs.getchef.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a>
32
- </div>
33
-
34
-
35
-
36
-
37
- <div class="document">
38
- <div class="documentwrapper">
39
-
40
- <div class="body">
41
-
42
- <div class="section" id="knife-configure">
43
- <h1>knife configure<a class="headerlink" href="#knife-configure" title="Permalink to this headline">¶</a></h1>
44
- <p>The <strong>knife configure</strong> subcommand is used to create the knife.rb and client.rb files so that they can be distributed to workstations and nodes.</p>
45
- <div class="section" id="syntax">
46
- <h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
47
- <p>This subcommand has the following syntax when creating a knife.rb file:</p>
48
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure <span class="o">(</span>options<span class="o">)</span>
49
- </pre></div>
50
- </div>
51
- <p>and the following syntax when creating a client.rb file:</p>
52
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure client DIRECTORY
53
- </pre></div>
54
- </div>
55
- </div>
56
- <div class="section" id="options">
57
- <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
58
- <div class="admonition note">
59
- <p class="first admonition-title">Note</p>
60
- <p class="last">Review the list of <a class="reference internal" href="knife_common_options.html"><em>common options</em></a> available to this (and all) knife subcommands and plugins.</p>
61
- </div>
62
- <p>This subcommand has the following options for use when configuring a knife.rb file:</p>
63
- <dl class="docutils">
64
- <dt><tt class="docutils literal"><span class="pre">--admin-client-name</span> <span class="pre">NAME</span></tt></dt>
65
- <dd>The name of the client, typically the name of the admin client.</dd>
66
- <dt><tt class="docutils literal"><span class="pre">--admin-client-key</span> <span class="pre">PATH</span></tt></dt>
67
- <dd>The path to the private key used by the client, typically a file named <tt class="docutils literal"><span class="pre">admin.pem</span></tt>.</dd>
68
- <dt><tt class="docutils literal"><span class="pre">-i</span></tt>, <tt class="docutils literal"><span class="pre">--initial</span></tt></dt>
69
- <dd>Use to create a API client, typically an administrator client on a freshly-installed Chef server.</dd>
70
- <dt><tt class="docutils literal"><span class="pre">-r</span> <span class="pre">REPO</span></tt>, <tt class="docutils literal"><span class="pre">--repository</span> <span class="pre">REPO</span></tt></dt>
71
- <dd>The path to the chef-repo.</dd>
72
- <dt><tt class="docutils literal"><span class="pre">--validation-client-name</span> <span class="pre">NAME</span></tt></dt>
73
- <dd>The name of the validation client, typically a client named chef-validator.</dd>
74
- <dt><tt class="docutils literal"><span class="pre">--validation-key</span> <span class="pre">PATH</span></tt></dt>
75
- <dd>The path to the validation key used by the client, typically a file named chef-validator.pem.</dd>
76
- </dl>
77
- </div>
78
- <div class="section" id="examples">
79
- <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
80
- <p>The following examples show how to use this knife subcommand:</p>
81
- <p><strong>Configure knife.rb</strong></p>
82
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure
83
- </pre></div>
84
- </div>
85
- <p><strong>Configure client.rb</strong></p>
86
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure client <span class="s1">&#39;/directory&#39;</span>
87
- </pre></div>
88
- </div>
89
- </div>
90
- </div>
91
-
92
-
93
- </div>
94
-
95
- </div>
96
-
97
-
98
- <div class="clearer"></div>
99
- </div>
100
-
101
-
102
-
103
-
104
- </body>
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml">
6
+ <head>
7
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
+
9
+ <title>knife configure &mdash; chef-client Man Pages</title>
10
+
11
+ <link rel="stylesheet" href="_static/guide.css" type="text/css" />
12
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
+
14
+ <script type="text/javascript">
15
+ var DOCUMENTATION_OPTIONS = {
16
+ URL_ROOT: './',
17
+ VERSION: '',
18
+ COLLAPSE_INDEX: false,
19
+ FILE_SUFFIX: '.html',
20
+ HAS_SOURCE: true
21
+ };
22
+ </script>
23
+ <script type="text/javascript" src="_static/jquery.js"></script>
24
+ <script type="text/javascript" src="_static/underscore.js"></script>
25
+ <script type="text/javascript" src="_static/doctools.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px">
31
+ <a href="http://docs.getchef.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a>
32
+ </div>
33
+
34
+
35
+
36
+
37
+ <div class="document">
38
+ <div class="documentwrapper">
39
+
40
+ <div class="body">
41
+
42
+ <div class="section" id="knife-configure">
43
+ <h1>knife configure<a class="headerlink" href="#knife-configure" title="Permalink to this headline">¶</a></h1>
44
+ <p>The <strong>knife configure</strong> subcommand is used to create the knife.rb and client.rb files so that they can be distributed to workstations and nodes.</p>
45
+ <div class="section" id="syntax">
46
+ <h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
47
+ <p>This subcommand has the following syntax when creating a knife.rb file:</p>
48
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure <span class="o">(</span>options<span class="o">)</span>
49
+ </pre></div>
50
+ </div>
51
+ <p>and the following syntax when creating a client.rb file:</p>
52
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure client DIRECTORY
53
+ </pre></div>
54
+ </div>
55
+ </div>
56
+ <div class="section" id="options">
57
+ <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
58
+ <div class="admonition note">
59
+ <p class="first admonition-title">Note</p>
60
+ <p class="last">Review the list of <a class="reference internal" href="knife_common_options.html"><em>common options</em></a> available to this (and all) knife subcommands and plugins.</p>
61
+ </div>
62
+ <p>This subcommand has the following options for use when configuring a knife.rb file:</p>
63
+ <dl class="docutils">
64
+ <dt><tt class="docutils literal"><span class="pre">--admin-client-name</span> <span class="pre">NAME</span></tt></dt>
65
+ <dd>The name of the client, typically the name of the admin client.</dd>
66
+ <dt><tt class="docutils literal"><span class="pre">--admin-client-key</span> <span class="pre">PATH</span></tt></dt>
67
+ <dd>The path to the private key used by the client, typically a file named <tt class="docutils literal"><span class="pre">admin.pem</span></tt>.</dd>
68
+ <dt><tt class="docutils literal"><span class="pre">-i</span></tt>, <tt class="docutils literal"><span class="pre">--initial</span></tt></dt>
69
+ <dd>Use to create a API client, typically an administrator client on a freshly-installed Chef server.</dd>
70
+ <dt><tt class="docutils literal"><span class="pre">-r</span> <span class="pre">REPO</span></tt>, <tt class="docutils literal"><span class="pre">--repository</span> <span class="pre">REPO</span></tt></dt>
71
+ <dd>The path to the chef-repo.</dd>
72
+ <dt><tt class="docutils literal"><span class="pre">--validation-client-name</span> <span class="pre">NAME</span></tt></dt>
73
+ <dd>The name of the validation client, typically a client named chef-validator.</dd>
74
+ <dt><tt class="docutils literal"><span class="pre">--validation-key</span> <span class="pre">PATH</span></tt></dt>
75
+ <dd>The path to the validation key used by the client, typically a file named chef-validator.pem.</dd>
76
+ </dl>
77
+ </div>
78
+ <div class="section" id="examples">
79
+ <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
80
+ <p>The following examples show how to use this knife subcommand:</p>
81
+ <p><strong>Configure knife.rb</strong></p>
82
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure
83
+ </pre></div>
84
+ </div>
85
+ <p><strong>Configure client.rb</strong></p>
86
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure client <span class="s1">&#39;/directory&#39;</span>
87
+ </pre></div>
88
+ </div>
89
+ </div>
90
+ </div>
91
+
92
+
93
+ </div>
94
+
95
+ </div>
96
+
97
+
98
+ <div class="clearer"></div>
99
+ </div>
100
+
101
+
102
+
103
+
104
+ </body>
105
105
  </html>
data/distro/common/html/knife_cookbook.html CHANGED
@@ -1,487 +1,487 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
-
4
-
5
- <html xmlns="http://www.w3.org/1999/xhtml">
6
- <head>
7
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
-
9
- <title>knife cookbook &mdash; chef-client Man Pages</title>
10
-
11
- <link rel="stylesheet" href="_static/guide.css" type="text/css" />
12
- <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
-
14
- <script type="text/javascript">
15
- var DOCUMENTATION_OPTIONS = {
16
- URL_ROOT: './',
17
- VERSION: '',
18
- COLLAPSE_INDEX: false,
19
- FILE_SUFFIX: '.html',
20
- HAS_SOURCE: true
21
- };
22
- </script>
23
- <script type="text/javascript" src="_static/jquery.js"></script>
24
- <script type="text/javascript" src="_static/underscore.js"></script>
25
- <script type="text/javascript" src="_static/doctools.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px">
31
- <a href="http://docs.getchef.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a>
32
- </div>
33
-
34
-
35
-
36
-
37
- <div class="document">
38
- <div class="documentwrapper">
39
-
40
- <div class="body">
41
-
42
- <div class="section" id="knife-cookbook">
43
- <h1>knife cookbook<a class="headerlink" href="#knife-cookbook" title="Permalink to this headline">¶</a></h1>
44
- <p>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:</p>
45
- <ul class="simple">
46
- <li>Attribute values that are set on nodes</li>
47
- <li>Definitions that allow the creation of reusable collections of resources</li>
48
- <li>File distributions</li>
49
- <li>Libraries that extend the chef-client and/or provide helpers to Ruby code</li>
50
- <li>Recipes that specify which resources to manage and the order in which those resources will be applied</li>
51
- <li>Custom resources and providers</li>
52
- <li>Templates</li>
53
- <li>Versions</li>
54
- <li>Metadata about recipes (including dependencies), version constraints, supported platforms, and so on</li>
55
- </ul>
56
- <p>The <strong>knife cookbook</strong> subcommand is used to interact with cookbooks that are located on the Chef server or the local chef-repo.</p>
57
- <div class="admonition note">
58
- <p class="first admonition-title">Note</p>
59
- <p class="last">Review the list of <a class="reference internal" href="knife_common_options.html"><em>common options</em></a> available to this (and all) knife subcommands and plugins.</p>
60
- </div>
61
- <div class="section" id="bulk-delete">
62
- <h2>bulk delete<a class="headerlink" href="#bulk-delete" title="Permalink to this headline">¶</a></h2>
63
- <p>The <tt class="docutils literal"><span class="pre">bulk</span> <span class="pre">delete</span></tt> 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 (/).</p>
64
- <div class="section" id="syntax">
65
- <h3>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h3>
66
- <p>This argument has the following syntax:</p>
67
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook bulk delete REGEX <span class="o">(</span>options<span class="o">)</span>
68
- </pre></div>
69
- </div>
70
- </div>
71
- <div class="section" id="options">
72
- <h3>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h3>
73
- <p>This argument has the following options:</p>
74
- <dl class="docutils">
75
- <dt><tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--purge</span></tt></dt>
76
- <dd>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.</dd>
77
- </dl>
78
- </div>
79
- <div class="section" id="examples">
80
- <h3>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3>
81
- <p>The following examples show how to use this knife subcommand:</p>
82
- <p><strong>Bulk delete many cookbooks</strong></p>
83
- <p>Use a regular expression to define the pattern used to bulk delete cookbooks:</p>
84
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook bulk delete <span class="s2">&quot;^[0-9]{3}$&quot;</span> -p
85
- </pre></div>
86
- </div>
87
- </div>
88
- </div>
89
- <div class="section" id="create">
90
- <h2>create<a class="headerlink" href="#create" title="Permalink to this headline">¶</a></h2>
91
- <p>The <tt class="docutils literal"><span class="pre">create</span></tt> argument is used to create a new cookbook directory on the local machine, including the following directories and files:</p>
92
- <blockquote>
93
- <div><ul class="simple">
94
- <li>cookbook/attributes</li>
95
- <li>cookbook/CHANGELOG.md</li>
96
- <li>cookbook/definitions</li>
97
- <li>cookbook/files/default</li>
98
- <li>cookbook/libraries</li>
99
- <li>cookbook/metadata.rb</li>
100
- <li>cookbook/providers</li>
101
- <li>cookbook/README.md (or .rdoc)</li>
102
- <li>cookbook/recipes/default.rb</li>
103
- <li>cookbook/resources</li>
104
- <li>cookbook/templates/default</li>
105
- </ul>
106
- </div></blockquote>
107
- <p>After the cookbook is created, it can be uploaded to the Chef server using the <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">upload</span></tt> argument.</p>
108
- <div class="section" id="id1">
109
- <h3>Syntax<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
110
- <p>This argument has the following syntax:</p>
111
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook create COOKBOOK_NAME <span class="o">(</span>options<span class="o">)</span>
112
- </pre></div>
113
- </div>
114
- </div>
115
- <div class="section" id="id2">
116
- <h3>Options<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
117
- <p>This argument has the following options:</p>
118
- <dl class="docutils">
119
- <dt><tt class="docutils literal"><span class="pre">-C</span> <span class="pre">COPYRIGHT_HOLDER</span></tt>, <tt class="docutils literal"><span class="pre">--copyright</span> <span class="pre">COPYRIGHT_HOLDER</span></tt></dt>
120
- <dd>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 &#8220;your_company_name&#8221; will be used instead; it can be easily modified later.</dd>
121
- <dt><tt class="docutils literal"><span class="pre">-I</span> <span class="pre">LICENSE</span></tt>, <tt class="docutils literal"><span class="pre">--license</span> <span class="pre">LICENSE</span></tt></dt>
122
- <dd>The type of license under which a cookbook is distributed: <tt class="docutils literal"><span class="pre">apachev2</span></tt>, <tt class="docutils literal"><span class="pre">gplv2</span></tt>, <tt class="docutils literal"><span class="pre">gplv3</span></tt>, <tt class="docutils literal"><span class="pre">mit</span></tt>, or <tt class="docutils literal"><span class="pre">none</span></tt> (default). This option will place the appropriate license notice in the pre-created files: <tt class="docutils literal"><span class="pre">Apache</span> <span class="pre">v2.0</span></tt> (for <tt class="docutils literal"><span class="pre">apachev2</span></tt>), <tt class="docutils literal"><span class="pre">GPL</span> <span class="pre">v2</span></tt> (for <tt class="docutils literal"><span class="pre">gplv2</span></tt>), <tt class="docutils literal"><span class="pre">GPL</span> <span class="pre">v3</span></tt> (for <tt class="docutils literal"><span class="pre">gplv3</span></tt>), <tt class="docutils literal"><span class="pre">MIT</span></tt> (for <tt class="docutils literal"><span class="pre">mit</span></tt>), or <tt class="docutils literal"><span class="pre">license</span> <span class="pre">'Proprietary</span> <span class="pre">-</span> <span class="pre">All</span> <span class="pre">Rights</span> <span class="pre">Reserved</span></tt> (for <tt class="docutils literal"><span class="pre">none</span></tt>). Be aware of the licenses for files inside of a cookbook and be sure to follow any restrictions they describe.</dd>
123
- <dt><tt class="docutils literal"><span class="pre">-m</span> <span class="pre">EMAIL</span></tt>, <tt class="docutils literal"><span class="pre">--email</span> <span class="pre">EMAIL</span></tt></dt>
124
- <dd>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 &#8220;your_email&#8221; will be used instead; it can be easily modified later.</dd>
125
- <dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH</span></tt></dt>
126
- <dd>The directory in which cookbooks are created. This can be a colon-separated path.</dd>
127
- <dt><tt class="docutils literal"><span class="pre">-r</span> <span class="pre">FORMAT</span></tt>, <tt class="docutils literal"><span class="pre">--readme-format</span> <span class="pre">FORMAT</span></tt></dt>
128
- <dd>The document format of the readme file: <tt class="docutils literal"><span class="pre">md</span></tt> (markdown) and <tt class="docutils literal"><span class="pre">rdoc</span></tt> (Ruby docs).</dd>
129
- </dl>
130
- </div>
131
- <div class="section" id="id3">
132
- <h3>Examples<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
133
- <p>The following examples show how to use this knife subcommand:</p>
134
- <p><strong>Create a cookbook</strong></p>
135
- <p>To create a cookbook named &#8220;my_cookbook&#8221; with copyright, email, license, and readme format options specified, enter:</p>
136
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook create my_cookbook -C <span class="s2">&quot;My Name&quot;</span> -m <span class="s2">&quot;my@email.com&quot;</span> -I apachev2 -r md
137
- </pre></div>
138
- </div>
139
- <p>to return something like:</p>
140
- <div class="highlight-bash"><div class="highlight"><pre>** Creating cookbook my_cookbook
141
- ** Creating README <span class="k">for </span>cookbook: my_cookbook
142
- ** Creating metadata <span class="k">for </span>cookbook: my_cookbook
143
- </pre></div>
144
- </div>
145
- </div>
146
- </div>
147
- <div class="section" id="delete">
148
- <h2>delete<a class="headerlink" href="#delete" title="Permalink to this headline">¶</a></h2>
149
- <p>The <tt class="docutils literal"><span class="pre">delete</span></tt> argument is used to delete a specified cookbook or cookbook version on the Chef server (and not locally).</p>
150
- <div class="section" id="id4">
151
- <h3>Syntax<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
152
- <p>This argument has the following syntax:</p>
153
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook delete COOKBOOK_NAME <span class="o">[</span>COOKBOOK_VERSION<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span>
154
- </pre></div>
155
- </div>
156
- </div>
157
- <div class="section" id="id5">
158
- <h3>Options<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
159
- <p>This argument has the following options:</p>
160
- <dl class="docutils">
161
- <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
162
- <dd>Use to delete all cookbooks (and cookbook versions).</dd>
163
- <dt><tt class="docutils literal"><span class="pre">COOKBOOK_VERSION</span></tt></dt>
164
- <dd>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.</dd>
165
- <dt><tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--purge</span></tt></dt>
166
- <dd>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.</dd>
167
- </dl>
168
- </div>
169
- <div class="section" id="id6">
170
- <h3>Examples<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
171
- <p>The following examples show how to use this knife subcommand:</p>
172
- <p><strong>Delete a cookbook</strong></p>
173
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook delete cookbook_name version
174
- </pre></div>
175
- </div>
176
- <p>For example:</p>
177
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook delete smartmon 0.8
178
- </pre></div>
179
- </div>
180
- <p>Type <tt class="docutils literal"><span class="pre">Y</span></tt> to confirm a deletion.</p>
181
- </div>
182
- </div>
183
- <div class="section" id="download">
184
- <h2>download<a class="headerlink" href="#download" title="Permalink to this headline">¶</a></h2>
185
- <p>The <tt class="docutils literal"><span class="pre">download</span></tt> argument is used to download a cookbook from the Chef server to the current working directory.</p>
186
- <div class="section" id="id7">
187
- <h3>Syntax<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
188
- <p>This argument has the following syntax:</p>
189
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook download COOKBOOK_NAME <span class="o">[</span>COOKBOOK_VERSION<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span>
190
- </pre></div>
191
- </div>
192
- </div>
193
- <div class="section" id="id8">
194
- <h3>Options<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
195
- <p>This argument has the following options:</p>
196
- <dl class="docutils">
197
- <dt><tt class="docutils literal"><span class="pre">-d</span> <span class="pre">DOWNLOAD_DIRECTORY</span></tt>, <tt class="docutils literal"><span class="pre">--dir</span> <span class="pre">DOWNLOAD_DIRECTORY</span></tt></dt>
198
- <dd>The directory in which cookbooks are located.</dd>
199
- <dt><tt class="docutils literal"><span class="pre">-f</span></tt>, <tt class="docutils literal"><span class="pre">--force</span></tt></dt>
200
- <dd>Use to overwrite an existing directory.</dd>
201
- <dt><tt class="docutils literal"><span class="pre">-N</span></tt>, <tt class="docutils literal"><span class="pre">--latest</span></tt></dt>
202
- <dd>Use to download the most recent version of a cookbook.</dd>
203
- </dl>
204
- </div>
205
- <div class="section" id="id9">
206
- <h3>Examples<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
207
- <p>The following examples show how to use this knife subcommand:</p>
208
- <p><strong>Download a cookbook</strong></p>
209
- <p>To download a cookbook named &#8220;smartmon&#8221;, enter:</p>
210
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook download smartmon
211
- </pre></div>
212
- </div>
213
- </div>
214
- </div>
215
- <div class="section" id="list">
216
- <h2>list<a class="headerlink" href="#list" title="Permalink to this headline">¶</a></h2>
217
- <p>The <tt class="docutils literal"><span class="pre">list</span></tt> 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.</p>
218
- <div class="section" id="id10">
219
- <h3>Syntax<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
220
- <p>This argument has the following syntax:</p>
221
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook list <span class="o">(</span>options<span class="o">)</span>
222
- </pre></div>
223
- </div>
224
- </div>
225
- <div class="section" id="id11">
226
- <h3>Options<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
227
- <p>This argument has the following options:</p>
228
- <dl class="docutils">
229
- <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
230
- <dd>Use to return all available versions for every cookbook.</dd>
231
- <dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
232
- <dd>Use to show the corresponding URIs.</dd>
233
- </dl>
234
- </div>
235
- <div class="section" id="id12">
236
- <h3>Examples<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
237
- <p>The following examples show how to use this knife subcommand:</p>
238
- <p><strong>View a list of cookbooks</strong></p>
239
- <p>To view a list of cookbooks:</p>
240
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook list
241
- </pre></div>
242
- </div>
243
- </div>
244
- </div>
245
- <div class="section" id="metadata">
246
- <h2>metadata<a class="headerlink" href="#metadata" title="Permalink to this headline">¶</a></h2>
247
- <p>The <tt class="docutils literal"><span class="pre">metadata</span></tt> argument is used to generate the metadata for one or more cookbooks.</p>
248
- <div class="section" id="id13">
249
- <h3>Syntax<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
250
- <p>This argument has the following syntax:</p>
251
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata <span class="o">(</span>options<span class="o">)</span>
252
- </pre></div>
253
- </div>
254
- </div>
255
- <div class="section" id="id14">
256
- <h3>Options<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3>
257
- <p>This argument has the following options:</p>
258
- <dl class="docutils">
259
- <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
260
- <dd>Use to generate metadata for all cookbooks.</dd>
261
- <dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH:PATH</span></tt></dt>
262
- <dd>The directory in which cookbooks are created. This can be a colon-separated path.</dd>
263
- </dl>
264
- </div>
265
- <div class="section" id="id15">
266
- <h3>Examples<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
267
- <p>The following examples show how to use this knife subcommand:</p>
268
- <p><strong>Generate metadata</strong></p>
269
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata -a
270
- </pre></div>
271
- </div>
272
- </div>
273
- </div>
274
- <div class="section" id="metadata-from-file">
275
- <h2>metadata from file<a class="headerlink" href="#metadata-from-file" title="Permalink to this headline">¶</a></h2>
276
- <p>The <tt class="docutils literal"><span class="pre">metadata</span> <span class="pre">from</span> <span class="pre">file</span></tt> argument is used to load the metadata for a cookbook from a file.</p>
277
- <div class="section" id="id16">
278
- <h3>Syntax<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3>
279
- <p>This argument has the following syntax:</p>
280
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata from file FILE
281
- </pre></div>
282
- </div>
283
- </div>
284
- <div class="section" id="id17">
285
- <h3>Options<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3>
286
- <p>This command does not have any specific options.</p>
287
- </div>
288
- <div class="section" id="id18">
289
- <h3>Examples<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3>
290
- <p>The following examples show how to use this knife subcommand:</p>
291
- <p><strong>View metadata</strong></p>
292
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata from file /path/to/file
293
- </pre></div>
294
- </div>
295
- </div>
296
- </div>
297
- <div class="section" id="show">
298
- <h2>show<a class="headerlink" href="#show" title="Permalink to this headline">¶</a></h2>
299
- <p>The <tt class="docutils literal"><span class="pre">show</span></tt> 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).</p>
300
- <div class="section" id="id19">
301
- <h3>Syntax<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h3>
302
- <p>This argument has the following syntax:</p>
303
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook show COOKBOOK_NAME <span class="o">[</span>COOKBOOK_VERSION<span class="o">]</span> <span class="o">[</span>PART...<span class="o">]</span> <span class="o">[</span>FILE_NAME<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span>
304
- </pre></div>
305
- </div>
306
- </div>
307
- <div class="section" id="id20">
308
- <h3>Options<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h3>
309
- <p>This argument has the following options:</p>
310
- <dl class="docutils">
311
- <dt><tt class="docutils literal"><span class="pre">COOKBOOK_VERSION</span></tt></dt>
312
- <dd>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.</dd>
313
- <dt><tt class="docutils literal"><span class="pre">-f</span> <span class="pre">FQDN</span></tt>, <tt class="docutils literal"><span class="pre">--fqdn</span> <span class="pre">FQDN</span></tt></dt>
314
- <dd>The FQDN of the host.</dd>
315
- <dt><tt class="docutils literal"><span class="pre">FILE_NAME</span></tt></dt>
316
- <dd>The name of a file that is associated with a cookbook.</dd>
317
- <dt><tt class="docutils literal"><span class="pre">-p</span> <span class="pre">PLATFORM</span></tt>, <tt class="docutils literal"><span class="pre">--platform</span> <span class="pre">PLATFORM</span></tt></dt>
318
- <dd>The platform for which a cookbook is designed.</dd>
319
- <dt><tt class="docutils literal"><span class="pre">PART</span></tt></dt>
320
- <dd>The part of the cookbook to show: <tt class="docutils literal"><span class="pre">attributes</span></tt>, <tt class="docutils literal"><span class="pre">definitions</span></tt>, <tt class="docutils literal"><span class="pre">files</span></tt>, <tt class="docutils literal"><span class="pre">libraries</span></tt>, <tt class="docutils literal"><span class="pre">providers</span></tt>, <tt class="docutils literal"><span class="pre">recipes</span></tt>, <tt class="docutils literal"><span class="pre">resources</span></tt>, or <tt class="docutils literal"><span class="pre">templates</span></tt>. More than one part can be specified.</dd>
321
- <dt><tt class="docutils literal"><span class="pre">-V</span> <span class="pre">PLATFORM_VERSION</span></tt>, <tt class="docutils literal"><span class="pre">--platform-version</span> <span class="pre">PLATFORM_VERSION</span></tt></dt>
322
- <dd>The version of the platform.</dd>
323
- <dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
324
- <dd>Use to show the corresponding URIs.</dd>
325
- </dl>
326
- </div>
327
- <div class="section" id="id21">
328
- <h3>Examples<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h3>
329
- <p>The following examples show how to use this knife subcommand:</p>
330
- <p><strong>Show cookbook data</strong></p>
331
- <p>To get the list of available versions of a cookbook named &#8220;getting-started&#8221;, enter:</p>
332
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook show getting-started
333
- </pre></div>
334
- </div>
335
- <p>to return something like:</p>
336
- <div class="highlight-bash"><div class="highlight"><pre>getting-started 0.3.0 0.2.0
337
- </pre></div>
338
- </div>
339
- <p><strong>Show cookbook versions</strong></p>
340
- <p>To show a list of data about a cookbook using the name of the cookbook and the version, enter:</p>
341
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook show getting-started 0.3.0
342
- </pre></div>
343
- </div>
344
- <p>to return something like:</p>
345
- <div class="highlight-bash"><div class="highlight"><pre>attributes:
346
- checksum: fa0fc4abf3f6787aeb5c3c5c35de667c
347
- name: default.rb
348
- path: attributes/default.rb
349
- specificity: default
350
- url: https://somelongurlhere.com
351
- chef_type: cookbook_version
352
- cookbook_name: getting-started
353
- definitions: <span class="o">[]</span>
354
- files: <span class="o">[]</span>
355
- frozen?: <span class="nb">false</span>
356
- json_class: Chef::CookbookVersion
357
- libraries: <span class="o">[]</span>
358
- </pre></div>
359
- </div>
360
- <p><strong>Show a cookbook version</strong></p>
361
- <p>To only view data about &#8220;templates&#8221;, enter:</p>
362
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook show getting-started 0.3.0 templates
363
- </pre></div>
364
- </div>
365
- <p>to return something like:</p>
366
- <div class="highlight-bash"><div class="highlight"><pre>checksum: a29d6f254577b830091f140c3a78b1fe
367
- name: chef-getting-started.txt.erb
368
- path: templates/default/chef-getting-started.txt.erb
369
- specificity: default
370
- url: https://someurlhere.com
371
- </pre></div>
372
- </div>
373
- <p><strong>Show cookbook data as JSON</strong></p>
374
- <p>To view information in JSON format, use the <tt class="docutils literal"><span class="pre">-F</span></tt> common option as part of the command like this:</p>
375
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role show devops -F json
376
- </pre></div>
377
- </div>
378
- <p>Other formats available include <tt class="docutils literal"><span class="pre">text</span></tt>, <tt class="docutils literal"><span class="pre">yaml</span></tt>, and <tt class="docutils literal"><span class="pre">pp</span></tt>.</p>
379
- </div>
380
- </div>
381
- <div class="section" id="test">
382
- <h2>test<a class="headerlink" href="#test" title="Permalink to this headline">¶</a></h2>
383
- <p>The <tt class="docutils literal"><span class="pre">test</span></tt> 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.</p>
384
- <div class="section" id="id22">
385
- <h3>Syntax<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3>
386
- <p>This argument has the following syntax:</p>
387
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook <span class="nb">test </span>COOKBOOK_NAME <span class="o">(</span>options<span class="o">)</span>
388
- </pre></div>
389
- </div>
390
- </div>
391
- <div class="section" id="id23">
392
- <h3>Options<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3>
393
- <p>This argument has the following options:</p>
394
- <dl class="docutils">
395
- <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
396
- <dd>Use to test all cookbooks.</dd>
397
- <dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH:PATH</span></tt></dt>
398
- <dd>The directory in which cookbooks are created. This can be a colon-separated path.</dd>
399
- </dl>
400
- </div>
401
- <div class="section" id="id24">
402
- <h3>Examples<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3>
403
- <p>The following examples show how to use this knife subcommand:</p>
404
- <p><strong>Test a cookbook</strong></p>
405
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook <span class="nb">test </span>cookbook_name
406
- </pre></div>
407
- </div>
408
- </div>
409
- </div>
410
- <div class="section" id="upload">
411
- <h2>upload<a class="headerlink" href="#upload" title="Permalink to this headline">¶</a></h2>
412
- <p>The <tt class="docutils literal"><span class="pre">upload</span></tt> 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.</p>
413
- <div class="admonition note">
414
- <p class="first admonition-title">Note</p>
415
- <p class="last">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 <tt class="docutils literal"><span class="pre">File.fnmatch</span></tt> syntax).</p>
416
- </div>
417
- <div class="admonition note">
418
- <p class="first admonition-title">Note</p>
419
- <p class="last">Empty directories are not uploaded to the Chef server. To upload an empty directory, create a &#8220;dot&#8221; file&#8212;e.g. <tt class="docutils literal"><span class="pre">.keep</span></tt>&#8212;in that directory to ensure that the directory itself is not empty.</p>
420
- </div>
421
- <div class="section" id="id25">
422
- <h3>Syntax<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h3>
423
- <p>This argument has the following syntax:</p>
424
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook upload <span class="o">[</span>COOKBOOK_NAME...<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span>
425
- </pre></div>
426
- </div>
427
- </div>
428
- <div class="section" id="id26">
429
- <h3>Options<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h3>
430
- <p>This argument has the following options:</p>
431
- <dl class="docutils">
432
- <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
433
- <dd>Use to upload all cookbooks.</dd>
434
- <dt><tt class="docutils literal"><span class="pre">--concurrency</span></tt></dt>
435
- <dd>The number of allowed concurrent connections. Default: <tt class="docutils literal"><span class="pre">10</span></tt>.</dd>
436
- <dt><tt class="docutils literal"><span class="pre">-d</span></tt>, <tt class="docutils literal"><span class="pre">--include-dependencies</span></tt></dt>
437
- <dd>Use to ensure that when a cookbook has a dependency on one (or more) cookbooks, those cookbooks will also be uploaded.</dd>
438
- <dt><tt class="docutils literal"><span class="pre">-E</span> <span class="pre">ENVIRONMENT</span></tt>, <tt class="docutils literal"><span class="pre">--environment</span> <span class="pre">ENVIRONMENT</span></tt></dt>
439
- <dd>Use to set the environment version dependency to the cookbook version being uploaded.</dd>
440
- <dt><tt class="docutils literal"><span class="pre">--force</span></tt></dt>
441
- <dd>Use to update a cookbook even if the <tt class="docutils literal"><span class="pre">--freeze</span></tt> flag has been set.</dd>
442
- <dt><tt class="docutils literal"><span class="pre">--freeze</span></tt></dt>
443
- <dd>Use to require changes to a cookbook be included as a new version. Only the <tt class="docutils literal"><span class="pre">--force</span></tt> option can override this setting.</dd>
444
- <dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH:PATH</span></tt></dt>
445
- <dd>The directory in which cookbooks are created. This can be a colon-separated path.</dd>
446
- </dl>
447
- </div>
448
- <div class="section" id="id27">
449
- <h3>Examples<a class="headerlink" href="#id27" title="Permalink to this headline">¶</a></h3>
450
- <p>The following examples show how to use this knife subcommand:</p>
451
- <p><strong>Upload a cookbook</strong></p>
452
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook upload cookbook_name
453
- </pre></div>
454
- </div>
455
- <p><strong>Freeze a cookbook</strong></p>
456
- <p>To upload a cookbook, and then prevent other users from being able to make changes to it, enter:</p>
457
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook upload redis --freeze
458
- </pre></div>
459
- </div>
460
- <p>to return something like:</p>
461
- <div class="highlight-bash"><div class="highlight"><pre>Uploading redis...
462
- Upload completed
463
- </pre></div>
464
- </div>
465
- <p>If a cookbook is frozen and the <tt class="docutils literal"><span class="pre">--force</span></tt> option is not specified, knife will return an error message similar to the following:</p>
466
- <div class="highlight-bash"><div class="highlight"><pre>Uploading redis...
467
- ERROR: Version 0.1.6 of cookbook redis is frozen. Use --force to override.
468
- </pre></div>
469
- </div>
470
- </div>
471
- </div>
472
- </div>
473
-
474
-
475
- </div>
476
-
477
- </div>
478
-
479
-
480
- <div class="clearer"></div>
481
- </div>
482
-
483
-
484
-
485
-
486
- </body>
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml">
6
+ <head>
7
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
+
9
+ <title>knife cookbook &mdash; chef-client Man Pages</title>
10
+
11
+ <link rel="stylesheet" href="_static/guide.css" type="text/css" />
12
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
+
14
+ <script type="text/javascript">
15
+ var DOCUMENTATION_OPTIONS = {
16
+ URL_ROOT: './',
17
+ VERSION: '',
18
+ COLLAPSE_INDEX: false,
19
+ FILE_SUFFIX: '.html',
20
+ HAS_SOURCE: true
21
+ };
22
+ </script>
23
+ <script type="text/javascript" src="_static/jquery.js"></script>
24
+ <script type="text/javascript" src="_static/underscore.js"></script>
25
+ <script type="text/javascript" src="_static/doctools.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px">
31
+ <a href="http://docs.getchef.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a>
32
+ </div>
33
+
34
+
35
+
36
+
37
+ <div class="document">
38
+ <div class="documentwrapper">
39
+
40
+ <div class="body">
41
+
42
+ <div class="section" id="knife-cookbook">
43
+ <h1>knife cookbook<a class="headerlink" href="#knife-cookbook" title="Permalink to this headline">¶</a></h1>
44
+ <p>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:</p>
45
+ <ul class="simple">
46
+ <li>Attribute values that are set on nodes</li>
47
+ <li>Definitions that allow the creation of reusable collections of resources</li>
48
+ <li>File distributions</li>
49
+ <li>Libraries that extend the chef-client and/or provide helpers to Ruby code</li>
50
+ <li>Recipes that specify which resources to manage and the order in which those resources will be applied</li>
51
+ <li>Custom resources and providers</li>
52
+ <li>Templates</li>
53
+ <li>Versions</li>
54
+ <li>Metadata about recipes (including dependencies), version constraints, supported platforms, and so on</li>
55
+ </ul>
56
+ <p>The <strong>knife cookbook</strong> subcommand is used to interact with cookbooks that are located on the Chef server or the local chef-repo.</p>
57
+ <div class="admonition note">
58
+ <p class="first admonition-title">Note</p>
59
+ <p class="last">Review the list of <a class="reference internal" href="knife_common_options.html"><em>common options</em></a> available to this (and all) knife subcommands and plugins.</p>
60
+ </div>
61
+ <div class="section" id="bulk-delete">
62
+ <h2>bulk delete<a class="headerlink" href="#bulk-delete" title="Permalink to this headline">¶</a></h2>
63
+ <p>The <tt class="docutils literal"><span class="pre">bulk</span> <span class="pre">delete</span></tt> 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 (/).</p>
64
+ <div class="section" id="syntax">
65
+ <h3>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h3>
66
+ <p>This argument has the following syntax:</p>
67
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook bulk delete REGEX <span class="o">(</span>options<span class="o">)</span>
68
+ </pre></div>
69
+ </div>
70
+ </div>
71
+ <div class="section" id="options">
72
+ <h3>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h3>
73
+ <p>This argument has the following options:</p>
74
+ <dl class="docutils">
75
+ <dt><tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--purge</span></tt></dt>
76
+ <dd>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.</dd>
77
+ </dl>
78
+ </div>
79
+ <div class="section" id="examples">
80
+ <h3>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3>
81
+ <p>The following examples show how to use this knife subcommand:</p>
82
+ <p><strong>Bulk delete many cookbooks</strong></p>
83
+ <p>Use a regular expression to define the pattern used to bulk delete cookbooks:</p>
84
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook bulk delete <span class="s2">&quot;^[0-9]{3}$&quot;</span> -p
85
+ </pre></div>
86
+ </div>
87
+ </div>
88
+ </div>
89
+ <div class="section" id="create">
90
+ <h2>create<a class="headerlink" href="#create" title="Permalink to this headline">¶</a></h2>
91
+ <p>The <tt class="docutils literal"><span class="pre">create</span></tt> argument is used to create a new cookbook directory on the local machine, including the following directories and files:</p>
92
+ <blockquote>
93
+ <div><ul class="simple">
94
+ <li>cookbook/attributes</li>
95
+ <li>cookbook/CHANGELOG.md</li>
96
+ <li>cookbook/definitions</li>
97
+ <li>cookbook/files/default</li>
98
+ <li>cookbook/libraries</li>
99
+ <li>cookbook/metadata.rb</li>
100
+ <li>cookbook/providers</li>
101
+ <li>cookbook/README.md (or .rdoc)</li>
102
+ <li>cookbook/recipes/default.rb</li>
103
+ <li>cookbook/resources</li>
104
+ <li>cookbook/templates/default</li>
105
+ </ul>
106
+ </div></blockquote>
107
+ <p>After the cookbook is created, it can be uploaded to the Chef server using the <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">upload</span></tt> argument.</p>
108
+ <div class="section" id="id1">
109
+ <h3>Syntax<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
110
+ <p>This argument has the following syntax:</p>
111
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook create COOKBOOK_NAME <span class="o">(</span>options<span class="o">)</span>
112
+ </pre></div>
113
+ </div>
114
+ </div>
115
+ <div class="section" id="id2">
116
+ <h3>Options<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
117
+ <p>This argument has the following options:</p>
118
+ <dl class="docutils">
119
+ <dt><tt class="docutils literal"><span class="pre">-C</span> <span class="pre">COPYRIGHT_HOLDER</span></tt>, <tt class="docutils literal"><span class="pre">--copyright</span> <span class="pre">COPYRIGHT_HOLDER</span></tt></dt>
120
+ <dd>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 &#8220;your_company_name&#8221; will be used instead; it can be easily modified later.</dd>
121
+ <dt><tt class="docutils literal"><span class="pre">-I</span> <span class="pre">LICENSE</span></tt>, <tt class="docutils literal"><span class="pre">--license</span> <span class="pre">LICENSE</span></tt></dt>
122
+ <dd>The type of license under which a cookbook is distributed: <tt class="docutils literal"><span class="pre">apachev2</span></tt>, <tt class="docutils literal"><span class="pre">gplv2</span></tt>, <tt class="docutils literal"><span class="pre">gplv3</span></tt>, <tt class="docutils literal"><span class="pre">mit</span></tt>, or <tt class="docutils literal"><span class="pre">none</span></tt> (default). This option will place the appropriate license notice in the pre-created files: <tt class="docutils literal"><span class="pre">Apache</span> <span class="pre">v2.0</span></tt> (for <tt class="docutils literal"><span class="pre">apachev2</span></tt>), <tt class="docutils literal"><span class="pre">GPL</span> <span class="pre">v2</span></tt> (for <tt class="docutils literal"><span class="pre">gplv2</span></tt>), <tt class="docutils literal"><span class="pre">GPL</span> <span class="pre">v3</span></tt> (for <tt class="docutils literal"><span class="pre">gplv3</span></tt>), <tt class="docutils literal"><span class="pre">MIT</span></tt> (for <tt class="docutils literal"><span class="pre">mit</span></tt>), or <tt class="docutils literal"><span class="pre">license</span> <span class="pre">'Proprietary</span> <span class="pre">-</span> <span class="pre">All</span> <span class="pre">Rights</span> <span class="pre">Reserved</span></tt> (for <tt class="docutils literal"><span class="pre">none</span></tt>). Be aware of the licenses for files inside of a cookbook and be sure to follow any restrictions they describe.</dd>
123
+ <dt><tt class="docutils literal"><span class="pre">-m</span> <span class="pre">EMAIL</span></tt>, <tt class="docutils literal"><span class="pre">--email</span> <span class="pre">EMAIL</span></tt></dt>
124
+ <dd>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 &#8220;your_email&#8221; will be used instead; it can be easily modified later.</dd>
125
+ <dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH</span></tt></dt>
126
+ <dd>The directory in which cookbooks are created. This can be a colon-separated path.</dd>
127
+ <dt><tt class="docutils literal"><span class="pre">-r</span> <span class="pre">FORMAT</span></tt>, <tt class="docutils literal"><span class="pre">--readme-format</span> <span class="pre">FORMAT</span></tt></dt>
128
+ <dd>The document format of the readme file: <tt class="docutils literal"><span class="pre">md</span></tt> (markdown) and <tt class="docutils literal"><span class="pre">rdoc</span></tt> (Ruby docs).</dd>
129
+ </dl>
130
+ </div>
131
+ <div class="section" id="id3">
132
+ <h3>Examples<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
133
+ <p>The following examples show how to use this knife subcommand:</p>
134
+ <p><strong>Create a cookbook</strong></p>
135
+ <p>To create a cookbook named &#8220;my_cookbook&#8221; with copyright, email, license, and readme format options specified, enter:</p>
136
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook create my_cookbook -C <span class="s2">&quot;My Name&quot;</span> -m <span class="s2">&quot;my@email.com&quot;</span> -I apachev2 -r md
137
+ </pre></div>
138
+ </div>
139
+ <p>to return something like:</p>
140
+ <div class="highlight-bash"><div class="highlight"><pre>** Creating cookbook my_cookbook
141
+ ** Creating README <span class="k">for </span>cookbook: my_cookbook
142
+ ** Creating metadata <span class="k">for </span>cookbook: my_cookbook
143
+ </pre></div>
144
+ </div>
145
+ </div>
146
+ </div>
147
+ <div class="section" id="delete">
148
+ <h2>delete<a class="headerlink" href="#delete" title="Permalink to this headline">¶</a></h2>
149
+ <p>The <tt class="docutils literal"><span class="pre">delete</span></tt> argument is used to delete a specified cookbook or cookbook version on the Chef server (and not locally).</p>
150
+ <div class="section" id="id4">
151
+ <h3>Syntax<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
152
+ <p>This argument has the following syntax:</p>
153
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook delete COOKBOOK_NAME <span class="o">[</span>COOKBOOK_VERSION<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span>
154
+ </pre></div>
155
+ </div>
156
+ </div>
157
+ <div class="section" id="id5">
158
+ <h3>Options<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
159
+ <p>This argument has the following options:</p>
160
+ <dl class="docutils">
161
+ <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
162
+ <dd>Use to delete all cookbooks (and cookbook versions).</dd>
163
+ <dt><tt class="docutils literal"><span class="pre">COOKBOOK_VERSION</span></tt></dt>
164
+ <dd>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.</dd>
165
+ <dt><tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--purge</span></tt></dt>
166
+ <dd>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.</dd>
167
+ </dl>
168
+ </div>
169
+ <div class="section" id="id6">
170
+ <h3>Examples<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
171
+ <p>The following examples show how to use this knife subcommand:</p>
172
+ <p><strong>Delete a cookbook</strong></p>
173
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook delete cookbook_name version
174
+ </pre></div>
175
+ </div>
176
+ <p>For example:</p>
177
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook delete smartmon 0.8
178
+ </pre></div>
179
+ </div>
180
+ <p>Type <tt class="docutils literal"><span class="pre">Y</span></tt> to confirm a deletion.</p>
181
+ </div>
182
+ </div>
183
+ <div class="section" id="download">
184
+ <h2>download<a class="headerlink" href="#download" title="Permalink to this headline">¶</a></h2>
185
+ <p>The <tt class="docutils literal"><span class="pre">download</span></tt> argument is used to download a cookbook from the Chef server to the current working directory.</p>
186
+ <div class="section" id="id7">
187
+ <h3>Syntax<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
188
+ <p>This argument has the following syntax:</p>
189
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook download COOKBOOK_NAME <span class="o">[</span>COOKBOOK_VERSION<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span>
190
+ </pre></div>
191
+ </div>
192
+ </div>
193
+ <div class="section" id="id8">
194
+ <h3>Options<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
195
+ <p>This argument has the following options:</p>
196
+ <dl class="docutils">
197
+ <dt><tt class="docutils literal"><span class="pre">-d</span> <span class="pre">DOWNLOAD_DIRECTORY</span></tt>, <tt class="docutils literal"><span class="pre">--dir</span> <span class="pre">DOWNLOAD_DIRECTORY</span></tt></dt>
198
+ <dd>The directory in which cookbooks are located.</dd>
199
+ <dt><tt class="docutils literal"><span class="pre">-f</span></tt>, <tt class="docutils literal"><span class="pre">--force</span></tt></dt>
200
+ <dd>Use to overwrite an existing directory.</dd>
201
+ <dt><tt class="docutils literal"><span class="pre">-N</span></tt>, <tt class="docutils literal"><span class="pre">--latest</span></tt></dt>
202
+ <dd>Use to download the most recent version of a cookbook.</dd>
203
+ </dl>
204
+ </div>
205
+ <div class="section" id="id9">
206
+ <h3>Examples<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
207
+ <p>The following examples show how to use this knife subcommand:</p>
208
+ <p><strong>Download a cookbook</strong></p>
209
+ <p>To download a cookbook named &#8220;smartmon&#8221;, enter:</p>
210
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook download smartmon
211
+ </pre></div>
212
+ </div>
213
+ </div>
214
+ </div>
215
+ <div class="section" id="list">
216
+ <h2>list<a class="headerlink" href="#list" title="Permalink to this headline">¶</a></h2>
217
+ <p>The <tt class="docutils literal"><span class="pre">list</span></tt> 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.</p>
218
+ <div class="section" id="id10">
219
+ <h3>Syntax<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
220
+ <p>This argument has the following syntax:</p>
221
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook list <span class="o">(</span>options<span class="o">)</span>
222
+ </pre></div>
223
+ </div>
224
+ </div>
225
+ <div class="section" id="id11">
226
+ <h3>Options<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
227
+ <p>This argument has the following options:</p>
228
+ <dl class="docutils">
229
+ <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
230
+ <dd>Use to return all available versions for every cookbook.</dd>
231
+ <dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
232
+ <dd>Use to show the corresponding URIs.</dd>
233
+ </dl>
234
+ </div>
235
+ <div class="section" id="id12">
236
+ <h3>Examples<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
237
+ <p>The following examples show how to use this knife subcommand:</p>
238
+ <p><strong>View a list of cookbooks</strong></p>
239
+ <p>To view a list of cookbooks:</p>
240
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook list
241
+ </pre></div>
242
+ </div>
243
+ </div>
244
+ </div>
245
+ <div class="section" id="metadata">
246
+ <h2>metadata<a class="headerlink" href="#metadata" title="Permalink to this headline">¶</a></h2>
247
+ <p>The <tt class="docutils literal"><span class="pre">metadata</span></tt> argument is used to generate the metadata for one or more cookbooks.</p>
248
+ <div class="section" id="id13">
249
+ <h3>Syntax<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
250
+ <p>This argument has the following syntax:</p>
251
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata <span class="o">(</span>options<span class="o">)</span>
252
+ </pre></div>
253
+ </div>
254
+ </div>
255
+ <div class="section" id="id14">
256
+ <h3>Options<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3>
257
+ <p>This argument has the following options:</p>
258
+ <dl class="docutils">
259
+ <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
260
+ <dd>Use to generate metadata for all cookbooks.</dd>
261
+ <dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH:PATH</span></tt></dt>
262
+ <dd>The directory in which cookbooks are created. This can be a colon-separated path.</dd>
263
+ </dl>
264
+ </div>
265
+ <div class="section" id="id15">
266
+ <h3>Examples<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
267
+ <p>The following examples show how to use this knife subcommand:</p>
268
+ <p><strong>Generate metadata</strong></p>
269
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata -a
270
+ </pre></div>
271
+ </div>
272
+ </div>
273
+ </div>
274
+ <div class="section" id="metadata-from-file">
275
+ <h2>metadata from file<a class="headerlink" href="#metadata-from-file" title="Permalink to this headline">¶</a></h2>
276
+ <p>The <tt class="docutils literal"><span class="pre">metadata</span> <span class="pre">from</span> <span class="pre">file</span></tt> argument is used to load the metadata for a cookbook from a file.</p>
277
+ <div class="section" id="id16">
278
+ <h3>Syntax<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3>
279
+ <p>This argument has the following syntax:</p>
280
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata from file FILE
281
+ </pre></div>
282
+ </div>
283
+ </div>
284
+ <div class="section" id="id17">
285
+ <h3>Options<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3>
286
+ <p>This command does not have any specific options.</p>
287
+ </div>
288
+ <div class="section" id="id18">
289
+ <h3>Examples<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3>
290
+ <p>The following examples show how to use this knife subcommand:</p>
291
+ <p><strong>View metadata</strong></p>
292
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata from file /path/to/file
293
+ </pre></div>
294
+ </div>
295
+ </div>
296
+ </div>
297
+ <div class="section" id="show">
298
+ <h2>show<a class="headerlink" href="#show" title="Permalink to this headline">¶</a></h2>
299
+ <p>The <tt class="docutils literal"><span class="pre">show</span></tt> 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).</p>
300
+ <div class="section" id="id19">
301
+ <h3>Syntax<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h3>
302
+ <p>This argument has the following syntax:</p>
303
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook show COOKBOOK_NAME <span class="o">[</span>COOKBOOK_VERSION<span class="o">]</span> <span class="o">[</span>PART...<span class="o">]</span> <span class="o">[</span>FILE_NAME<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span>
304
+ </pre></div>
305
+ </div>
306
+ </div>
307
+ <div class="section" id="id20">
308
+ <h3>Options<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h3>
309
+ <p>This argument has the following options:</p>
310
+ <dl class="docutils">
311
+ <dt><tt class="docutils literal"><span class="pre">COOKBOOK_VERSION</span></tt></dt>
312
+ <dd>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.</dd>
313
+ <dt><tt class="docutils literal"><span class="pre">-f</span> <span class="pre">FQDN</span></tt>, <tt class="docutils literal"><span class="pre">--fqdn</span> <span class="pre">FQDN</span></tt></dt>
314
+ <dd>The FQDN of the host.</dd>
315
+ <dt><tt class="docutils literal"><span class="pre">FILE_NAME</span></tt></dt>
316
+ <dd>The name of a file that is associated with a cookbook.</dd>
317
+ <dt><tt class="docutils literal"><span class="pre">-p</span> <span class="pre">PLATFORM</span></tt>, <tt class="docutils literal"><span class="pre">--platform</span> <span class="pre">PLATFORM</span></tt></dt>
318
+ <dd>The platform for which a cookbook is designed.</dd>
319
+ <dt><tt class="docutils literal"><span class="pre">PART</span></tt></dt>
320
+ <dd>The part of the cookbook to show: <tt class="docutils literal"><span class="pre">attributes</span></tt>, <tt class="docutils literal"><span class="pre">definitions</span></tt>, <tt class="docutils literal"><span class="pre">files</span></tt>, <tt class="docutils literal"><span class="pre">libraries</span></tt>, <tt class="docutils literal"><span class="pre">providers</span></tt>, <tt class="docutils literal"><span class="pre">recipes</span></tt>, <tt class="docutils literal"><span class="pre">resources</span></tt>, or <tt class="docutils literal"><span class="pre">templates</span></tt>. More than one part can be specified.</dd>
321
+ <dt><tt class="docutils literal"><span class="pre">-V</span> <span class="pre">PLATFORM_VERSION</span></tt>, <tt class="docutils literal"><span class="pre">--platform-version</span> <span class="pre">PLATFORM_VERSION</span></tt></dt>
322
+ <dd>The version of the platform.</dd>
323
+ <dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
324
+ <dd>Use to show the corresponding URIs.</dd>
325
+ </dl>
326
+ </div>
327
+ <div class="section" id="id21">
328
+ <h3>Examples<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h3>
329
+ <p>The following examples show how to use this knife subcommand:</p>
330
+ <p><strong>Show cookbook data</strong></p>
331
+ <p>To get the list of available versions of a cookbook named &#8220;getting-started&#8221;, enter:</p>
332
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook show getting-started
333
+ </pre></div>
334
+ </div>
335
+ <p>to return something like:</p>
336
+ <div class="highlight-bash"><div class="highlight"><pre>getting-started 0.3.0 0.2.0
337
+ </pre></div>
338
+ </div>
339
+ <p><strong>Show cookbook versions</strong></p>
340
+ <p>To show a list of data about a cookbook using the name of the cookbook and the version, enter:</p>
341
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook show getting-started 0.3.0
342
+ </pre></div>
343
+ </div>
344
+ <p>to return something like:</p>
345
+ <div class="highlight-bash"><div class="highlight"><pre>attributes:
346
+ checksum: fa0fc4abf3f6787aeb5c3c5c35de667c
347
+ name: default.rb
348
+ path: attributes/default.rb
349
+ specificity: default
350
+ url: https://somelongurlhere.com
351
+ chef_type: cookbook_version
352
+ cookbook_name: getting-started
353
+ definitions: <span class="o">[]</span>
354
+ files: <span class="o">[]</span>
355
+ frozen?: <span class="nb">false</span>
356
+ json_class: Chef::CookbookVersion
357
+ libraries: <span class="o">[]</span>
358
+ </pre></div>
359
+ </div>
360
+ <p><strong>Show a cookbook version</strong></p>
361
+ <p>To only view data about &#8220;templates&#8221;, enter:</p>
362
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook show getting-started 0.3.0 templates
363
+ </pre></div>
364
+ </div>
365
+ <p>to return something like:</p>
366
+ <div class="highlight-bash"><div class="highlight"><pre>checksum: a29d6f254577b830091f140c3a78b1fe
367
+ name: chef-getting-started.txt.erb
368
+ path: templates/default/chef-getting-started.txt.erb
369
+ specificity: default
370
+ url: https://someurlhere.com
371
+ </pre></div>
372
+ </div>
373
+ <p><strong>Show cookbook data as JSON</strong></p>
374
+ <p>To view information in JSON format, use the <tt class="docutils literal"><span class="pre">-F</span></tt> common option as part of the command like this:</p>
375
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role show devops -F json
376
+ </pre></div>
377
+ </div>
378
+ <p>Other formats available include <tt class="docutils literal"><span class="pre">text</span></tt>, <tt class="docutils literal"><span class="pre">yaml</span></tt>, and <tt class="docutils literal"><span class="pre">pp</span></tt>.</p>
379
+ </div>
380
+ </div>
381
+ <div class="section" id="test">
382
+ <h2>test<a class="headerlink" href="#test" title="Permalink to this headline">¶</a></h2>
383
+ <p>The <tt class="docutils literal"><span class="pre">test</span></tt> 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.</p>
384
+ <div class="section" id="id22">
385
+ <h3>Syntax<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3>
386
+ <p>This argument has the following syntax:</p>
387
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook <span class="nb">test </span>COOKBOOK_NAME <span class="o">(</span>options<span class="o">)</span>
388
+ </pre></div>
389
+ </div>
390
+ </div>
391
+ <div class="section" id="id23">
392
+ <h3>Options<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3>
393
+ <p>This argument has the following options:</p>
394
+ <dl class="docutils">
395
+ <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
396
+ <dd>Use to test all cookbooks.</dd>
397
+ <dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH:PATH</span></tt></dt>
398
+ <dd>The directory in which cookbooks are created. This can be a colon-separated path.</dd>
399
+ </dl>
400
+ </div>
401
+ <div class="section" id="id24">
402
+ <h3>Examples<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3>
403
+ <p>The following examples show how to use this knife subcommand:</p>
404
+ <p><strong>Test a cookbook</strong></p>
405
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook <span class="nb">test </span>cookbook_name
406
+ </pre></div>
407
+ </div>
408
+ </div>
409
+ </div>
410
+ <div class="section" id="upload">
411
+ <h2>upload<a class="headerlink" href="#upload" title="Permalink to this headline">¶</a></h2>
412
+ <p>The <tt class="docutils literal"><span class="pre">upload</span></tt> 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.</p>
413
+ <div class="admonition note">
414
+ <p class="first admonition-title">Note</p>
415
+ <p class="last">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 <tt class="docutils literal"><span class="pre">File.fnmatch</span></tt> syntax).</p>
416
+ </div>
417
+ <div class="admonition note">
418
+ <p class="first admonition-title">Note</p>
419
+ <p class="last">Empty directories are not uploaded to the Chef server. To upload an empty directory, create a &#8220;dot&#8221; file&#8212;e.g. <tt class="docutils literal"><span class="pre">.keep</span></tt>&#8212;in that directory to ensure that the directory itself is not empty.</p>
420
+ </div>
421
+ <div class="section" id="id25">
422
+ <h3>Syntax<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h3>
423
+ <p>This argument has the following syntax:</p>
424
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook upload <span class="o">[</span>COOKBOOK_NAME...<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span>
425
+ </pre></div>
426
+ </div>
427
+ </div>
428
+ <div class="section" id="id26">
429
+ <h3>Options<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h3>
430
+ <p>This argument has the following options:</p>
431
+ <dl class="docutils">
432
+ <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
433
+ <dd>Use to upload all cookbooks.</dd>
434
+ <dt><tt class="docutils literal"><span class="pre">--concurrency</span></tt></dt>
435
+ <dd>The number of allowed concurrent connections. Default: <tt class="docutils literal"><span class="pre">10</span></tt>.</dd>
436
+ <dt><tt class="docutils literal"><span class="pre">-d</span></tt>, <tt class="docutils literal"><span class="pre">--include-dependencies</span></tt></dt>
437
+ <dd>Use to ensure that when a cookbook has a dependency on one (or more) cookbooks, those cookbooks will also be uploaded.</dd>
438
+ <dt><tt class="docutils literal"><span class="pre">-E</span> <span class="pre">ENVIRONMENT</span></tt>, <tt class="docutils literal"><span class="pre">--environment</span> <span class="pre">ENVIRONMENT</span></tt></dt>
439
+ <dd>Use to set the environment version dependency to the cookbook version being uploaded.</dd>
440
+ <dt><tt class="docutils literal"><span class="pre">--force</span></tt></dt>
441
+ <dd>Use to update a cookbook even if the <tt class="docutils literal"><span class="pre">--freeze</span></tt> flag has been set.</dd>
442
+ <dt><tt class="docutils literal"><span class="pre">--freeze</span></tt></dt>
443
+ <dd>Use to require changes to a cookbook be included as a new version. Only the <tt class="docutils literal"><span class="pre">--force</span></tt> option can override this setting.</dd>
444
+ <dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">PATH:PATH</span></tt>, <tt class="docutils literal"><span class="pre">--cookbook-path</span> <span class="pre">PATH:PATH</span></tt></dt>
445
+ <dd>The directory in which cookbooks are created. This can be a colon-separated path.</dd>
446
+ </dl>
447
+ </div>
448
+ <div class="section" id="id27">
449
+ <h3>Examples<a class="headerlink" href="#id27" title="Permalink to this headline">¶</a></h3>
450
+ <p>The following examples show how to use this knife subcommand:</p>
451
+ <p><strong>Upload a cookbook</strong></p>
452
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook upload cookbook_name
453
+ </pre></div>
454
+ </div>
455
+ <p><strong>Freeze a cookbook</strong></p>
456
+ <p>To upload a cookbook, and then prevent other users from being able to make changes to it, enter:</p>
457
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook upload redis --freeze
458
+ </pre></div>
459
+ </div>
460
+ <p>to return something like:</p>
461
+ <div class="highlight-bash"><div class="highlight"><pre>Uploading redis...
462
+ Upload completed
463
+ </pre></div>
464
+ </div>
465
+ <p>If a cookbook is frozen and the <tt class="docutils literal"><span class="pre">--force</span></tt> option is not specified, knife will return an error message similar to the following:</p>
466
+ <div class="highlight-bash"><div class="highlight"><pre>Uploading redis...
467
+ ERROR: Version 0.1.6 of cookbook redis is frozen. Use --force to override.
468
+ </pre></div>
469
+ </div>
470
+ </div>
471
+ </div>
472
+ </div>
473
+
474
+
475
+ </div>
476
+
477
+ </div>
478
+
479
+
480
+ <div class="clearer"></div>
481
+ </div>
482
+
483
+
484
+
485
+
486
+ </body>
487
487
  </html>