chef 0.10.0.beta.9 → 0.10.0.beta.10

Sign up to get free protection for your applications and to get access to all the features.
Files changed (86) hide show
  1. data/README.rdoc +2 -0
  2. data/distro/common/html/chef-client.8.html +141 -0
  3. data/distro/common/html/chef-expander-cluster.8.html +164 -0
  4. data/distro/common/html/chef-expanderctl.8.html +146 -0
  5. data/distro/common/html/chef-server-webui.8.html +185 -0
  6. data/distro/common/html/chef-server.8.html +182 -0
  7. data/distro/common/html/chef-solo.8.html +191 -0
  8. data/distro/common/html/chef-solr.8.html +163 -0
  9. data/distro/common/html/knife-bootstrap.1.html +3 -3
  10. data/distro/common/html/knife-client.1.html +3 -3
  11. data/distro/common/html/knife-configure.1.html +1 -1
  12. data/distro/common/html/knife-cookbook-site.1.html +3 -3
  13. data/distro/common/html/knife-cookbook.1.html +3 -3
  14. data/distro/common/html/knife-data-bag.1.html +1 -1
  15. data/distro/common/html/knife-environment.1.html +3 -3
  16. data/distro/common/html/knife-exec.1.html +3 -3
  17. data/distro/common/html/knife-index.1.html +1 -1
  18. data/distro/common/html/knife-node.1.html +3 -3
  19. data/distro/common/html/knife-recipe.1.html +1 -1
  20. data/distro/common/html/knife-role.1.html +3 -3
  21. data/distro/common/html/knife-search.1.html +3 -3
  22. data/distro/common/html/knife-ssh.1.html +3 -3
  23. data/distro/common/html/knife-status.1.html +3 -3
  24. data/distro/common/html/knife-tag.1.html +3 -3
  25. data/distro/common/html/knife.1.html +3 -3
  26. data/distro/common/html/shef.1.html +3 -3
  27. data/distro/common/man/man1/knife-bootstrap.1 +1 -1
  28. data/distro/common/man/man1/knife-client.1 +1 -1
  29. data/distro/common/man/man1/knife-configure.1 +1 -1
  30. data/distro/common/man/man1/knife-cookbook-site.1 +1 -1
  31. data/distro/common/man/man1/knife-cookbook.1 +1 -1
  32. data/distro/common/man/man1/knife-data-bag.1 +1 -1
  33. data/distro/common/man/man1/knife-environment.1 +1 -1
  34. data/distro/common/man/man1/knife-exec.1 +1 -1
  35. data/distro/common/man/man1/knife-index.1 +1 -1
  36. data/distro/common/man/man1/knife-node.1 +1 -1
  37. data/distro/common/man/man1/knife-role.1 +1 -1
  38. data/distro/common/man/man1/knife-search.1 +1 -1
  39. data/distro/common/man/man1/knife-ssh.1 +1 -1
  40. data/distro/common/man/man1/knife-status.1 +1 -1
  41. data/distro/common/man/man1/knife-tag.1 +1 -1
  42. data/distro/common/man/man1/knife.1 +1 -1
  43. data/distro/common/man/man1/shef.1 +1 -1
  44. data/distro/common/man/man8/chef-client.8 +53 -32
  45. data/distro/common/man/man8/chef-expander-cluster.8 +97 -0
  46. data/distro/common/man/man8/chef-expanderctl.8 +62 -0
  47. data/distro/common/man/man8/chef-server-webui.8 +121 -72
  48. data/distro/common/man/man8/chef-server.8 +113 -73
  49. data/distro/common/man/man8/chef-solo.8 +131 -30
  50. data/distro/common/man/man8/chef-solr.8 +85 -26
  51. data/distro/common/markdown/man8/chef-client.mkd +65 -0
  52. data/distro/common/markdown/man8/chef-expander-cluster.mkd +82 -0
  53. data/distro/common/markdown/man8/chef-expanderctl.mkd +58 -0
  54. data/distro/common/markdown/man8/chef-server-webui.mkd +121 -0
  55. data/distro/common/markdown/man8/chef-server.mkd +121 -0
  56. data/distro/common/markdown/man8/chef-solo.mkd +107 -0
  57. data/distro/common/markdown/man8/chef-solr.mkd +85 -0
  58. data/lib/chef/config.rb +1 -1
  59. data/lib/chef/cookbook/metadata.rb +1 -0
  60. data/lib/chef/cookbook_uploader.rb +12 -5
  61. data/lib/chef/couchdb.rb +21 -21
  62. data/lib/chef/file_access_control.rb +4 -4
  63. data/lib/chef/knife.rb +11 -3
  64. data/lib/chef/knife/bootstrap/centos5-gems.erb +13 -7
  65. data/lib/chef/knife/bootstrap/fedora13-gems.erb +1 -1
  66. data/lib/chef/knife/bootstrap/ubuntu10.04-apt.erb +2 -2
  67. data/lib/chef/knife/bootstrap/ubuntu10.04-gems.erb +1 -1
  68. data/lib/chef/knife/client_create.rb +1 -1
  69. data/lib/chef/knife/configure.rb +10 -1
  70. data/lib/chef/knife/cookbook_bulk_delete.rb +13 -3
  71. data/lib/chef/knife/cookbook_site_download.rb +5 -5
  72. data/lib/chef/knife/cookbook_site_install.rb +5 -5
  73. data/lib/chef/knife/cookbook_site_list.rb +6 -2
  74. data/lib/chef/knife/cookbook_site_search.rb +1 -1
  75. data/lib/chef/knife/cookbook_site_show.rb +3 -3
  76. data/lib/chef/knife/cookbook_upload.rb +7 -8
  77. data/lib/chef/knife/core/ui.rb +1 -1
  78. data/lib/chef/knife/node_bulk_delete.rb +37 -3
  79. data/lib/chef/knife/recipe_list.rb +0 -1
  80. data/lib/chef/knife/role_bulk_delete.rb +27 -4
  81. data/lib/chef/mixin/language.rb +2 -2
  82. data/lib/chef/resource/deploy_revision.rb +5 -0
  83. data/lib/chef/rest.rb +5 -8
  84. data/lib/chef/version.rb +1 -1
  85. data/lib/chef/version_class.rb +4 -4
  86. metadata +20 -4
