chef 0.10.4.rc.4 → 0.10.4.rc.5

data/distro/common/man/man8/chef-client.8

@@ -0,0 +1,84 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "CHEF\-CLIENT" "8" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
+.
+.SH "NAME"
+\fBchef\-client\fR \- Runs a client node connecting to a chef\-server\.
+.
+.SH "SYNOPSIS"
+\fBchef\-client\fR \fI(options)\fR
+.
+.TP
+\fB\-S\fR, \fB\-\-server CHEFSERVERURL\fR
+The chef server URL
+.
+.TP
+\fB\-c\fR, \fB\-\-config CONFIG\fR
+The configuration file to use
+.
+.TP
+\fB\-d\fR, \fB\-\-daemonize\fR
+Daemonize the process
+.
+.TP
+\fB\-g\fR, \fB\-\-group GROUP\fR
+Group to set privilege to
+.
+.TP
+\fB\-i\fR, \fB\-\-interval SECONDS\fR
+Run chef\-client periodically, in seconds
+.
+.TP
+\fB\-j\fR, \fB\-\-json\-attributes JSON_ATTRIBS\fR
+Load attributes from a JSON file or URL
+.
+.TP
+\fB\-l\fR, \fB\-\-log_level LEVEL\fR
+Set the log level (debug, info, warn, error, fatal)
+.
+.TP
+\fB\-L\fR, \fB\-\-logfile LOGLOCATION\fR
+Set the log file location, defaults to STDOUT \- recommended for daemonizing
+.
+.TP
+\fB\-V\fR, \fB\-\-verbose\fR
+Ensures logging goes to STDOUT as well as to other configured log location(s)\.
+.
+.TP
+\fB\-N\fR, \fB\-\-node\-name NODE_NAME\fR
+The node name for this client
+.
+.TP
+\fB\-s\fR, \fB\-\-splay SECONDS\fR
+The splay time for running at intervals, in seconds
+.
+.TP
+\fB\-u\fR, \fB\-\-user USER\fR
+User to set privilege to
+.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Show chef version
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show this message
+.
+.SH "DESCRIPTION"
+The Chef Client is where almost all of the work in Chef is done\. It communicates with the Chef Server via REST, authenticates via Signed Header Authentication, and compiles and executes Cookbooks\.
+.
+.P
+A Chef Client does work on behalf of a Node\. A single Chef Client can run recipes for multiple Nodes\.
+.
+.P
+Clients are where all the action happens \- the Chef Server and Chef Expander are largely services that exist only to provide the Client with information\.
+.
+.SH "SEE ALSO"
+Full documentation for Chef and chef\-client is located on the Chef wiki, http://wiki\.opscode\.com/display/chef/Home\.
+.
+.SH "AUTHOR"
+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\.
+.
+.P
+On Debian systems, the complete text of the Apache 2\.0 License can be found in /usr/share/common\-licenses/Apache\-2\.0\.

data/distro/common/man/man8/chef-expander.8

