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,260 +0,0 @@
1
- .\" Man page generated from reStructuredText.
2
- .
3
- .TH "CHEF-SOLO" "8" "Chef 12.0" "" "chef-solo"
4
- .SH NAME
5
- chef-solo \- The man page for the chef-solo command line tool.
6
- .
7
- .nr rst2man-indent-level 0
8
- .
9
- .de1 rstReportMargin
10
- \\$1 \\n[an-margin]
11
- level \\n[rst2man-indent-level]
12
- level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
13
- -
14
- \\n[rst2man-indent0]
15
- \\n[rst2man-indent1]
16
- \\n[rst2man-indent2]
17
- ..
18
- .de1 INDENT
19
- .\" .rstReportMargin pre:
20
- . RS \\$1
21
- . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
22
- . nr rst2man-indent-level +1
23
- .\" .rstReportMargin post:
24
- ..
25
- .de UNINDENT
26
- . RE
27
- .\" indent \\n[an-margin]
28
- .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
29
- .nr rst2man-indent-level -1
30
- .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
31
- .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
32
- ..
33
- .sp
34
- chef\-solo is an open source version of the chef\-client that allows using cookbooks with nodes without requiring access to a Chef server\&. chef\-solo runs locally and requires that a cookbook (and any of its dependencies) be on the same physical disk as the node. chef\-solo is a limited\-functionality version of the chef\-client and \fBdoes not support\fP the following:
35
- .INDENT 0.0
36
- .IP \(bu 2
37
- Node data storage
38
- .IP \(bu 2
39
- Search indexes
40
- .IP \(bu 2
41
- Centralized distribution of cookbooks
42
- .IP \(bu 2
43
- A centralized API that interacts with and integrates infrastructure components
44
- .IP \(bu 2
45
- Authentication or authorization
46
- .IP \(bu 2
47
- Persistent attributes
48
- .UNINDENT
49
- .sp
50
- \fBNOTE:\fP
51
- .INDENT 0.0
52
- .INDENT 3.5
53
- chef\-solo can be run as a daemon.
54
- .UNINDENT
55
- .UNINDENT
56
- .sp
57
- The chef\-solo executable is run as a command\-line tool.
58
- .sp
59
- \fBOptions\fP
60
- .sp
61
- This command has the following syntax:
62
- .INDENT 0.0
63
- .INDENT 3.5
64
- .sp
65
- .nf
66
- .ft C
67
- chef\-solo OPTION VALUE OPTION VALUE ...
68
- .ft P
69
- .fi
70
- .UNINDENT
71
- .UNINDENT
72
- .sp
73
- This command has the following options:
74
- .INDENT 0.0
75
- .TP
76
- .B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP
77
- The configuration file to use.
78
- .TP
79
- .B \fB\-d\fP, \fB\-\-daemonize\fP
80
- Use to run the executable as a daemon. This option may not be used in the same command with the \fB\-\-[no\-]fork\fP option.
81
- .sp
82
- This option is only available on machines that run in UNIX or Linux environments. For machines that are running Microsoft Windows that require similar functionality, use the \fBchef\-client::service\fP recipe in the \fBchef\-client\fP cookbook: \fI\%http://community.opscode.com/cookbooks/chef\-client\fP\&. This will install a chef\-client service under Microsoft Windows using the Windows Service Wrapper\&.
83
- .TP
84
- .B \fB\-E ENVIRONMENT_NAME\fP, \fB\-\-environment ENVIRONMENT_NAME\fP
85
- The name of the environment.
86
- .TP
87
- .B \fB\-f\fP, \fB\-\-[no\-]fork\fP
88
- Use to contain the chef\-client run in a secondary process with dedicated RAM. When the chef\-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef\-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use \fB\-\-no\-fork\fP to disable running the chef\-client in fork node. Default value: \fB\-\-fork\fP\&. This option may not be used in the same command with the \fB\-\-daemonize\fP and \fB\-\-interval\fP options.
89
- .TP
90
- .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
91
- The output format: \fBdoc\fP (default) or \fBmin\fP\&.
92
- .sp
93
- Use \fBdoc\fP to print the progress of the chef\-client run using full strings that display a summary of updates as they occur.
94
- .sp
95
- Use \fBmin\fP to print the progress of the chef\-client run using single characters. A summary of updates is printed at the end of the chef\-client run. A dot (\fB\&.\fP) is printed for events that do not have meaningful status information, such as loading a file or synchronizing a cookbook. For resources, a dot (\fB\&.\fP) is printed when the resource is up to date, an \fBS\fP is printed when the resource is skipped by \fBnot_if\fP or \fBonly_if\fP, and a \fBU\fP is printed when the resource is updated.
96
- .sp
97
- Other formatting options are available when those formatters are configured in the client.rb file using the \fBadd_formatter\fP option.
98
- .TP
99
- .B \fB\-\-force\-formatter\fP
100
- Use to show formatter output instead of logger output.
101
- .TP
102
- .B \fB\-\-force\-logger\fP
103
- Use to show logger output instead of formatter output.
104
- .TP
105
- .B \fB\-g GROUP\fP, \fB\-\-group GROUP\fP
106
- The name of the group that owns a process. This is required when starting any executable as a daemon.
107
- .TP
108
- .B \fB\-h\fP, \fB\-\-help\fP
109
- Shows help for the command.
110
- .TP
111
- .B \fB\-i SECONDS\fP, \fB\-\-interval SECONDS\fP
112
- The frequency (in seconds) at which the chef\-client runs. When the chef\-client is run at intervals, \fB\-\-splay\fP and \fB\-\-interval\fP values are applied before the chef\-client run. This option may not be used in the same command with the \fB\-\-[no\-]fork\fP option.
113
- .TP
114
- .B \fB\-j PATH\fP, \fB\-\-json\-attributes PATH\fP
115
- The path to a file that contains JSON data.
116
- .sp
117
- Use this option to define a \fBrun_list\fP object. For example, a JSON file similar to:
118
- .INDENT 7.0
119
- .INDENT 3.5
120
- .sp
121
- .nf
122
- .ft C
123
- "run_list": [
124
- "recipe[base]",
125
- "recipe[foo]",
126
- "recipe[bar]",
127
- "role[webserver]"
128
- ],
129
- .ft P
130
- .fi
131
- .UNINDENT
132
- .UNINDENT
133
- .sp
134
- may be used by running \fBchef\-client \-j path/to/file.json\fP\&.
135
- .sp
136
- In certain situations this option may be used to update \fBnormal\fP attributes.
137
- .sp
138
- \fBWARNING:\fP
139
- .INDENT 7.0
140
- .INDENT 3.5
141
- Any other attribute type that is contained in this JSON file will be treated as a \fBnormal\fP attribute. For example, attempting to update \fBoverride\fP attributes using the \fB\-j\fP option:
142
- .INDENT 0.0
143
- .INDENT 3.5
144
- .sp
145
- .nf
146
- .ft C
147
- {
148
- "name": "dev\-99",
149
- "description": "Install some stuff",
150
- "override_attributes": {
151
- "apptastic": {
152
- "enable_apptastic": "false",
153
- "apptastic_tier_name": "dev\-99.bomb.com"
154
- }
155
- }
156
- }
157
- .ft P
158
- .fi
159
- .UNINDENT
160
- .UNINDENT
161
- .sp
162
- will result in a node object similar to:
163
- .INDENT 0.0
164
- .INDENT 3.5
165
- .sp
166
- .nf
167
- .ft C
168
- {
169
- "name": "maybe\-dev\-99",
170
- "normal": {
171
- "name": "dev\-99",
172
- "description": "Install some stuff",
173
- "override_attributes": {
174
- "apptastic": {
175
- "enable_apptastic": "false",
176
- "apptastic_tier_name": "dev\-99.bomb.com"
177
- }
178
- }
179
- }
180
- }
181
- .ft P
182
- .fi
183
- .UNINDENT
184
- .UNINDENT
185
- .UNINDENT
186
- .UNINDENT
187
- .TP
188
- .B \fB\-l LEVEL\fP, \fB\-\-log_level LEVEL\fP
189
- The level of logging that will be stored in a log file.
190
- .TP
191
- .B \fB\-L LOGLOCATION\fP, \fB\-\-logfile c\fP
192
- The location in which log file output files will be saved. If this location is set to something other than \fBSTDOUT\fP, standard output logging will still be performed (otherwise there would be no output other than to a file). This is recommended when starting any executable as a daemon.
193
- .TP
194
- .B \fB\-\-[no\-]color\fP
195
- Use to view colored output. Default setting: \fB\-\-color\fP\&.
196
- .TP
197
- .B \fB\-N NODE_NAME\fP, \fB\-\-node\-name NODE_NAME\fP
198
- The name of the node.
199
- .TP
200
- .B \fB\-o RUN_LIST_ITEM\fP, \fB\-\-override\-runlist RUN_LIST_ITEM\fP
201
- Replace the current run list with the specified items.
202
- .TP
203
- .B \fB\-r RECIPE_URL\fP, \fB\-\-recipe\-url RECIPE_URL\fP
204
- The URL location from which a remote cookbook tar.gz will be downloaded.
205
- .TP
206
- .B \fB\-\-run\-lock\-timeout SECONDS\fP
207
- The amount of time (in seconds) to wait for a chef\-client run to finish. Default value: not set (indefinite). Set to \fB0\fP to cause a second chef\-client to exit immediately.
208
- .TP
209
- .B \fB\-s SECONDS\fP, \fB\-\-splay SECONDS\fP
210
- A number (in seconds) to add to the \fBinterval\fP that is used to determine the frequency of chef\-client runs. This number can help prevent server load when there are many clients running at the same time. When the chef\-client is run at intervals, \fB\-\-splay\fP and \fB\-\-interval\fP values are applied before the chef\-client run.
211
- .TP
212
- .B \fB\-u USER\fP, \fB\-\-user USER\fP
213
- The user that owns a process. This is required when starting any executable as a daemon.
214
- .TP
215
- .B \fB\-v\fP, \fB\-\-version\fP
216
- The version of the chef\-client\&.
217
- .TP
218
- .B \fB\-W\fP, \fB\-\-why\-run\fP
219
- Use to run the executable in why\-run mode, which is a type of chef\-client run that does everything except modify the system. Use why\-run mode to understand why the chef\-client makes the decisions that it makes and to learn more about the current and proposed state of the system.
220
- .UNINDENT
221
- .sp
222
- \fBExamples\fP
223
- .INDENT 0.0
224
- .INDENT 3.5
225
- .sp
226
- .nf
227
- .ft C
228
- $ chef\-solo \-c ~/solo.rb \-j ~/node.json \-r http://www.example.com/chef\-solo.tar.gz
229
- .ft P
230
- .fi
231
- .UNINDENT
232
- .UNINDENT
233
- .sp
234
- The tar.gz archived into the \fBfile_cache_path\fP, and then extracted to \fBcookbooks_path\fP\&.
235
- .INDENT 0.0
236
- .INDENT 3.5
237
- .sp
238
- .nf
239
- .ft C
240
- $ chef\-solo \-c ~/solo.rb \-j ~/node.json
241
- .ft P
242
- .fi
243
- .UNINDENT
244
- .UNINDENT
245
- .sp
246
- chef\-solo will look in the solo.rb file to determine the directory in which cookbooks are located.
247
- .INDENT 0.0
248
- .INDENT 3.5
249
- .sp
250
- .nf
251
- .ft C
252
- $ chef\-solo \-c ~/solo.rb \-j http://www.example.com/node.json \-r http://www.example.com/chef\-solo.tar.gz
253
- .ft P
254
- .fi
255
- .UNINDENT
256
- .UNINDENT
257
- .SH AUTHOR
258
- Chef
259
- .\" Generated by docutils manpage writer.
260
- .
@@ -1,3 +0,0 @@
1
- This directory contains markdown documentation that is used in other places.
2
- For example, markdown (.mkd) documents that are generated as man pages
3
- with ronn.
@@ -1,195 +0,0 @@
1
- chef-shell(1) -- Interactive Chef Console
2
- =========================================
3
-
4
- ## SYNOPSIS
5
-
6
- __chef-shell__ [_named configuration_] _(options)_
7
-
8
- * `-S`, `--server CHEF_SERVER_URL`:
9
- The chef server URL
10
- * `-z`, `--client`:
11
- chef-client mode
12
- * `-c`, `--config CONFIG`:
13
- The configuration file to use
14
- * `-j`, `--json-attributes JSON_ATTRIBS`:
15
- Load attributes from a JSON file or URL
16
- * `-l`, `--log-level LOG_LEVEL`:
17
- Set the logging level
18
- * `-s`, `--solo`:
19
- chef-solo session
20
- * `-a`, `--standalone`:
21
- standalone session
22
- * `-v`, `--version`:
23
- Show chef version
24
- * `-h`, `--help`:
25
- Show command options
26
-
27
- When no --config option is specified, chef-shell attempts to load a
28
- default configuration file:
29
-
30
- * If a _named configuration_ is given, chef-shell will load ~/.chef/_named
31
- configuration_/chef_shell.rb
32
- * If no _named configuration_ is given chef-shell will load
33
- ~/.chef/chef_shell.rb if it exists
34
- * chef-shell falls back to loading /etc/chef/client.rb or
35
- /etc/chef/solo.rb if -z or -s options are given and no chef_shell.rb
36
- can be found.
37
- * The --config option takes precedence over implicit configuration
38
- paths.
39
-
40
- ## DESCRIPTION
41
-
42
- `chef-shell` is an irb(1) (interactive ruby) session customized for Chef.
43
- `chef-shell` serves two primary functions: it provides a means to
44
- interact with a Chef Server interactively using a convenient DSL; it
45
- allows you to define and run Chef recipes interactively.
46
-
47
- ## SYNTAX
48
-
49
- chef-shell uses irb's subsession feature to provide multiple modes of
50
- interaction. In addition to the primary mode which is entered on start,
51
- `recipe` and `attributes` modes are available.
52
-
53
- ## PRIMARY MODE
54
- The following commands are available in the primary
55
- session:
56
-
57
- * `help`:
58
- Prints a list of available commands
59
- * `version`:
60
- Prints the Chef version
61
- * `recipe`:
62
- Switches to `recipe` mode
63
- * `attributes`:
64
- Switches to `attributes` mode
65
- * `run_chef`:
66
- Initiates a chef run
67
- * `reset`:
68
- reinitializes chef-shell session
69
- * `echo :on|:off`:
70
- Turns irb's echo function on or off. Echo is _on_ by default.
71
- * `tracing :on|:off`:
72
- Turns irb's function tracing feature on or off. Tracing is extremely
73
- verbose and expected to be of interest primarily to developers.
74
- * `node`:
75
- Returns the _node_ object for the current host. See knife-node(1)
76
- for more information about nodes.
77
- * `ohai`:
78
- Prints the attributes of _node_
79
-
80
- In addition to these commands, chef-shell provides a DSL for accessing
81
- data on the Chef Server. When working with remote data in chef-shell, you
82
- chain method calls in the form _object type_._operation_, where
83
- _object type_ is in plural form. The following object types are
84
- available:
85
-
86
- * `nodes`
87
- * `roles`
88
- * `data_bags`
89
- * `clients`
90
- * `cookbooks`
91
-
92
- For each _object type_ the following operations are available:
93
-
94
- * _object type_.all(_&block_):
95
- Loads all items from the server. If the optional code _block_ is
96
- given, each item will be passed to the block and the results
97
- returned, similar to ruby's `Enumerable#map` method.
98
- * _object type_.show(_object name_):
99
- Aliased as _object type_.load
100
-
101
- Loads the singular item identified by _object name_.
102
- * _object type_.search(_query_, _&block_):
103
- Aliased as _object type_.find
104
-
105
- Runs a search against the server and returns the matching items. If
106
- the optional code _block_ is given each item will be passed to the
107
- block and the results returned.
108
-
109
- The _query_ may be a Solr/Lucene format query given as a String, or
110
- a Hash of conditions. If a Hash is given, the options will be ANDed
111
- together. To join conditions with OR, use negative queries, or any
112
- advanced search syntax, you must provide give the query in String
113
- form.
114
- * _object type_.transform(:all|_query_, _&block_):
115
- Aliased as _object type_.bulk_edit
116
-
117
- Bulk edit objects by processing them with the (required) code _block_.
118
- You can edit all objects of the given type by passing the Symbol
119
- `:all` as the argument, or only a subset by passing a _query_ as the
120
- argument. The _query_ is evaluated in the same way as with
121
- __search__.
122
-
123
- The return value of the code _block_ is used to alter the behavior
124
- of `transform`. If the value returned from the block is `nil` or
125
- `false`, the object will not be saved. Otherwise, the object is
126
- saved after being passed to the block. This behavior can be
127
- exploited to create a dry run to test a data transformation.
128
-
129
- ## RECIPE MODE
130
- Recipe mode implements Chef's recipe DSL. Exhaustively documenting this
131
- DSL is outside the scope of this document. See the following pages in
132
- the Chef documentation for more information:
133
-
134
- * <http://docs.chef.io/resources.html>
135
- * <http://docs.chef.io/recipes.html>
136
-
137
- Once you have defined resources in the recipe, you can trigger a
138
- convergence run via `run_chef`
139
-
140
- ## EXAMPLES
141
-
142
- * A "Hello World" interactive recipe
143
-
144
- chef > recipe
145
- chef:recipe > echo :off
146
- chef:recipe > file "/tmp/hello\_world"
147
- chef:recipe > run\_chef
148
- [Sat, 09 Apr 2011 08:56:56 -0700] INFO: Processing file[/tmp/hello\_world] action create ((irb#1) line 2)
149
- [Sat, 09 Apr 2011 08:56:56 -0700] INFO: file[/tmp/hello\_world] created file /tmp/hello\_world
150
- chef:recipe > pp ls '/tmp'
151
- [".",
152
- "..",
153
- "hello\_world"]
154
-
155
- * Search for _nodes_ by role, and print their IP addresses
156
-
157
- chef > nodes.find(:roles => 'monitoring-server') {|n| n[:ipaddress] }
158
- => ["10.254.199.5"]
159
-
160
- * Remove the role _obsolete_ from every node in the system
161
-
162
- chef > nodes.transform(:all) {|n| n.run\_list.delete('role[obsolete]') }
163
- => [node[chef098b2.opschef.com], node[ree-woot], node[graphite-dev], node[fluke.localdomain], node[ghost.local], node[kallistec]]
164
-
165
-
166
- ## BUGS
167
-
168
- `chef-shell` often does not perfectly replicate the context in which
169
- chef-client(8) configures a host, which may lead to discrepancies in
170
- observed behavior.
171
-
172
- `chef-shell` has to duplicate much code from chef-client's internal
173
- libraries and may become out of sync with the behavior of those
174
- libraries.
175
-
176
- ## SEE ALSO
177
-
178
- chef-client(8) knife(1)
179
- <http://docs.chef.io/ctl_chef_shell.html>
180
-
181
- ## AUTHOR
182
-
183
- Chef was written by Adam Jacob <adam@opscode.com> with many
184
- contributions from the community. chef-shell was written by Daniel
185
- DeLeo.
186
-
187
- ## DOCUMENTATION
188
-
189
- This manual page was written by Daniel DeLeo <dan@opscode.com>.
190
- Permission is granted to copy, distribute and / or modify this
191
- document under the terms of the Apache 2.0 License.
192
-
193
- ## CHEF
194
-
195
- chef-shell is distributed with Chef. <http://docs.chef.io>