rmm-chef 0.10.0.rc.0

data/distro/common/man/man1/shef.1

@@ -0,0 +1,256 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "SHEF" "1" "April 2011" "Chef 0.10.0.rc.0" "Chef Manual"
+.
+.SH "NAME"
+\fBshef\fR \- Interactive Chef Console
+.
+.SH "SYNOPSIS"
+\fBshef\fR [\fInamed configuration\fR] \fI(options)\fR
+.
+.TP
+\fB\-S\fR, \fB\-\-server CHEF_SERVER_URL\fR
+The chef server URL
+.
+.TP
+\fB\-z\fR, \fB\-\-client\fR
+chef\-client mode
+.
+.TP
+\fB\-c\fR, \fB\-\-config CONFIG\fR
+The configuration file to use
+.
+.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 LOG_LEVEL\fR
+Set the logging level
+.
+.TP
+\fB\-s\fR, \fB\-\-solo\fR
+chef\-solo shef session
+.
+.TP
+\fB\-a\fR, \fB\-\-standalone\fR
+standalone shef session
+.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Show chef version
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show command options
+.
+.P
+When no \-\-config option is specified, shef attempts to load a default configuration file:
+.
+.IP "\(bu" 4
+If a \fInamed configuration\fR is given, shef will load ~/\.chef/\fInamed configuration\fR/shef\.rb
+.
+.IP "\(bu" 4
+If no \fInamed configuration\fR is given shef will load ~/\.chef/shef\.rb if it exists
+.
+.IP "\(bu" 4
+Shef falls back to loading /etc/chef/client\.rb or /etc/chef/solo\.rb if \-z or \-s options are given and no shef\.rb can be found\.
+.
+.IP "\(bu" 4
+The \-\-config option takes precedence over implicit configuration paths\.
+.
+.IP "" 0
+.
+.SH "DESCRIPTION"
+\fBshef\fR is an irb(1) (interactive ruby) session customized for Chef\. \fBshef\fR serves two primary functions: it provides a means to interact with a Chef Server interactively using a convenient DSL; it allows you to define and run Chef recipes interactively\.
+.
+.SH "SYNTAX"
+Shef uses irb\'s subsession feature to provide multiple modes of interaction\. In addition to the primary mode which is entered on start, \fBrecipe\fR and \fBattributes\fR modes are available\.
+.
+.SH "PRIMARY MODE"
+The following commands are available in the primary session:
+.
+.TP
+\fBhelp\fR
+Prints a list of available commands
+.
+.TP
+\fBversion\fR
+Prints the Chef version
+.
+.TP
+\fBrecipe\fR
+Switches to \fBrecipe\fR mode
+.
+.TP
+\fBattributes\fR
+Switches to \fBattributes\fR mode
+.
+.TP
+\fBrun_chef\fR
+Initiates a chef run
+.
+.TP
+\fBreset\fR
+reinitializes shef
+.
+.TP
+\fBecho :on|:off\fR
+Turns irb\'s echo function on or off\. Echo is \fIon\fR by default\.
+.
+.TP
+\fBtracing :on|:off\fR
+Turns irb\'s function tracing feature on or off\. Tracing is extremely verbose and expected to be of interest primarily to developers\.
+.
+.TP
+\fBnode\fR
+Returns the \fInode\fR object for the current host\. See knife\-node(1) for more information about nodes\.
+.
+.TP
+\fBohai\fR
+Prints the attributes of \fInode\fR
+.
+.P
+In addition to these commands, shef provides a DSL for accessing data on the Chef Server\. When working with remote data in shef, you chain method calls in the form \fIobject type\fR\.\fIoperation\fR, where \fIobject type\fR is in plural form\. The following object types are available:
+.
+.IP "\(bu" 4
+\fBnodes\fR
+.
+.IP "\(bu" 4
+\fBroles\fR
+.
+.IP "\(bu" 4
+\fBdata_bags\fR
+.
+.IP "\(bu" 4
+\fBclients\fR
+.
+.IP "\(bu" 4
+\fBcookbooks\fR
+.
+.IP "" 0
+.
+.P
+For each \fIobject type\fR the following operations are available:
+.
+.TP
+\fIobject type\fR\.all(\fI&block\fR)
+Loads all items from the server\. If the optional code \fIblock\fR is given, each item will be passed to the block and the results returned, similar to ruby\'s \fBEnumerable#map\fR method\.
+.
+.TP
+\fIobject type\fR\.show(\fIobject name\fR)
+Aliased as \fIobject type\fR\.load
+.
+.IP
+Loads the singular item identified by \fIobject name\fR\.
+.
+.TP
+\fIobject type\fR\.search(\fIquery\fR, \fI&block\fR)
+Aliased as \fIobject type\fR\.find
+.
+.IP
+Runs a search against the server and returns the matching items\. If the optional code \fIblock\fR is given each item will be passed to the block and the results returned\.
+.
+.IP
+The \fIquery\fR may be a Solr/Lucene format query given as a String, or a Hash of conditions\. If a Hash is given, the options will be ANDed together\. To join conditions with OR, use negative queries, or any advanced search syntax, you must provide give the query in String form\.
+.
+.TP
+\fIobject type\fR\.transform(:all|\fIquery\fR, \fI&block\fR)
+Aliased as \fIobject type\fR\.bulk_edit
+.
+.IP
+Bulk edit objects by processing them with the (required) code \fIblock\fR\. You can edit all objects of the given type by passing the Symbol \fB:all\fR as the argument, or only a subset by passing a \fIquery\fR as the argument\. The \fIquery\fR is evaluated in the same way as with \fBsearch\fR\.
+.
+.IP
+The return value of the code \fIblock\fR is used to alter the behavior of \fBtransform\fR\. If the value returned from the block is \fBnil\fR or \fBfalse\fR, the object will not be saved\. Otherwise, the object is saved after being passed to the block\. This behavior can be exploited to create a dry run to test a data transformation\.
+.
+.SH "RECIPE MODE"
+Recipe mode implements Chef\'s recipe DSL\. Exhaustively documenting this DSL is outside the scope of this document\. See the following pages in the Chef documentation for more information:
+.
+.IP "\(bu" 4
+\fIhttp://wiki\.opscode\.com/display/chef/Resources\fR
+.
+.IP "\(bu" 4
+\fIhttp://wiki\.opscode\.com/display/chef/Recipes\fR
+.
+.IP "" 0
+.
+.P
+Once you have defined resources in the recipe, you can trigger a convergence run via \fBrun_chef\fR
+.
+.SH "EXAMPLES"
+.
+.IP "\(bu" 4
+A "Hello World" interactive recipe
+.
+.IP
+chef > recipe
+.
+.br
+chef:recipe > echo :off
+.
+.br
+chef:recipe > file "/tmp/hello_world"
+.
+.br
+chef:recipe > run_chef
+.
+.br
+[Sat, 09 Apr 2011 08:56:56 \-0700] INFO: Processing file[/tmp/hello_world] action create ((irb#1) line 2)
+.
+.br
+[Sat, 09 Apr 2011 08:56:56 \-0700] INFO: file[/tmp/hello_world] created file /tmp/hello_world
+.
+.br
+chef:recipe > pp ls \'/tmp\'
+.
+.br
+["\.",
+.
+.br
+"\.\.",
+.
+.br
+"hello_world"]
+.
+.IP "\(bu" 4
+Search for \fInodes\fR by role, and print their IP addresses
+.
+.IP
+chef > nodes\.find(:roles => \'monitoring\-server\') {|n| n[:ipaddress] }
+.
+.br
+=> ["10\.254\.199\.5"]
+.
+.IP "\(bu" 4
+Remove the role \fIobsolete\fR from every node in the system
+.
+.IP
+chef > nodes\.transform(:all) {|n| n\.run_list\.delete(\'role[obsolete]\') }
+.
+.br
+=> [node[chef098b2\.opschef\.com], node[ree\-woot], node[graphite\-dev], node[fluke\.localdomain], node[ghost\.local], node[kallistec]]
+.
+.IP "" 0
+.
+.SH "BUGS"
+The name \fBshef\fR is clever in print but is confusing when spoken aloud\. Pronouncing \fBshef\fR as \fBchef console\fR is an imperfect workaround\.
+.
+.P
+\fBshef\fR often does not perfectly replicate the context in which chef\-client(8) configures a host, which may lead to discrepancies in observed behavior\.
+.
+.P
+\fBshef\fR has to duplicate much code from chef\-client\'s internal libraries and may become out of sync with the behavior of those libraries\.
+.
+.SH "SEE ALSO"
+chef\-client(8) knife(1) \fIhttp://wiki\.opscode\.com/display/chef/Shef\fR
+.
+.SH "AUTHOR"
+Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\. Shef was written by Daniel DeLeo\.
+.
+.SH "DOCUMENTATION"
+This manual page was written by Daniel DeLeo \fIdan@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
+.
+.SH "CHEF"
+Shef is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR

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" "April 2011" "Chef 0.10.0.rc.0" "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-cluster.8

@@ -0,0 +1,97 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "CHEF\-EXPANDER\-CLUSTER" "8" "April 2011" "Chef 0.10.0.rc.0" "Chef Manual"
+.
+.SH "NAME"
+\fBchef\-expander\-cluster\fR \- fetches messages from RabbitMQ, processes, and loads into chef\-solr
+.
+.SH "SYNOPSIS"
+\fBchef\-expander\-cluster\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\-cluster \-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\-cluster \-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" "April 2011" "Chef 0.10.0.rc.0" "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\.