chef 11.10.0.rc.0 → 11.10.0.rc.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (401) hide show
  1. data/Rakefile +0 -75
  2. data/distro/common/html/_sources/ctl_chef_client.txt +36 -0
  3. data/distro/common/html/_sources/ctl_chef_server.txt +26 -0
  4. data/distro/common/html/_sources/ctl_chef_shell.txt +15 -0
  5. data/distro/common/html/_sources/ctl_chef_solo.txt +25 -0
  6. data/distro/common/html/_sources/index.txt +126 -0
  7. data/distro/common/html/_sources/knife.txt +74 -0
  8. data/distro/common/html/_sources/knife_bootstrap.txt +56 -0
  9. data/distro/common/html/_sources/knife_client.txt +151 -0
  10. data/distro/common/html/_sources/knife_common_options.txt +6 -0
  11. data/distro/common/html/_sources/knife_configure.txt +29 -0
  12. data/distro/common/html/_sources/knife_cookbook.txt +236 -0
  13. data/distro/common/html/_sources/knife_cookbook_site.txt +157 -0
  14. data/distro/common/html/_sources/knife_data_bag.txt +160 -0
  15. data/distro/common/html/_sources/knife_delete.txt +26 -0
  16. data/distro/common/html/_sources/knife_deps.txt +61 -0
  17. data/distro/common/html/_sources/knife_diff.txt +34 -0
  18. data/distro/common/html/_sources/knife_download.txt +44 -0
  19. data/distro/common/html/_sources/knife_edit.txt +26 -0
  20. data/distro/common/html/_sources/knife_environment.txt +158 -0
  21. data/distro/common/html/_sources/knife_exec.txt +47 -0
  22. data/distro/common/html/_sources/knife_index_rebuild.txt +21 -0
  23. data/distro/common/html/_sources/knife_list.txt +33 -0
  24. data/distro/common/html/_sources/knife_node.txt +250 -0
  25. data/distro/common/html/_sources/knife_raw.txt +35 -0
  26. data/distro/common/html/_sources/knife_recipe_list.txt +23 -0
  27. data/distro/common/html/_sources/knife_role.txt +157 -0
  28. data/distro/common/html/_sources/knife_search.txt +53 -0
  29. data/distro/common/html/_sources/knife_show.txt +27 -0
  30. data/distro/common/html/_sources/knife_ssh.txt +43 -0
  31. data/distro/common/html/_sources/knife_status.txt +37 -0
  32. data/distro/common/html/_sources/knife_tag.txt +69 -0
  33. data/distro/common/html/_sources/knife_upload.txt +49 -0
  34. data/distro/common/html/_sources/knife_user.txt +127 -0
  35. data/distro/common/html/_sources/knife_using.txt +43 -0
  36. data/distro/common/html/_sources/knife_xargs.txt +30 -0
  37. data/distro/common/html/_static/ajax-loader.gif +0 -0
  38. data/distro/common/html/_static/basic.css +540 -0
  39. data/distro/common/html/_static/chef.css +507 -0
  40. data/distro/common/html/_static/chef.ico +0 -0
  41. data/distro/common/html/_static/chef_html_logo.png +0 -0
  42. data/distro/common/html/_static/chef_logo.png +0 -0
  43. data/distro/common/html/_static/comment-bright.png +0 -0
  44. data/distro/common/html/_static/comment-close.png +0 -0
  45. data/distro/common/html/_static/comment.png +0 -0
  46. data/distro/common/html/_static/contents.png +0 -0
  47. data/distro/common/html/_static/doctools.js +247 -0
  48. data/distro/common/html/_static/down-pressed.png +0 -0
  49. data/distro/common/html/_static/down.png +0 -0
  50. data/distro/common/html/_static/file.png +0 -0
  51. data/distro/common/html/_static/guide.css +505 -0
  52. data/distro/common/html/_static/jquery.js +154 -0
  53. data/distro/common/html/_static/minus.png +0 -0
  54. data/distro/common/html/_static/navigation.png +0 -0
  55. data/distro/common/html/_static/plus.png +0 -0
  56. data/distro/common/html/_static/pygments.css +62 -0
  57. data/distro/common/html/_static/searchtools.js +560 -0
  58. data/distro/common/html/_static/underscore.js +23 -0
  59. data/distro/common/html/_static/up-pressed.png +0 -0
  60. data/distro/common/html/_static/up.png +0 -0
  61. data/distro/common/html/_static/websupport.js +808 -0
  62. data/distro/common/html/ctl_chef_client.html +219 -0
  63. data/distro/common/html/ctl_chef_server.html +111 -0
  64. data/distro/common/html/ctl_chef_shell.html +120 -0
  65. data/distro/common/html/ctl_chef_solo.html +144 -0
  66. data/distro/common/html/index.html +185 -0
  67. data/distro/common/html/knife.html +172 -0
  68. data/distro/common/html/knife_bootstrap.html +250 -0
  69. data/distro/common/html/knife_client.html +283 -0
  70. data/distro/common/html/knife_common_options.html +98 -0
  71. data/distro/common/html/knife_configure.html +107 -0
  72. data/distro/common/html/knife_cookbook.html +481 -0
  73. data/distro/common/html/knife_cookbook_site.html +372 -0
  74. data/distro/common/html/knife_data_bag.html +359 -0
  75. data/distro/common/html/knife_delete.html +95 -0
  76. data/distro/common/html/knife_deps.html +145 -0
  77. data/distro/common/html/knife_diff.html +125 -0
  78. data/distro/common/html/knife_download.html +147 -0
  79. data/distro/common/html/knife_edit.html +91 -0
  80. data/distro/common/html/knife_environment.html +328 -0
  81. data/distro/common/html/knife_exec.html +222 -0
  82. data/distro/common/html/knife_index_rebuild.html +85 -0
  83. data/distro/common/html/knife_list.html +116 -0
  84. data/distro/common/html/knife_node.html +450 -0
  85. data/distro/common/html/knife_raw.html +112 -0
  86. data/distro/common/html/knife_recipe_list.html +93 -0
  87. data/distro/common/html/knife_role.html +295 -0
  88. data/distro/common/html/knife_search.html +204 -0
  89. data/distro/common/html/knife_show.html +106 -0
  90. data/distro/common/html/knife_ssh.html +179 -0
  91. data/distro/common/html/knife_status.html +142 -0
  92. data/distro/common/html/knife_tag.html +140 -0
  93. data/distro/common/html/knife_upload.html +155 -0
  94. data/distro/common/html/knife_user.html +244 -0
  95. data/distro/common/html/knife_using.html +211 -0
  96. data/distro/common/html/knife_xargs.html +115 -0
  97. data/distro/common/html/objects.inv +0 -0
  98. data/distro/common/html/search.html +84 -0
  99. data/distro/common/html/searchindex.js +1 -0
  100. data/distro/common/man/man1/chef-shell.1 +5 -5
  101. data/distro/common/man/man1/knife-bootstrap.1 +6 -9
  102. data/distro/common/man/man1/knife-client.1 +1 -9
  103. data/distro/common/man/man1/knife-configure.1 +10 -6
  104. data/distro/common/man/man1/knife-cookbook-site.1 +1 -9
  105. data/distro/common/man/man1/knife-cookbook.1 +11 -21
  106. data/distro/common/man/man1/knife-data-bag.1 +8 -22
  107. data/distro/common/man/man1/knife-delete.1 +1 -1
  108. data/distro/common/man/man1/knife-deps.1 +4 -12
  109. data/distro/common/man/man1/knife-diff.1 +1 -1
  110. data/distro/common/man/man1/knife-download.1 +2 -2
  111. data/distro/common/man/man1/knife-edit.1 +1 -1
  112. data/distro/common/man/man1/knife-environment.1 +108 -9
  113. data/distro/common/man/man1/knife-exec.1 +1 -15
  114. data/distro/common/man/man1/knife-index-rebuild.1 +1 -1
  115. data/distro/common/man/man1/knife-list.1 +1 -1
  116. data/distro/common/man/man1/knife-node.1 +3 -13
  117. data/distro/common/man/man1/knife-raw.1 +1 -1
  118. data/distro/common/man/man1/knife-recipe-list.1 +1 -1
  119. data/distro/common/man/man1/knife-role.1 +2 -12
  120. data/distro/common/man/man1/knife-search.1 +5 -5
  121. data/distro/common/man/man1/knife-show.1 +1 -3
  122. data/distro/common/man/man1/knife-ssh.1 +1 -5
  123. data/distro/common/man/man1/knife-status.1 +1 -1
  124. data/distro/common/man/man1/knife-tag.1 +1 -9
  125. data/distro/common/man/man1/knife-upload.1 +7 -9
  126. data/distro/common/man/man1/knife-user.1 +3 -17
  127. data/distro/common/man/man1/knife-xargs.1 +1 -3
  128. data/distro/common/man/man8/chef-client.8 +18 -18
  129. data/distro/common/man/man8/chef-solo.8 +12 -6
  130. data/lib/chef/client.rb +9 -5
  131. data/lib/chef/cookbook_uploader.rb +1 -1
  132. data/lib/chef/dsl/recipe.rb +119 -38
  133. data/lib/chef/exceptions.rb +4 -0
  134. data/lib/chef/policy_builder/expand_node_object.rb +11 -4
  135. data/lib/chef/policy_builder/policyfile.rb +7 -1
  136. data/lib/chef/provider/file.rb +1 -0
  137. data/lib/chef/resource_platform_map.rb +1 -1
  138. data/lib/chef/resource_reporter.rb +2 -2
  139. data/lib/chef/version.rb +1 -1
  140. data/spec/functional/knife/cookbook_delete_spec.rb +9 -9
  141. data/spec/functional/knife/ssh_spec.rb +1 -1
  142. data/spec/functional/resource/link_spec.rb +6 -6
  143. data/spec/functional/resource/registry_spec.rb +7 -7
  144. data/spec/functional/run_lock_spec.rb +1 -1
  145. data/spec/integration/knife/download_spec.rb +1 -1
  146. data/spec/integration/solo/solo_spec.rb +1 -1
  147. data/spec/spec_helper.rb +0 -1
  148. data/spec/stress/win32/file_spec.rb +6 -0
  149. data/spec/support/lib/chef/resource/zen_master.rb +1 -1
  150. data/spec/support/mock/platform.rb +1 -1
  151. data/spec/support/shared/functional/file_resource.rb +0 -2
  152. data/spec/support/shared/functional/securable_resource.rb +2 -2
  153. data/spec/support/shared/unit/api_error_inspector.rb +7 -7
  154. data/spec/support/shared/unit/provider/file.rb +47 -8
  155. data/spec/support/shared/unit/provider/useradd_based_user_provider.rb +23 -23
  156. data/spec/unit/api_client/registration_spec.rb +5 -5
  157. data/spec/unit/api_client_spec.rb +2 -2
  158. data/spec/unit/application/apply.rb +6 -6
  159. data/spec/unit/application/client_spec.rb +6 -6
  160. data/spec/unit/application/knife_spec.rb +5 -5
  161. data/spec/unit/application/solo_spec.rb +13 -13
  162. data/spec/unit/application_spec.rb +19 -19
  163. data/spec/unit/checksum/storage/filesystem_spec.rb +2 -2
  164. data/spec/unit/client_spec.rb +23 -23
  165. data/spec/unit/config_spec.rb +4 -4
  166. data/spec/unit/cookbook/metadata_spec.rb +22 -22
  167. data/spec/unit/cookbook/synchronizer_spec.rb +17 -17
  168. data/spec/unit/daemon_spec.rb +21 -22
  169. data/spec/unit/data_bag_item_spec.rb +8 -8
  170. data/spec/unit/data_bag_spec.rb +6 -6
  171. data/spec/unit/deprecation_spec.rb +1 -1
  172. data/spec/unit/dsl/data_query_spec.rb +1 -1
  173. data/spec/unit/environment_spec.rb +5 -5
  174. data/spec/unit/file_access_control_spec.rb +5 -5
  175. data/spec/unit/file_cache_spec.rb +1 -1
  176. data/spec/unit/file_content_management/deploy/mv_unix_spec.rb +1 -1
  177. data/spec/unit/file_content_management/deploy/mv_windows_spec.rb +12 -12
  178. data/spec/unit/formatters/error_inspectors/compile_error_inspector_spec.rb +4 -4
  179. data/spec/unit/formatters/error_inspectors/cookbook_resolve_error_inspector_spec.rb +4 -4
  180. data/spec/unit/formatters/error_inspectors/cookbook_sync_error_inspector_spec.rb +1 -1
  181. data/spec/unit/formatters/error_inspectors/resource_failure_inspector_spec.rb +6 -6
  182. data/spec/unit/formatters/error_inspectors/run_list_expansion_error_inspector_spec.rb +4 -4
  183. data/spec/unit/handler/json_file_spec.rb +1 -1
  184. data/spec/unit/handler_spec.rb +3 -3
  185. data/spec/unit/knife/bootstrap_spec.rb +17 -17
  186. data/spec/unit/knife/client_bulk_delete_spec.rb +4 -4
  187. data/spec/unit/knife/client_create_spec.rb +7 -7
  188. data/spec/unit/knife/client_reregister_spec.rb +2 -2
  189. data/spec/unit/knife/client_show_spec.rb +1 -1
  190. data/spec/unit/knife/config_file_selection_spec.rb +4 -4
  191. data/spec/unit/knife/configure_client_spec.rb +4 -4
  192. data/spec/unit/knife/configure_spec.rb +16 -16
  193. data/spec/unit/knife/cookbook_bulk_delete_spec.rb +10 -10
  194. data/spec/unit/knife/cookbook_create_spec.rb +5 -5
  195. data/spec/unit/knife/cookbook_delete_spec.rb +6 -6
  196. data/spec/unit/knife/cookbook_download_spec.rb +10 -10
  197. data/spec/unit/knife/cookbook_list_spec.rb +3 -3
  198. data/spec/unit/knife/cookbook_metadata_from_file_spec.rb +2 -2
  199. data/spec/unit/knife/cookbook_metadata_spec.rb +8 -8
  200. data/spec/unit/knife/cookbook_show_spec.rb +4 -4
  201. data/spec/unit/knife/cookbook_site_download_spec.rb +3 -3
  202. data/spec/unit/knife/cookbook_site_install_spec.rb +8 -8
  203. data/spec/unit/knife/cookbook_site_share_spec.rb +22 -22
  204. data/spec/unit/knife/cookbook_site_unshare_spec.rb +8 -8
  205. data/spec/unit/knife/cookbook_test_spec.rb +7 -7
  206. data/spec/unit/knife/cookbook_upload_spec.rb +20 -20
  207. data/spec/unit/knife/core/cookbook_scm_repo_spec.rb +6 -6
  208. data/spec/unit/knife/core/object_loader_spec.rb +1 -1
  209. data/spec/unit/knife/core/ui_spec.rb +19 -21
  210. data/spec/unit/knife/data_bag_create_spec.rb +4 -4
  211. data/spec/unit/knife/data_bag_edit_spec.rb +7 -7
  212. data/spec/unit/knife/data_bag_from_file_spec.rb +15 -15
  213. data/spec/unit/knife/data_bag_show_spec.rb +5 -5
  214. data/spec/unit/knife/environment_create_spec.rb +6 -6
  215. data/spec/unit/knife/environment_delete_spec.rb +6 -6
  216. data/spec/unit/knife/environment_edit_spec.rb +5 -5
  217. data/spec/unit/knife/environment_from_file_spec.rb +7 -7
  218. data/spec/unit/knife/environment_list_spec.rb +4 -4
  219. data/spec/unit/knife/environment_show_spec.rb +4 -4
  220. data/spec/unit/knife/index_rebuild_spec.rb +2 -2
  221. data/spec/unit/knife/knife_help.rb +11 -11
  222. data/spec/unit/knife/node_bulk_delete_spec.rb +4 -4
  223. data/spec/unit/knife/node_delete_spec.rb +5 -5
  224. data/spec/unit/knife/node_edit_spec.rb +2 -2
  225. data/spec/unit/knife/node_from_file_spec.rb +5 -5
  226. data/spec/unit/knife/node_list_spec.rb +3 -3
  227. data/spec/unit/knife/node_run_list_add_spec.rb +3 -3
  228. data/spec/unit/knife/node_run_list_remove_spec.rb +4 -4
  229. data/spec/unit/knife/node_run_list_set_spec.rb +5 -5
  230. data/spec/unit/knife/node_show_spec.rb +2 -2
  231. data/spec/unit/knife/role_bulk_delete_spec.rb +4 -4
  232. data/spec/unit/knife/role_create_spec.rb +5 -5
  233. data/spec/unit/knife/role_delete_spec.rb +5 -5
  234. data/spec/unit/knife/role_edit_spec.rb +5 -5
  235. data/spec/unit/knife/role_from_file_spec.rb +5 -5
  236. data/spec/unit/knife/role_list_spec.rb +2 -2
  237. data/spec/unit/knife/ssh_spec.rb +6 -6
  238. data/spec/unit/knife/status_spec.rb +4 -4
  239. data/spec/unit/knife/tag_create_spec.rb +3 -3
  240. data/spec/unit/knife/tag_delete_spec.rb +3 -3
  241. data/spec/unit/knife/tag_list_spec.rb +2 -2
  242. data/spec/unit/knife/user_create_spec.rb +7 -7
  243. data/spec/unit/knife/user_reregister_spec.rb +3 -3
  244. data/spec/unit/knife/user_show_spec.rb +1 -1
  245. data/spec/unit/knife_spec.rb +29 -29
  246. data/spec/unit/lwrp_spec.rb +2 -2
  247. data/spec/unit/mixin/checksum_spec.rb +2 -2
  248. data/spec/unit/mixin/command_spec.rb +1 -1
  249. data/spec/unit/mixin/enforce_ownership_and_permissions_spec.rb +4 -4
  250. data/spec/unit/mixin/params_validate_spec.rb +17 -17
  251. data/spec/unit/mixin/path_sanity_spec.rb +8 -8
  252. data/spec/unit/mixin/securable_spec.rb +87 -87
  253. data/spec/unit/mixin/shell_out_spec.rb +1 -1
  254. data/spec/unit/mixin/template_spec.rb +2 -2
  255. data/spec/unit/node/attribute_spec.rb +3 -3
  256. data/spec/unit/node_spec.rb +12 -12
  257. data/spec/unit/platform_spec.rb +1 -1
  258. data/spec/unit/policy_builder/expand_node_object_spec.rb +16 -0
  259. data/spec/unit/policy_builder/policyfile_spec.rb +4 -0
  260. data/spec/unit/provider/breakpoint_spec.rb +8 -8
  261. data/spec/unit/provider/cookbook_file/content_spec.rb +4 -4
  262. data/spec/unit/provider/cookbook_file_spec.rb +1 -1
  263. data/spec/unit/provider/cron/unix_spec.rb +11 -11
  264. data/spec/unit/provider/cron_spec.rb +40 -40
  265. data/spec/unit/provider/deploy/revision_spec.rb +11 -12
  266. data/spec/unit/provider/deploy/timestamped_spec.rb +3 -3
  267. data/spec/unit/provider/deploy_spec.rb +50 -50
  268. data/spec/unit/provider/directory_spec.rb +18 -18
  269. data/spec/unit/provider/env_spec.rb +15 -15
  270. data/spec/unit/provider/erl_call_spec.rb +1 -1
  271. data/spec/unit/provider/execute_spec.rb +5 -5
  272. data/spec/unit/provider/file/content_spec.rb +5 -5
  273. data/spec/unit/provider/file_spec.rb +1 -1
  274. data/spec/unit/provider/git_spec.rb +47 -47
  275. data/spec/unit/provider/group/dscl_spec.rb +16 -15
  276. data/spec/unit/provider/group/gpasswd_spec.rb +6 -5
  277. data/spec/unit/provider/group/groupadd_spec.rb +10 -10
  278. data/spec/unit/provider/group/groupmod_spec.rb +3 -3
  279. data/spec/unit/provider/group/pw_spec.rb +9 -8
  280. data/spec/unit/provider/group/usermod_spec.rb +13 -12
  281. data/spec/unit/provider/group/windows_spec.rb +9 -9
  282. data/spec/unit/provider/group_spec.rb +31 -31
  283. data/spec/unit/provider/http_request_spec.rb +3 -3
  284. data/spec/unit/provider/ifconfig/aix_spec.rb +7 -7
  285. data/spec/unit/provider/ifconfig/debian_spec.rb +3 -3
  286. data/spec/unit/provider/ifconfig/redhat_spec.rb +5 -5
  287. data/spec/unit/provider/ifconfig_spec.rb +13 -13
  288. data/spec/unit/provider/link_spec.rb +33 -33
  289. data/spec/unit/provider/mdadm_spec.rb +4 -4
  290. data/spec/unit/provider/mount/aix_spec.rb +5 -5
  291. data/spec/unit/provider/mount/mount_spec.rb +49 -50
  292. data/spec/unit/provider/mount/windows_spec.rb +18 -18
  293. data/spec/unit/provider/mount_spec.rb +12 -12
  294. data/spec/unit/provider/ohai_spec.rb +6 -6
  295. data/spec/unit/provider/package/aix_spec.rb +14 -14
  296. data/spec/unit/provider/package/apt_spec.rb +10 -10
  297. data/spec/unit/provider/package/dpkg_spec.rb +13 -13
  298. data/spec/unit/provider/package/easy_install_spec.rb +6 -6
  299. data/spec/unit/provider/package/freebsd_spec.rb +29 -29
  300. data/spec/unit/provider/package/ips_spec.rb +4 -4
  301. data/spec/unit/provider/package/macports_spec.rb +6 -6
  302. data/spec/unit/provider/package/pacman_spec.rb +17 -17
  303. data/spec/unit/provider/package/portage_spec.rb +18 -18
  304. data/spec/unit/provider/package/rpm_spec.rb +7 -7
  305. data/spec/unit/provider/package/rubygems_spec.rb +31 -31
  306. data/spec/unit/provider/package/smartos_spec.rb +4 -4
  307. data/spec/unit/provider/package/solaris_spec.rb +15 -15
  308. data/spec/unit/provider/package/yum_spec.rb +100 -100
  309. data/spec/unit/provider/package/zypper_spec.rb +10 -10
  310. data/spec/unit/provider/package_spec.rb +21 -21
  311. data/spec/unit/provider/registry_key_spec.rb +2 -2
  312. data/spec/unit/provider/remote_file/content_spec.rb +31 -31
  313. data/spec/unit/provider/remote_file/fetcher_spec.rb +8 -8
  314. data/spec/unit/provider/remote_file/ftp_spec.rb +10 -10
  315. data/spec/unit/provider/remote_file/http_spec.rb +4 -4
  316. data/spec/unit/provider/remote_file/local_file_spec.rb +2 -2
  317. data/spec/unit/provider/remote_file_spec.rb +1 -1
  318. data/spec/unit/provider/route_spec.rb +23 -23
  319. data/spec/unit/provider/script_spec.rb +5 -5
  320. data/spec/unit/provider/service/arch_service_spec.rb +41 -41
  321. data/spec/unit/provider/service/debian_service_spec.rb +23 -23
  322. data/spec/unit/provider/service/freebsd_service_spec.rb +33 -33
  323. data/spec/unit/provider/service/gentoo_service_spec.rb +16 -16
  324. data/spec/unit/provider/service/init_service_spec.rb +13 -13
  325. data/spec/unit/provider/service/insserv_service_spec.rb +4 -4
  326. data/spec/unit/provider/service/invokercd_service_spec.rb +12 -12
  327. data/spec/unit/provider/service/macosx_spec.rb +20 -20
  328. data/spec/unit/provider/service/redhat_spec.rb +15 -15
  329. data/spec/unit/provider/service/simple_service_spec.rb +9 -9
  330. data/spec/unit/provider/service/solaris_smf_service_spec.rb +13 -13
  331. data/spec/unit/provider/service/systemd_service_spec.rb +28 -28
  332. data/spec/unit/provider/service/upstart_service_spec.rb +41 -41
  333. data/spec/unit/provider/service/windows_spec.rb +37 -37
  334. data/spec/unit/provider/service_spec.rb +9 -9
  335. data/spec/unit/provider/subversion_spec.rb +36 -36
  336. data/spec/unit/provider/template/content_spec.rb +8 -8
  337. data/spec/unit/provider/template_spec.rb +1 -1
  338. data/spec/unit/provider/user/dscl_spec.rb +9 -9
  339. data/spec/unit/provider/user/pw_spec.rb +20 -20
  340. data/spec/unit/provider/user/solaris_spec.rb +5 -5
  341. data/spec/unit/provider/user/windows_spec.rb +8 -8
  342. data/spec/unit/provider/user_spec.rb +34 -34
  343. data/spec/unit/provider_spec.rb +3 -3
  344. data/spec/unit/recipe_spec.rb +79 -4
  345. data/spec/unit/registry_helper_spec.rb +2 -2
  346. data/spec/unit/resource/cron_spec.rb +2 -2
  347. data/spec/unit/resource/directory_spec.rb +5 -5
  348. data/spec/unit/resource/env_spec.rb +2 -2
  349. data/spec/unit/resource/erl_call_spec.rb +1 -1
  350. data/spec/unit/resource/file_spec.rb +8 -8
  351. data/spec/unit/resource/group_spec.rb +3 -3
  352. data/spec/unit/resource/link_spec.rb +8 -8
  353. data/spec/unit/resource/mdadm_spec.rb +3 -3
  354. data/spec/unit/resource/mount_spec.rb +3 -3
  355. data/spec/unit/resource/route_spec.rb +2 -2
  356. data/spec/unit/resource/user_spec.rb +2 -2
  357. data/spec/unit/resource/yum_package_spec.rb +2 -2
  358. data/spec/unit/resource_collection_spec.rb +1 -1
  359. data/spec/unit/resource_definition_spec.rb +2 -2
  360. data/spec/unit/resource_reporter_spec.rb +71 -16
  361. data/spec/unit/resource_spec.rb +3 -3
  362. data/spec/unit/rest/auth_credentials_spec.rb +2 -2
  363. data/spec/unit/rest_spec.rb +3 -40
  364. data/spec/unit/run_list/run_list_expansion_spec.rb +3 -3
  365. data/spec/unit/run_list_spec.rb +9 -9
  366. data/spec/unit/run_status_spec.rb +1 -1
  367. data/spec/unit/runner_spec.rb +8 -8
  368. data/spec/unit/scan_access_control_spec.rb +3 -3
  369. data/spec/unit/search/query_spec.rb +7 -7
  370. data/spec/unit/shell/model_wrapper_spec.rb +2 -2
  371. data/spec/unit/shell/shell_ext_spec.rb +15 -15
  372. data/spec/unit/shell/shell_session_spec.rb +9 -9
  373. data/spec/unit/shell_spec.rb +1 -2
  374. data/spec/unit/user_spec.rb +4 -4
  375. data/spec/unit/util/backup_spec.rb +1 -1
  376. data/spec/unit/util/selinux_spec.rb +7 -7
  377. metadata +106 -51
  378. data/distro/common/html/chef-client.8.html +0 -145
  379. data/distro/common/html/chef-expander.8.html +0 -164
  380. data/distro/common/html/chef-expanderctl.8.html +0 -146
  381. data/distro/common/html/chef-server-webui.8.html +0 -185
  382. data/distro/common/html/chef-server.8.html +0 -182
  383. data/distro/common/html/chef-shell.1.html +0 -286
  384. data/distro/common/html/chef-solo.8.html +0 -185
  385. data/distro/common/html/chef-solr.8.html +0 -165
  386. data/distro/common/html/knife-bootstrap.1.html +0 -241
  387. data/distro/common/html/knife-client.1.html +0 -219
  388. data/distro/common/html/knife-configure.1.html +0 -170
  389. data/distro/common/html/knife-cookbook-site.1.html +0 -241
  390. data/distro/common/html/knife-cookbook.1.html +0 -381
  391. data/distro/common/html/knife-data-bag.1.html +0 -235
  392. data/distro/common/html/knife-environment.1.html +0 -265
  393. data/distro/common/html/knife-exec.1.html +0 -134
  394. data/distro/common/html/knife-index.1.html +0 -125
  395. data/distro/common/html/knife-node.1.html +0 -250
  396. data/distro/common/html/knife-role.1.html +0 -200
  397. data/distro/common/html/knife-search.1.html +0 -288
  398. data/distro/common/html/knife-ssh.1.html +0 -156
  399. data/distro/common/html/knife-status.1.html +0 -128
  400. data/distro/common/html/knife-tag.1.html +0 -137
  401. data/distro/common/html/knife.1.html +0 -315
