chef 0.8.16 → 0.9.0.a3

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of chef might be problematic. Click here for more details.

Files changed (185) hide show
  1. data/bin/shef +1 -0
  2. data/distro/common/man/man1/chef-server-webui.1 +106 -0
  3. data/distro/common/man/man1/chef-server.1 +0 -1
  4. data/distro/common/man/man1/chef-solr-indexer.1 +55 -0
  5. data/distro/common/man/man1/chef-solr.1 +55 -0
  6. data/distro/common/man/man8/chef-client.8 +4 -2
  7. data/distro/common/man/man8/chef-solo.8 +1 -2
  8. data/distro/common/man/man8/chef-solr-rebuild.8 +37 -0
  9. data/distro/common/man/man8/knife.8 +668 -266
  10. data/distro/common/man/man8/shef.8 +45 -0
  11. data/distro/common/markdown/README +3 -0
  12. data/distro/common/markdown/knife.mkd +520 -0
  13. data/distro/debian/etc/default/chef-client +4 -0
  14. data/distro/debian/etc/default/chef-server +6 -0
  15. data/distro/debian/etc/default/chef-server-webui +6 -0
  16. data/distro/debian/etc/default/chef-solr +4 -0
  17. data/distro/debian/etc/default/chef-solr-indexer +4 -0
  18. data/distro/debian/etc/init.d/chef-client +41 -41
  19. data/distro/debian/etc/init.d/chef-server +10 -10
  20. data/distro/debian/etc/init.d/chef-server-webui +121 -0
  21. data/distro/debian/etc/init.d/chef-solr +177 -0
  22. data/distro/debian/etc/init.d/chef-solr-indexer +176 -0
  23. data/distro/redhat/etc/init.d/chef-client +76 -48
  24. data/distro/redhat/etc/init.d/chef-server +85 -51
  25. data/distro/redhat/etc/init.d/chef-server-webui +85 -51
  26. data/distro/redhat/etc/init.d/chef-solr +77 -49
  27. data/distro/redhat/etc/init.d/chef-solr-indexer +77 -48
  28. data/distro/redhat/etc/logrotate.d/chef-client +8 -0
  29. data/distro/redhat/etc/logrotate.d/chef-server +8 -0
  30. data/distro/redhat/etc/logrotate.d/chef-server-webui +8 -0
  31. data/distro/redhat/etc/logrotate.d/chef-solr +8 -0
  32. data/distro/redhat/etc/logrotate.d/chef-solr-indexer +8 -0
  33. data/distro/redhat/etc/sysconfig/chef-client +9 -4
  34. data/distro/redhat/etc/sysconfig/chef-server +10 -6
  35. data/distro/redhat/etc/sysconfig/chef-server-webui +10 -6
  36. data/distro/redhat/etc/sysconfig/chef-solr +3 -4
  37. data/distro/redhat/etc/sysconfig/chef-solr-indexer +3 -3
  38. data/lib/chef.rb +16 -5
  39. data/lib/chef/application/knife.rb +2 -2
  40. data/lib/chef/application/solo.rb +1 -7
  41. data/lib/chef/cache/checksum.rb +12 -5
  42. data/lib/chef/cache/file_cache_by_checksum.rb +52 -0
  43. data/lib/chef/checksum.rb +115 -0
  44. data/lib/chef/client.rb +193 -185
  45. data/lib/chef/config.rb +9 -1
  46. data/lib/chef/cookbook/cookbook_collection.rb +43 -0
  47. data/lib/chef/cookbook/file_system_file_vendor.rb +53 -0
  48. data/lib/chef/cookbook/file_vendor.rb +47 -0
  49. data/lib/chef/cookbook/metadata.rb +34 -35
  50. data/lib/chef/cookbook/metadata/version.rb +1 -1
  51. data/lib/chef/cookbook_loader.rb +70 -45
  52. data/lib/chef/cookbook_version.rb +760 -0
  53. data/lib/chef/couchdb.rb +8 -5
  54. data/lib/chef/data_bag_item.rb +5 -5
  55. data/lib/chef/exceptions.rb +10 -0
  56. data/lib/chef/file_access_control.rb +134 -0
  57. data/lib/chef/handler.rb +62 -0
  58. data/lib/chef/handler/json_file.rb +47 -0
  59. data/lib/chef/knife.rb +14 -2
  60. data/lib/chef/knife/bootstrap.rb +126 -0
  61. data/lib/chef/knife/cookbook_bulk_delete.rb +1 -1
  62. data/lib/chef/knife/cookbook_delete.rb +4 -4
  63. data/lib/chef/knife/cookbook_download.rb +57 -26
  64. data/lib/chef/knife/cookbook_metadata.rb +2 -2
  65. data/lib/chef/knife/cookbook_show.rb +30 -11
  66. data/lib/chef/knife/cookbook_upload.rb +113 -86
  67. data/lib/chef/knife/ec2_server_create.rb +146 -0
  68. data/lib/chef/knife/ec2_server_delete.rb +84 -0
  69. data/lib/chef/knife/ec2_server_list.rb +82 -0
  70. data/lib/chef/knife/status.rb +51 -0
  71. data/lib/chef/mixin/language_include_attribute.rb +16 -11
  72. data/lib/chef/mixin/language_include_recipe.rb +15 -16
  73. data/lib/chef/mixin/recipe_definition_dsl_core.rb +17 -20
  74. data/lib/chef/mixin/shell_out.rb +38 -0
  75. data/lib/chef/mixins.rb +1 -1
  76. data/lib/chef/node.rb +190 -63
  77. data/lib/chef/node/attribute.rb +92 -78
  78. data/lib/chef/platform.rb +24 -4
  79. data/lib/chef/provider.rb +28 -10
  80. data/lib/chef/provider/breakpoint.rb +2 -2
  81. data/lib/chef/provider/cookbook_file.rb +96 -0
  82. data/lib/chef/provider/cron.rb +2 -2
  83. data/lib/chef/provider/deploy.rb +12 -10
  84. data/lib/chef/provider/env.rb +152 -0
  85. data/lib/chef/provider/env/windows.rb +75 -0
  86. data/lib/chef/provider/file.rb +10 -14
  87. data/lib/chef/provider/group.rb +15 -2
  88. data/lib/chef/provider/group/dscl.rb +17 -25
  89. data/lib/chef/provider/group/gpasswd.rb +6 -3
  90. data/lib/chef/provider/group/pw.rb +3 -7
  91. data/lib/chef/provider/group/windows.rb +79 -0
  92. data/lib/chef/provider/link.rb +4 -5
  93. data/lib/chef/provider/mdadm.rb +25 -18
  94. data/lib/chef/provider/mount/mount.rb +28 -27
  95. data/lib/chef/provider/package.rb +35 -35
  96. data/lib/chef/provider/package/dpkg.rb +13 -10
  97. data/lib/chef/provider/package/easy_install.rb +6 -6
  98. data/lib/chef/provider/package/freebsd.rb +17 -51
  99. data/lib/chef/provider/package/rpm.rb +1 -1
  100. data/lib/chef/provider/package/rubygems.rb +391 -74
  101. data/lib/chef/provider/package/yum.rb +2 -2
  102. data/lib/chef/provider/package/zypper.rb +2 -1
  103. data/lib/chef/provider/remote_directory.rb +60 -83
  104. data/lib/chef/provider/remote_file.rb +17 -66
  105. data/lib/chef/provider/script.rb +20 -9
  106. data/lib/chef/provider/service.rb +23 -30
  107. data/lib/chef/provider/service/arch.rb +3 -3
  108. data/lib/chef/provider/service/debian.rb +22 -17
  109. data/lib/chef/provider/service/freebsd.rb +4 -4
  110. data/lib/chef/provider/service/init.rb +2 -2
  111. data/lib/chef/provider/service/redhat.rb +14 -16
  112. data/lib/chef/provider/service/simple.rb +7 -3
  113. data/lib/chef/provider/service/solaris.rb +85 -0
  114. data/lib/chef/provider/service/upstart.rb +12 -7
  115. data/lib/chef/provider/service/windows.rb +2 -2
  116. data/lib/chef/provider/template.rb +133 -118
  117. data/lib/chef/provider/user.rb +34 -17
  118. data/lib/chef/provider/user/dscl.rb +117 -114
  119. data/lib/chef/provider/user/windows.rb +124 -0
  120. data/lib/chef/providers.rb +7 -0
  121. data/lib/chef/recipe.rb +39 -20
  122. data/lib/chef/resource.rb +47 -52
  123. data/lib/chef/resource/apt_package.rb +4 -4
  124. data/lib/chef/resource/bash.rb +4 -4
  125. data/lib/chef/resource/cookbook_file.rb +45 -0
  126. data/lib/chef/resource/cron.rb +3 -3
  127. data/lib/chef/resource/csh.rb +4 -4
  128. data/lib/chef/resource/deploy.rb +3 -3
  129. data/lib/chef/resource/directory.rb +4 -4
  130. data/lib/chef/resource/dpkg_package.rb +4 -4
  131. data/lib/chef/resource/easy_install_package.rb +3 -3
  132. data/lib/chef/resource/env.rb +58 -0
  133. data/lib/chef/resource/erl_call.rb +3 -3
  134. data/lib/chef/resource/execute.rb +3 -3
  135. data/lib/chef/resource/file.rb +3 -3
  136. data/lib/chef/resource/freebsd_package.rb +3 -3
  137. data/lib/chef/resource/gem_package.rb +17 -9
  138. data/lib/chef/resource/git.rb +3 -3
  139. data/lib/chef/resource/group.rb +3 -3
  140. data/lib/chef/resource/http_request.rb +4 -4
  141. data/lib/chef/resource/ifconfig.rb +3 -3
  142. data/lib/chef/resource/link.rb +3 -3
  143. data/lib/chef/resource/log.rb +2 -2
  144. data/lib/chef/resource/macports_package.rb +2 -2
  145. data/lib/chef/resource/mdadm.rb +3 -3
  146. data/lib/chef/resource/mount.rb +2 -2
  147. data/lib/chef/resource/package.rb +4 -4
  148. data/lib/chef/resource/pacman_package.rb +4 -4
  149. data/lib/chef/resource/perl.rb +4 -4
  150. data/lib/chef/resource/portage_package.rb +4 -4
  151. data/lib/chef/resource/python.rb +4 -4
  152. data/lib/chef/resource/remote_directory.rb +3 -3
  153. data/lib/chef/resource/remote_file.rb +26 -3
  154. data/lib/chef/resource/route.rb +3 -3
  155. data/lib/chef/resource/ruby.rb +3 -3
  156. data/lib/chef/resource/ruby_block.rb +3 -2
  157. data/lib/chef/resource/scm.rb +7 -5
  158. data/lib/chef/resource/script.rb +4 -4
  159. data/lib/chef/resource/service.rb +3 -3
  160. data/lib/chef/resource/subversion.rb +4 -2
  161. data/lib/chef/resource/template.rb +3 -3
  162. data/lib/chef/resource/user.rb +3 -3
  163. data/lib/chef/resource/yum_package.rb +3 -3
  164. data/lib/chef/resource_collection.rb +9 -5
  165. data/lib/chef/resources.rb +2 -0
  166. data/lib/chef/rest.rb +4 -0
  167. data/lib/chef/role.rb +2 -0
  168. data/lib/chef/run_context.rb +108 -0
  169. data/lib/chef/run_list.rb +75 -98
  170. data/lib/chef/run_list/run_list_expansion.rb +156 -0
  171. data/lib/chef/run_list/run_list_item.rb +71 -0
  172. data/lib/chef/runner.rb +58 -61
  173. data/lib/chef/sandbox.rb +147 -0
  174. data/lib/chef/shef.rb +4 -3
  175. data/lib/chef/shef/ext.rb +12 -4
  176. data/lib/chef/shef/shef_session.rb +27 -23
  177. data/lib/chef/shell_out.rb +375 -0
  178. data/lib/chef/util/windows.rb +56 -0
  179. data/lib/chef/util/windows/net_group.rb +101 -0
  180. data/lib/chef/util/windows/net_user.rb +198 -0
  181. data/lib/chef/version.rb +20 -0
  182. metadata +112 -22
  183. data/lib/chef/compile.rb +0 -158
  184. data/lib/chef/cookbook.rb +0 -201
  185. data/lib/chef/mixin/generate_url.rb +0 -58
