chef 13.11.3 → 13.12.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (261) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +4 -3
  3. data/README.md +35 -40
  4. data/Rakefile +18 -22
  5. data/chef-universal-mingw32.gemspec +1 -1
  6. data/chef.gemspec +3 -3
  7. data/lib/chef/client.rb +1 -1
  8. data/lib/chef/mixin/params_validate.rb +3 -1
  9. data/lib/chef/provider/script.rb +2 -2
  10. data/lib/chef/version.rb +1 -1
  11. data/spec/functional/http/simple_spec.rb +12 -6
  12. data/spec/functional/resource/remote_file_spec.rb +19 -15
  13. data/spec/support/platform_helpers.rb +2 -1
  14. data/tasks/announce.rb +1 -1
  15. data/tasks/dependencies.rb +5 -39
  16. data/tasks/maintainers.rb +10 -10
  17. data/tasks/rspec.rb +2 -2
  18. data/tasks/templates/prerelease.md.erb +11 -2
  19. data/tasks/templates/release.md.erb +9 -1
  20. metadata +6 -248
  21. data/CONTRIBUTING.md +0 -151
  22. data/VERSION +0 -1
  23. data/acceptance/.gitignore +0 -3
  24. data/acceptance/.shared/kitchen_acceptance/.kitchen.digitalocean.yml +0 -33
  25. data/acceptance/.shared/kitchen_acceptance/.kitchen.ec2.yml +0 -283
  26. data/acceptance/.shared/kitchen_acceptance/.kitchen.vagrant.yml +0 -59
  27. data/acceptance/.shared/kitchen_acceptance/libraries/kitchen.rb +0 -68
  28. data/acceptance/.shared/kitchen_acceptance/metadata.rb +0 -1
  29. data/acceptance/Gemfile +0 -19
  30. data/acceptance/Gemfile.lock +0 -266
  31. data/acceptance/README.md +0 -137
  32. data/acceptance/basics/.acceptance/acceptance-cookbook/.gitignore +0 -2
  33. data/acceptance/basics/.acceptance/acceptance-cookbook/metadata.rb +0 -3
  34. data/acceptance/basics/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
  35. data/acceptance/basics/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
  36. data/acceptance/basics/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
  37. data/acceptance/basics/.kitchen.yml +0 -4
  38. data/acceptance/basics/test/integration/chef-current-install/serverspec/chef_client_spec.rb +0 -19
  39. data/acceptance/basics/test/integration/chef-current-install/serverspec/spec_helper.rb +0 -6
  40. data/acceptance/basics/test/integration/helpers/serverspec/Gemfile +0 -8
  41. data/acceptance/data-collector/.acceptance/acceptance-cookbook/.gitignore +0 -2
  42. data/acceptance/data-collector/.acceptance/acceptance-cookbook/metadata.rb +0 -3
  43. data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -2
  44. data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -2
  45. data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -2
  46. data/acceptance/data-collector/.acceptance/data-collector-test/.gitignore +0 -16
  47. data/acceptance/data-collector/.acceptance/data-collector-test/Berksfile +0 -3
  48. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/api.rb +0 -101
  49. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/apigemfile +0 -3
  50. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-both-mode.rb +0 -4
  51. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-client-mode.rb +0 -4
  52. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-no-endpoint.rb +0 -2
  53. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-solo-mode.rb +0 -4
  54. data/acceptance/data-collector/.acceptance/data-collector-test/files/default/config.ru +0 -2
  55. data/acceptance/data-collector/.acceptance/data-collector-test/metadata.rb +0 -7
  56. data/acceptance/data-collector/.acceptance/data-collector-test/recipes/default.rb +0 -44
  57. data/acceptance/data-collector/.kitchen.yml +0 -9
  58. data/acceptance/data-collector/Berksfile +0 -3
  59. data/acceptance/data-collector/test/integration/default/serverspec/default_spec.rb +0 -208
  60. data/acceptance/data-collector/test/integration/helpers/serverspec/Gemfile +0 -8
  61. data/acceptance/omnitruck/.acceptance/acceptance-cookbook/.gitignore +0 -2
  62. data/acceptance/omnitruck/.acceptance/acceptance-cookbook/metadata.rb +0 -1
  63. data/acceptance/omnitruck/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
  64. data/acceptance/omnitruck/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
  65. data/acceptance/omnitruck/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -61
  66. data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/.gitignore +0 -2
  67. data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/libraries/cookbook_kitchen.rb +0 -43
  68. data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/libraries/top_cookbooks.rb +0 -41
  69. data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/metadata.rb +0 -3
  70. data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
  71. data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
  72. data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
  73. data/acceptance/top-cookbooks/.gitignore +0 -1
  74. data/acceptance/top-cookbooks/.kitchen.chocolatey.yml +0 -6
  75. data/acceptance/top-cookbooks/.kitchen.iis.yml +0 -4
  76. data/acceptance/top-cookbooks/.kitchen.learn-the-basics-rhel.yml +0 -7
  77. data/acceptance/top-cookbooks/.kitchen.learn-the-basics-ubuntu.yml +0 -7
  78. data/acceptance/top-cookbooks/.kitchen.learn-the-basics-windows.yml +0 -7
  79. data/acceptance/top-cookbooks/.kitchen.powershell.yml +0 -4
  80. data/acceptance/top-cookbooks/.kitchen.sql_server.yml +0 -5
  81. data/acceptance/top-cookbooks/.kitchen.winbox.yml +0 -8
  82. data/acceptance/top-cookbooks/.kitchen.windows.yml +0 -38
  83. data/acceptance/trivial/.acceptance/acceptance-cookbook/.gitignore +0 -2
  84. data/acceptance/trivial/.acceptance/acceptance-cookbook/metadata.rb +0 -2
  85. data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
  86. data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
  87. data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
  88. data/acceptance/trivial/.kitchen.yml +0 -7
  89. data/acceptance/trivial/test/integration/chef-current-install/inspec/chef_client_spec.rb +0 -5
  90. data/acceptance/windows-service/.acceptance/acceptance-cookbook/.gitignore +0 -2
  91. data/acceptance/windows-service/.acceptance/acceptance-cookbook/metadata.rb +0 -2
  92. data/acceptance/windows-service/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
  93. data/acceptance/windows-service/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
  94. data/acceptance/windows-service/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
  95. data/acceptance/windows-service/.kitchen.yml +0 -7
  96. data/acceptance/windows-service/test/integration/chef-windows-service/inspec/chef_windows_service_spec.rb +0 -58
  97. data/distro/common/html/_sources/ctl_chef_client.txt +0 -36
  98. data/distro/common/html/_sources/ctl_chef_server.txt +0 -341
  99. data/distro/common/html/_sources/ctl_chef_shell.txt +0 -15
  100. data/distro/common/html/_sources/ctl_chef_solo.txt +0 -25
  101. data/distro/common/html/_sources/index.txt +0 -135
  102. data/distro/common/html/_sources/knife.txt +0 -74
  103. data/distro/common/html/_sources/knife_bootstrap.txt +0 -56
  104. data/distro/common/html/_sources/knife_client.txt +0 -151
  105. data/distro/common/html/_sources/knife_common_options.txt +0 -6
  106. data/distro/common/html/_sources/knife_configure.txt +0 -29
  107. data/distro/common/html/_sources/knife_cookbook.txt +0 -236
  108. data/distro/common/html/_sources/knife_cookbook_site.txt +0 -157
  109. data/distro/common/html/_sources/knife_data_bag.txt +0 -160
  110. data/distro/common/html/_sources/knife_delete.txt +0 -26
  111. data/distro/common/html/_sources/knife_deps.txt +0 -61
  112. data/distro/common/html/_sources/knife_diff.txt +0 -34
  113. data/distro/common/html/_sources/knife_download.txt +0 -44
  114. data/distro/common/html/_sources/knife_edit.txt +0 -26
  115. data/distro/common/html/_sources/knife_environment.txt +0 -158
  116. data/distro/common/html/_sources/knife_exec.txt +0 -47
  117. data/distro/common/html/_sources/knife_index_rebuild.txt +0 -21
  118. data/distro/common/html/_sources/knife_list.txt +0 -33
  119. data/distro/common/html/_sources/knife_node.txt +0 -250
  120. data/distro/common/html/_sources/knife_raw.txt +0 -35
  121. data/distro/common/html/_sources/knife_recipe_list.txt +0 -23
  122. data/distro/common/html/_sources/knife_role.txt +0 -157
  123. data/distro/common/html/_sources/knife_search.txt +0 -53
  124. data/distro/common/html/_sources/knife_serve.txt +0 -19
  125. data/distro/common/html/_sources/knife_show.txt +0 -27
  126. data/distro/common/html/_sources/knife_ssh.txt +0 -43
  127. data/distro/common/html/_sources/knife_ssl_check.txt +0 -41
  128. data/distro/common/html/_sources/knife_ssl_fetch.txt +0 -41
  129. data/distro/common/html/_sources/knife_status.txt +0 -37
  130. data/distro/common/html/_sources/knife_tag.txt +0 -69
  131. data/distro/common/html/_sources/knife_upload.txt +0 -49
  132. data/distro/common/html/_sources/knife_user.txt +0 -127
  133. data/distro/common/html/_sources/knife_using.txt +0 -43
  134. data/distro/common/html/_sources/knife_xargs.txt +0 -30
  135. data/distro/common/html/_static/ajax-loader.gif +0 -0
  136. data/distro/common/html/_static/basic.css +0 -537
  137. data/distro/common/html/_static/chef.ico +0 -0
  138. data/distro/common/html/_static/chef_html_logo.png +0 -0
  139. data/distro/common/html/_static/comment-bright.png +0 -0
  140. data/distro/common/html/_static/comment-close.png +0 -0
  141. data/distro/common/html/_static/comment.png +0 -0
  142. data/distro/common/html/_static/contents.png +0 -0
  143. data/distro/common/html/_static/doctools.js +0 -238
  144. data/distro/common/html/_static/down-pressed.png +0 -0
  145. data/distro/common/html/_static/down.png +0 -0
  146. data/distro/common/html/_static/file.png +0 -0
  147. data/distro/common/html/_static/guide.css +0 -505
  148. data/distro/common/html/_static/jquery.js +0 -2
  149. data/distro/common/html/_static/minus.png +0 -0
  150. data/distro/common/html/_static/navigation.png +0 -0
  151. data/distro/common/html/_static/plus.png +0 -0
  152. data/distro/common/html/_static/pygments.css +0 -62
  153. data/distro/common/html/_static/searchtools.js +0 -622
  154. data/distro/common/html/_static/underscore.js +0 -31
  155. data/distro/common/html/_static/up-pressed.png +0 -0
  156. data/distro/common/html/_static/up.png +0 -0
  157. data/distro/common/html/_static/websupport.js +0 -808
  158. data/distro/common/html/ctl_chef_client.html +0 -270
  159. data/distro/common/html/ctl_chef_server.html +0 -728
  160. data/distro/common/html/ctl_chef_shell.html +0 -163
  161. data/distro/common/html/ctl_chef_solo.html +0 -194
  162. data/distro/common/html/index.html +0 -202
  163. data/distro/common/html/knife.html +0 -170
  164. data/distro/common/html/knife_bootstrap.html +0 -285
  165. data/distro/common/html/knife_client.html +0 -285
  166. data/distro/common/html/knife_common_options.html +0 -96
  167. data/distro/common/html/knife_configure.html +0 -105
  168. data/distro/common/html/knife_cookbook.html +0 -487
  169. data/distro/common/html/knife_cookbook_site.html +0 -375
  170. data/distro/common/html/knife_data_bag.html +0 -374
  171. data/distro/common/html/knife_delete.html +0 -93
  172. data/distro/common/html/knife_deps.html +0 -143
  173. data/distro/common/html/knife_diff.html +0 -123
  174. data/distro/common/html/knife_download.html +0 -145
  175. data/distro/common/html/knife_edit.html +0 -89
  176. data/distro/common/html/knife_environment.html +0 -322
  177. data/distro/common/html/knife_exec.html +0 -220
  178. data/distro/common/html/knife_index_rebuild.html +0 -83
  179. data/distro/common/html/knife_list.html +0 -114
  180. data/distro/common/html/knife_node.html +0 -458
  181. data/distro/common/html/knife_raw.html +0 -110
  182. data/distro/common/html/knife_recipe_list.html +0 -91
  183. data/distro/common/html/knife_role.html +0 -295
  184. data/distro/common/html/knife_search.html +0 -203
  185. data/distro/common/html/knife_serve.html +0 -79
  186. data/distro/common/html/knife_show.html +0 -104
  187. data/distro/common/html/knife_ssh.html +0 -177
  188. data/distro/common/html/knife_ssl_check.html +0 -151
  189. data/distro/common/html/knife_ssl_fetch.html +0 -151
  190. data/distro/common/html/knife_status.html +0 -144
  191. data/distro/common/html/knife_tag.html +0 -138
  192. data/distro/common/html/knife_upload.html +0 -153
  193. data/distro/common/html/knife_user.html +0 -242
  194. data/distro/common/html/knife_using.html +0 -210
  195. data/distro/common/html/knife_xargs.html +0 -122
  196. data/distro/common/html/objects.inv +0 -0
  197. data/distro/common/html/search.html +0 -82
  198. data/distro/common/html/searchindex.js +0 -1
  199. data/distro/common/man/man1/README.md +0 -58
  200. data/distro/common/man/man1/chef-shell.1 +0 -194
  201. data/distro/common/man/man1/knife-bootstrap.1 +0 -215
  202. data/distro/common/man/man1/knife-client.1 +0 -443
  203. data/distro/common/man/man1/knife-configure.1 +0 -161
  204. data/distro/common/man/man1/knife-cookbook-site.1 +0 -552
  205. data/distro/common/man/man1/knife-cookbook.1 +0 -770
  206. data/distro/common/man/man1/knife-data-bag.1 +0 -617
  207. data/distro/common/man/man1/knife-delete.1 +0 -127
  208. data/distro/common/man/man1/knife-deps.1 +0 -246
  209. data/distro/common/man/man1/knife-diff.1 +0 -226
  210. data/distro/common/man/man1/knife-download.1 +0 -258
  211. data/distro/common/man/man1/knife-edit.1 +0 -121
  212. data/distro/common/man/man1/knife-environment.1 +0 -496
  213. data/distro/common/man/man1/knife-exec.1 +0 -362
  214. data/distro/common/man/man1/knife-index-rebuild.1 +0 -63
  215. data/distro/common/man/man1/knife-list.1 +0 -174
  216. data/distro/common/man/man1/knife-node.1 +0 -716
  217. data/distro/common/man/man1/knife-raw.1 +0 -172
  218. data/distro/common/man/man1/knife-recipe-list.1 +0 -85
  219. data/distro/common/man/man1/knife-role.1 +0 -426
  220. data/distro/common/man/man1/knife-search.1 +0 -359
  221. data/distro/common/man/man1/knife-serve.1 +0 -109
  222. data/distro/common/man/man1/knife-show.1 +0 -160
  223. data/distro/common/man/man1/knife-ssh.1 +0 -284
  224. data/distro/common/man/man1/knife-ssl-check.1 +0 -207
  225. data/distro/common/man/man1/knife-ssl-fetch.1 +0 -207
  226. data/distro/common/man/man1/knife-status.1 +0 -234
  227. data/distro/common/man/man1/knife-tag.1 +0 -189
  228. data/distro/common/man/man1/knife-upload.1 +0 -280
  229. data/distro/common/man/man1/knife-user.1 +0 -356
  230. data/distro/common/man/man1/knife-xargs.1 +0 -189
  231. data/distro/common/man/man1/knife.1 +0 -332
  232. data/distro/common/man/man8/chef-apply.8 +0 -86
  233. data/distro/common/man/man8/chef-client.8 +0 -398
  234. data/distro/common/man/man8/chef-solo.8 +0 -260
  235. data/distro/common/markdown/README +0 -3
  236. data/distro/common/markdown/man1/chef-shell.mkd +0 -195
  237. data/distro/common/markdown/man1/knife-bootstrap.mkd +0 -141
  238. data/distro/common/markdown/man1/knife-client.mkd +0 -103
  239. data/distro/common/markdown/man1/knife-configure.mkd +0 -71
  240. data/distro/common/markdown/man1/knife-cookbook-site.mkd +0 -123
  241. data/distro/common/markdown/man1/knife-cookbook.mkd +0 -263
  242. data/distro/common/markdown/man1/knife-data-bag.mkd +0 -121
  243. data/distro/common/markdown/man1/knife-environment.mkd +0 -151
  244. data/distro/common/markdown/man1/knife-exec.mkd +0 -42
  245. data/distro/common/markdown/man1/knife-index.mkd +0 -30
  246. data/distro/common/markdown/man1/knife-node.mkd +0 -130
  247. data/distro/common/markdown/man1/knife-role.mkd +0 -85
  248. data/distro/common/markdown/man1/knife-search.mkd +0 -180
  249. data/distro/common/markdown/man1/knife-ssh.mkd +0 -69
  250. data/distro/common/markdown/man1/knife-status.mkd +0 -36
  251. data/distro/common/markdown/man1/knife-tag.mkd +0 -39
  252. data/distro/common/markdown/man1/knife.mkd +0 -213
  253. data/distro/common/markdown/man8/chef-client.mkd +0 -75
  254. data/distro/common/markdown/man8/chef-expander.mkd +0 -81
  255. data/distro/common/markdown/man8/chef-expanderctl.mkd +0 -57
  256. data/distro/common/markdown/man8/chef-server-webui.mkd +0 -121
  257. data/distro/common/markdown/man8/chef-server.mkd +0 -120
  258. data/distro/common/markdown/man8/chef-solo.mkd +0 -107
  259. data/distro/common/markdown/man8/chef-solr.mkd +0 -89
  260. data/distro/powershell/chef/chef.psm1 +0 -459
  261. data/tasks/cbgb.rb +0 -84
