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
@@ -1,114 +1,114 @@
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 list &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-list">
43
- <h1>knife list<a class="headerlink" href="#knife-list" title="Permalink to this headline">¶</a></h1>
44
- <p>The <strong>knife list</strong> subcommand is used to view a list of objects on the Chef server. This subcommand works similar to <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">cookbook</span> <span class="pre">list</span></tt>, <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">data</span> <span class="pre">bag</span> <span class="pre">list</span></tt>, <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">environment</span> <span class="pre">list</span></tt>, <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">node</span> <span class="pre">list</span></tt>, and <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">role</span> <span class="pre">list</span></tt>, but with a single verb (and a single action).</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:</p>
48
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife list <span class="o">[</span>PATTERN...<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span>
49
- </pre></div>
50
- </div>
51
- </div>
52
- <div class="section" id="options">
53
- <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
54
- <div class="admonition note">
55
- <p class="first admonition-title">Note</p>
56
- <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>
57
- </div>
58
- <p>This subcommand has the following options:</p>
59
- <dl class="docutils">
60
- <dt><tt class="docutils literal"><span class="pre">-1</span></tt></dt>
61
- <dd>Use to show only one column of results. Default: <tt class="docutils literal"><span class="pre">false</span></tt>.</dd>
62
- <dt><tt class="docutils literal"><span class="pre">--chef-repo-path</span> <span class="pre">PATH</span></tt></dt>
63
- <dd>The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same value as specified by <tt class="docutils literal"><span class="pre">chef_repo_path</span></tt> in client.rb.</dd>
64
- <dt><tt class="docutils literal"><span class="pre">--concurrency</span></tt></dt>
65
- <dd>The number of allowed concurrent connections. Default: <tt class="docutils literal"><span class="pre">10</span></tt>.</dd>
66
- <dt><tt class="docutils literal"><span class="pre">-d</span></tt></dt>
67
- <dd>Use to prevent a directory&#8217;s children from showing when a directory matches a pattern. Default value: <tt class="docutils literal"><span class="pre">false</span></tt>.</dd>
68
- <dt><tt class="docutils literal"><span class="pre">-f</span></tt>, <tt class="docutils literal"><span class="pre">--flat</span></tt></dt>
69
- <dd>Use to show a list of file names. Set to <tt class="docutils literal"><span class="pre">false</span></tt> to view ls-like output. Default: <tt class="docutils literal"><span class="pre">false</span></tt>.</dd>
70
- <dt><tt class="docutils literal"><span class="pre">--local</span></tt></dt>
71
- <dd>Use to return only the contents of the local directory. Default: <tt class="docutils literal"><span class="pre">false</span></tt>.</dd>
72
- <dt><tt class="docutils literal"><span class="pre">-p</span></tt></dt>
73
- <dd>Use to show directories with trailing slashes (/). Default: <tt class="docutils literal"><span class="pre">false</span></tt>.</dd>
74
- <dt><tt class="docutils literal"><span class="pre">-R</span></tt></dt>
75
- <dd>Use to list directories recursively. Default: <tt class="docutils literal"><span class="pre">false</span></tt>.</dd>
76
- <dt><tt class="docutils literal"><span class="pre">--repo-mode</span> <span class="pre">MODE</span></tt></dt>
77
- <dd>The layout of the local chef-repo. Possible values: <tt class="docutils literal"><span class="pre">static</span></tt>, <tt class="docutils literal"><span class="pre">everything</span></tt>, or <tt class="docutils literal"><span class="pre">hosted_everything</span></tt>. Use <tt class="docutils literal"><span class="pre">static</span></tt> for just roles, environments, cookbooks, and data bags. By default, <tt class="docutils literal"><span class="pre">everything</span></tt> and <tt class="docutils literal"><span class="pre">hosted_everything</span></tt> are dynamically selected depending on the server type. Default: <tt class="docutils literal"><span class="pre">everything</span></tt> / <tt class="docutils literal"><span class="pre">hosted_everything</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>List roles</strong></p>
84
- <p>For example, to view a list of roles on the Chef server:</p>
85
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife list roles/
86
- </pre></div>
87
- </div>
88
- <p><strong>List roles and environments</strong></p>
89
- <p>To view a list of roles and environments on the Chef server:</p>
90
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife list roles/ environments/
91
- </pre></div>
92
- </div>
93
- <p><strong>List everything</strong></p>
94
- <p>To view a list of absolutely everything on the Chef server:</p>
95
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife list -R /
96
- </pre></div>
97
- </div>
98
- </div>
99
- </div>
100
-
101
-
102
- </div>
103
-
104
- </div>
105
-
106
-
107
- <div class="clearer"></div>
108
- </div>
109
-
110
-
111
-
112
-
113
- </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 list &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-list">
43
+ <h1>knife list<a class="headerlink" href="#knife-list" title="Permalink to this headline">¶</a></h1>
44
+ <p>The <strong>knife list</strong> subcommand is used to view a list of objects on the Chef server. This subcommand works similar to <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">cookbook</span> <span class="pre">list</span></tt>, <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">data</span> <span class="pre">bag</span> <span class="pre">list</span></tt>, <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">environment</span> <span class="pre">list</span></tt>, <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">node</span> <span class="pre">list</span></tt>, and <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">role</span> <span class="pre">list</span></tt>, but with a single verb (and a single action).</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:</p>
48
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife list <span class="o">[</span>PATTERN...<span class="o">]</span> <span class="o">(</span>options<span class="o">)</span>
49
+ </pre></div>
50
+ </div>
51
+ </div>
52
+ <div class="section" id="options">
53
+ <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
54
+ <div class="admonition note">
55
+ <p class="first admonition-title">Note</p>
56
+ <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>
57
+ </div>
58
+ <p>This subcommand has the following options:</p>
59
+ <dl class="docutils">
60
+ <dt><tt class="docutils literal"><span class="pre">-1</span></tt></dt>
61
+ <dd>Use to show only one column of results. Default: <tt class="docutils literal"><span class="pre">false</span></tt>.</dd>
62
+ <dt><tt class="docutils literal"><span class="pre">--chef-repo-path</span> <span class="pre">PATH</span></tt></dt>
63
+ <dd>The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same value as specified by <tt class="docutils literal"><span class="pre">chef_repo_path</span></tt> in client.rb.</dd>
64
+ <dt><tt class="docutils literal"><span class="pre">--concurrency</span></tt></dt>
65
+ <dd>The number of allowed concurrent connections. Default: <tt class="docutils literal"><span class="pre">10</span></tt>.</dd>
66
+ <dt><tt class="docutils literal"><span class="pre">-d</span></tt></dt>
67
+ <dd>Use to prevent a directory&#8217;s children from showing when a directory matches a pattern. Default value: <tt class="docutils literal"><span class="pre">false</span></tt>.</dd>
68
+ <dt><tt class="docutils literal"><span class="pre">-f</span></tt>, <tt class="docutils literal"><span class="pre">--flat</span></tt></dt>
69
+ <dd>Use to show a list of file names. Set to <tt class="docutils literal"><span class="pre">false</span></tt> to view ls-like output. Default: <tt class="docutils literal"><span class="pre">false</span></tt>.</dd>
70
+ <dt><tt class="docutils literal"><span class="pre">--local</span></tt></dt>
71
+ <dd>Use to return only the contents of the local directory. Default: <tt class="docutils literal"><span class="pre">false</span></tt>.</dd>
72
+ <dt><tt class="docutils literal"><span class="pre">-p</span></tt></dt>
73
+ <dd>Use to show directories with trailing slashes (/). Default: <tt class="docutils literal"><span class="pre">false</span></tt>.</dd>
74
+ <dt><tt class="docutils literal"><span class="pre">-R</span></tt></dt>
75
+ <dd>Use to list directories recursively. Default: <tt class="docutils literal"><span class="pre">false</span></tt>.</dd>
76
+ <dt><tt class="docutils literal"><span class="pre">--repo-mode</span> <span class="pre">MODE</span></tt></dt>
77
+ <dd>The layout of the local chef-repo. Possible values: <tt class="docutils literal"><span class="pre">static</span></tt>, <tt class="docutils literal"><span class="pre">everything</span></tt>, or <tt class="docutils literal"><span class="pre">hosted_everything</span></tt>. Use <tt class="docutils literal"><span class="pre">static</span></tt> for just roles, environments, cookbooks, and data bags. By default, <tt class="docutils literal"><span class="pre">everything</span></tt> and <tt class="docutils literal"><span class="pre">hosted_everything</span></tt> are dynamically selected depending on the server type. Default: <tt class="docutils literal"><span class="pre">everything</span></tt> / <tt class="docutils literal"><span class="pre">hosted_everything</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>List roles</strong></p>
84
+ <p>For example, to view a list of roles on the Chef server:</p>
85
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife list roles/
86
+ </pre></div>
87
+ </div>
88
+ <p><strong>List roles and environments</strong></p>
89
+ <p>To view a list of roles and environments on the Chef server:</p>
90
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife list roles/ environments/
91
+ </pre></div>
92
+ </div>
93
+ <p><strong>List everything</strong></p>
94
+ <p>To view a list of absolutely everything on the Chef server:</p>
95
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife list -R /
96
+ </pre></div>
97
+ </div>
98
+ </div>
99
+ </div>
100
+
101
+
102
+ </div>
103
+
104
+ </div>
105
+
106
+
107
+ <div class="clearer"></div>
108
+ </div>
109
+
110
+
111
+
112
+
113
+ </body>
114
114
  </html>
@@ -1,458 +1,458 @@
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 node &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-node">
43
- <h1>knife node<a class="headerlink" href="#knife-node" title="Permalink to this headline">¶</a></h1>
44
- <p>A node is any physical, virtual, or cloud machine that is configured to be maintained by a chef-client.</p>
45
- <p>The <strong>knife node</strong> subcommand is used to manage the nodes that exist on a Chef server.</p>
46
- <div class="admonition note">
47
- <p class="first admonition-title">Note</p>
48
- <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>
49
- </div>
50
- <div class="section" id="bulk-delete">
51
- <h2>bulk delete<a class="headerlink" href="#bulk-delete" title="Permalink to this headline">¶</a></h2>
52
- <p>The <tt class="docutils literal"><span class="pre">bulk</span> <span class="pre">delete</span></tt> argument is used to delete one or more nodes that match a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (/).</p>
53
- <div class="section" id="syntax">
54
- <h3>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h3>
55
- <p>This argument has the following syntax:</p>
56
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node bulk delete REGEX
57
- </pre></div>
58
- </div>
59
- </div>
60
- <div class="section" id="options">
61
- <h3>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h3>
62
- <p>This command does not have any specific options.</p>
63
- </div>
64
- <div class="section" id="examples">
65
- <h3>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3>
66
- <p>The following examples show how to use this knife subcommand:</p>
67
- <p><strong>Bulk delete nodes</strong></p>
68
- <p>Use a regular expression to define the pattern used to bulk delete nodes:</p>
69
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node bulk delete <span class="s2">&quot;^[0-9]{3}$&quot;</span>
70
- </pre></div>
71
- </div>
72
- <p>Type <tt class="docutils literal"><span class="pre">Y</span></tt> to confirm a deletion.</p>
73
- </div>
74
- </div>
75
- <div class="section" id="create">
76
- <h2>create<a class="headerlink" href="#create" title="Permalink to this headline">¶</a></h2>
77
- <p>The <tt class="docutils literal"><span class="pre">create</span></tt> argument is used to add a node to the Chef server. Node data is stored as JSON on the Chef server.</p>
78
- <div class="section" id="id1">
79
- <h3>Syntax<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
80
- <p>This argument has the following syntax:</p>
81
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node create NODE_NAME
82
- </pre></div>
83
- </div>
84
- </div>
85
- <div class="section" id="id2">
86
- <h3>Options<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
87
- <p>This command does not have any specific options.</p>
88
- </div>
89
- <div class="section" id="id3">
90
- <h3>Examples<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
91
- <p>The following examples show how to use this knife subcommand:</p>
92
- <p><strong>Create a node</strong></p>
93
- <p>To add a node, enter:</p>
94
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node create node1
95
- </pre></div>
96
- </div>
97
- <p>In the $EDITOR enter the node data in JSON:</p>
98
- <div class="highlight-javascript"><div class="highlight"><pre>## sample:
99
- {
100
- &quot;normal&quot;: {
101
- },
102
- &quot;name&quot;: &quot;foobar&quot;,
103
- &quot;override&quot;: {
104
- },
105
- &quot;default&quot;: {
106
- },
107
- &quot;json_class&quot;: &quot;Chef::Node&quot;,
108
- &quot;automatic&quot;: {
109
- },
110
- &quot;run_list&quot;: [
111
- &quot;recipe[zsh]&quot;,
112
- &quot;role[webserver]&quot;
113
- ],
114
- &quot;chef_type&quot;: &quot;node&quot;
115
- }
116
- </pre></div>
117
- </div>
118
- <p>When finished, save it.</p>
119
- </div>
120
- </div>
121
- <div class="section" id="delete">
122
- <h2>delete<a class="headerlink" href="#delete" title="Permalink to this headline">¶</a></h2>
123
- <p>The <tt class="docutils literal"><span class="pre">delete</span></tt> argument is used to delete a node from the Chef server.</p>
124
- <div class="admonition note">
125
- <p class="first admonition-title">Note</p>
126
- <p class="last">Deleting a node will not delete any corresponding API clients.</p>
127
- </div>
128
- <div class="section" id="id4">
129
- <h3>Syntax<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
130
- <p>This argument has the following syntax:</p>
131
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node delete NODE_NAME
132
- </pre></div>
133
- </div>
134
- </div>
135
- <div class="section" id="id5">
136
- <h3>Options<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
137
- <p>This command does not have any specific options.</p>
138
- </div>
139
- <div class="section" id="id6">
140
- <h3>Examples<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
141
- <p>The following examples show how to use this knife subcommand:</p>
142
- <p><strong>Delete a node</strong></p>
143
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node delete node_name
144
- </pre></div>
145
- </div>
146
- </div>
147
- </div>
148
- <div class="section" id="edit">
149
- <h2>edit<a class="headerlink" href="#edit" title="Permalink to this headline">¶</a></h2>
150
- <p>The <tt class="docutils literal"><span class="pre">edit</span></tt> argument is used to edit the details of a node on a Chef server. Node data is stored as JSON on the Chef server.</p>
151
- <div class="section" id="id7">
152
- <h3>Syntax<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
153
- <p>This argument has the following syntax:</p>
154
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node edit NODE_NAME <span class="o">(</span>options<span class="o">)</span>
155
- </pre></div>
156
- </div>
157
- </div>
158
- <div class="section" id="id8">
159
- <h3>Options<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
160
- <p>This argument has the following options:</p>
161
- <dl class="docutils">
162
- <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
163
- <dd>Displays a node in the $EDITOR. By default, attributes that are default, override, or automatic are not shown.</dd>
164
- </dl>
165
- </div>
166
- <div class="section" id="id9">
167
- <h3>Examples<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
168
- <p>The following examples show how to use this knife subcommand:</p>
169
- <p><strong>Edit a node</strong></p>
170
- <p>To edit the data for a node named <tt class="docutils literal"><span class="pre">node1</span></tt>, enter:</p>
171
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node edit node1 -a
172
- </pre></div>
173
- </div>
174
- <p>Update the role data in JSON:</p>
175
- <div class="highlight-javascript"><div class="highlight"><pre>## sample:
176
- {
177
- &quot;normal&quot;: {
178
- },
179
- &quot;name&quot;: &quot;node1&quot;,
180
- &quot;override&quot;: {
181
- },
182
- &quot;default&quot;: {
183
- },
184
- &quot;json_class&quot;: &quot;Chef::Node&quot;,
185
- &quot;automatic&quot;: {
186
- },
187
- &quot;run_list&quot;: [
188
- &quot;recipe[devops]&quot;,
189
- &quot;role[webserver]&quot;
190
- ],
191
- &quot;chef_type&quot;: &quot;node&quot;
192
- }
193
- </pre></div>
194
- </div>
195
- <p>When finished, save it.</p>
196
- </div>
197
- </div>
198
- <div class="section" id="from-file">
199
- <h2>from file<a class="headerlink" href="#from-file" title="Permalink to this headline">¶</a></h2>
200
- <p>The <tt class="docutils literal"><span class="pre">from</span> <span class="pre">file</span></tt> argument is used to create a node using existing node data as a template.</p>
201
- <div class="section" id="id10">
202
- <h3>Syntax<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
203
- <p>This argument has the following syntax:</p>
204
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node from file FILE
205
- </pre></div>
206
- </div>
207
- </div>
208
- <div class="section" id="id11">
209
- <h3>Options<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
210
- <p>This command does not have any specific options.</p>
211
- </div>
212
- <div class="section" id="id12">
213
- <h3>Examples<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
214
- <p>The following examples show how to use this knife subcommand:</p>
215
- <p><strong>Create a node using a JSON file</strong></p>
216
- <p>To add a node using data contained in a JSON file:</p>
217
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node from file <span class="s2">&quot;path to JSON file&quot;</span>
218
- </pre></div>
219
- </div>
220
- </div>
221
- </div>
222
- <div class="section" id="list">
223
- <h2>list<a class="headerlink" href="#list" title="Permalink to this headline">¶</a></h2>
224
- <p>The <tt class="docutils literal"><span class="pre">list</span></tt> argument is used to view all of the nodes that exist on a Chef server.</p>
225
- <div class="section" id="id13">
226
- <h3>Syntax<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
227
- <p>This argument has the following syntax:</p>
228
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node list <span class="o">(</span>options<span class="o">)</span>
229
- </pre></div>
230
- </div>
231
- </div>
232
- <div class="section" id="id14">
233
- <h3>Options<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3>
234
- <p>This argument has the following options:</p>
235
- <dl class="docutils">
236
- <dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
237
- <dd>Use to show the corresponding URIs.</dd>
238
- </dl>
239
- </div>
240
- <div class="section" id="id15">
241
- <h3>Examples<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
242
- <p>The following examples show how to use this knife subcommand:</p>
243
- <p><strong>View a list of nodes</strong></p>
244
- <p>To verify the list of nodes that are registered with the Chef server, enter:</p>
245
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node list
246
- </pre></div>
247
- </div>
248
- <p>to return something similar to:</p>
249
- <div class="highlight-bash"><div class="highlight"><pre>i-12345678
250
- rs-123456
251
- </pre></div>
252
- </div>
253
- </div>
254
- </div>
255
- <div class="section" id="run-list-add">
256
- <h2>run_list add<a class="headerlink" href="#run-list-add" title="Permalink to this headline">¶</a></h2>
257
- <p>A run-list defines all of the configuration settings that are necessary for a node that is under management by Chef to be put into the desired state. A run-list is:</p>
258
- <ul class="simple">
259
- <li>An ordered list of roles and/or recipes that are run in an exact order; if a recipe appears more than once in the run-list, the chef-client will never run that recipe twice</li>
260
- <li>Always specific to the node on which it runs, though it is possible for many nodes to have run-lists that are similar or even identical</li>
261
- <li>Stored as part of the node object on the Chef server</li>
262
- <li>Maintained using knife and uploaded to the Chef server or via the Chef management console user interface</li>
263
- </ul>
264
- <p>The <tt class="docutils literal"><span class="pre">run_list</span> <span class="pre">add</span></tt> argument is used to add run-list items (roles or recipes) to a node.</p>
265
- <p>A run-list must be in one of the following formats: fully qualified, cookbook, or default. Both roles and recipes must be in quotes, for example:</p>
266
- <div class="highlight-ruby"><div class="highlight"><pre><span class="s1">&#39;role[ROLE_NAME]&#39;</span>
267
- </pre></div>
268
- </div>
269
- <p>or</p>
270
- <div class="highlight-ruby"><div class="highlight"><pre><span class="s1">&#39;recipe[COOKBOOK::RECIPE_NAME]&#39;</span>
271
- </pre></div>
272
- </div>
273
- <p>Use a comma to separate roles and recipes when adding more than one item the run-list:</p>
274
- <div class="highlight-ruby"><div class="highlight"><pre><span class="s1">&#39;recipe[COOKBOOK::RECIPE_NAME],COOKBOOK::RECIPE_NAME,role[ROLE_NAME]&#39;</span>
275
- </pre></div>
276
- </div>
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 node run_list add NODE_NAME RUN_LIST_ITEM <span class="o">(</span>options<span class="o">)</span>
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 argument has the following options:</p>
287
- <dl class="docutils">
288
- <dt><tt class="docutils literal"><span class="pre">-a</span> <span class="pre">ITEM</span></tt>, <tt class="docutils literal"><span class="pre">--after</span> <span class="pre">ITEM</span></tt></dt>
289
- <dd>Use this to add the run list item after the specified run list item.</dd>
290
- <dt><tt class="docutils literal"><span class="pre">-b</span> <span class="pre">ITEM</span></tt>, <tt class="docutils literal"><span class="pre">--before</span> <span class="pre">ITEM</span></tt></dt>
291
- <dd>Use this to add the run list item before the specified run list item.</dd>
292
- </dl>
293
- </div>
294
- <div class="section" id="id18">
295
- <h3>Examples<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3>
296
- <p>The following examples show how to use this knife subcommand:</p>
297
- <p><strong>Add a role</strong></p>
298
- <p>To add a role to a run-list, enter:</p>
299
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list add node <span class="s1">&#39;role[ROLE_NAME]&#39;</span>
300
- </pre></div>
301
- </div>
302
- <p><strong>Add roles and recipes</strong></p>
303
- <p>To add roles and recipes to a run-list, enter:</p>
304
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list add node <span class="s1">&#39;recipe[COOKBOOK::RECIPE_NAME],recipe[COOKBOOK::RECIPE_NAME],role[ROLE_NAME]&#39;</span>
305
- </pre></div>
306
- </div>
307
- <p><strong>Add a recipe with a FQDN</strong></p>
308
- <p>To add a recipe to a run-list using the fully qualified format, enter:</p>
309
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list add node <span class="s1">&#39;recipe[COOKBOOK::RECIPE_NAME]&#39;</span>
310
- </pre></div>
311
- </div>
312
- <p><strong>Add a recipe with a cookbook</strong></p>
313
- <p>To add a recipe to a run-list using the cookbook format, enter:</p>
314
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list add node <span class="s1">&#39;COOKBOOK::RECIPE_NAME&#39;</span>
315
- </pre></div>
316
- </div>
317
- <p><strong>Add the default recipe</strong></p>
318
- <p>To add the default recipe of a cookbook to a run-list, enter:</p>
319
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list add node <span class="s1">&#39;COOKBOOK&#39;</span>
320
- </pre></div>
321
- </div>
322
- </div>
323
- </div>
324
- <div class="section" id="run-list-remove">
325
- <h2>run_list remove<a class="headerlink" href="#run-list-remove" title="Permalink to this headline">¶</a></h2>
326
- <p>The <tt class="docutils literal"><span class="pre">run_list</span> <span class="pre">remove</span></tt> argument is used to remove run-list items (roles or recipes) from a node. A recipe must be in one of the following formats: fully qualified, cookbook, or default. Both roles and recipes must be in quotes, for example: <tt class="docutils literal"><span class="pre">'role[ROLE_NAME]'</span></tt> or <tt class="docutils literal"><span class="pre">'recipe[COOKBOOK::RECIPE_NAME]'</span></tt>. Use a comma to separate roles and recipes when removing more than one, like this: <tt class="docutils literal"><span class="pre">'recipe[COOKBOOK::RECIPE_NAME],COOKBOOK::RECIPE_NAME,role[ROLE_NAME]'</span></tt>.</p>
327
- <div class="section" id="id19">
328
- <h3>Syntax<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h3>
329
- <p>This argument has the following syntax:</p>
330
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list remove NODE_NAME RUN_LIST_ITEM
331
- </pre></div>
332
- </div>
333
- </div>
334
- <div class="section" id="id20">
335
- <h3>Options<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h3>
336
- <p>This command does not have any specific options.</p>
337
- </div>
338
- <div class="section" id="id21">
339
- <h3>Examples<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h3>
340
- <p>The following examples show how to use this knife subcommand:</p>
341
- <p><strong>Remove a role</strong></p>
342
- <p>To remove a role from a run-list, enter:</p>
343
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list remove node <span class="s1">&#39;role[ROLE_NAME]&#39;</span>
344
- </pre></div>
345
- </div>
346
- <p><strong>Remove a run-list</strong></p>
347
- <p>To remove a recipe from a run-list using the fully qualified format, enter:</p>
348
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list remove node <span class="s1">&#39;recipe[COOKBOOK::RECIPE_NAME]&#39;</span>
349
- </pre></div>
350
- </div>
351
- </div>
352
- </div>
353
- <div class="section" id="show">
354
- <h2>show<a class="headerlink" href="#show" title="Permalink to this headline">¶</a></h2>
355
- <p>The <tt class="docutils literal"><span class="pre">show</span></tt> argument is used to display information about a node.</p>
356
- <div class="section" id="id22">
357
- <h3>Syntax<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3>
358
- <p>This argument has the following syntax:</p>
359
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node show NODE_NAME <span class="o">(</span>options<span class="o">)</span>
360
- </pre></div>
361
- </div>
362
- </div>
363
- <div class="section" id="id23">
364
- <h3>Options<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3>
365
- <p>This argument has the following options:</p>
366
- <dl class="docutils">
367
- <dt><tt class="docutils literal"><span class="pre">-a</span> <span class="pre">ATTR</span></tt>, <tt class="docutils literal"><span class="pre">--attribute</span> <span class="pre">ATTR</span></tt></dt>
368
- <dd>The attribute (or attributes) to show.</dd>
369
- <dt><tt class="docutils literal"><span class="pre">-l</span></tt>, <tt class="docutils literal"><span class="pre">--long</span></tt></dt>
370
- <dd>Use to display all attributes in the output and to show the output as JSON.</dd>
371
- <dt><tt class="docutils literal"><span class="pre">-m</span></tt>, <tt class="docutils literal"><span class="pre">--medium</span></tt></dt>
372
- <dd>Use to display normal attributes in the output and to show the output as JSON.</dd>
373
- <dt><tt class="docutils literal"><span class="pre">-r</span></tt>, <tt class="docutils literal"><span class="pre">--run-list</span></tt></dt>
374
- <dd>Use to show only the run-list.</dd>
375
- </dl>
376
- </div>
377
- <div class="section" id="id24">
378
- <h3>Examples<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3>
379
- <p>The following examples show how to use this knife subcommand:</p>
380
- <p><strong>Show all data about nodes</strong></p>
381
- <p>To view all data for a node named <tt class="docutils literal"><span class="pre">build</span></tt>, enter:</p>
382
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node show build
383
- </pre></div>
384
- </div>
385
- <p>to return:</p>
386
- <div class="highlight-bash"><div class="highlight"><pre>Node Name: build
387
- Environment: _default
388
- FQDN:
389
- IP:
390
- Run List:
391
- Roles:
392
- Recipes:
393
- Platform:
394
- </pre></div>
395
- </div>
396
- <p><strong>Show basic information about nodes</strong></p>
397
- <p>To show basic information about a node, truncated and nicely formatted:</p>
398
- <div class="highlight-bash"><div class="highlight"><pre>knife node show &lt;node_name&gt;
399
- </pre></div>
400
- </div>
401
- <p><strong>Show all data about nodes, truncated</strong></p>
402
- <p>To show all information about a node, nicely formatted:</p>
403
- <div class="highlight-bash"><div class="highlight"><pre>knife node show -l &lt;node_name&gt;
404
- </pre></div>
405
- </div>
406
- <p><strong>Show attributes</strong></p>
407
- <p>To list a single node attribute:</p>
408
- <div class="highlight-bash"><div class="highlight"><pre>knife node show &lt;node_name&gt; -a &lt;attribute_name&gt;
409
- </pre></div>
410
- </div>
411
- <p>where <tt class="docutils literal"><span class="pre">&lt;attribute_name&gt;</span></tt> is something like kernel or platform. (This doesn&#8217;t work for nested attributes like <tt class="docutils literal"><span class="pre">node[kernel][machine]</span></tt> because <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">node</span> <span class="pre">show</span></tt> doesn&#8217;t understand nested attributes.)</p>
412
- <p><strong>Show the FQDN</strong></p>
413
- <p>To view the FQDN for a node named <tt class="docutils literal"><span class="pre">i-12345678</span></tt>, enter:</p>
414
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node show i-12345678 -a fqdn
415
- </pre></div>
416
- </div>
417
- <p>to return:</p>
418
- <div class="highlight-bash"><div class="highlight"><pre>fqdn: ip-10-251-75-20.ec2.internal
419
- </pre></div>
420
- </div>
421
- <p><strong>Show a run-list</strong></p>
422
- <p>To view the run list for a node named <tt class="docutils literal"><span class="pre">dev</span></tt>, enter:</p>
423
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node show dev -r
424
- </pre></div>
425
- </div>
426
- <p><strong>Show as JSON data</strong></p>
427
- <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>
428
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role show devops -F json
429
- </pre></div>
430
- </div>
431
- <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>
432
- <p><strong>Show as raw JSON data</strong></p>
433
- <p>To view node information in raw JSON, use the <tt class="docutils literal"><span class="pre">-l</span></tt> or <tt class="docutils literal"><span class="pre">--long</span></tt> option:</p>
434
- <div class="highlight-bash"><div class="highlight"><pre>knife node show -l -F json &lt;node_name&gt;
435
- </pre></div>
436
- </div>
437
- <p>and/or:</p>
438
- <div class="highlight-bash"><div class="highlight"><pre>knife node show -l --format<span class="o">=</span>json &lt;node_name&gt;
439
- </pre></div>
440
- </div>
441
- </div>
442
- </div>
443
- </div>
444
-
445
-
446
- </div>
447
-
448
- </div>
449
-
450
-
451
- <div class="clearer"></div>
452
- </div>
453
-
454
-
455
-
456
-
457
- </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 node &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-node">
43
+ <h1>knife node<a class="headerlink" href="#knife-node" title="Permalink to this headline">¶</a></h1>
44
+ <p>A node is any physical, virtual, or cloud machine that is configured to be maintained by a chef-client.</p>
45
+ <p>The <strong>knife node</strong> subcommand is used to manage the nodes that exist on a Chef server.</p>
46
+ <div class="admonition note">
47
+ <p class="first admonition-title">Note</p>
48
+ <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>
49
+ </div>
50
+ <div class="section" id="bulk-delete">
51
+ <h2>bulk delete<a class="headerlink" href="#bulk-delete" title="Permalink to this headline">¶</a></h2>
52
+ <p>The <tt class="docutils literal"><span class="pre">bulk</span> <span class="pre">delete</span></tt> argument is used to delete one or more nodes that match a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (/).</p>
53
+ <div class="section" id="syntax">
54
+ <h3>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h3>
55
+ <p>This argument has the following syntax:</p>
56
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node bulk delete REGEX
57
+ </pre></div>
58
+ </div>
59
+ </div>
60
+ <div class="section" id="options">
61
+ <h3>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h3>
62
+ <p>This command does not have any specific options.</p>
63
+ </div>
64
+ <div class="section" id="examples">
65
+ <h3>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3>
66
+ <p>The following examples show how to use this knife subcommand:</p>
67
+ <p><strong>Bulk delete nodes</strong></p>
68
+ <p>Use a regular expression to define the pattern used to bulk delete nodes:</p>
69
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node bulk delete <span class="s2">&quot;^[0-9]{3}$&quot;</span>
70
+ </pre></div>
71
+ </div>
72
+ <p>Type <tt class="docutils literal"><span class="pre">Y</span></tt> to confirm a deletion.</p>
73
+ </div>
74
+ </div>
75
+ <div class="section" id="create">
76
+ <h2>create<a class="headerlink" href="#create" title="Permalink to this headline">¶</a></h2>
77
+ <p>The <tt class="docutils literal"><span class="pre">create</span></tt> argument is used to add a node to the Chef server. Node data is stored as JSON on the Chef server.</p>
78
+ <div class="section" id="id1">
79
+ <h3>Syntax<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
80
+ <p>This argument has the following syntax:</p>
81
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node create NODE_NAME
82
+ </pre></div>
83
+ </div>
84
+ </div>
85
+ <div class="section" id="id2">
86
+ <h3>Options<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
87
+ <p>This command does not have any specific options.</p>
88
+ </div>
89
+ <div class="section" id="id3">
90
+ <h3>Examples<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
91
+ <p>The following examples show how to use this knife subcommand:</p>
92
+ <p><strong>Create a node</strong></p>
93
+ <p>To add a node, enter:</p>
94
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node create node1
95
+ </pre></div>
96
+ </div>
97
+ <p>In the $EDITOR enter the node data in JSON:</p>
98
+ <div class="highlight-javascript"><div class="highlight"><pre>## sample:
99
+ {
100
+ &quot;normal&quot;: {
101
+ },
102
+ &quot;name&quot;: &quot;foobar&quot;,
103
+ &quot;override&quot;: {
104
+ },
105
+ &quot;default&quot;: {
106
+ },
107
+ &quot;json_class&quot;: &quot;Chef::Node&quot;,
108
+ &quot;automatic&quot;: {
109
+ },
110
+ &quot;run_list&quot;: [
111
+ &quot;recipe[zsh]&quot;,
112
+ &quot;role[webserver]&quot;
113
+ ],
114
+ &quot;chef_type&quot;: &quot;node&quot;
115
+ }
116
+ </pre></div>
117
+ </div>
118
+ <p>When finished, save it.</p>
119
+ </div>
120
+ </div>
121
+ <div class="section" id="delete">
122
+ <h2>delete<a class="headerlink" href="#delete" title="Permalink to this headline">¶</a></h2>
123
+ <p>The <tt class="docutils literal"><span class="pre">delete</span></tt> argument is used to delete a node from the Chef server.</p>
124
+ <div class="admonition note">
125
+ <p class="first admonition-title">Note</p>
126
+ <p class="last">Deleting a node will not delete any corresponding API clients.</p>
127
+ </div>
128
+ <div class="section" id="id4">
129
+ <h3>Syntax<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
130
+ <p>This argument has the following syntax:</p>
131
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node delete NODE_NAME
132
+ </pre></div>
133
+ </div>
134
+ </div>
135
+ <div class="section" id="id5">
136
+ <h3>Options<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
137
+ <p>This command does not have any specific options.</p>
138
+ </div>
139
+ <div class="section" id="id6">
140
+ <h3>Examples<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
141
+ <p>The following examples show how to use this knife subcommand:</p>
142
+ <p><strong>Delete a node</strong></p>
143
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node delete node_name
144
+ </pre></div>
145
+ </div>
146
+ </div>
147
+ </div>
148
+ <div class="section" id="edit">
149
+ <h2>edit<a class="headerlink" href="#edit" title="Permalink to this headline">¶</a></h2>
150
+ <p>The <tt class="docutils literal"><span class="pre">edit</span></tt> argument is used to edit the details of a node on a Chef server. Node data is stored as JSON on the Chef server.</p>
151
+ <div class="section" id="id7">
152
+ <h3>Syntax<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
153
+ <p>This argument has the following syntax:</p>
154
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node edit NODE_NAME <span class="o">(</span>options<span class="o">)</span>
155
+ </pre></div>
156
+ </div>
157
+ </div>
158
+ <div class="section" id="id8">
159
+ <h3>Options<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
160
+ <p>This argument has the following options:</p>
161
+ <dl class="docutils">
162
+ <dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all</span></tt></dt>
163
+ <dd>Displays a node in the $EDITOR. By default, attributes that are default, override, or automatic are not shown.</dd>
164
+ </dl>
165
+ </div>
166
+ <div class="section" id="id9">
167
+ <h3>Examples<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
168
+ <p>The following examples show how to use this knife subcommand:</p>
169
+ <p><strong>Edit a node</strong></p>
170
+ <p>To edit the data for a node named <tt class="docutils literal"><span class="pre">node1</span></tt>, enter:</p>
171
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node edit node1 -a
172
+ </pre></div>
173
+ </div>
174
+ <p>Update the role data in JSON:</p>
175
+ <div class="highlight-javascript"><div class="highlight"><pre>## sample:
176
+ {
177
+ &quot;normal&quot;: {
178
+ },
179
+ &quot;name&quot;: &quot;node1&quot;,
180
+ &quot;override&quot;: {
181
+ },
182
+ &quot;default&quot;: {
183
+ },
184
+ &quot;json_class&quot;: &quot;Chef::Node&quot;,
185
+ &quot;automatic&quot;: {
186
+ },
187
+ &quot;run_list&quot;: [
188
+ &quot;recipe[devops]&quot;,
189
+ &quot;role[webserver]&quot;
190
+ ],
191
+ &quot;chef_type&quot;: &quot;node&quot;
192
+ }
193
+ </pre></div>
194
+ </div>
195
+ <p>When finished, save it.</p>
196
+ </div>
197
+ </div>
198
+ <div class="section" id="from-file">
199
+ <h2>from file<a class="headerlink" href="#from-file" title="Permalink to this headline">¶</a></h2>
200
+ <p>The <tt class="docutils literal"><span class="pre">from</span> <span class="pre">file</span></tt> argument is used to create a node using existing node data as a template.</p>
201
+ <div class="section" id="id10">
202
+ <h3>Syntax<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
203
+ <p>This argument has the following syntax:</p>
204
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node from file FILE
205
+ </pre></div>
206
+ </div>
207
+ </div>
208
+ <div class="section" id="id11">
209
+ <h3>Options<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
210
+ <p>This command does not have any specific options.</p>
211
+ </div>
212
+ <div class="section" id="id12">
213
+ <h3>Examples<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
214
+ <p>The following examples show how to use this knife subcommand:</p>
215
+ <p><strong>Create a node using a JSON file</strong></p>
216
+ <p>To add a node using data contained in a JSON file:</p>
217
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node from file <span class="s2">&quot;path to JSON file&quot;</span>
218
+ </pre></div>
219
+ </div>
220
+ </div>
221
+ </div>
222
+ <div class="section" id="list">
223
+ <h2>list<a class="headerlink" href="#list" title="Permalink to this headline">¶</a></h2>
224
+ <p>The <tt class="docutils literal"><span class="pre">list</span></tt> argument is used to view all of the nodes that exist on a Chef server.</p>
225
+ <div class="section" id="id13">
226
+ <h3>Syntax<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
227
+ <p>This argument has the following syntax:</p>
228
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node list <span class="o">(</span>options<span class="o">)</span>
229
+ </pre></div>
230
+ </div>
231
+ </div>
232
+ <div class="section" id="id14">
233
+ <h3>Options<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3>
234
+ <p>This argument has the following options:</p>
235
+ <dl class="docutils">
236
+ <dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
237
+ <dd>Use to show the corresponding URIs.</dd>
238
+ </dl>
239
+ </div>
240
+ <div class="section" id="id15">
241
+ <h3>Examples<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
242
+ <p>The following examples show how to use this knife subcommand:</p>
243
+ <p><strong>View a list of nodes</strong></p>
244
+ <p>To verify the list of nodes that are registered with the Chef server, enter:</p>
245
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node list
246
+ </pre></div>
247
+ </div>
248
+ <p>to return something similar to:</p>
249
+ <div class="highlight-bash"><div class="highlight"><pre>i-12345678
250
+ rs-123456
251
+ </pre></div>
252
+ </div>
253
+ </div>
254
+ </div>
255
+ <div class="section" id="run-list-add">
256
+ <h2>run_list add<a class="headerlink" href="#run-list-add" title="Permalink to this headline">¶</a></h2>
257
+ <p>A run-list defines all of the configuration settings that are necessary for a node that is under management by Chef to be put into the desired state. A run-list is:</p>
258
+ <ul class="simple">
259
+ <li>An ordered list of roles and/or recipes that are run in an exact order; if a recipe appears more than once in the run-list, the chef-client will never run that recipe twice</li>
260
+ <li>Always specific to the node on which it runs, though it is possible for many nodes to have run-lists that are similar or even identical</li>
261
+ <li>Stored as part of the node object on the Chef server</li>
262
+ <li>Maintained using knife and uploaded to the Chef server or via the Chef management console user interface</li>
263
+ </ul>
264
+ <p>The <tt class="docutils literal"><span class="pre">run_list</span> <span class="pre">add</span></tt> argument is used to add run-list items (roles or recipes) to a node.</p>
265
+ <p>A run-list must be in one of the following formats: fully qualified, cookbook, or default. Both roles and recipes must be in quotes, for example:</p>
266
+ <div class="highlight-ruby"><div class="highlight"><pre><span class="s1">&#39;role[ROLE_NAME]&#39;</span>
267
+ </pre></div>
268
+ </div>
269
+ <p>or</p>
270
+ <div class="highlight-ruby"><div class="highlight"><pre><span class="s1">&#39;recipe[COOKBOOK::RECIPE_NAME]&#39;</span>
271
+ </pre></div>
272
+ </div>
273
+ <p>Use a comma to separate roles and recipes when adding more than one item the run-list:</p>
274
+ <div class="highlight-ruby"><div class="highlight"><pre><span class="s1">&#39;recipe[COOKBOOK::RECIPE_NAME],COOKBOOK::RECIPE_NAME,role[ROLE_NAME]&#39;</span>
275
+ </pre></div>
276
+ </div>
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 node run_list add NODE_NAME RUN_LIST_ITEM <span class="o">(</span>options<span class="o">)</span>
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 argument has the following options:</p>
287
+ <dl class="docutils">
288
+ <dt><tt class="docutils literal"><span class="pre">-a</span> <span class="pre">ITEM</span></tt>, <tt class="docutils literal"><span class="pre">--after</span> <span class="pre">ITEM</span></tt></dt>
289
+ <dd>Use this to add the run list item after the specified run list item.</dd>
290
+ <dt><tt class="docutils literal"><span class="pre">-b</span> <span class="pre">ITEM</span></tt>, <tt class="docutils literal"><span class="pre">--before</span> <span class="pre">ITEM</span></tt></dt>
291
+ <dd>Use this to add the run list item before the specified run list item.</dd>
292
+ </dl>
293
+ </div>
294
+ <div class="section" id="id18">
295
+ <h3>Examples<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3>
296
+ <p>The following examples show how to use this knife subcommand:</p>
297
+ <p><strong>Add a role</strong></p>
298
+ <p>To add a role to a run-list, enter:</p>
299
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list add node <span class="s1">&#39;role[ROLE_NAME]&#39;</span>
300
+ </pre></div>
301
+ </div>
302
+ <p><strong>Add roles and recipes</strong></p>
303
+ <p>To add roles and recipes to a run-list, enter:</p>
304
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list add node <span class="s1">&#39;recipe[COOKBOOK::RECIPE_NAME],recipe[COOKBOOK::RECIPE_NAME],role[ROLE_NAME]&#39;</span>
305
+ </pre></div>
306
+ </div>
307
+ <p><strong>Add a recipe with a FQDN</strong></p>
308
+ <p>To add a recipe to a run-list using the fully qualified format, enter:</p>
309
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list add node <span class="s1">&#39;recipe[COOKBOOK::RECIPE_NAME]&#39;</span>
310
+ </pre></div>
311
+ </div>
312
+ <p><strong>Add a recipe with a cookbook</strong></p>
313
+ <p>To add a recipe to a run-list using the cookbook format, enter:</p>
314
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list add node <span class="s1">&#39;COOKBOOK::RECIPE_NAME&#39;</span>
315
+ </pre></div>
316
+ </div>
317
+ <p><strong>Add the default recipe</strong></p>
318
+ <p>To add the default recipe of a cookbook to a run-list, enter:</p>
319
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list add node <span class="s1">&#39;COOKBOOK&#39;</span>
320
+ </pre></div>
321
+ </div>
322
+ </div>
323
+ </div>
324
+ <div class="section" id="run-list-remove">
325
+ <h2>run_list remove<a class="headerlink" href="#run-list-remove" title="Permalink to this headline">¶</a></h2>
326
+ <p>The <tt class="docutils literal"><span class="pre">run_list</span> <span class="pre">remove</span></tt> argument is used to remove run-list items (roles or recipes) from a node. A recipe must be in one of the following formats: fully qualified, cookbook, or default. Both roles and recipes must be in quotes, for example: <tt class="docutils literal"><span class="pre">'role[ROLE_NAME]'</span></tt> or <tt class="docutils literal"><span class="pre">'recipe[COOKBOOK::RECIPE_NAME]'</span></tt>. Use a comma to separate roles and recipes when removing more than one, like this: <tt class="docutils literal"><span class="pre">'recipe[COOKBOOK::RECIPE_NAME],COOKBOOK::RECIPE_NAME,role[ROLE_NAME]'</span></tt>.</p>
327
+ <div class="section" id="id19">
328
+ <h3>Syntax<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h3>
329
+ <p>This argument has the following syntax:</p>
330
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list remove NODE_NAME RUN_LIST_ITEM
331
+ </pre></div>
332
+ </div>
333
+ </div>
334
+ <div class="section" id="id20">
335
+ <h3>Options<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h3>
336
+ <p>This command does not have any specific options.</p>
337
+ </div>
338
+ <div class="section" id="id21">
339
+ <h3>Examples<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h3>
340
+ <p>The following examples show how to use this knife subcommand:</p>
341
+ <p><strong>Remove a role</strong></p>
342
+ <p>To remove a role from a run-list, enter:</p>
343
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list remove node <span class="s1">&#39;role[ROLE_NAME]&#39;</span>
344
+ </pre></div>
345
+ </div>
346
+ <p><strong>Remove a run-list</strong></p>
347
+ <p>To remove a recipe from a run-list using the fully qualified format, enter:</p>
348
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node run_list remove node <span class="s1">&#39;recipe[COOKBOOK::RECIPE_NAME]&#39;</span>
349
+ </pre></div>
350
+ </div>
351
+ </div>
352
+ </div>
353
+ <div class="section" id="show">
354
+ <h2>show<a class="headerlink" href="#show" title="Permalink to this headline">¶</a></h2>
355
+ <p>The <tt class="docutils literal"><span class="pre">show</span></tt> argument is used to display information about a node.</p>
356
+ <div class="section" id="id22">
357
+ <h3>Syntax<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3>
358
+ <p>This argument has the following syntax:</p>
359
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node show NODE_NAME <span class="o">(</span>options<span class="o">)</span>
360
+ </pre></div>
361
+ </div>
362
+ </div>
363
+ <div class="section" id="id23">
364
+ <h3>Options<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3>
365
+ <p>This argument has the following options:</p>
366
+ <dl class="docutils">
367
+ <dt><tt class="docutils literal"><span class="pre">-a</span> <span class="pre">ATTR</span></tt>, <tt class="docutils literal"><span class="pre">--attribute</span> <span class="pre">ATTR</span></tt></dt>
368
+ <dd>The attribute (or attributes) to show.</dd>
369
+ <dt><tt class="docutils literal"><span class="pre">-l</span></tt>, <tt class="docutils literal"><span class="pre">--long</span></tt></dt>
370
+ <dd>Use to display all attributes in the output and to show the output as JSON.</dd>
371
+ <dt><tt class="docutils literal"><span class="pre">-m</span></tt>, <tt class="docutils literal"><span class="pre">--medium</span></tt></dt>
372
+ <dd>Use to display normal attributes in the output and to show the output as JSON.</dd>
373
+ <dt><tt class="docutils literal"><span class="pre">-r</span></tt>, <tt class="docutils literal"><span class="pre">--run-list</span></tt></dt>
374
+ <dd>Use to show only the run-list.</dd>
375
+ </dl>
376
+ </div>
377
+ <div class="section" id="id24">
378
+ <h3>Examples<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3>
379
+ <p>The following examples show how to use this knife subcommand:</p>
380
+ <p><strong>Show all data about nodes</strong></p>
381
+ <p>To view all data for a node named <tt class="docutils literal"><span class="pre">build</span></tt>, enter:</p>
382
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node show build
383
+ </pre></div>
384
+ </div>
385
+ <p>to return:</p>
386
+ <div class="highlight-bash"><div class="highlight"><pre>Node Name: build
387
+ Environment: _default
388
+ FQDN:
389
+ IP:
390
+ Run List:
391
+ Roles:
392
+ Recipes:
393
+ Platform:
394
+ </pre></div>
395
+ </div>
396
+ <p><strong>Show basic information about nodes</strong></p>
397
+ <p>To show basic information about a node, truncated and nicely formatted:</p>
398
+ <div class="highlight-bash"><div class="highlight"><pre>knife node show &lt;node_name&gt;
399
+ </pre></div>
400
+ </div>
401
+ <p><strong>Show all data about nodes, truncated</strong></p>
402
+ <p>To show all information about a node, nicely formatted:</p>
403
+ <div class="highlight-bash"><div class="highlight"><pre>knife node show -l &lt;node_name&gt;
404
+ </pre></div>
405
+ </div>
406
+ <p><strong>Show attributes</strong></p>
407
+ <p>To list a single node attribute:</p>
408
+ <div class="highlight-bash"><div class="highlight"><pre>knife node show &lt;node_name&gt; -a &lt;attribute_name&gt;
409
+ </pre></div>
410
+ </div>
411
+ <p>where <tt class="docutils literal"><span class="pre">&lt;attribute_name&gt;</span></tt> is something like kernel or platform. (This doesn&#8217;t work for nested attributes like <tt class="docutils literal"><span class="pre">node[kernel][machine]</span></tt> because <tt class="docutils literal"><span class="pre">knife</span> <span class="pre">node</span> <span class="pre">show</span></tt> doesn&#8217;t understand nested attributes.)</p>
412
+ <p><strong>Show the FQDN</strong></p>
413
+ <p>To view the FQDN for a node named <tt class="docutils literal"><span class="pre">i-12345678</span></tt>, enter:</p>
414
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node show i-12345678 -a fqdn
415
+ </pre></div>
416
+ </div>
417
+ <p>to return:</p>
418
+ <div class="highlight-bash"><div class="highlight"><pre>fqdn: ip-10-251-75-20.ec2.internal
419
+ </pre></div>
420
+ </div>
421
+ <p><strong>Show a run-list</strong></p>
422
+ <p>To view the run list for a node named <tt class="docutils literal"><span class="pre">dev</span></tt>, enter:</p>
423
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife node show dev -r
424
+ </pre></div>
425
+ </div>
426
+ <p><strong>Show as JSON data</strong></p>
427
+ <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>
428
+ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role show devops -F json
429
+ </pre></div>
430
+ </div>
431
+ <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>
432
+ <p><strong>Show as raw JSON data</strong></p>
433
+ <p>To view node information in raw JSON, use the <tt class="docutils literal"><span class="pre">-l</span></tt> or <tt class="docutils literal"><span class="pre">--long</span></tt> option:</p>
434
+ <div class="highlight-bash"><div class="highlight"><pre>knife node show -l -F json &lt;node_name&gt;
435
+ </pre></div>
436
+ </div>
437
+ <p>and/or:</p>
438
+ <div class="highlight-bash"><div class="highlight"><pre>knife node show -l --format<span class="o">=</span>json &lt;node_name&gt;
439
+ </pre></div>
440
+ </div>
441
+ </div>
442
+ </div>
443
+ </div>
444
+
445
+
446
+ </div>
447
+
448
+ </div>
449
+
450
+
451
+ <div class="clearer"></div>
452
+ </div>
453
+
454
+
455
+
456
+
457
+ </body>
458
458
  </html>