data/bin/shef CHANGED
@@ -24,6 +24,7 @@ require "mixlib/cli"
24
24
 
25
25
  require "irb"
26
26
  require "irb/completion"
27
+ require 'irb/ext/save-history'
27
28
 
28
29
  # TODO::EVIL
29
30
  $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
@@ -0,0 +1,106 @@
1
+ .TH CHEF-SERVER-WEBUI "1" "March 2010" "chef-server-webui" "User Commands"
2
+ .SH NAME
3
+ chef-server-webui \- Start the Chef Server merb application slice providing Web User Interface.
4
+ .SH SYNOPSIS
5
+ .B chef-server-webui
6
+ [\fIuGdcIpPhmailLerkKX\fR] [\fIargument\fR]
7
+ .SH DESCRIPTION
8
+ The Chef Server WebUI is a Merb application slice. The default listen port is 4040.
9
+ .TP
10
+ \fB\-u\fR, \fB\-\-user\fR USER
11
+ This flag is for having chef-server-webui run as a user other than the one currently logged in. Note: if you set this you must also provide a \fB\-\-group\fR option for it to take effect.
12
+ .TP
13
+ \fB\-G\fR, \fB\-\-group\fR GROUP
14
+ This flag is for having chef-server-webui run as a group other than the one currently logged in. Note: if you set this you must also provide a \fB\-\-user\fR option for it to take effect.
15
+ .TP
16
+ \fB\-d\fR, \fB\-\-daemonize\fR
17
+ This will run a single chef-server-webui in the background.
18
+ .TP
19
+ \fB\-N\fR, \fB\-\-no\-daemonize\fR
20
+ This will allow you to run a cluster in console mode
21
+ .TP
22
+ \fB\-c\fR, \fB\-\-cluster\-nodes\fR NUM_MERBS
23
+ Number of merb daemons to run for chef-server-webui.
24
+ .TP
25
+ \fB\-I\fR, \fB\-\-init\-file\fR FILE
26
+ File to use for initialization on load, defaults to config/init.rb
27
+ .TP
28
+ \fB\-p\fR, \fB\-\-port\fR PORTNUM
29
+ Port to run chef-server-webui on, defaults to 4040. Additional nodes (\-c) listen on incrementing port numbers.
30
+ .TP
31
+ \fB\-o\fR, \fB\-\-socket\-file\fR FILE
32
+ Socket file to run chef-server-webui on, defaults to [Merb.root]/log/merb.sock. This is for web servers, like thin, that use sockets.Specify this *only* if you *must*.
33
+ .TP
34
+ \fB\-s\fR, \fB\-\-socket\fR SOCKNUM
35
+ Socket number to run chef-server-webui on, defaults to 0.
36
+ .TP
37
+ \fB\-n\fR, \fB\-\-name\fR NAME
38
+ Set the name of the application. This is used in the process title and log file names.
39
+ .TP
40
+ \fB\-P\fR, \fB\-\-pid\fR PIDFILE
41
+ PID file, defaults to [Merb.root]/log/merb.main.pid for the master process and[Merb.root]/log/merb.[port number].pid for worker processes. For clusters, use %s to specify where in the file chef-server-webui should place the port number. For instance: \fB\-P\fR myapp.%s.pid
42
+ .TP
43
+ \fB\-h\fR, \fB\-\-host\fR HOSTNAME
44
+ Host to bind to (default is 0.0.0.0).
45
+ .HP
46
+ \fB\-m\fR, \fB\-\-merb\-root\fR /path/to/approot The path to the Merb.root for the app you want to run (default is current working directory).
47
+ .TP
48
+ \fB\-a\fR, \fB\-\-adapter\fR ADAPTER
49
+ The rack adapter to use to run chef-server-webui (default is mongrel)[mongrel, emongrel, thin, ebb, fastcgi, webrick]
50
+ .TP
51
+ \fB\-R\fR, \fB\-\-rackup\fR FILE
52
+ Load an alternate Rack config file (default is config/rack.rb)
53
+ .TP
54
+ \fB\-i\fR, \fB\-\-irb\-console\fR
55
+ This flag will start chef-server-webui in irb console mode. All your models and other classes will be available for you in an irb session.
56
+ .TP
57
+ \fB\-S\fR, \fB\-\-sandbox\fR
58
+ This flag will enable a sandboxed irb console. If your ORM supports transactions, all edits will be rolled back on exit.
59
+ .TP
60
+ \fB\-l\fR, \fB\-\-log\-level\fR LEVEL
61
+ Log levels can be set to any of these options: debug < info < warn < error < fatal (default is info)
62
+ .TP
63
+ \fB\-L\fR, \fB\-\-log\fR LOGFILE
64
+ A string representing the logfile to use. Defaults to [Merb.root]/log/merb.[main].log for the master process and [Merb.root]/log/merb[port number].logfor worker processes
65
+ .TP
66
+ \fB\-e\fR, \fB\-\-environment\fR STRING
67
+ Environment to run Merb under [development, production, testing] (default is development)
68
+ .HP
69
+ \fB\-r\fR ['RUBY CODE'| FULL_SCRIPT_PATH]
70
+ .TP
71
+ \fB\-\-script\-runner\fR
72
+ Command\-line option to run scripts and/or code in the chef-server-webui app.
73
+ .TP
74
+ \fB\-K\fR, \fB\-\-graceful\fR PORT or all
75
+ Gracefully kill chef-server-webui proceses by port number. Use chef-server \fB\-K\fR all to gracefully kill all merbs.
76
+ .TP
77
+ \fB\-k\fR, \fB\-\-kill\fR PORT
78
+ Force kill one merb worker by port number. This will cause the worker tobe respawned.
79
+ .TP
80
+ \fB\-\-fast\-deploy\fR
81
+ Reload the code, but not yourinit.rb or gems
82
+ .TP
83
+ \fB\-X\fR, \fB\-\-mutex\fR on/off
84
+ This flag is for turning the mutex lock on and off.
85
+ .TP
86
+ \fB\-D\fR, \fB\-\-debugger\fR
87
+ Run chef-server-webui using rDebug.
88
+ .TP
89
+ \fB\-V\fR, \fB\-\-verbose\fR
90
+ Print extra information
91
+ .TP
92
+ \fB\-C\fR, \fB\-\-console\-trap\fR
93
+ Enter an irb console on ^C
94
+ .TP
95
+ \-?, \fB\-H\fR, \fB\-\-help\fR
96
+ Show this help message
97
+ .SH "SEE ALSO"
98
+ Full documentation for Chef and chef-server-webui is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home.
99
+ .SH AUTHOR
100
+ Chef was written by Adam Jacob <adam@ospcode.com> of Opscode (http://www.opscode.com), with contributions from the community.
101
+ This manual page was written by Joshua Timberman <joshua@opscode.com> with help2man
102
+ for the Debian project (but may be used by others).. Permission is granted
103
+ to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
104
+
105
+ On Debian systems, the complete text of the Apache 2.0 License can be found in
106
+ /usr/share/common-licenses/Apache-2.0.
@@ -1,4 +1,3 @@
1
- .\" DO NOT MODIFY THIS FILE! It was generated by help2man.
2
1
  .TH CHEF-SERVER "1" "August 2009" "chef-server" "User Commands"
3
2
  .SH NAME
4
3
  chef-server \- Start the Chef Server merb application slice.
@@ -0,0 +1,55 @@
1
+ .TH CHEF-SOLR-INDEXER: "1" "March 2010" "chef-solr-indexer" "User Commands"
2
+ .SH NAME
3
+ chef-solr-indexer: \- manual page for chef-solr-indexer
4
+ .SH SYNOPSIS
5
+ .B chef-solr-indexer
6
+ \fI(options)\fR
7
+ .SH DESCRIPTION
8
+ .TP
9
+ \fB\-\-amqp\-host\fR HOST
10
+ The amqp host
11
+ .TP
12
+ \fB\-\-amqp\-pass\fR PASS
13
+ The amqp password
14
+ .TP
15
+ \fB\-\-amqp\-port\fR PORT
16
+ The amqp port
17
+ .TP
18
+ \fB\-\-amqp\-user\fR USER
19
+ The amqp user
20
+ .TP
21
+ \fB\-\-amqp\-vhost\fR VHOST
22
+ The amqp vhost
23
+ .TP
24
+ \fB\-c\fR, \fB\-\-config\fR CONFIG
25
+ The configuration file to use
26
+ .TP
27
+ \fB\-d\fR, \fB\-\-daemonize\fR
28
+ Daemonize the process
29
+ .TP
30
+ \fB\-g\fR, \fB\-\-group\fR GROUP
31
+ Group to set privilege to
32
+ .TP
33
+ \fB\-l\fR, \fB\-\-log_level\fR LEVEL
34
+ Set the log level (debug, info, warn, error, fatal)
35
+ .TP
36
+ \fB\-L\fR, \fB\-\-logfile\fR LOGLOCATION
37
+ Set the log file location, defaults to STDOUT \- recommended for daemonizing
38
+ .TP
39
+ \fB\-u\fR, \fB\-\-user\fR USER
40
+ User to set privilege to
41
+ .TP
42
+ \fB\-v\fR, \fB\-\-version\fR
43
+ Show chef\-solr\-indexer version
44
+ .TP
45
+ \fB\-h\fR, \fB\-\-help\fR
46
+ Show this message
47
+ .SH "SEE ALSO"
48
+ Full documentation for Chef and chef-solr is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home.
49
+ .SH AUTHOR
50
+ chef-solr-indexer was written by Adam Jacob <adam@ospcode.com> of Opscode (http://www.opscode.com), with contributions from the community.
51
+ This manual page was written by Joshua Timberman <joshua@opscode.com> with help2man. Permission is granted
52
+ to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
53
+
54
+ On Debian systems, the complete text of the Apache 2.0 License can be found in
55
+ /usr/share/common-licenses/Apache-2.0.
@@ -0,0 +1,55 @@
1
+ .TH CHEF-SOLR: "1" "March 2010" "chef-solr" "User Commands"
2
+ .SH NAME
3
+ chef-solr: \- manual page for chef-solr
4
+ .SH SYNOPSIS
5
+ .B chef-solr
6
+ \fI(options)\fR
7
+ .SH DESCRIPTION
8
+ .TP
9
+ \fB\-c\fR, \fB\-\-config\fR CONFIG
10
+ The configuration file to use
11
+ .TP
12
+ \fB\-d\fR, \fB\-\-daemonize\fR
13
+ Daemonize the process
14
+ .TP
15
+ \fB\-g\fR, \fB\-\-group\fR GROUP
16
+ Group to set privilege to
17
+ .TP
18
+ \fB\-l\fR, \fB\-\-log_level\fR LEVEL
19
+ Set the log level (debug, info, warn, error, fatal)
20
+ .TP
21
+ \fB\-L\fR, \fB\-\-logfile\fR LOGLOCATION
22
+ Set the log file location, defaults to STDOUT \- recommended for daemonizing
23
+ .TP
24
+ \fB\-D\fR, \fB\-\-solr\-data\-dir\fR PATH
25
+ Where the Solr data lives
26
+ .TP
27
+ \fB\-x\fR, \fB\-\-solor\-heap\-size\fR SIZE
28
+ Set the size of the Java Heap
29
+ .TP
30
+ \fB\-H\fR, \fB\-\-solr\-home\-dir\fR PATH
31
+ Solr home directory
32
+ .TP
33
+ \fB\-j\fR, \fB\-\-java\-opts\fR OPTS
34
+ Raw options passed to Java
35
+ .TP
36
+ \fB\-W\fR, \fB\-\-solr\-jetty\-dir\fR PATH
37
+ Where to place the Solr Jetty instance
38
+ .TP
39
+ \fB\-u\fR, \fB\-\-user\fR USER
40
+ User to set privilege to
41
+ .TP
42
+ \fB\-v\fR, \fB\-\-version\fR
43
+ Show chef\-solr version
44
+ .TP
45
+ \fB\-h\fR, \fB\-\-help\fR
46
+ Show this message
47
+ .SH "SEE ALSO"
48
+ Full documentation for Chef and chef-solr is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home.
49
+ .SH AUTHOR
50
+ chef-solr was written by Adam Jacob <adam@ospcode.com> of Opscode (http://www.opscode.com), with contributions from the community.
51
+ This manual page was written by Joshua Timberman <joshua@opscode.com> with help2man. Permission is granted
52
+ to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
53
+
54
+ On Debian systems, the complete text of the Apache 2.0 License can be found in
55
+ /usr/share/common-licenses/Apache-2.0.
@@ -1,5 +1,4 @@
1
- .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
2
- .TH CHEF-CLIENT: "8" "August 2009" "chef-client 0.7.8" "System Administration Utilities"
1
+ .TH CHEF-CLIENT: "8" "August 2009" "chef-client" "System Administration Utilities"
3
2
  .SH NAME
4
3
  chef-client: \- Runs a client node connecting to a chef-server.
5
4
  .SH SYNOPSIS
@@ -33,6 +32,9 @@ Set the log level (debug, info, warn, error, fatal)
33
32
  \fB\-L\fR, \fB\-\-logfile\fR LOGLOCATION
34
33
  Set the log file location, defaults to STDOUT \- recommended for daemonizing
35
34
  .TP
35
+ \fB\-V\fR, \fB\-\-verbose\fR
36
+ Ensures logging goes to STDOUT as well as to other configured log location(s).
37
+ .TP
36
38
  \fB\-N\fR, \fB\-\-node\-name\fR NODE_NAME
37
39
  The node name for this client
38
40
  .TP
@@ -1,5 +1,4 @@
1
- .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
2
- .TH CHEF-SOLO: "8" "August 2009" "chef-solo 0.7.8" "System Administration Utilities"
1
+ .TH CHEF-SOLO: "8" "August 2009" "chef-solo" "System Administration Utilities"
3
2
  .SH NAME
4
3
  chef-solo: \- Runs chef in solo mode against a specified cookbook location.
5
4
  .SH SYNOPSIS
@@ -0,0 +1,37 @@
1
+ .TH CHEF-SOLR-REBUILD: "1" "March 2010" "chef-solr-rebuild" "User Commands"
2
+ .SH NAME
3
+ chef-solr-rebuild: \- manual page for chef-solr-rebuild
4
+ .SH SYNOPSIS
5
+ .B chef-solr-rebuild
6
+ \fI(options)\fR
7
+ .SH DESCRIPTION
8
+ .TP
9
+ \fB\-c\fR, \fB\-\-config\fR CONFIG
10
+ The configuration file to use
11
+ .TP
12
+ \fB\-d\fR, \fB\-\-couchdb\-database\fR DB
13
+ The CouchDB Database to re\-index
14
+ .TP
15
+ \fB\-u\fR, \fB\-\-couchdb\-url\fR URL
16
+ The CouchDB URL
17
+ .TP
18
+ \fB\-l\fR, \fB\-\-log_level\fR LEVEL
19
+ Set the log level (debug, info, warn, error, fatal)
20
+ .TP
21
+ \fB\-L\fR, \fB\-\-logfile\fR LOGLOCATION
22
+ Set the log file location, defaults to STDOUT \- recommended for daemonizing
23
+ .TP
24
+ \fB\-v\fR, \fB\-\-version\fR
25
+ Show chef\-solr\-rebuild version
26
+ .TP
27
+ \fB\-h\fR, \fB\-\-help\fR
28
+ Show this message
29
+ .SH "SEE ALSO"
30
+ Full documentation for Chef and chef-solr is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home.
31
+ .SH AUTHOR
32
+ chef-solr-rebuild was written by Adam Jacob <adam@ospcode.com> of Opscode (http://www.opscode.com), with contributions from the community.
33
+ This manual page was written by Joshua Timberman <joshua@opscode.com> with help2man. Permission is granted
34
+ to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
35
+
36
+ On Debian systems, the complete text of the Apache 2.0 License can be found in
37
+ /usr/share/common-licenses/Apache-2.0.
@@ -1,375 +1,777 @@
1
- .TH CHEF: "1" "December 2009" "knife: 0.8.0" "System Administration Utilities"
2
- .SH NAME
3
- knife: \- Chef server REST API utility
4
- .SH SYNOPSIS
5
- .B knife
6
- \fIsub-command (options)\fR
7
- .SH DESCRIPTION
8
- .TP
9
- This manual page documents knife, a command-line utility used to interact with a Chef server directly through the RESTful API. Knife uses sub-commands to take various actions on different types of Chef objects. Some sub-commands take additional options. General options follow sub-commands and their options. A configuration file can be created for common defaults.
10
- .TP
1
+ .\" generated with Ronn/v0.5
2
+ .\" http://github.com/rtomayko/ronn/
3
+ .
4
+ .TH "KNIFE" "8" "June 2010" "" ""
5
+ .
6
+ .SH "NAME"
7
+ \fBknife\fR \-\- Chef Server REST API utility
8
+ .
9
+ .SH "SYNOPSIS"
10
+ \fBknife\fR \fIsub\-command\fR \fI(options)\fR
11
+ .
12
+ .SH "DESCRIPTION"
13
+ This manual page documents knife, a command\-line utility used to interact with a Chef server directly through the RESTful API. Knife uses sub\-commands to take various actions on different types of Chef objects. Some sub\-commands take additional options. General options follow sub\-commands and their options. A configuration file can be created for common defaults.
14
+ .
15
+ .P
11
16
  Unless otherwise specified, output is in JSON format, and input files are also JSON format.
12
- .SH GENERAL OPTIONS
17
+ .
18
+ .SH "GENERAL OPTIONS"
19
+ .
13
20
  .TP
14
21
  \fB\-s\fR, \fB\-\-server\-url\fR URL
15
22
  Chef Server URL
23
+ .
16
24
  .TP
17
25
  \fB\-k\fR, \fB\-\-key\fR KEY
18
26
  API Client Key
27
+ .
19
28
  .TP
20
29
  \fB\-c\fR, \fB\-\-config\fR CONFIG
21
30
  The configuration file to use
31
+ .
22
32
  .TP
23
33
  \fB\-e\fR, \fB\-\-editor\fR EDITOR
24
34
  Set the editor to use for interactive commands
35
+ .
36
+ .TP
37
+ \fB\-f\fR, \fB\-\-format\fR FORMAT
38
+ Which format to use for output
39
+ .
25
40
  .TP
26
41
  \fB\-l\fR, \fB\-\-log_level\fR LEVEL
27
42
  Set the log level (debug, info, warn, error, fatal)
43
+ .
28
44
  .TP
29
45
  \fB\-L\fR, \fB\-\-logfile\fR LOGLOCATION
30
46
  Set the log file location, defaults to STDOUT
47
+ .
31
48
  .TP
32
49
  \fB\-n\fR, \fB\-\-no\-editor\fR
33
50
  Do not open EDITOR, just accept the data as is
51
+ .
34
52
  .TP
35
53
  \fB\-u\fR, \fB\-\-user\fR USER
36
54
  API Client Username
55
+ .
37
56
  .TP
38
57
  \fB\-p\fR, \fB\-\-print\-after\fR
39
58
  Show the data after a destructive operation
59
+ .
40
60
  .TP
41
61
  \fB\-v\fR, \fB\-\-version\fR
42
62
  Show chef version
63
+ .
43
64
  .TP
44
65
  \fB\-y\fR, \fB\-\-yes\fR
45
66
  Say yes to all prompts for confirmation
67
+ .
46
68
  .TP
47
69
  \fB\-h\fR, \fB\-\-help\fR
48
- Show usage information.
49
- .SH SUB-COMMANDS
50
- Knife sub-commands are structured as "NOUN verb NOUN (options)". The sub-commands are meant to be intuitively named.
51
- .SH CLIENT SUB-COMMANDS
70
+ Show this message
71
+ .
72
+ .SH "SUB\-COMMANDS"
73
+ Knife sub\-commands are structured as "\fINOUN\fR \fBverb\fR \fINOUN\fR (options)". The sub\-commands are meant to be intuitively named. Because the Chef Server API is RESTful, sub\-commands generally utilize CRUD operations.
74
+ .
75
+ .IP "\(bu" 4
76
+ create (create)
77
+ .
78
+ .IP "\(bu" 4
79
+ list and show (read)
80
+ .
81
+ .IP "\(bu" 4
82
+ edit (update)
83
+ .
84
+ .IP "\(bu" 4
85
+ delete (destroy)
86
+ .
87
+ .IP "" 0
88
+ .
89
+ .P
90
+ Objects stored on the server support these, as described below.
91
+ .
92
+ .SH "GENERAL SUB\-COMMANDS"
93
+ The following are general sub\-commands that do not fit within the other object types utilized in the Chef Server API.
94
+ .
95
+ .P
96
+ \fBconfigure\fR \fI(options)\fR
97
+ .
98
+ .TP
99
+ \fB\-i\fR, \fB\-\-initial\fR
100
+ Create an initial API Client
101
+ .
102
+ .TP
103
+ \fB\-r\fR, \fB\-\-repository REPO\fR
104
+ The path to your chef\-repo
105
+ .
106
+ .P
107
+ Create a configuration file for knife. This will prompt for values to enter into the file. Default values are listed in square brackets if no other entry is typed. See "\fBCONFIGURATION\fR" below for available options.
108
+ .
109
+ .P
110
+ \fBindex rebuild\fR \fI(options)\fR
111
+ .
52
112
  .TP
53
- Sub-commands related to working with clients, which are registered entities that access the Chef server.
113
+ \fB\-y\fR, \fB\-\-yes\fR
114
+ don't bother to ask if I'm sure
115
+ .
116
+ .P
117
+ Rebuilds all the search indexes on the server.
118
+ .
119
+ .P
120
+ \fBsearch INDEX QUERY\fR \fI(options)\fR
121
+ .
122
+ .TP
123
+ \fB\-a\fR, \fB\-\-attribute ATTR\fR
124
+ Show only one attribute
125
+ .
54
126
  .TP
55
- .B client bulk delete REGEX \fI(options)\fR
56
- .PP
57
- Delete clients on the Chef server based on a regular expression.
58
- .PP
59
- The regular expression (REGEX) here should be in quotes, not //'s.
127
+ \fB\-i\fR, \fB\-\-id\-only\fR
128
+ Show only the ID of matching objects
129
+ .
130
+ .TP
131
+ \fB\-R\fR, \fB\-\-rows INT\fR
132
+ The number of rows to return
133
+ .
134
+ .TP
135
+ \fB\-r\fR, \fB\-\-run\-list\fR
136
+ Show only the run list
137
+ .
138
+ .TP
139
+ \fB\-o\fR, \fB\-\-sort SORT\fR
140
+ The order to sort the results in
141
+ .
60
142
  .TP
61
- .B client create CLIENT (options)
143
+ \fB\-b\fR, \fB\-\-start ROW\fR
144
+ The row to start returning results at
145
+ .
146
+ .P
147
+ Search indexes are a feature of the Chef Server and the search sub\-command allows querying any of the available indexes using SOLR query syntax. The following data types are indexed for search: \fInode\fR, \fIrole\fR, \fIclient\fR, \fIdata bag\fR.
148
+ .
149
+ .P
150
+ \fBssh QUERY COMMAND\fR \fI(options)\fR
151
+ .
152
+ .TP
153
+ \fB\-a\fR, \fB\-\-attribute ATTR \fR
154
+ The attribute to use for opening the connection \- default is fqdn
155
+ .
62
156
  .TP
63
- \fB\-f\fR, \fB\-\-file\fR FILE
157
+ \fB\-C\fR, \fB\-\-concurrency NUM \fR
158
+ The number of concurrent connections
159
+ .
160
+ .TP
161
+ \fB\-m\fR, \fB\-\-manual\-list \fR
162
+ QUERY is a space separated list of servers
163
+ .
164
+ .TP
165
+ \fB\-P\fR, \fB\-\-ssh\-password PASSWORD\fR
166
+ The ssh password
167
+ .
168
+ .TP
169
+ \fB\-x\fR, \fB\-\-ssh\-user USERNAME \fR
170
+ The ssh username
171
+ .
172
+ .P
173
+ The \fBssh\fR sub\-command opens an ssh session to each of the nodes in the search results of the \fIQUERY\fR. This sub\-command requires that the net\-ssh\-multi and highline Ruby libraries are installed. On Debian systems, these are the libnet\-ssh\-multi\-ruby and libhighline\-ruby packages. They can also be installed as RubyGems (net\-ssh\-multi and highline, respectively).
174
+ .
175
+ .SH "CLIENT SUB\-COMMANDS"
176
+ Clients are entities that communicate with the Chef Server API.
177
+ .
178
+ .P
179
+ \fBclient bulk delete REGEX\fR \fI(options)\fR
180
+ .
181
+ .P
182
+ Delete clients on the Chef Server based on a regular expression. The regular expression (\fIREGEX\fR) should be in quotes, not in //'s.
183
+ .
184
+ .P
185
+ \fBclient create CLIENT\fR \fI(options)\fR
186
+ .
187
+ .TP
188
+ \fB\-a\fR, \fB\-\-admin \fR
189
+ Create the client as an admin
190
+ .
191
+ .TP
192
+ \fB\-f\fR, \fB\-\-file FILE\fR
64
193
  Write the key to a file
65
- .PP
66
- Create a new client.
67
- .PP
68
- .B client delete CLIENT (options)
69
- .PP
194
+ .
195
+ .P
196
+ Create a new client. This generates an RSA keypair. The private key will be displayed on \fISTDOUT\fR or written to the named file. The public half will be stored on the Server. For \fIchef\-client\fR systems, the private key should be copied to the system as \fB/etc/chef/client.pem\fR.
197
+ .
198
+ .P
199
+ Admin clients should be created for users that will use \fIknife\fR to access the API as an administrator. The private key will generally be copied to \fB~/.chef/CLIENT.pem\fR and referenced in the \fBknife.rb\fR configuration file.
200
+ .
201
+ .P
202
+ \fBclient delete CLIENT\fR \fI(options)\fR
203
+ .
204
+ .P
70
205
  Deletes a registered client.
71
- .PP
72
- .B client edit CLIENT (options)
73
- .PP
206
+ .
207
+ .P
208
+ \fBclient edit CLIENT\fR \fI(options)\fR
209
+ .
210
+ .P
74
211
  Edit a registered client.
75
- .PP
76
- .B client list (options)
212
+ .
213
+ .P
214
+ \fBclient list\fR \fI(options)\fR
215
+ .
77
216
  .TP
78
217
  \fB\-w\fR, \fB\-\-with\-uri\fR
79
- Show corresponding URIs
80
- .PP
218
+ Show corresponding URIs
219
+ .
220
+ .P
81
221
  List all registered clients.
82
- .PP
83
- .B client reregister CLIENT (options)
222
+ .
223
+ .P
224
+ \fBclient reregister CLIENT\fR \fI(options)\fR
225
+ .
84
226
  .TP
85
- \fB\-f\fR, \fB\-\-file\fR FILE
227
+ \fB\-f\fR, \fB\-\-file FILE\fR
86
228
  Write the key to a file
87
- .PP
88
- Regenerate the private key for a client.
89
- .PP
90
- .B client show CLIENT (options)
91
- .TP
92
- \fB\-a\fR, \fB\-\-attribute\fR [ATTR]
229
+ .
230
+ .P
231
+ Regenerate the RSA keypair for a client. The public half will be stored on the server and the private key displayed on \fISTDOUT\fR or written to the named file.
232
+ .
233
+ .P
234
+ \fBclient show CLIENT\fR \fI(options)\fR
235
+ .
236
+ .TP
237
+ \fB\-a\fR, \fB\-\-attribute ATTR\fR
93
238
  Show only one attribute
94
- .PP
239
+ .
240
+ .P
95
241
  Show a client.
96
- .SH COOKBOOK SUB-COMMANDS
97
- .TP
98
- Cookbooks are the fundamental unit of distribution in Chef. They encapsulate all the recipes of resources and the assets used to configure a particular aspect of the infrastructure.
99
- .PP
100
- .B cookbook bulk delete COOKBOOK REGEX (options)
101
- .PP
102
- Delete cookbooks based on a regular expression.
103
- .PP
104
- The regular expression (REGEX) here should be in quotes, not //'s.
105
- .PP
106
- .B cookbook delete COOKBOOK (options)
107
- .PP
108
- Delete a single named COOKBOOK.
109
- .PP
110
- .B cookbook download COOKBOOK (options)
111
- .TP
112
- \fB\-f\fR, \fB\-\-file\fR FILE
242
+ .
243
+ .SH "COOKBOOK SUB\-COMMANDS"
244
+ Cookbooks are the fundamental unit of distribution in Chef. They encapsulate all recipes of resources and assets used to configure a particular aspect of the infrastructure. The following sub\-commands can be used to manipulate the cookbooks stored on the Chef Server.
245
+ .
246
+ .P
247
+ \fBcookbook bulk delete REGEX\fR \fI(options)\fR
248
+ .
249
+ .P
250
+ Delete cookbooks on the Chef Server based on a regular expression. The regular expression (\fIREGEX\fR) should be in quotes, not in //'s.
251
+ .
252
+ .P
253
+ \fBcookbook delete COOKBOOK\fR \fI(options)\fR
254
+ .
255
+ .P
256
+ Delete a single named \fICOOKBOOK\fR.
257
+ .
258
+ .P
259
+ \fBcookbook download COOKBOOK\fR \fI(options)\fR
260
+ .
261
+ .TP
262
+ \fB\-f\fR, \fB\-\-file FILE\fR
113
263
  The filename to write to
114
- .PP
115
- Download a cookbook from the server as a gzip(1)'ed, tar(1) archive.
116
- .PP
117
- .B cookbook list (options)
264
+ .
265
+ .P
266
+ Download a cookbook from the Chef Server as a gzip(1)'ed, tar(1) archive.
267
+ .
268
+ .P
269
+ \fBcookbook list\fR \fI(options)\fR
270
+ .
118
271
  .TP
119
272
  \fB\-w\fR, \fB\-\-with\-uri\fR
120
273
  Show corresponding URIs
121
- .PP
122
- List all cookbooks.
123
- .PP
124
- .B cookbook metadata COOKBOOK (options)
274
+ .
275
+ .P
276
+ List all the cookbooks.
277
+ .
278
+ .P
279
+ \fBcookbook metadata COOKBOOK\fR \fI(options)\fR
280
+ .
125
281
  .TP
126
282
  \fB\-a\fR, \fB\-\-all\fR
127
283
  Generate metadata for all cookbooks, rather than just a single cookbook
128
- .PP
129
- Generate cookbook metadata for the named COOKBOOK.
284
+ .
130
285
  .TP
131
- \fB\-o\fR, \fB\-\-cookbook\-path\fR PATH:PATH
286
+ \fB\-o\fR, \fB\-\-cookbook\-path PATH:PATH\fR
132
287
  A colon\-separated path to look for cookbooks in
133
- .PP
134
- .B cookbook show COOKBOOK [PART] [FILENAME] (options)
135
- .TP
136
- \fB\-f\fR, \fB\-\-fqdn\fR FQDN
288
+ .
289
+ .P
290
+ Generate cookbook metadata for the named \fICOOKBOOK\fR. The \fIPATH\fR used here specifies where the "cookbooks" directory is located and corresponds to the \fBcookbook_path\fR configuration option.
291
+ .
292
+ .P
293
+ \fBcookbook metadata from FILE\fR \fI(options)\fR
294
+ .
295
+ .P
296
+ Load the cookbook metadata from a specified file.
297
+ .
298
+ .P
299
+ \fBcookbook show COOKBOOK [PART] [FILENAME]\fR \fI(options)\fR
300
+ .
301
+ .TP
302
+ \fB\-f\fR, \fB\-\-fqdn FQDN \fR
137
303
  The FQDN of the host to see the file for
304
+ .
138
305
  .TP
139
- \fB\-p\fR, \fB\-\-platform\fR PLATFORM
306
+ \fB\-p\fR, \fB\-\-platform PLATFORM \fR
140
307
  The platform to see the file for
308
+ .
141
309
  .TP
142
- \fB\-V\fR, \fB\-\-platform\-version\fR VERSION
310
+ \fB\-V\fR, \fB\-\-platform\-version VERSION\fR
143
311
  The platform version to see the file for
144
- .PP
145
- Show the particular part of a COOKBOOK. PART can be one of:
312
+ .
313
+ .P
314
+ Show a particular part of a \fICOOKBOOK\fR. \fIPART\fR can be one of:
315
+ .
316
+ .IP "\(bu" 4
317
+ \fIattributes\fR
318
+ .
319
+ .IP "\(bu" 4
320
+ \fIdefinitions\fR
321
+ .
322
+ .IP "\(bu" 4
323
+ \fIfiles\fR
324
+ .
325
+ .IP "\(bu" 4
326
+ \fIlibraries\fR
327
+ .
328
+ .IP "\(bu" 4
329
+ \fIproviders\fR
330
+ .
331
+ .IP "\(bu" 4
332
+ \fIrecipes\fR
333
+ .
334
+ .IP "\(bu" 4
335
+ \fIresources\fR
336
+ .
337
+ .IP "\(bu" 4
338
+ \fItemplates\fR
339
+ .
340
+ .IP "" 0
341
+ .
342
+ .P
343
+ \fBcookbook test [COOKBOOKS...]\fR \fI(options)\fR
344
+ .
146
345
  .TP
147
- \fIattributes definitions files libraries providers recipes resources templates\fR
148
- .PP
149
- .B cookbook upload COOKBOOK (options)
346
+ \fB\-a\fR, \fB\-\-all\fR
347
+ Test all cookbooks, rather than just a single cookbook
348
+ .
349
+ .TP
350
+ \fB\-o\fR, \fB\-\-cookbook\-path PATH:PATH\fR
351
+ A colon\-separated path to look for cookbooks in
352
+ .
353
+ .P
354
+ Test the specified cookbooks for syntax errors. This uses the built\-in Ruby syntax checking option for files in the cookbook ending in \fB.rb\fR, and the ERB syntax check for files ending in \fB.erb\fR (templates).
355
+ .
356
+ .P
357
+ \fBcookbook upload [COOKBOOKS...]\fR \fI(options)\fR
358
+ .
150
359
  .TP
151
360
  \fB\-a\fR, \fB\-\-all\fR
152
361
  Upload all cookbooks, rather than just a single cookbook
362
+ .
153
363
  .TP
154
- \fB\-o\fR, \fB\-\-cookbook\-path\fR PATH:PATH
364
+ \fB\-o\fR, \fB\-\-cookbook\-path PATH:PATH\fR
155
365
  A colon\-separated path to look for cookbooks in
156
- .PP
157
- Upload a cookbook to the server.
158
- .SH DATA BAG SUB-COMMANDS
159
- .PP
160
- Data bags are stores of JSON blobs. These blobs are called items. They are free form and indexed by the search mechanism on the Chef server.
161
- .PP
162
- .B data bag create BAG [ITEM] (options)
163
- .PP
164
- Create a new data bag, or item in a data bag.
165
- .PP
166
- .B data bag delete BAG [ITEM] (options)
167
- .PP
168
- Delete a data bag, or item from a data bag.
169
- .PP
170
- .B data bag edit BAG ITEM (options)
171
- .PP
366
+ .
367
+ .P
368
+ Uploads the specified cookbooks to the Chef Server. The actual upload executes a number of commands, most of which occur on the local machine. The cookbook is staged in a temporary location. Then the \fBcookbook_path\fR (or \fB\-o PATH\fR) is processed to search for the named cookbook, and each occurance is copied in the order specified. A syntax check is performed a la \fBcookbook test\fR, above. The metadata is generated, a la \fBcookbook metadata\fR. A gzip(1)'ed, tar(1) file is created, and is uploaded to the server.
369
+ .
370
+ .SH "COOKBOOK SITE SUB\-COMMANDS"
371
+ The following sub\-commands are still in the context of cookbooks, but they make use of Opscode's Cookbook Community site, \fIhttp://cookbooks.opscode.com/\fR. That site has an API, and these sub\-commands utilize that API, rather than the Chef Server API.
372
+ .
373
+ .P
374
+ \fBcookbook site download COOKBOOK [VERSION]\fR \fI(options)\fR
375
+ .
376
+ .TP
377
+ \fB\-f\fR, \fB\-\-file FILE\fR
378
+ The filename to write to
379
+ .
380
+ .P
381
+ Downloads a specific cookbook from the Community site, optionally specifying a certain version.
382
+ .
383
+ .P
384
+ \fBcookbook site list\fR \fI(options)\fR
385
+ .
386
+ .TP
387
+ \fB\-w\fR, \fB\-\-with\-uri\fR
388
+ Show corresponding URIs
389
+ .
390
+ .P
391
+ Lists available cookbooks from the Community site.
392
+ .
393
+ .P
394
+ \fBcookbook site search QUERY\fR \fI(options)\fR
395
+ .
396
+ .P
397
+ Searches the Community site with the specified query.
398
+ .
399
+ .P
400
+ \fBcookbook site show COOKBOOK [VERSION]\fR \fI(options)\fR
401
+ .
402
+ .P
403
+ Shows information from the site about a particular cookbook.
404
+ .
405
+ .P
406
+ \fBcookbook site vendor COOKBOOK [VERSION]\fR \fI(options)\fR
407
+ .
408
+ .TP
409
+ \fB\-d\fR, \fB\-\-dependencies\fR
410
+ Grab dependencies automatically
411
+ .
412
+ .P
413
+ Downloads a cookbook and untars it in the cookbooks directory. If \fI\-d\fR is specified, all the cookbooks it depends on (via metadata \fIdependencies\fR) are downloaded and untarred as well.
414
+ .
415
+ .SH "DATA BAG SUB\-COMMANDS"
416
+ Data bags are stores of JSON blobs. These blobs are called items. They are free form JSON and indexed by the Chef Server.
417
+ .
418
+ .P
419
+ \fBdata bag create BAG [ITEM]\fR \fI(options)\fR
420
+ .
421
+ .P
422
+ Create a new data bag, or an item in a data bag.
423
+ .
424
+ .P
425
+ \fBdata bag delete BAG [ITEM]\fR \fI(options)\fR
426
+ .
427
+ .P
428
+ Delete a data bag, or an item from a data bag.
429
+ .
430
+ .P
431
+ \fBdata bag edit BAG ITEM\fR \fI(options)\fR
432
+ .
433
+ .P
172
434
  Edit an item in a data bag.
173
- .PP
174
- .B data bag list (options)
435
+ .
436
+ .P
437
+ \fBdata bag list\fR \fI(options)\fR
438
+ .
175
439
  .TP
176
440
  \fB\-w\fR, \fB\-\-with\-uri\fR
177
441
  Show corresponding URIs
178
- .PP
442
+ .
443
+ .P
179
444
  List the available data bags.
180
- .PP
181
- .B data bag show BAG [ITEM] (options)
182
- .PP
445
+ .
446
+ .P
447
+ \fBdata bag show BAG [ITEM]\fR \fI(options)\fR
448
+ .
449
+ .P
183
450
  Show a specific data bag or an item in a data bag.
184
- .SH NODE SUB-COMMANDS
185
- .PP
186
- Nodes are the entities which are configured with Chef, typically servers or workstations. Nodes are registered as a client, typcially of the same name, but a single client might represent one or more nodes.
187
- .PP
188
- .B node bulk delete REGEX (options)
189
- .TP
190
- Delete nodes based on a regular expression.
191
- .PP
192
- The regular expression (REGEX) here should be in quotes, not //'s.
193
- .PP
194
- .B node create NODE (options)
195
- .PP
451
+ .
452
+ .SH "NODE SUB\-COMMANDS"
453
+ Nodes are the entities which are configured with Chef. Typically these are servers or workstations. Nodes are registered as a client, by default by the fully qualified domain name (fqdn). A single client may configure more than one node.
454
+ .
455
+ .P
456
+ \fBnode bulk delete REGEX\fR \fI(options)\fR
457
+ .
458
+ .P
459
+ Delete nodes on the Chef Server based on a regular expression. The regular expression (\fIREGEX\fR) should be in quotes, not in //'s.
460
+ .
461
+ .P
462
+ \fBnode create NODE\fR \fI(options)\fR
463
+ .
464
+ .P
196
465
  Create a new node.
197
- .PP
198
- .B node delete NODE (options)
199
- .PP
466
+ .
467
+ .P
468
+ \fBnode delete NODE\fR \fI(options)\fR
469
+ .
470
+ .P
200
471
  Delete a single node.
201
- .PP
202
- .B node edit NODE (options)
203
- .PP
472
+ .
473
+ .P
474
+ \fBnode edit NODE\fR \fI(options)\fR
475
+ .
476
+ .P
204
477
  Edit a node.
205
- .PP
206
- .B node from file FILE (options)
207
- .PP
478
+ .
479
+ .P
480
+ \fBnode from file FILE\fR \fI(options)\fR
481
+ .
482
+ .P
208
483
  Create a node from a JSON file.
209
- .PP
210
- .B node list (options)
484
+ .
485
+ .P
486
+ \fBnode list\fR \fI(options)\fR
487
+ .
211
488
  .TP
212
489
  \fB\-w\fR, \fB\-\-with\-uri\fR
213
490
  Show corresponding URIs
214
- .PP
491
+ .
492
+ .P
215
493
  List all nodes.
216
- .PP
217
- .B node run_list add [NODE] [ENTRY] (options)
494
+ .
495
+ .P
496
+ \fBnode run_list add [NODE] [ENTRY]\fR \fI(options)\fR
497
+ .
218
498
  .TP
219
- \fB\-a\fR, \fB\-\-after\fR [ITEM]
499
+ \fB\-a\fR, \fB\-\-after ITEM\fR
220
500
  Place the ENTRY in the run list after ITEM
221
- .PP
222
- Add a recipe or role to the node's run_list.
223
- .PP
224
- .B node run_list remove [NODE] [ENTRY] (options)
225
- .PP
226
- Remove a recipe or role from the node's run_list.
227
- .PP
228
- .B node show NODE (options)
229
- .TP
230
- \fB\-a\fR, \fB\-\-attribute\fR [ATTR]
501
+ .
502
+ .P
503
+ Add a recipe or role to the node's \fBrun_list\fR.
504
+ .
505
+ .P
506
+ \fBnode run_list remove [NODE] [ENTRY]\fR \fI(options)\fR
507
+ .
508
+ .P
509
+ Remove a recipe or role from the node's \fBrun_list\fR.
510
+ .
511
+ .P
512
+ \fBnode show NODE\fR \fI(options)\fR
513
+ .
514
+ .TP
515
+ \fB\-a\fR, \fB\-\-attribute [ATTR]\fR
231
516
  Show only one attribute
517
+ .
232
518
  .TP
233
- \fB\-r\fR, \fB\-\-run\-list\fR
519
+ \fB\-r\fR, \fB\-\-run\-list \fR
234
520
  Show only the run list
235
- .PP
521
+ .
522
+ .P
236
523
  Show a node.
237
- .SH ROLE SUB-COMMANDS
238
- .PP
239
- Roles provide a mechanism to apply a set of recipes and attributes to nodes. For example, the 'webserver' role might instruct Chef to add a recipe for Apache, and specify a default domain to use.
240
- .PP
241
- .B role bulk delete REGEX (options)
242
- .TP
243
- Delete roles based on a regular expression.
244
- .PP
245
- The regular expression (REGEX) here should be in quotes, not //'s.
246
- .PP
247
- .B role create ROLE (options)
524
+ .
525
+ .SH "ROLE SUB\-COMMANDS"
526
+ \fBrole bulk delete REGEX\fR \fI(options)\fR
527
+ .
528
+ .P
529
+ Delete roles on the Chef Server based on a regular expression. The regular expression (\fIREGEX\fR) should be in quotes, not in //'s.
530
+ .
531
+ .P
532
+ \fBrole create ROLE\fR \fI(options)\fR
533
+ .
248
534
  .TP
249
535
  \fB\-d\fR, \fB\-\-description\fR
250
536
  The role description
251
- .PP
537
+ .
538
+ .P
252
539
  Create a new role.
253
- .PP
254
- .B role delete ROLE (options)
255
- .PP
540
+ .
541
+ .P
542
+ \fBrole delete ROLE\fR \fI(options)\fR
543
+ .
544
+ .P
256
545
  Delete a role.
257
- .PP
258
- .B role edit ROLE (options)
546
+ .
547
+ .P
548
+ \fBrole edit ROLE\fR \fI(options)\fR
549
+ .
550
+ .P
259
551
  Edit a role.
260
- .PP
261
- .B role from file FILE (options)
262
- .PP
263
- Update a role from a file.
264
- .PP
265
- .B role list (options)
552
+ .
553
+ .P
554
+ \fBrole from file FILE\fR \fI(options)\fR
555
+ .
556
+ .P
557
+ Create or update a role from a role Ruby DSL (\fB.rb\fR) or JSON file.
558
+ .
559
+ .P
560
+ \fBrole list\fR \fI(options)\fR
561
+ .
266
562
  .TP
267
563
  \fB\-w\fR, \fB\-\-with\-uri\fR
268
564
  Show corresponding URIs
269
- .PP
565
+ .
566
+ .P
270
567
  List roles.
271
- .PP
272
- .B role show ROLE (options)
568
+ .
569
+ .P
570
+ \fBrole show ROLE\fR \fI(options)\fR
571
+ .
273
572
  .TP
274
- \fB\-a\fR, \fB\-\-attribute\fR [ATTR]
573
+ \fB\-a\fR, \fB\-\-attribute ATTR\fR
275
574
  Show only one attribute
276
- .PP
575
+ .
576
+ .P
277
577
  Show a specific role.
278
- .SH GENERAL SUB-COMMANDS
279
- .PP
280
- The following are general sub-commands that do not fit within the other object types used in Chef.
281
- .PP
282
- .B configure (options)
283
- .TP
284
- \fB\-r\fR, \fB\-\-repository\fR REPO
285
- The path to your chef\-repo
286
- .PP
287
- Create a configuration file for knife. This will prompt for values to enter into the file. See "\fBCONFIGURATION\fR" below for available options.
288
- .PP
289
- .B ec2 instance data [RUN LIST...] (options)
578
+ .
579
+ .SH "CLOUD COMPUTING SUB\-COMMANDS"
580
+ The next sections describe sub\-commands to work with various Cloud Computing APIs to launch server instances with validation and run\-time configuration that Chef knows about. These sub\-commands require the fog Ruby library. On Debian and Ubuntu systems this is the package \fBlibfog\-ruby\fR. It is also available as a RubyGem, \fBfog\fR.
581
+ .
582
+ .P
583
+ The Rackspace and Terremark sub\-commands are early stage of development. Right now when creating instances of these types, knife will assume an Ubuntu image, install Ruby from packages, RubyGems from source and Chef as a RubyGem. As these commands are developed, other installation styles may become available, as options.
584
+ .
585
+ .SH "EC2 SUB\-COMMANDS"
586
+ Chef is commonly used with Amazon AWS EC2 nodes. This sub\-command will generate instance metadata that can be used to automatically configure an EC2 instance with Chef. This requires an AMI that has Chef preinstalled with a configuration file that can parse the metadata at run\-time. At this time this is the only sub\-command for EC2, but more may be added later similar to \fBRACKSPACE\fR and \fBTERREMARK\fR below.
587
+ .
588
+ .P
589
+ \fBec2 instance data [RUN LIST...]\fR \fI(options)\fR
590
+ .
290
591
  .TP
291
592
  \fB\-e\fR, \fB\-\-edit\fR
292
593
  Edit the instance data
293
- .PP
294
- Chef is commonly used with Amazon AWS EC2 nodes. This command will generate instance metadata that can be used to automatically configure an EC2 instance with Chef.
295
- .PP
296
- .B search INDEX QUERY (options)
297
- .TP
298
- \fB\-a\fR, \fB\-\-attribute\fR [ATTR]
299
- Show only one attribute
300
- .TP
301
- \fB\-i\fR, \fB\-\-id\-only\fR
302
- Show only the ID of matching objects
303
- .TP
304
- \fB\-R\fR, \fB\-\-rows\fR INT
305
- The number of rows to return
306
- .TP
307
- \fB\-r\fR, \fB\-\-run\-list\fR
308
- Show only the run list
309
- .TP
310
- \fB\-o\fR, \fB\-\-sort\fR SORT
311
- The order to sort the results in
312
- .TP
313
- \fB\-b\fR, \fB\-\-start\fR ROW
314
- The row to start returning results at
315
- .PP
316
- Search indexes are a powerful feature of the Chef server and the search subcommand allows searching any of the available indexes using the SOLR query syntax.
317
- .PP
318
- .B ssh QUERY COMMAND (options)
319
- .TP
320
- \fB\-a\fR, \fB\-\-attribute\fR ATTR
321
- The attribute to use for opening the connection \- default is fqdn
322
- .TP
323
- \fB\-C\fR, \fB\-\-concurrency\fR NUM
324
- The number of concurrent connections
325
- .PP
326
- The ssh sub-command requires the net-ssh-multi Ruby library.
327
- .PP
328
- .SH CONFIGURATION
329
- The knife configuration file is a Ruby DSL. If it exists, knife uses the settings for \fBGENERAL OPTIONS\fR defaults.
330
- .TP
331
- .B log_level
332
- A Ruby symbol specifying the log level. Corresponds to the \-l or \-\-log_level option. Default is :info.
333
- .TP
334
- .B log_location
335
- Corresponds to the \-L or \-\-logfile option. Default is STDOUT.
336
- .TP
337
- .B node_name
338
- User to authenticate to the Chef server. Corresponds to the \-u or \-\-user option. This is requested from the user when running this sub-command.
339
- .TP
340
- .B client_key
341
- Private key file to authenticate to the Chef server. Corresponds to the \-k or \-\-key option. This is requested from the user when running this sub-command.
342
- .TP
343
- .B chef_server_url
344
- URL of the Chef server. Corresponds to the \-s or \-\-server\-url option. This is requested from the user when running this sub-command.
345
- .TP
346
- .B cache_type
347
- The type of cache to use. Default is \fIBasicFile\fR. This can be any type of Cache that moneta supports: BasicFile, Berkeley, Couch, DataMapper, File, LMC, Memcache, Memory, MongoDB, Redis, Rufus, S3, SDBM, Tyrant, Xattr, YAML.
348
- .TP
349
- .B cache_options
594
+ .
595
+ .P
596
+ The \fIRUN LIST\fR should be specified as a space separated list of roles or recipes that will be used by the instance to configure the server.
597
+ .
598
+ .SH "RACKSPACE SUB\-COMMANDS"
599
+ In addition to EC2 nodes, Chef can be used on Rackspace Cloud nodes. The following sub\-commands allow manipulating Rackspace Cloud nodes via the \fBfog\fR library.
600
+ .
601
+ .P
602
+ \fBrackspace server create [RUN LIST...]\fR \fI(options)\fR
603
+ .
604
+ .TP
605
+ \fB\-K\fR, \fB\-\-rackspace\-api\-key KEY\fR
606
+ Your rackspace API key
607
+ .
608
+ .TP
609
+ \fB\-A USERNAME\fR, \fB\-\-rackspace\-api\-username\fR
610
+ Your rackspace API username
611
+ .
612
+ .TP
613
+ \fB\-f\fR, \fB\-\-flavor FLAVOR \fR
614
+ The flavor of server
615
+ .
616
+ .TP
617
+ \fB\-i\fR, \fB\-\-image IMAGE \fR
618
+ The image of the server
619
+ .
620
+ .TP
621
+ \fB\-N\fR, \fB\-\-server\-name NAME\fR
622
+ The server name
623
+ .
624
+ .P
625
+ Creates a new Rackspace Cloud server.
626
+ .
627
+ .P
628
+ \fBrackspace server delete SERVER\fR \fI(options)\fR
629
+ .
630
+ .P
631
+ Deletes a running Rackspace Cloud server.
632
+ .
633
+ .P
634
+ \fBrackspace server list\fR \fI(options)\fR
635
+ .
636
+ .P
637
+ Lists running Rackspace Cloud servers.
638
+ .
639
+ .SH "TERREMARK SUB\-COMMANDS"
640
+ As above, Chef can also be used on Terremark vCloud nodes. The following sub\-commands allow manipulating Terremark vCloud nodes via the \fBfog\fR library.
641
+ .
642
+ .P
643
+ \fBterremark server create NAME [RUN LIST...]\fR \fI(options)\fR
644
+ .
645
+ .TP
646
+ \fB\-K PASSWORD\fR, \fB\-\-terremark\-password\fR
647
+ Your terremark password
648
+ .
649
+ .TP
650
+ \fB\-S\fR, \fB\-\-terremark\-service SERVICE\fR
651
+ Your terremark service name
652
+ .
653
+ .TP
654
+ \fB\-A USERNAME\fR, \fB\-\-terremark\-username\fR
655
+ Your terremark username
656
+ .
657
+ .P
658
+ Creates a new Terremark vCloud server.
659
+ .
660
+ .P
661
+ \fBterremark server delete SERVER\fR \fI(options)\fR
662
+ .
663
+ .P
664
+ Deletes a running Terremark vCloud server.
665
+ .
666
+ .P
667
+ \fBterremark server list\fR \fI(options)\fR
668
+ .
669
+ .TP
670
+ \fB\-K PASSWORD\fR, \fB\-\-terremark\-password\fR
671
+ Your terremark password
672
+ .
673
+ .TP
674
+ \fB\-S\fR, \fB\-\-terremark\-service SERVICE\fR
675
+ Your terremark service name
676
+ .
677
+ .TP
678
+ \fB\-A USERNAME\fR, \fB\-\-terremark\-username\fR
679
+ Your terremark username
680
+ .
681
+ .P
682
+ Lists running Terremark vCloud servers.
683
+ .
684
+ .SH "CONFIGURATION"
685
+ The knife configuration file is a Ruby DSL. If it exists, knife uses these settings for \fBGENERAL OPTIONS\fR defaults.
686
+ .
687
+ .P
688
+ \fBlog_level\fR
689
+ .
690
+ .P
691
+ A Ruby symbol specifying the log level. Corresponds to \fB\-l\fR or \fB\-\-log_level\fR option. Default is \fI:info\fR. Valid values are:
692
+ .
693
+ .IP "\(bu" 4
694
+ :info
695
+ .
696
+ .IP "\(bu" 4
697
+ :debug
698
+ .
699
+ .IP "\(bu" 4
700
+ :warn
701
+ .
702
+ .IP "\(bu" 4
703
+ :fatal
704
+ .
705
+ .IP "" 0
706
+ .
707
+ .P
708
+ \fBlog_location\fR
709
+ .
710
+ .P
711
+ Corresponds to the \fB\-L\fR or \fB\-\-log\-file\fR option. Defaults is \fBSTDOUT\fR. Valid values are \fBSTDOUT\fR or a filename.
712
+ .
713
+ .P
714
+ \fBnode_name\fR
715
+ .
716
+ .P
717
+ User to authenticate to the Chef server. Corresponds to the \fB\-u\fR or \fB\-\-user\fR option. This is requested from the user when running this sub\-command.
718
+ .
719
+ .P
720
+ \fBclient_key\fR
721
+ .
722
+ .P
723
+ Private key file to authenticate to the Chef server. Corresponds to the \fB\-k\fR or \fB\-\-key\fR option. This is requested from the user when running this sub\-command.
724
+ .
725
+ .P
726
+ \fBchef_server_url\fR
727
+ .
728
+ .P
729
+ URL of the Chef server. Corresponds to the \fB\-s\fR or \fB\-\-server\-url\fR option. This is requested from the user when running this sub\-command.
730
+ .
731
+ .P
732
+ \fBcache_type\fR
733
+ .
734
+ .P
735
+ The type of cache to use. Default is BasicFile. This can be any type of Cache that moneta supports: BasicFile, Berkeley, Couch, DataMapper, File, LMC, Memcache, Memory, MongoDB, Redis, Rufus, S3, SDBM, Tyrant, Xattr, YAML.
736
+ .
737
+ .P
738
+ \fBcache_options\fR
739
+ .
740
+ .P
350
741
  Specifies various options to use for caching. Default reads the Chef client configuration (/etc/chef/checksums).
351
- .TP
352
- .B validation_client_name
353
- Specifies the name of the client used to validate new clients. This is requested from the user when running the configuration sub-command.
354
- .TP
355
- .B validation_key
356
- Specifies the private key file to use for generating ec2 instance data for validating new clients. This is implied from the validation_client_name.
357
- .SH FILES
358
- .PP
742
+ .
743
+ .P
744
+ \fBvalidation_client_name\fR
745
+ .
746
+ .P
747
+ Specifies the name of the client used to validate new clients. This is requested from the user when running the configuration sub\-command.
748
+ .
749
+ .P
750
+ \fBvalidation_key\fR
751
+ .
752
+ .P
753
+ Specifies the private key file to use for generating ec2 instance data for validating new clients. This is implied from the \fBvalidation_client_name\fR.
754
+ .
755
+ .SH "FILES"
359
756
  \fI~/.chef/knife.rb\fR
360
- .TP
361
- Ruby DSL configuration file for Knife. See "\fBCONFIGURATION\fR".
362
- .SH SEE ALSO
363
- .PP
364
- Full documentation for Chef and Knife is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home.
365
- .PP
757
+ .
758
+ .P
759
+ Ruby DSL configuration file for knife. See "\fBCONFIGURATION\fR".
760
+ .
761
+ .SH "SEE ALSO"
762
+ Full documentation for Chef is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home/.
763
+ .
764
+ .P
366
765
  JSON is JavaScript Object Notation and more information can be found at http://json.org/.
367
- .PP
368
- SOLR is an open source search engine. The Chef Server includes a SOLR installation. More information about SOLR, including search query syntax, can be found at http://lucene.apache.org/solr/.
369
- .SH AUTHOR
370
- Chef was written by Adam Jacob <adam@ospcode.com> of Opscode (http://www.opscode.com), with contributions from the community.
371
- This manual page was written by Joshua Timberman <joshua@opscode.com> with help2man. Permission is granted
372
- to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
373
- .PP
374
- On Debian systems, the complete text of the Apache 2.0 License can be found in
375
- /usr/share/common-licenses/Apache-2.0.
766
+ .
767
+ .P
768
+ SOLR is an open source search engine. The Chef Server includes a SOLR installation. More information about SOLR, including the search query syntax, can be found at http://lucene.apache.org/solr/.
769
+ .
770
+ .P
771
+ This manual page was generated in nroff from Markdown with ronn. Ryan Tomayko wrote ronn and more information can be found at http://rtomayko.github.com/ronn/ronn.5.html.
772
+ .
773
+ .SH "AUTHOR"
774
+ Chef was written by Adam Jacob \fIadam@opscode.com\fR of Opscode (http://www.opscode.com), with contributions from the community. This manual page was written by Joshua Timberman \fIjoshua@opscode.com\fR. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
775
+ .
776
+ .P
777
+ On Debian systems, the complete text of the Apache 2.0 License can be found in \fB/usr/share/common\-licenses/Apache\-2.0\fR.