@@ -0,0 +1,97 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "CHEF\-EXPANDER" "8" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
+.
+.SH "NAME"
+\fBchef\-expander\fR \- fetches messages from RabbitMQ, processes, and loads into chef\-solr
+.
+.SH "SYNOPSIS"
+\fBchef\-expander\fR \fI(options)\fR
+.
+.TP
+\fB\-c\fR, \fB\-\-config CONFIG_FILE\fR
+a configuration file to use
+.
+.TP
+\fB\-i\fR, \fB\-\-index INDEX\fR
+the slot this node will occupy in the ring
+.
+.TP
+\fB\-n\fR, \fB\-\-node\-count NUMBER\fR
+the number of nodes in the ring
+.
+.TP
+\fB\-l\fR, \fB\-\-log\-level LOG_LEVEL\fR
+set the log level
+.
+.TP
+\fB\-L\fR, \fB\-\-logfile LOG_LOCATION\fR
+Logfile to use
+.
+.TP
+\fB\-d\fR, \fB\-\-daemonize\fR
+fork into the background
+.
+.TP
+\fB\-P\fR, \fB\-\-pid PIDFILE\fR
+PID file
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show help message
+.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+show the version and exit
+.
+.SH "DESCRIPTION"
+Chef Expander fetches messages from RabbitMQ, processes them into the correct format to be loaded into Solr and loads them into Solr\.
+.
+.P
+\fBRunning Chef Expander\fR
+.
+.P
+Chef Expander is designed for clustered operation, though small installations will only need one worker process\. To run Chef Expander with one worker process, run chef\-expander \-n 1\. You will then have a master and worker process, which looks like this in ps:
+.
+.IP "" 4
+.
+.nf
+
+your\-shell> ps aux|grep expander
+you   52110   0\.1  0\.7  2515476  62748 s003  S+    3:49PM   0:00\.80 chef\-expander worker #1 (vnodes 0\-1023)
+you   52108   0\.1  0\.5  2492880  41696 s003  S+    3:49PM   0:00\.91 ruby bin/chef\-expander \-n 1
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Workers are single threaded and therefore cannot use more than 100% of a single CPU\. If you find that your queues are getting backlogged, increase the number of workers
+.
+.P
+\fBDesign\fR
+.
+.P
+Chef Expander uses 1024 queues (called vnodes in some places) to allow you to scale the number of Chef Expander workers to meet the needs of your infrastructure\. When objects are saved in the API server, they are added to queues based on their database IDs\. These queues can be assigned to different Chef Expander workers to distribute the load of processing the index updates\.
+.
+.P
+\fBChef Expander Operation and Troubleshooting\fR
+.
+.P
+Chef Expander includes chef\-expanderctl, a management program that allows you to get status information or change the logging verbosity (without restarting)\.
+.
+.P
+See \fBchef\-expanderctl\fR(8) for details\.
+.
+.SH "SEE ALSO"
+\fBchef\-expanderctl\fR(8) \fBchef\-solr\fR(8)
+.
+.P
+Full documentation for Chef and chef\-server is located on the Chef wiki, http://wiki\.opscode\.com/display/chef/Home\.
+.
+.SH "AUTHOR"
+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 created by Nuo Yan \fInuo@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
+.
+.P
+On Debian systems, the complete text of the Apache 2\.0 License can be found in /usr/share/common\-licenses/Apache\-2\.0\.

data/distro/common/man/man8/chef-expanderctl.8

@@ -0,0 +1,62 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "CHEF\-EXPANDERCTL" "8" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
+.
+.SH "NAME"
+\fBchef\-expanderctl\fR \- management program for chef\-expander
+.
+.SH "SYNOPSIS"
+\fBchef\-expanderctl\fR \fICOMMAND\fR
+.
+.P
+\fBCommands:\fR
+.
+.TP
+\fBhelp\fR
+Show help message
+.
+.TP
+\fBqueue\-depth\fR
+display the aggregate queue backlog
+.
+.TP
+\fBqueue\-status\fR
+show the backlog and consumer count for each vnode queue
+.
+.TP
+\fBnode\-status\fR
+show the status of the nodes in the cluster
+.
+.TP
+\fBlog\-level\fR
+sets the log level of all nodes in the cluster
+.
+.SH "DESCRIPTION"
+Chef\-expanderctl is a management program that allows you to get status information or change the logging verbosity (without restarting)\. chef\-expanderctl has the following commands:
+.
+.IP "\(bu" 4
+\fBchef\-expanderctl help\fR prints usage\.
+.
+.IP "\(bu" 4
+\fBchef\-expanderctl queue\-depth\fR Shows the total number of messages in the queues\.
+.
+.IP "\(bu" 4
+\fBchef\-expanderctl queue\-status\fR Show the number of messages in each queue\. This is mainly of use when debugging a Chef Expander cluster\.
+.
+.IP "\(bu" 4
+\fBchef\-expanderctl log\-level LEVEL\fR Sets the log level on a running Chef Expander or cluster\. If you suspect that a worker process is stuck, as long as you are using clustered operation, you can simply kill the worker process and it will be restarted by the master process\.
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+\fBchef\-expander\-cluster\fR(8) \fBchef\-solr\fR(8)
+.
+.P
+Full documentation for Chef and chef\-server is located on the Chef wiki, http://wiki\.opscode\.com/display/chef/Home\.
+.
+.SH "AUTHOR"
+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 created by Nuo Yan \fInuo@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
+.
+.P
+On Debian systems, the complete text of the Apache 2\.0 License can be found in /usr/share/common\-licenses/Apache\-2\.0\.