@@ -1,57 +1,158 @@
1
- .TH CHEF-SOLO: "8" "August 2009" "chef-solo" "System Administration Utilities"
2
- .SH NAME
3
- chef-solo: \- Runs chef in solo mode against a specified cookbook location.
4
- .SH SYNOPSIS
5
- .B chef-solo
6
- \fI(options)\fR
7
- .SH DESCRIPTION
8
- .TP
9
- \fB\-c\fR, \fB\-\-config\fR CONFIG
1
+ .\" generated with Ronn/v0.7.3
2
+ .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
+ .
4
+ .TH "CHEF\-SOLO" "8" "April 2011" "Chef 0.10.0.beta.10" "Chef Manual"
5
+ .
6
+ .SH "NAME"
7
+ \fBchef\-solo\fR \- Runs chef in solo mode against a specified cookbook location\.
8
+ .
9
+ .SH "SYNOPSIS"
10
+ \fBchef\-solo\fR \fI(options)\fR
11
+ .
12
+ .TP
13
+ \fB\-c\fR, \fB\-\-config CONFIG\fR
10
14
  The configuration file to use
15
+ .
11
16
  .TP
12
17
  \fB\-d\fR, \fB\-\-daemonize\fR
13
18
  Daemonize the process
19
+ .
14
20
  .TP
15
- \fB\-g\fR, \fB\-\-group\fR GROUP
21
+ \fB\-g\fR, \fB\-\-group GROUP\fR
16
22
  Group to set privilege to