@@ -0,0 +1,98 @@
1
+
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
+
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml">
7
+ <head>
8
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9
+
10
+ <title>Common Options &mdash; chef-client Man Pages</title>
11
+
12
+ <link rel="stylesheet" href="_static/guide.css" type="text/css" />
13
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
14
+
15
+ <script type="text/javascript">
16
+ var DOCUMENTATION_OPTIONS = {
17
+ URL_ROOT: '',
18
+ VERSION: '',
19
+ COLLAPSE_INDEX: false,
20
+ FILE_SUFFIX: '.html',
21
+ HAS_SOURCE: true
22
+ };
23
+ </script>
24
+ <script type="text/javascript" src="_static/jquery.js"></script>
25
+ <script type="text/javascript" src="_static/underscore.js"></script>
26
+ <script type="text/javascript" src="_static/doctools.js"></script>
27
+ <link rel="shortcut icon" href="_static/chef.ico"/>
28
+
29
+
30
+ </head>
31
+ <body>
32
+ <div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px">
33
+ <a href="http://docs.opscode.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a>
34
+ </div>
35
+
36
+
37
+
38
+
39
+ <div class="document">
40
+ <div class="documentwrapper">
41
+
42
+ <div class="body">
43
+
44
+ <div class="section" id="common-options">
45
+ <h1>Common Options<a class="headerlink" href="#common-options" title="Permalink to this headline">¶</a></h1>
46
+ <p>The following options can be run with all Knife sub-commands and plug-ins:</p>
47
+ <dl class="docutils">
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">-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>
51
+ <dd>The configuration file to use. For example, when Knife is run from a node that is configured to be managed by the server, this option is used to allow Knife to use the same credentials as the chef-client when communicating with the server.</dd>
52
+ <dt><tt class="docutils literal"><span class="pre">-d</span></tt>, <tt class="docutils literal"><span class="pre">--disable-editing</span></tt></dt>
53
+ <dd>Indicates that $EDITOR will not be opened; data will be accepted as-is.</dd>
54
+ <dt><tt class="docutils literal"><span class="pre">--defaults</span></tt></dt>
55
+ <dd>Indicates that Knife will use the default value, instead of asking a user to provide one.</dd>
56
+ <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>
57
+ <dd>The $EDITOR that is used for all interactive commands.</dd>
58
+ <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>
59
+ <dd>The name of the environment. When this option is added to a command, the command will run only against the named environment.</dd>
60
+ <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>
61
+ <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>
62
+ <dt><tt class="docutils literal"><span class="pre">-h</span></tt>, <tt class="docutils literal"><span class="pre">--help</span></tt></dt>
63
+ <dd>Shows help for the command.</dd>
64
+ <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>
65
+ <dd>The private key that Knife will use to sign requests made by the API client to the server.</dd>
66
+ <dt><tt class="docutils literal"><span class="pre">--[no-]color</span></tt></dt>
67
+ <dd>Indicates whether colored output will be used.</dd>
68
+ <dt><tt class="docutils literal"><span class="pre">--print-after</span></tt></dt>
69
+ <dd>Indicates that data will be shown after a destructive operation.</dd>
70
+ <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>
71
+ <dd>The URL for the server.</dd>
72
+ <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>
73
+ <dd>The user name used by Knife to sign requests made by the API client to the server. Authentication will fail if the user name does not match the private key.</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">-v</span></tt>, <tt class="docutils literal"><span class="pre">--version</span></tt></dt>
77
+ <dd>The version of the chef-client.</dd>
78
+ <dt><tt class="docutils literal"><span class="pre">-y</span></tt>, <tt class="docutils literal"><span class="pre">--yes</span></tt></dt>
79
+ <dd>Indicates that the response to all confirmation prompts will be &#8220;Yes&#8221; (and that Knife will not ask for confirmation).</dd>
80
+ <dt><tt class="docutils literal"><span class="pre">-z</span></tt>, <tt class="docutils literal"><span class="pre">--local-mode</span></tt></dt>
81
+ <dd>Indicates that the chef-client will be run in local mode, which allows all commands that work against the server to also work against the local chef-repo.</dd>
82
+ </dl>
83
+ </div>
84
+
85
+
86
+ </div>
87
+
88
+ </div>
89
+
90
+
91
+ <div class="clearer"></div>
92
+ </div>
93
+
94
+
95
+
96
+
97
+ </body>
98
+ </html>
@@ -0,0 +1,107 @@
1
+
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
+
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml">
7
+ <head>
8
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9
+
10
+ <title>knife configure &mdash; chef-client Man Pages</title>
11
+
12
+ <link rel="stylesheet" href="_static/guide.css" type="text/css" />
13
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
14
+
15
+ <script type="text/javascript">
16
+ var DOCUMENTATION_OPTIONS = {
17
+ URL_ROOT: '',
18
+ VERSION: '',
19
+ COLLAPSE_INDEX: false,
20
+ FILE_SUFFIX: '.html',
21
+ HAS_SOURCE: true
22
+ };
23
+ </script>
24
+ <script type="text/javascript" src="_static/jquery.js"></script>
25
+ <script type="text/javascript" src="_static/underscore.js"></script>
26
+ <script type="text/javascript" src="_static/doctools.js"></script>
27
+ <link rel="shortcut icon" href="_static/chef.ico"/>
28
+
29
+
30
+ </head>
31
+ <body>
32
+ <div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px">
33
+ <a href="http://docs.opscode.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a>
34
+ </div>
35
+
36
+
37
+
38
+
39
+ <div class="document">
40
+ <div class="documentwrapper">
41
+
42
+ <div class="body">
43
+
44
+ <div class="section" id="knife-configure">
45
+ <h1>knife configure<a class="headerlink" href="#knife-configure" title="Permalink to this headline">¶</a></h1>
46
+ <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>
47
+ <div class="section" id="syntax">
48
+ <h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
49
+ <p>This argument has the following syntax when creating a knife.rb file:</p>
50
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure <span class="o">(</span>options<span class="o">)</span>
51
+ </pre></div>
52
+ </div>
53
+ <p>and the following syntax when creating a client.rb file:</p>
54
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure client DIRECTORY
55
+ </pre></div>
56
+ </div>
57
+ </div>
58
+ <div class="section" id="options">
59
+ <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
60
+ <div class="admonition note">
61
+ <p class="first admonition-title">Note</p>
62
+ <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>
63
+ </div>
64
+ <p>This subcommand has the following options for use when configuring a knife.rb file:</p>
65
+ <dl class="docutils">
66
+ <dt><tt class="docutils literal"><span class="pre">--admin-client-name</span> <span class="pre">NAME</span></tt></dt>
67
+ <dd>The name of the client, typically the name of the admin client.</dd>
68
+ <dt><tt class="docutils literal"><span class="pre">--admin-client-key</span> <span class="pre">PATH</span></tt></dt>
69
+ <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>
70
+ <dt><tt class="docutils literal"><span class="pre">-i</span></tt>, <tt class="docutils literal"><span class="pre">--initial</span></tt></dt>
71
+ <dd>Use to create a API client, typically an administrator client on a freshly-installed server.</dd>
72
+ <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>
73
+ <dd>The path to the chef-repo.</dd>
74
+ <dt><tt class="docutils literal"><span class="pre">--validation-client-name</span> <span class="pre">NAME</span></tt></dt>
75
+ <dd>The name of the validation client, typically a client named chef-validator</dd>
76
+ <dt><tt class="docutils literal"><span class="pre">--validation-key</span> <span class="pre">PATH</span></tt></dt>
77
+ <dd>The path to the validation key used by the client, typically a file named <tt class="docutils literal"><span class="pre">validation.pem</span></tt>.</dd>
78
+ </dl>
79
+ </div>
80
+ <div class="section" id="examples">
81
+ <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
82
+ <p>The following examples show how to use this Knife subcommand:</p>
83
+ <p><strong>Configure knife.rb</strong></p>
84
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure
85
+ </pre></div>
86
+ </div>
87
+ <p><strong>Configure client.rb</strong></p>
88
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure client <span class="s1">&#39;/directory&#39;</span>
89
+ </pre></div>
90
+ </div>
91
+ </div>
92
+ </div>
93
+
94
+
95
+ </div>
96
+
97
+ </div>
98
+
99
+
100
+ <div class="clearer"></div>
101
+ </div>
102
+
103
+
104
+
105
+
106
+ </body>
107
+ </html>
@@ -0,0 +1,481 @@
1
+
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
+
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml">
7
+ <head>
8
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9
+
10
+ <title>knife cookbook &mdash; chef-client Man Pages</title>
11
+
12
+ <link rel="stylesheet" href="_static/guide.css" type="text/css" />
13
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
14
+
15
+ <script type="text/javascript">
16
+ var DOCUMENTATION_OPTIONS = {
17
+ URL_ROOT: '',
18
+ VERSION: '',
19
+ COLLAPSE_INDEX: false,
20
+ FILE_SUFFIX: '.html',
21
+ HAS_SOURCE: true
22
+ };
23
+ </script>
24
+ <script type="text/javascript" src="_static/jquery.js"></script>
25
+ <script type="text/javascript" src="_static/underscore.js"></script>
26
+ <script type="text/javascript" src="_static/doctools.js"></script>
27
+ <link rel="shortcut icon" href="_static/chef.ico"/>
28
+
29
+
30
+ </head>
31
+ <body>
32
+ <div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px">
33
+ <a href="http://docs.opscode.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a>
34
+ </div>
35
+
36
+
37
+
38
+
39
+ <div class="document">
40
+ <div class="documentwrapper">
41
+
42
+ <div class="body">
43
+
44
+ <div class="section" id="knife-cookbook">
45
+ <h1>knife cookbook<a class="headerlink" href="#knife-cookbook" title="Permalink to this headline">¶</a></h1>
46
+ <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>
47
+ <ul class="simple">
48
+ <li>Attribute values that are set on nodes</li>
49
+ <li>Definitions that allow the creation of reusable collections of resources</li>
50
+ <li>File distributions</li>
51
+ <li>Libraries that extend the chef-client and/or provide helpers to Ruby code</li>
52
+ <li>Recipes that specify which resources to manage and the order in which those resources will be applied</li>
53
+ <li>Custom resources and providers</li>
54
+ <li>Templates</li>
55
+ <li>Versions</li>
56
+ <li>Metadata about recipes (including dependencies), version constraints, supported platforms, and so on</li>
57
+ </ul>
58
+ <p>The <strong>knife cookbook</strong> subcommand is used to interact with cookbooks that are located on the server or the local chef-repo.</p>
59
+ <div class="admonition note">
60
+ <p class="first admonition-title">Note</p>
61
+ <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>
62
+ </div>
63
+ <div class="section" id="bulk-delete">
64
+ <h2>bulk delete<a class="headerlink" href="#bulk-delete" title="Permalink to this headline">¶</a></h2>
65
+ <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>
66
+ <div class="section" id="syntax">
67
+ <h3>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h3>
68
+ <p>This argument has the following syntax:</p>
69
+ <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>
70
+ </pre></div>
71
+ </div>
72
+ </div>
73
+ <div class="section" id="options">
74
+ <h3>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h3>
75
+ <p>This argument has the following options:</p>
76
+ <dl class="docutils">
77
+ <dt><tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--purge</span></tt></dt>
78
+ <dd>Indicates that a cookbook (or cookbook version) will be removed entirely from the server. This action should be used carefully because only one copy of any single file is stored on the server. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged.</dd>
79
+ </dl>
80
+ </div>
81
+ <div class="section" id="examples">
82
+ <h3>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3>
83
+ <p>The following examples show how to use this Knife subcommand:</p>
84
+ <p><strong>Bulk delete many cookbooks</strong></p>
85
+ <p>Use a regular expression to define the pattern used to bulk delete cookbooks:</p>
86
+ <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
87
+ </pre></div>
88
+ </div>
89
+ </div>
90
+ </div>
91
+ <div class="section" id="create">
92
+ <h2>create<a class="headerlink" href="#create" title="Permalink to this headline">¶</a></h2>
93
+ <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>
94
+ <blockquote>
95
+ <div><ul class="simple">
96
+ <li>cookbook/attributes</li>
97
+ <li>cookbook/CHANGELOG.md</li>
98
+ <li>cookbook/definitions</li>
99
+ <li>cookbook/files/default</li>
100
+ <li>cookbook/libraries</li>
101
+ <li>cookbook/metadata.rb</li>
102
+ <li>cookbook/providers</li>
103
+ <li>cookbook/README.md (or .rdoc)</li>
104
+ <li>cookbook/recipes/default.rb</li>
105
+ <li>cookbook/resources</li>
106
+ <li>cookbook/templates/default</li>
107
+ </ul>
108
+ </div></blockquote>
109
+ <p>After the cookbook is created, it can be uploaded to the server using the <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">upload</span></tt> argument.</p>
110
+ <div class="section" id="id1">
111
+ <h3>Syntax<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
112
+ <p>This argument has the following syntax:</p>
113
+ <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>
114
+ </pre></div>
115
+ </div>
116
+ </div>
117
+ <div class="section" id="id2">
118
+ <h3>Options<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
119
+ <p>This argument has the following options:</p>
120
+ <dl class="docutils">
121
+ <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>
122
+ <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>
123
+ <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>
124
+ <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>
125
+ <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>
126
+ <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>
127
+ <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>
128
+ <dd>The directory in which cookbook are created. This can be a colon-separated path.</dd>
129
+ <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>
130
+ <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>
131
+ </dl>
132
+ </div>
133
+ <div class="section" id="id3">
134
+ <h3>Examples<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
135
+ <p>The following examples show how to use this Knife subcommand:</p>
136
+ <p><strong>Create a cookbook</strong></p>
137
+ <p>To create a cookbook named &#8220;my_cookbook&#8221; with copyright, email, license, and readme format options specified, enter:</p>
138
+ <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
139
+ </pre></div>
140
+ </div>
141
+ <p>to return something like:</p>
142
+ <div class="highlight-bash"><div class="highlight"><pre>** Creating cookbook my_cookbook
143
+ ** Creating README <span class="k">for </span>cookbook: my_cookbook
144
+ ** Creating metadata <span class="k">for </span>cookbook: my_cookbook
145
+ </pre></div>
146
+ </div>
147
+ </div>
148
+ </div>
149
+ <div class="section" id="delete">
150
+ <h2>delete<a class="headerlink" href="#delete" title="Permalink to this headline">¶</a></h2>
151
+ <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 server (and not locally).</p>
152
+ <div class="section" id="id4">
153
+ <h3>Syntax<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
154
+ <p>This argument has the following syntax:</p>
155
+ <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>
156
+ </pre></div>
157
+ </div>
158
+ </div>
159
+ <div class="section" id="id5">
160
+ <h3>Options<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
161
+ <p>This argument has the following options:</p>
162
+ <dl class="docutils">
163
+ <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
164
+ <dd>Indicates that a cookbook and every version of that cookbook will be deleted.</dd>
165
+ <dt><tt class="docutils literal"><span class="pre">COOKBOOK_VERSION</span></tt></dt>
166
+ <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>
167
+ <dt><tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--purge</span></tt></dt>
168
+ <dd>Indicates that a cookbook (or cookbook version) will be removed entirely from the server. This action should be used carefully because only one copy of any single file is stored on the server. Consequently, purging a cookbook will disable any other cookbook that references one or more files from a cookbook that has been purged.</dd>
169
+ </dl>
170
+ </div>
171
+ <div class="section" id="id6">
172
+ <h3>Examples<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
173
+ <p>The following examples show how to use this Knife subcommand:</p>
174
+ <p><strong>Delete a cookbook</strong></p>
175
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook delete cookbook_name version
176
+ </pre></div>
177
+ </div>
178
+ <p>For example:</p>
179
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook delete smartmon 0.8
180
+ </pre></div>
181
+ </div>
182
+ <p>Type <tt class="docutils literal"><span class="pre">Y</span></tt> to confirm a deletion.</p>
183
+ </div>
184
+ </div>
185
+ <div class="section" id="download">
186
+ <h2>download<a class="headerlink" href="#download" title="Permalink to this headline">¶</a></h2>
187
+ <p>The <tt class="docutils literal"><span class="pre">download</span></tt> argument is used to download a cookbook from the server to the current working directory.</p>
188
+ <div class="section" id="id7">
189
+ <h3>Syntax<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
190
+ <p>This argument has the following syntax:</p>
191
+ <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>
192
+ </pre></div>
193
+ </div>
194
+ </div>
195
+ <div class="section" id="id8">
196
+ <h3>Options<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
197
+ <p>This argument has the following options:</p>
198
+ <dl class="docutils">
199
+ <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>
200
+ <dd>The directory into which a cookbook will be downloaded.</dd>
201
+ <dt><tt class="docutils literal"><span class="pre">-f</span></tt>, <tt class="docutils literal"><span class="pre">--force</span></tt></dt>
202
+ <dd>Indicates that an existing directory will be overwritten.</dd>
203
+ <dt><tt class="docutils literal"><span class="pre">-N</span></tt>, <tt class="docutils literal"><span class="pre">--latest</span></tt></dt>
204
+ <dd>Indicates that the most recent version of a cookbook will be downloaded.</dd>
205
+ </dl>
206
+ </div>
207
+ <div class="section" id="id9">
208
+ <h3>Examples<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
209
+ <p>The following examples show how to use this Knife subcommand:</p>
210
+ <p><strong>Download a cookbook</strong></p>
211
+ <p>To download a cookbook named &#8220;smartmon&#8221;, enter:</p>
212
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook download smartmon
213
+ </pre></div>
214
+ </div>
215
+ </div>
216
+ </div>
217
+ <div class="section" id="list">
218
+ <h2>list<a class="headerlink" href="#list" title="Permalink to this headline">¶</a></h2>
219
+ <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 server. The list will contain only the most recent version for each cookbook by default.</p>
220
+ <div class="section" id="id10">
221
+ <h3>Syntax<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
222
+ <p>This argument has the following syntax:</p>
223
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook list <span class="o">(</span>options<span class="o">)</span>
224
+ </pre></div>
225
+ </div>
226
+ </div>
227
+ <div class="section" id="id11">
228
+ <h3>Options<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
229
+ <p>This argument has the following options:</p>
230
+ <dl class="docutils">
231
+ <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
232
+ <dd>Indicates that all available versions of each cookbook will be returned.</dd>
233
+ <dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
234
+ <dd>Indicates that the corresponding URIs will be shown.</dd>
235
+ </dl>
236
+ </div>
237
+ <div class="section" id="id12">
238
+ <h3>Examples<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
239
+ <p>The following examples show how to use this Knife subcommand:</p>
240
+ <p><strong>View a list of cookbooks</strong></p>
241
+ <p>To view a list of cookbooks:</p>
242
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook list
243
+ </pre></div>
244
+ </div>
245
+ </div>
246
+ </div>
247
+ <div class="section" id="metadata">
248
+ <h2>metadata<a class="headerlink" href="#metadata" title="Permalink to this headline">¶</a></h2>
249
+ <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>
250
+ <div class="section" id="id13">
251
+ <h3>Syntax<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
252
+ <p>This argument has the following syntax:</p>
253
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata <span class="o">(</span>options<span class="o">)</span>
254
+ </pre></div>
255
+ </div>
256
+ </div>
257
+ <div class="section" id="id14">
258
+ <h3>Options<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3>
259
+ <p>This argument has the following options:</p>
260
+ <dl class="docutils">
261
+ <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
262
+ <dd>Indicates that metadata should be generated for all cookbooks, and not just for a specified cookbook.</dd>
263
+ <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>
264
+ <dd>The directory in which cookbook are created. This can be a colon-separated path.</dd>
265
+ </dl>
266
+ </div>
267
+ <div class="section" id="id15">
268
+ <h3>Examples<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
269
+ <p>The following examples show how to use this Knife subcommand:</p>
270
+ <p><strong>Generate metadata</strong></p>
271
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata -a
272
+ </pre></div>
273
+ </div>
274
+ </div>
275
+ </div>
276
+ <div class="section" id="metadata-from-file">
277
+ <h2>metadata from file<a class="headerlink" href="#metadata-from-file" title="Permalink to this headline">¶</a></h2>
278
+ <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>
279
+ <div class="section" id="id16">
280
+ <h3>Syntax<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3>
281
+ <p>This argument has the following syntax:</p>
282
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadata from file FILE
283
+ </pre></div>
284
+ </div>
285
+ </div>
286
+ <div class="section" id="id17">
287
+ <h3>Options<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3>
288
+ <p>This command does not have any specific options.</p>
289
+ </div>
290
+ <div class="section" id="id18">
291
+ <h3>Examples<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3>
292
+ <p>The following examples show how to use this Knife subcommand:</p>
293
+ <p><strong>View metadata</strong></p>
294
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook metadta from file /path/to/file
295
+ </pre></div>
296
+ </div>
297
+ </div>
298
+ </div>
299
+ <div class="section" id="show">
300
+ <h2>show<a class="headerlink" href="#show" title="Permalink to this headline">¶</a></h2>
301
+ <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>
302
+ <div class="section" id="id19">
303
+ <h3>Syntax<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h3>
304
+ <p>This argument has the following syntax:</p>
305
+ <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>
306
+ </pre></div>
307
+ </div>
308
+ </div>
309
+ <div class="section" id="id20">
310
+ <h3>Options<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h3>
311
+ <p>This argument has the following options:</p>
312
+ <dl class="docutils">
313
+ <dt><tt class="docutils literal"><span class="pre">COOKBOOK_VERSION</span></tt></dt>
314
+ <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>
315
+ <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>
316
+ <dd>The FQDN of the host.</dd>
317
+ <dt><tt class="docutils literal"><span class="pre">FILE_NAME</span></tt></dt>
318
+ <dd>The name of a file that is associated with a cookbook.</dd>
319
+ <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>
320
+ <dd>The platform for which a cookbook is designed.</dd>
321
+ <dt><tt class="docutils literal"><span class="pre">PART</span></tt></dt>
322
+ <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>
323
+ <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>
324
+ <dd>The version of the platform.</dd>
325
+ <dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
326
+ <dd>Indicates that the corresponding URIs will be shown.</dd>
327
+ </dl>
328
+ </div>
329
+ <div class="section" id="id21">
330
+ <h3>Examples<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h3>
331
+ <p>The following examples show how to use this Knife subcommand:</p>
332
+ <p><strong>Show cookbook data</strong></p>
333
+ <p>To get the list of available versions of a cookbook named &#8220;getting-started&#8221;, enter:</p>
334
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook show getting-started
335
+ </pre></div>
336
+ </div>
337
+ <p>to return something like:</p>
338
+ <div class="highlight-bash"><div class="highlight"><pre>getting-started 0.3.0 0.2.0
339
+ </pre></div>
340
+ </div>
341
+ <p><strong>Show cookbook versions</strong></p>
342
+ <p>To show a list of data about a cookbook using the name of the cookbook and the version, enter:</p>
343
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook show getting-started 0.3.0
344
+ </pre></div>
345
+ </div>
346
+ <p>to return something like:</p>
347
+ <div class="highlight-bash"><div class="highlight"><pre>attributes:
348
+ checksum: fa0fc4abf3f6787aeb5c3c5c35de667c
349
+ name: default.rb
350
+ path: attributes/default.rb
351
+ specificity: default
352
+ url: https://somelongurlhere.com
353
+ chef_type: cookbook_version
354
+ cookbook_name: getting-started
355
+ definitions: <span class="o">[]</span>
356
+ files: <span class="o">[]</span>
357
+ frozen?: <span class="nb">false</span>
358
+ json_class: Chef::CookbookVersion
359
+ libraries: <span class="o">[]</span>
360
+ </pre></div>
361
+ </div>
362
+ <p><strong>Show a cookbook version</strong></p>
363
+ <p>To only view data about &#8220;templates&#8221;, enter:</p>
364
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook show getting-started 0.3.0 templates
365
+ </pre></div>
366
+ </div>
367
+ <p>to return something like:</p>
368
+ <div class="highlight-bash"><div class="highlight"><pre>checksum: a29d6f254577b830091f140c3a78b1fe
369
+ name: chef-getting-started.txt.erb
370
+ path: templates/default/chef-getting-started.txt.erb
371
+ specificity: default
372
+ url: https://someurlhere.com
373
+ </pre></div>
374
+ </div>
375
+ <p><strong>Show cookbook data as JSON</strong></p>
376
+ <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>
377
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role show devops -F json
378
+ </pre></div>
379
+ </div>
380
+ <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>
381
+ </div>
382
+ </div>
383
+ <div class="section" id="test">
384
+ <h2>test<a class="headerlink" href="#test" title="Permalink to this headline">¶</a></h2>
385
+ <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).</p>
386
+ <div class="section" id="id22">
387
+ <h3>Syntax<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3>
388
+ <p>This argument has the following syntax:</p>
389
+ <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>
390
+ </pre></div>
391
+ </div>
392
+ </div>
393
+ <div class="section" id="id23">
394
+ <h3>Options<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3>
395
+ <p>This argument has the following options:</p>
396
+ <dl class="docutils">
397
+ <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
398
+ <dd>Indicates that all cookbooks will be tested.</dd>
399
+ <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>
400
+ <dd>The directory in which cookbook are created. This can be a colon-separated path.</dd>
401
+ </dl>
402
+ </div>
403
+ <div class="section" id="id24">
404
+ <h3>Examples<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3>
405
+ <p>The following examples show how to use this Knife subcommand:</p>
406
+ <p><strong>Test a cookbook</strong></p>
407
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook <span class="nb">test </span>cookbook_name
408
+ </pre></div>
409
+ </div>
410
+ </div>
411
+ </div>
412
+ <div class="section" id="upload">
413
+ <h2>upload<a class="headerlink" href="#upload" title="Permalink to this headline">¶</a></h2>
414
+ <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 server. Only files that do not already exist on the server will be uploaded.</p>
415
+ <div class="admonition note">
416
+ <p class="first admonition-title">Note</p>
417
+ <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>
418
+ </div>
419
+ <div class="section" id="id25">
420
+ <h3>Syntax<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h3>
421
+ <p>This argument has the following syntax:</p>
422
+ <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>
423
+ </pre></div>
424
+ </div>
425
+ </div>
426
+ <div class="section" id="id26">
427
+ <h3>Options<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h3>
428
+ <p>This argument has the following options:</p>
429
+ <dl class="docutils">
430
+ <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
431
+ <dd>Indicates that all cookbooks will be uploaded.</dd>
432
+ <dt><tt class="docutils literal"><span class="pre">-d</span></tt>, <tt class="docutils literal"><span class="pre">--include-dependencies</span></tt></dt>
433
+ <dd>Indicates that when a cookbook has a dependency on one (or more) cookbooks, those cookbooks will also be uploaded.</dd>
434
+ <dt><tt class="docutils literal"><span class="pre">--force</span></tt></dt>
435
+ <dd>Indicates that a cookbook should be updated even if the <tt class="docutils literal"><span class="pre">--freeze</span></tt> flag has been set.</dd>
436
+ <dt><tt class="docutils literal"><span class="pre">--freeze</span></tt></dt>
437
+ <dd>Indicates that a cookbook cannot be modified; any changes to this cookbook must be included as a new version. Only the <tt class="docutils literal"><span class="pre">--force</span></tt> option can override this setting.</dd>
438
+ <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>
439
+ <dd>The directory in which cookbook are created. This can be a colon-separated path.</dd>
440
+ </dl>
441
+ </div>
442
+ <div class="section" id="id27">
443
+ <h3>Examples<a class="headerlink" href="#id27" title="Permalink to this headline">¶</a></h3>
444
+ <p>The following examples show how to use this Knife subcommand:</p>
445
+ <p><strong>Upload a cookbook</strong></p>
446
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook upload cookbook_name
447
+ </pre></div>
448
+ </div>
449
+ <p><strong>Freeze a cookbook</strong></p>
450
+ <p>To upload a cookbook, and then prevent other users from being able to make changes to it, enter:</p>
451
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife cookbook upload redis --freeze
452
+ </pre></div>
453
+ </div>
454
+ <p>to return something like:</p>
455
+ <div class="highlight-bash"><div class="highlight"><pre>Uploading redis...
456
+ Upload completed
457
+ </pre></div>
458
+ </div>
459
+ <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>
460
+ <div class="highlight-bash"><div class="highlight"><pre>Uploading redis...
461
+ ERROR: Version 0.1.6 of cookbook redis is frozen. Use --force to override.
462
+ </pre></div>
463
+ </div>
464
+ </div>
465
+ </div>
466
+ </div>
467
+
468
+
469
+ </div>
470
+
471
+ </div>
472
+
473
+
474
+ <div class="clearer"></div>
475
+ </div>
476
+
477
+
478
+
479
+
480
+ </body>
481
+ </html>