data/distro/common/man/man8/chef-server-webui.8

@@ -0,0 +1,155 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "CHEF\-SERVER\-WEBUI" "8" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
+.
+.SH "NAME"
+\fBchef\-server\-webui\fR \- Start the Chef Server merb application slice providing Web User Interface (Management Console)\.
+.
+.SH "SYNOPSIS"
+\fBchef\-server\-webui\fR \fI(options)\fR
+.
+.TP
+\fB\-u\fR, \fB\-\-user USER\fR
+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 \-\-group option for it to take effect\.
+.
+.TP
+\fB\-G\fR, \fB\-\-group GROUP\fR
+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 \-\-user option for it to take effect\.
+.
+.TP
+\fB\-d\fR, \fB\-\-daemonize\fR
+This will run a single chef\-server\-webui in the background\.
+.
+.TP
+\fB\-N\fR, \fB\-\-no\-daemonize\fR
+This will allow you to run a cluster in console mode\.
+.
+.TP
+\fB\-c\fR, \fB\-\-cluster\-nodes NUM_MERBS\fR
+Number of merb daemons to run for chef\-server\-webui\.
+.
+.TP
+\fB\-I\fR, \fB\-\-init\-file FILE\fR
+File to use for initialization on load, defaults to config/init\.rb\.
+.
+.TP
+\fB\-p\fR, \fB\-\-port PORTNUM\fR
+Port to run chef\-server\-webui on, defaults to 4040\. Additional nodes (\-c) listen on incrementing port numbers\.
+.
+.TP
+\fB\-o\fR, \fB\-\-socket\-file FILE\fR
+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 \fIonly\fR if you \fImust\fR\.
+.
+.TP
+\fB\-s\fR, \fB\-\-socket SOCKNUM\fR
+Socket number to run chef\-server\-webui on, defaults to 0\.
+.
+.TP
+\fB\-n\fR, \fB\-\-name NAME\fR
+Set the name of the application\. This is used in the process title and log file names\.
+.
+.TP
+\fB\-P\fR, \fB\-\-pid PIDFILE\fR
+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: \-P myapp\.%s\.pid\.
+.
+.TP
+\fB\-h\fR, \fB\-\-host HOSTNAME\fR
+Host to bind to (default is 0\.0\.0\.0)\.
+.
+.TP
+\fB\-m\fR, \fB\-\-merb\-root PATH_TO_APP_ROOT\fR
+The path to the Merb\.root for the app you want to run (default is current working directory)\.
+.
+.TP
+\fB\-a\fR, \fB\-\-adapter ADAPTER\fR
+The rack adapter to use to run chef\-server\-webui (default is mongrel) [mongrel, emongrel, thin, ebb, fastcgi, webrick]\.
+.
+.TP
+\fB\-R\fR, \fB\-\-rackup FILE\fR
+Load an alternate Rack config file (default is config/rack\.rb)\.
+.
+.TP
+\fB\-i\fR, \fB\-\-irb\-console\fR
+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\.
+.
+.TP
+\fB\-S\fR, \fB\-\-sandbox\fR
+This flag will enable a sandboxed irb console\. If your ORM supports transactions, all edits will be rolled back on exit\.
+.
+.TP
+\fB\-l\fR, \fB\-\-log\-level LEVEL\fR
+Log levels can be set to any of these options: debug < info < warn < error < fatal (default is info)\.
+.
+.TP
+\fB\-L\fR, \fB\-\-log LOGFILE\fR
+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\.
+.
+.TP
+\fB\-e\fR, \fB\-\-environment STRING\fR
+Environment to run Merb under [development, production, testing] (default is development)\.
+.
+.TP
+\fB\-r\fR, \fB\-\-script\-runner [\'RUBY CODE\'| FULL_SCRIPT_PATH]\fR
+Command\-line option to run scripts and/or code in the chef\-server\-webui app\.
+.
+.TP
+\fB\-K\fR, \fB\-graceful PORT or all\fR
+Gracefully kill chef\-server\-webui proceses by port number\. Use chef\-server \-K all to gracefully kill all merbs\.
+.
+.TP
+\fB\-k\fR, \fB\-\-kill PORT\fR
+Force kill one merb worker by port number\. This will cause the worker to be respawned\.
+.
+.TP
+\fB\-\-fast\-deploy\fR
+Reload the code, but not yourinit\.rb or gems\.
+.
+.TP
+\fB\-X\fR, \fB\-\-mutex on/off\fR
+This flag is for turning the mutex lock on and off\.
+.
+.TP
+\fB\-D\fR, \fB\-\-debugger\fR
+Run chef\-server\-webui using rDebug\.
+.
+.TP
+\fB\-V\fR, \fB\-\-verbose\fR
+Print extra information\.
+.
+.TP
+\fB\-C\fR, \fB\-\-console\-trap\fR
+Enter an irb console on ^C\.
+.
+.TP
+\fB\-?\fR, \fB\-H\fR, \fB\-\-help\fR
+Show this help message\.
+.
+.SH "DESCRIPTION"
+The Chef Server WebUI (Management Console) is a Merb application slice\. The default listen port is 4040\.
+.
+.P
+The Management Console is Chef Server\'s web interface\. Nodes, roles, cookbooks, data bags, and API clients can be managed through the Management Console\. Search can also be done on the console\.
+.
+.P
+In order to start using the Management Console, you need to first create a user or change the default password on the "admin" user\.
+.
+.P
+The default credentials are:
+.
+.IP "\(bu" 4
+\fBUsername\fR: admin
+.
+.IP "\(bu" 4
+\fBPassword\fR: p@ssw0rd1
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+Full documentation for Chef and chef\-server\-webui (Management Console) is located on the Chef wiki, http://wiki\.opscode\.com/display/chef/Home\.
+.
+.SH "AUTHOR"
+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 for the Debian project (but may be used by others)\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
+.
+.P
+On Debian systems, the complete text of the Apache 2\.0 License can be found in /usr/share/common\-licenses/Apache\-2\.0\.

data/distro/common/man/man8/chef-server.8

@@ -0,0 +1,147 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "CHEF\-SERVER" "8" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
+.
+.SH "NAME"
+\fBchef\-server\fR \- Start the Chef Server merb application slice\.
+.
+.SH "SYNOPSIS"
+\fBchef\-server\fR \fI(options)\fR
+.
+.TP
+\fB\-u\fR, \fB\-\-user USER\fR
+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 \-\-group option for it to take effect\.
+.
+.TP
+\fB\-G\fR, \fB\-\-group GROUP\fR
+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 \-\-user option for it to take effect\.
+.
+.TP
+\fB\-d\fR, \fB\-\-daemonize\fR
+This will run a single chef\-server\-webui in the background\.
+.
+.TP
+\fB\-N\fR, \fB\-\-no\-daemonize\fR
+This will allow you to run a cluster in console mode\.
+.
+.TP
+\fB\-c\fR, \fB\-\-cluster\-nodes NUM_MERBS\fR
+Number of merb daemons to run for chef\-server\-webui\.
+.
+.TP
+\fB\-I\fR, \fB\-\-init\-file FILE\fR
+File to use for initialization on load, defaults to config/init\.rb\.
+.
+.TP
+\fB\-p\fR, \fB\-\-port PORTNUM\fR
+Port to run chef\-server\-webui on, defaults to 4040\. Additional nodes (\-c) listen on incrementing port numbers\.
+.
+.TP
+\fB\-o\fR, \fB\-\-socket\-file FILE\fR
+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 \fIonly\fR if you \fImust\fR\.
+.
+.TP
+\fB\-s\fR, \fB\-\-socket SOCKNUM\fR
+Socket number to run chef\-server\-webui on, defaults to 0\.
+.
+.TP
+\fB\-n\fR, \fB\-\-name NAME\fR
+Set the name of the application\. This is used in the process title and log file names\.
+.
+.TP
+\fB\-P\fR, \fB\-\-pid PIDFILE\fR
+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: \-P myapp\.%s\.pid\.
+.
+.TP
+\fB\-h\fR, \fB\-\-host HOSTNAME\fR
+Host to bind to (default is 0\.0\.0\.0)\.
+.
+.TP
+\fB\-m\fR, \fB\-\-merb\-root PATH_TO_APP_ROOT\fR
+The path to the Merb\.root for the app you want to run (default is current working directory)\.
+.
+.TP
+\fB\-a\fR, \fB\-\-adapter ADAPTER\fR
+The rack adapter to use to run chef\-server\-webui (default is mongrel) [mongrel, emongrel, thin, ebb, fastcgi, webrick]\.
+.
+.TP
+\fB\-R\fR, \fB\-\-rackup FILE\fR
+Load an alternate Rack config file (default is config/rack\.rb)\.
+.
+.TP
+\fB\-i\fR, \fB\-\-irb\-console\fR
+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\.
+.
+.TP
+\fB\-S\fR, \fB\-\-sandbox\fR
+This flag will enable a sandboxed irb console\. If your ORM supports transactions, all edits will be rolled back on exit\.
+.
+.TP
+\fB\-l\fR, \fB\-\-log\-level LEVEL\fR
+Log levels can be set to any of these options: debug < info < warn < error < fatal (default is info)\.
+.
+.TP
+\fB\-L\fR, \fB\-\-log LOGFILE\fR
+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\.
+.
+.TP
+\fB\-e\fR, \fB\-\-environment STRING\fR
+Environment to run Merb under [development, production, testing] (default is development)\.
+.
+.TP
+\fB\-r\fR, \fB\-\-script\-runner [\'RUBY CODE\'| FULL_SCRIPT_PATH]\fR
+Command\-line option to run scripts and/or code in the chef\-server\-webui app\.
+.
+.TP
+\fB\-K\fR, \fB\-graceful PORT or all\fR
+Gracefully kill chef\-server\-webui proceses by port number\. Use chef\-server \-K all to gracefully kill all merbs\.
+.
+.TP
+\fB\-k\fR, \fB\-\-kill PORT\fR
+Force kill one merb worker by port number\. This will cause the worker to be respawned\.
+.
+.TP
+\fB\-\-fast\-deploy\fR
+Reload the code, but not yourinit\.rb or gems\.
+.
+.TP
+\fB\-X\fR, \fB\-\-mutex on/off\fR
+This flag is for turning the mutex lock on and off\.
+.
+.TP
+\fB\-D\fR, \fB\-\-debugger\fR
+Run chef\-server\-webui using rDebug\.
+.
+.TP
+\fB\-V\fR, \fB\-\-verbose\fR
+Print extra information\.
+.
+.TP
+\fB\-C\fR, \fB\-\-console\-trap\fR
+Enter an irb console on ^C\.
+.
+.TP
+\fB\-?\fR, \fB\-H\fR, \fB\-\-help\fR
+Show this help message\.
+.
+.SH "DESCRIPTION"
+The Chef Server provides a central point for the distribution of Cookbooks, management and authentication of Nodes, and the use of Search\. It provides a REST API\.
+.
+.P
+The API service is what clients use to interact with the server to manage node configuration in Chef\. By default, the service is started on port 4000 as a Merb application slice running with the thin server adapter\.
+.
+.P
+The two methods of interaction with the API for humans are the command\-line tool Knife and the Management Console\. The Chef Client library is used for interacting with the API for client nodes\.
+.
+.SH "SEE ALSO"
+\fBchef\-client\fR(8) \fBchef\-server\-webui\fR(8) \fBknife\fR(1)
+.
+.P
+Full documentation for Chef and chef\-server is located on the Chef wiki, http://wiki\.opscode\.com/display/chef/Home\.
+.
+.SH "AUTHOR"
+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\.
+.
+.P
+On Debian systems, the complete text of the Apache 2\.0 License can be found in /usr/share/common\-licenses/Apache\-2\.0\.