23
+ .
17
24
  .TP
18
- \fB\-i\fR, \fB\-\-interval\fR SECONDS
25
+ \fB\-i\fR, \fB\-\-interval SECONDS\fR
19
26
  Run chef\-client periodically, in seconds
27
+ .
20
28
  .TP
21
- \fB\-j\fR JSON_ATTRIBS
29
+ \fB\-j\fR, \fB\-\-json\-attributes JSON_ATTRIBS\fR
22
30
  Load attributes from a JSON file or URL
23
- .HP
24
- \fB\-\-json\-attributes\fR
31
+ .
25
32
  .TP
26
- \fB\-l\fR, \fB\-\-log_level\fR LEVEL
33
+ \fB\-l\fR, \fB\-\-log_level LEVEL\fR
27
34
  Set the log level (debug, info, warn, error, fatal)
35
+ .
28
36
  .TP
29
- \fB\-L\fR, \fB\-\-logfile\fR LOGLOCATION
30
- Set the log file location, defaults to STDOUT
37
+ \fB\-L\fR, \fB\-\-logfile LOGLOCATION\fR
38
+ Set the log file location, defaults to STDOUT \- recommended for daemonizing
39
+ .
31
40
  .TP
32
- \fB\-N\fR, \fB\-\-node\-name\fR NODE_NAME
41
+ \fB\-N\fR, \fB\-\-node\-name NODE_NAME\fR
33
42
  The node name for this client
43
+ .
34
44
  .TP
35
- \fB\-r\fR, \fB\-\-recipe\-url\fR RECIPE_URL
36
- Pull down a remote gzipped tarball of recipes and untar it to the cookbook cache.
45
+ \fB\-r\fR, \fB\-\-recipe\-url RECIPE_URL\fR
46
+ Pull down a remote gzipped tarball of recipes and untar it to the cookbook cache\.
47
+ .
37
48
  .TP
38
- \fB\-s\fR, \fB\-\-splay\fR SECONDS
49
+ \fB\-s\fR, \fB\-\-splay SECONDS\fR
39
50
  The splay time for running at intervals, in seconds
51
+ .
40
52
  .TP
41
- \fB\-u\fR, \fB\-\-user\fR USER
53
+ \fB\-u\fR, \fB\-\-user USER\fR
42
54
  User to set privilege to
55
+ .
43
56
  .TP
44
57
  \fB\-v\fR, \fB\-\-version\fR
45
58
  Show chef version
59
+ .
46
60
  .TP
47
61
  \fB\-h\fR, \fB\-\-help\fR
48
62
  Show this message