@@ -1,83 +0,0 @@
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 index rebuild &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-index-rebuild">
43
- <h1>knife index rebuild<a class="headerlink" href="#knife-index-rebuild" title="Permalink to this headline">¶</a></h1>
44
- <p>The <strong>knife index rebuild</strong> subcommand is used to rebuild the search indexes for the open source Chef server. This operation is destructive and may take some time.</p>
45
- <div class="admonition note">
46
- <p class="first admonition-title">Note</p>
47
- <p class="last">This subcommand ONLY works when run against the open source Chef server version 10.x. This subcommand will NOT run against open source Chef server 11, Enterprise Chef (including hosted Enterprise Chef), or Private Chef.</p>
48
- </div>
49
- <div class="section" id="syntax">
50
- <h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
51
- <p>This subcommand has the following syntax:</p>
52
- <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife index rebuild
53
- </pre></div>
54
- </div>
55
- </div>
56
- <div class="section" id="options">
57
- <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
58
- <div class="admonition note">
59
- <p class="first admonition-title">Note</p>
60
- <p class="last">Review the list of <a class="reference internal" href="knife_common_options.html"><em>common options</em></a> available to this (and all) knife subcommands and plugins.</p>
61
- </div>
62
- <p>This command does not have any specific options.</p>
63
- </div>
64
- <div class="section" id="examples">
65
- <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
66
- <p>None.</p>
67
- </div>
68
- </div>
69
-
70
-
71
- </div>
72
-
73
- </div>
74
-
75
-
76
- <div class="clearer"></div>
77
- </div>
78
-
79
-
80
-
81
-
82
- </body>
83
- </html>
@@ -1,114 +0,0 @@
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
- </html>
@@ -1,458 +0,0 @@
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
- </html>