49
- .SH "SEE ALSO"
50
- Full documentation for Chef and chef-solo is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home.
51
- .SH AUTHOR
52
- Chef was written by Adam Jacob <adam@ospcode.com> of Opscode (http://www.opscode.com), with contributions from the community.
53
- This manual page was written by Joshua Timberman <joshua@opscode.com> with help2man. Permission is granted
54
- to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
63
+ .
64
+ .SH "DESCRIPTION"
65
+ Chef Solo allows you to run Chef Cookbooks in the absence of a Chef Server\. To do this, the complete cookbook needs to be present on disk\.
66
+ .
67
+ .P
68
+ By default Chef Solo will look in /etc/chef/solo\.rb for its configuration\. This configuration file has two required variables: file_cache_path and cookbook_path\.
69
+ .
70
+ .P
71
+ For example:
72
+ .
73
+ .IP "" 4
74
+ .
75
+ .nf
76
+
77
+ file_cache_path "/var/chef\-solo"
78
+ cookbook_path "/var/chef\-solo/cookbooks"
79
+ .
80
+ .fi
81
+ .
82
+ .IP "" 0
83
+ .
84
+ .P
85
+ For your own systems, you can change this to reflect any directory you like, but you\'ll need to specify absolute paths and the cookbook_path directory should be a subdirectory of the file_cache_path\.
86
+ .
87
+ .P
88
+ You can also specify cookbook_path as an array, passing multiple locations to search for cookbooks\.
89
+ .
90
+ .P
91
+ For example:
92
+ .
93
+ .IP "" 4
94
+ .
95
+ .nf
55
96
 
56
- On Debian systems, the complete text of the Apache 2.0 License can be found in
57
- /usr/share/common-licenses/Apache-2.0.
97
+ file_cache_path "/var/chef\-solo"
98
+ cookbook_path ["/var/chef\-solo/cookbooks", "/var/chef\-solo/site\-cookbooks"]
99
+ .
100
+ .fi
101
+ .
102
+ .IP "" 0
103
+ .
104
+ .P
105
+ Note that earlier entries are now overridden by later ones\.
106
+ .
107
+ .P
108
+ Since chef\-solo doesn\'t have any interaction with a Chef Server, you\'ll need to specify node\-specifc attributes in a JSON file\. This can be located on the target system itself, or it can be stored on a remote server such as S3, or a web server on your network\.
109
+ .
110
+ .P
111
+ Within the JSON file, you\'ll also specify the recipes that Chef should run in the "run_list"\. An example JSON file, which sets a resolv\.conf:
112
+ .
113
+ .IP "" 4
114
+ .
115
+ .nf
116
+
117
+ {
118
+ "resolver": {
119
+ "nameservers": [ "10\.0\.0\.1" ],
120
+ "search":"int\.example\.com"
121
+ },
122
+ "run_list": [ "recipe[resolver]" ]
123
+ }
124
+ .
125
+ .fi
126
+ .
127
+ .IP "" 0
128
+ .
129
+ .P
130
+ Then you can run chef\-solo with \-j to specify the JSON file\. It will look for cookbooks in the cookbook_path configured in the configuration file, and apply attributes and use the run_list from the JSON file specified\.
131
+ .
132
+ .P
133
+ You can use \-c to specify the path to the configuration file (if you don\'t want chef\-solo to use the default)\. You can also specify \-r for a cookbook tarball\.
134
+ .
135
+ .P
136
+ For example:
137
+ .
138
+ .IP "" 4
139
+ .
140
+ .nf
141
+
142
+ chef\-solo \-c ~/solo\.rb \-j ~/node\.json \-r http://www\.example\.com/chef\-solo\.tar\.gz
143
+ .
144
+ .fi
145
+ .
146
+ .IP "" 0
147
+ .
148
+ .P
149
+ In the above case, chef\-solo would extract the tarball to your specified cookbook_path, use ~/solo\.rb as the configuration file, and apply attributes and use the run_list from ~/node\.json\.
150
+ .
151
+ .SH "SEE ALSO"
152
+ Full documentation for Chef and chef\-solo is located on the Chef wiki, http://wiki\.opscode\.com/display/chef/Home\.
153
+ .
154
+ .SH "AUTHOR"
155
+ Chef was written by Adam Jacob \fIadam@ospcode\.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 with help2man\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
156
+ .
157
+ .P
158
+ On Debian systems, the complete text of the Apache 2\.0 License can be found in /usr/share/common\-licenses/Apache\-2\.0\.
@@ -1,55 +1,114 @@
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
1
+ .\" generated with Ronn/v0.7.3
2
+ .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
+ .
4
+ .TH "CHEF\-SOLR" "8" "April 2011" "Chef 0.10.0.beta.10" "Chef Manual"
5
+ .
6
+ .SH "NAME"
7
+ \fBchef\-solr\fR \- Runs as Chef\'s search server
8
+ .
9
+ .SH "SYNOPSIS"
10
+ \fBchef\-solr\fR \fI(options)\fR
11
+ .
12
+ .TP
13
+ \fB\-c\fR, \fB\-\-config CONFIG\fR
10
14
  The configuration file to use
15
+ .
11
16
  .TP
12
17
  \fB\-d\fR, \fB\-\-daemonize\fR
13
18
  Daemonize the process
19
+ .
14
20
  .TP
15
- \fB\-g\fR, \fB\-\-group\fR GROUP
21
+ \fB\-g\fR, \fB\-\-group GROUP\fR
16
22
  Group to set privilege to
23
+ .
17
24
  .TP
18
- \fB\-l\fR, \fB\-\-log_level\fR LEVEL
25
+ \fB\-l\fR, \fB\-\-log_level LEVEL\fR
19
26
  Set the log level (debug, info, warn, error, fatal)
27
+ .
20
28
  .TP
21
- \fB\-L\fR, \fB\-\-logfile\fR LOGLOCATION
29
+ \fB\-L\fR, \fB\-\-logfile LOGLOCATION\fR
22
30
  Set the log file location, defaults to STDOUT \- recommended for daemonizing
31
+ .
23
32
  .TP
24
- \fB\-D\fR, \fB\-\-solr\-data\-dir\fR PATH
33
+ \fB\-D\fR, \fB\-\-solr\-data\-dir PATH\fR
25
34
  Where the Solr data lives
35
+ .
26
36
  .TP
27
- \fB\-x\fR, \fB\-\-solor\-heap\-size\fR SIZE
37
+ \fB\-x\fR, \fB\-\-solor\-heap\-size SIZE\fR
28
38
  Set the size of the Java Heap
39
+ .
29
40
  .TP
30
- \fB\-H\fR, \fB\-\-solr\-home\-dir\fR PATH
41
+ \fB\-H\fR, \fB\-\-solr\-home\-dir PATH\fR
31
42
  Solr home directory
43
+ .
32
44
  .TP
33
- \fB\-j\fR, \fB\-\-java\-opts\fR OPTS
45
+ \fB\-j\fR, \fB\-\-java\-opts OPTS\fR
34
46
  Raw options passed to Java
47
+ .
35
48
  .TP
36
- \fB\-W\fR, \fB\-\-solr\-jetty\-dir\fR PATH
49
+ \fB\-W\fR, \fB\-\-solr\-jetty\-dir PATH\fR
37
50
  Where to place the Solr Jetty instance
51
+ .
38
52
  .TP
39
- \fB\-u\fR, \fB\-\-user\fR USER
53
+ \fB\-u\fR, \fB\-\-user USER\fR
40
54
  User to set privilege to
55
+ .
41
56
  .TP
42
57
  \fB\-v\fR, \fB\-\-version\fR
43
58
  Show chef\-solr version
59
+ .
44
60
  .TP
45
61
  \fB\-h\fR, \fB\-\-help\fR
46
62
  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.
63
+ .
64
+ .SH "DESCRIPTION"
65
+ Chef\-solr provides search service for Chef\. You need to have both chef\-solr and chef\-expander\-cluster running in order for search to work\.
66
+ .
67
+ .P
68
+ \fBInstallation\fR
69
+ .
70
+ .P
71
+ Make sure you backed up your data if you are upgrading from a previous version\. Run chef\-solr\-installer to upgrade your Chef Solr installation\. Answer "yes" when prompted for confirmation\. The process should look like this:
72
+ .
73
+ .IP "" 4
74
+ .
75
+ .nf
76
+
77
+ yourshell> chef\-solr\-installer
78
+ Configuration setting solr_heap_size is unknown and will be ignored
53
79
 
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.
80
+ Chef Solr is already installed in /var/chef/solr
81
+ Do you want to overwrite the current install? All existing Solr data will be lost\. [y/n] y
82
+ Removing the existing Chef Solr installation
83
+ rm \-rf /var/chef/solr
84
+ rm \-rf /var/chef/solr\-jetty
85
+ rm \-rf /var/chef/solr/data
86
+ Creating Solr Home Directory
87
+ mkdir \-p /var/chef/solr
88
+ entering /var/chef/solr
89
+ tar zxvf /Users/ddeleo/opscode/chef/chef\-solr/solr/solr\-home\.tar\.gz
90
+ Creating Solr Data Directory
91
+ mkdir \-p /var/chef/solr/data
92
+ Unpacking Solr Jetty
93
+ mkdir \-p /var/chef/solr\-jetty
94
+ entering /var/chef/solr\-jetty
95
+ tar zxvf /Users/ddeleo/opscode/chef/chef\-solr/solr/solr\-jetty\.tar\.gz
96
+
97
+ Successfully installed Chef Solr\.
98
+ You can restore your search index using `knife index rebuild`
99
+ .
100
+ .fi
101
+ .
102
+ .IP "" 0
103
+ .
104
+ .SH "SEE ALSO"
105
+ \fBchef\-expander\-cluster\fR(8)
106
+ .
107
+ .P
108
+ Full documentation for Chef and chef\-server is located on the Chef wiki, http://wiki\.opscode\.com/display/chef/Home\.
109
+ .
110
+ .SH "AUTHOR"
111
+ Chef was written by Adam Jacob \fIadam@ospcode\.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 with help2man\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
112
+ .
113
+ .P
114
+ On Debian systems, the complete text of the Apache 2\.0 License can be found in /usr/share/common\-licenses/Apache\-2\.0\.
@@ -0,0 +1,65 @@
1
+ chef-client(8) -- Runs a client node connecting to a chef-server.
2
+ ========================================
3
+
4
+ ## SYNOPSIS
5
+
6
+ __chef-client__ _(options)_
7
+
8
+ * `-S`, `--server CHEFSERVERURL`:
9
+ The chef server URL
10
+ * `-c`, `--config CONFIG`:
11
+ The configuration file to use
12
+ * `-d`, `--daemonize`:
13
+ Daemonize the process
14
+ * `-g`, `--group GROUP`:
15
+ Group to set privilege to
16
+ * `-i`, `--interval SECONDS`:
17
+ Run chef-client periodically, in seconds
18
+ * `-j`, `--json-attributes JSON_ATTRIBS`:
19
+ Load attributes from a JSON file or URL
20
+ * `-l`, `--log_level LEVEL`:
21
+ Set the log level (debug, info, warn, error, fatal)
22
+ * `-L`, `--logfile LOGLOCATION`:
23
+ Set the log file location, defaults to STDOUT - recommended for
24
+ daemonizing
25
+ * `-V`, `--verbose`:
26
+ Ensures logging goes to STDOUT as well as to other configured
27
+ log location(s).
28
+ * `-N`, `--node-name NODE_NAME`:
29
+ The node name for this client
30
+ * `-s`, `--splay SECONDS`:
31
+ The splay time for running at intervals, in seconds
32
+ * `-u`, `--user USER`:
33
+ User to set privilege to
34
+ * `-v`, `--version`:
35
+ Show chef version
36
+ * `-h`, `--help`:
37
+ Show this message
38
+
39
+ ## DESCRIPTION
40
+
41
+ The Chef Client is where almost all of the work in Chef is done. It
42
+ communicates with the Chef Server via REST, authenticates via Signed
43
+ Header Authentication, and compiles and executes Cookbooks.
44
+
45
+ A Chef Client does work on behalf of a Node. A single Chef Client can
46
+ run recipes for multiple Nodes.
47
+
48
+ Clients are where all the action happens - the Chef Server and Chef Expander
49
+ are largely services that exist only to provide the Client with information.
50
+
51
+ ## SEE ALSO
52
+
53
+ Full documentation for Chef and chef-client is located on the Chef
54
+ wiki, http://wiki.opscode.com/display/chef/Home.
55
+
56
+ ## AUTHOR
57
+
58
+ Chef was written by Adam Jacob <adam@ospcode.com> of Opscode
59
+ (http://www.opscode.com), with contributions from the community. This
60
+ manual page was written by Joshua Timberman <joshua@opscode.com> with
61
+ help2man. Permission is granted to copy, distribute and / or modify
62
+ this document under the terms of the Apache 2.0 License.
63
+
64
+ On Debian systems, the complete text of the Apache 2.0 License can be
65
+ found in /usr/share/common-licenses/Apache-2.0.
@@ -0,0 +1,82 @@
1
+ chef-expander-cluster(8) -- fetches messages from RabbitMQ, processes, and loads into chef-solr
2
+ ========================================
3
+
4
+ ## SYNOPSIS
5
+
6
+ __chef-expander-cluster__ _(options)_
7
+
8
+ * `-c`, `--config CONFIG_FILE`:
9
+ a configuration file to use
10
+ * `-i`, `--index INDEX`:
11
+ the slot this node will occupy in the ring
12
+ * `-n`, `--node-count NUMBER`:
13
+ the number of nodes in the ring
14
+ * `-l`, `--log-level LOG_LEVEL`:
15
+ set the log level
16
+ * `-L`, `--logfile LOG_LOCATION`:
17
+ Logfile to use
18
+ * `-d`, `--daemonize`:
19
+ fork into the background
20
+ * `-P`, `--pid PIDFILE`:
21
+ PID file
22
+ * `-h`, `--help`:
23
+ show help message
24
+ * `-v`, `--version`:
25
+ show the version and exit
26
+
27
+ ## DESCRIPTION
28
+
29
+ Chef Expander fetches messages from RabbitMQ, processes them into the
30
+ correct format to be loaded into Solr and loads them into Solr.
31
+
32
+ __Running Chef Expander__
33
+
34
+ Chef Expander is designed for clustered operation, though small
35
+ installations will only need one worker process. To run Chef
36
+ Expander with one worker process, run chef-expander-cluster -n 1.
37
+ You will then have a master and worker process, which looks like
38
+ this in ps:
39
+
40
+ your-shell> ps aux|grep expander
41
+ you 52110 0.1 0.7 2515476 62748 s003 S+ 3:49PM 0:00.80 chef-expander worker #1 (vnodes 0-1023)
42
+ you 52108 0.1 0.5 2492880 41696 s003 S+ 3:49PM 0:00.91 ruby bin/chef-expander-cluster -n 1
43
+
44
+ Workers are single threaded and therefore cannot use more than 100%
45
+ of a single CPU. If you find that your queues are getting backlogged,
46
+ increase the number of workers
47
+
48
+ __Design__
49
+
50
+ Chef Expander uses 1024 queues (called vnodes in some places) to allow
51
+ you to scale the number of Chef Expander workers to meet the needs of
52
+ your infrastructure. When objects are saved in the API server, they are
53
+ added to queues based on their database IDs. These queues can be assigned
54
+ to different Chef Expander workers to distribute the load of processing
55
+ the index updates.
56
+
57
+ __Chef Expander Operation and Troubleshooting__
58
+
59
+ Chef Expander includes chef-expanderctl, a management program that allows
60
+ you to get status information or change the logging verbosity (without
61
+ restarting).
62
+
63
+ See __chef-expanderctl__(8) for details.
64
+
65
+ ## SEE ALSO
66
+
67
+ __chef-expanderctl__(8)
68
+ __chef-solr__(8)
69
+
70
+ Full documentation for Chef and chef-server is located on the Chef
71
+ wiki, http://wiki.opscode.com/display/chef/Home.
72
+
73
+ ## AUTHOR
74
+
75
+ Chef was written by Adam Jacob <adam@ospcode.com> of Opscode
76
+ (http://www.opscode.com), with contributions from the community. This
77
+ manual page was created by Nuo Yan <nuo@opscode.com>. Permission is
78
+ granted to copy, distribute and / or modify this document under the
79
+ terms of the Apache 2.0 License.
80
+
81
+ On Debian systems, the complete text of the Apache 2.0 License can be
82
+ found in /usr/share/common-licenses/Apache-2.0.