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

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

@@ -1,57 +1,158 @@
-.TH CHEF-SOLO: "8" "August 2009" "chef-solo" "System Administration Utilities"
-.SH NAME
-chef-solo: \- Runs chef in solo mode against a specified cookbook location.
-.SH SYNOPSIS
-.B chef-solo
-\fI(options)\fR
-.SH DESCRIPTION
-.TP
-\fB\-c\fR, \fB\-\-config\fR CONFIG
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "CHEF\-SOLO" "8" "April 2011" "Chef 0.10.0.beta.10" "Chef Manual"
+.
+.SH "NAME"
+\fBchef\-solo\fR \- Runs chef in solo mode against a specified cookbook location\.
+.
+.SH "SYNOPSIS"
+\fBchef\-solo\fR \fI(options)\fR
+.
+.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\fR GROUP
+\fB\-g\fR, \fB\-\-group GROUP\fR
 Group to set privilege to
+.
 .TP
-\fB\-i\fR, \fB\-\-interval\fR SECONDS
+\fB\-i\fR, \fB\-\-interval SECONDS\fR
 Run chef\-client periodically, in seconds
+.
 .TP
-\fB\-j\fR JSON_ATTRIBS
+\fB\-j\fR, \fB\-\-json\-attributes JSON_ATTRIBS\fR
 Load attributes from a JSON file or URL
-.HP
-\fB\-\-json\-attributes\fR
+.
 .TP
-\fB\-l\fR, \fB\-\-log_level\fR LEVEL
+\fB\-l\fR, \fB\-\-log_level LEVEL\fR
 Set the log level (debug, info, warn, error, fatal)
+.
 .TP
-\fB\-L\fR, \fB\-\-logfile\fR LOGLOCATION
-Set the log file location, defaults to STDOUT
+\fB\-L\fR, \fB\-\-logfile LOGLOCATION\fR
+Set the log file location, defaults to STDOUT \- recommended for daemonizing
+.
 .TP
-\fB\-N\fR, \fB\-\-node\-name\fR NODE_NAME
+\fB\-N\fR, \fB\-\-node\-name NODE_NAME\fR
 The node name for this client
+.
 .TP
-\fB\-r\fR, \fB\-\-recipe\-url\fR RECIPE_URL
-Pull down a remote gzipped tarball of recipes and untar it to the cookbook cache.
+\fB\-r\fR, \fB\-\-recipe\-url RECIPE_URL\fR
+Pull down a remote gzipped tarball of recipes and untar it to the cookbook cache\.
+.
 .TP
-\fB\-s\fR, \fB\-\-splay\fR SECONDS
+\fB\-s\fR, \fB\-\-splay SECONDS\fR
 The splay time for running at intervals, in seconds
+.
 .TP
-\fB\-u\fR, \fB\-\-user\fR USER
+\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 "SEE ALSO"
-Full documentation for Chef and chef-solo is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home.
-.SH AUTHOR
-Chef was written by Adam Jacob <adam@ospcode.com> of Opscode (http://www.opscode.com), with contributions from the community.
-This manual page was written by Joshua Timberman <joshua@opscode.com> with help2man. Permission is granted
-to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
+.
+.SH "DESCRIPTION"
+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\.
+.
+.P
+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\.
+.
+.P
+For example:
+.
+.IP "" 4
+.
+.nf
+
+file_cache_path "/var/chef\-solo"
+cookbook_path "/var/chef\-solo/cookbooks"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+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\.
+.
+.P
+You can also specify cookbook_path as an array, passing multiple locations to search for cookbooks\.
+.
+.P
+For example:
+.
+.IP "" 4
+.
+.nf
 
-On Debian systems, the complete text of the Apache 2.0 License can be found in
-/usr/share/common-licenses/Apache-2.0.
+file_cache_path "/var/chef\-solo"
+cookbook_path ["/var/chef\-solo/cookbooks", "/var/chef\-solo/site\-cookbooks"]
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Note that earlier entries are now overridden by later ones\.
+.
+.P
+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\.
+.
+.P
+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:
+.
+.IP "" 4
+.
+.nf
+
+{
+  "resolver": {
+    "nameservers": [ "10\.0\.0\.1" ],
+    "search":"int\.example\.com"
+  },
+  "run_list": [ "recipe[resolver]" ]
+}
+.
+.fi
+.
+.IP "" 0
+.
+.P
+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\.
+.
+.P
+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\.
+.
+.P
+For example:
+.
+.IP "" 4
+.
+.nf
+
+chef\-solo \-c ~/solo\.rb \-j ~/node\.json  \-r http://www\.example\.com/chef\-solo\.tar\.gz
+.
+.fi
+.
+.IP "" 0
+.
+.P
+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\.
+.
+.SH "SEE ALSO"
+Full documentation for Chef and chef\-solo 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-solr.8

@@ -1,55 +1,114 @@
-.TH CHEF-SOLR: "1" "March 2010" "chef-solr" "User Commands"
-.SH NAME
-chef-solr: \- manual page for chef-solr
-.SH SYNOPSIS
-.B chef-solr
-\fI(options)\fR
-.SH DESCRIPTION
-.TP
-\fB\-c\fR, \fB\-\-config\fR CONFIG
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "CHEF\-SOLR" "8" "April 2011" "Chef 0.10.0.beta.10" "Chef Manual"
+.
+.SH "NAME"
+\fBchef\-solr\fR \- Runs as Chef\'s search server
+.
+.SH "SYNOPSIS"
+\fBchef\-solr\fR \fI(options)\fR
+.
+.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\fR GROUP
+\fB\-g\fR, \fB\-\-group GROUP\fR
 Group to set privilege to
+.
 .TP
-\fB\-l\fR, \fB\-\-log_level\fR LEVEL
+\fB\-l\fR, \fB\-\-log_level LEVEL\fR
 Set the log level (debug, info, warn, error, fatal)
+.
 .TP
-\fB\-L\fR, \fB\-\-logfile\fR LOGLOCATION
+\fB\-L\fR, \fB\-\-logfile LOGLOCATION\fR
 Set the log file location, defaults to STDOUT \- recommended for daemonizing
+.
 .TP
-\fB\-D\fR, \fB\-\-solr\-data\-dir\fR PATH
+\fB\-D\fR, \fB\-\-solr\-data\-dir PATH\fR
 Where the Solr data lives
+.
 .TP
-\fB\-x\fR, \fB\-\-solor\-heap\-size\fR SIZE
+\fB\-x\fR, \fB\-\-solor\-heap\-size SIZE\fR
 Set the size of the Java Heap
+.
 .TP
-\fB\-H\fR, \fB\-\-solr\-home\-dir\fR PATH
+\fB\-H\fR, \fB\-\-solr\-home\-dir PATH\fR
 Solr home directory
+.
 .TP
-\fB\-j\fR, \fB\-\-java\-opts\fR OPTS
+\fB\-j\fR, \fB\-\-java\-opts OPTS\fR
 Raw options passed to Java
+.
 .TP
-\fB\-W\fR, \fB\-\-solr\-jetty\-dir\fR PATH
+\fB\-W\fR, \fB\-\-solr\-jetty\-dir PATH\fR
 Where to place the Solr Jetty instance
+.
 .TP
-\fB\-u\fR, \fB\-\-user\fR USER
+\fB\-u\fR, \fB\-\-user USER\fR
 User to set privilege to
+.
 .TP
 \fB\-v\fR, \fB\-\-version\fR
 Show chef\-solr version
+.
 .TP
 \fB\-h\fR, \fB\-\-help\fR
 Show this message
-.SH "SEE ALSO"
-Full documentation for Chef and chef-solr is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home.
-.SH AUTHOR
-chef-solr was written by Adam Jacob <adam@ospcode.com> of Opscode (http://www.opscode.com), with contributions from the community.
-This manual page was written by Joshua Timberman <joshua@opscode.com> with help2man. Permission is granted
-to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
+.
+.SH "DESCRIPTION"
+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\.
+.
+.P
+\fBInstallation\fR
+.
+.P
+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:
+.
+.IP "" 4
+.
+.nf
+
+yourshell> chef\-solr\-installer
+Configuration setting solr_heap_size is unknown and will be ignored
 
-On Debian systems, the complete text of the Apache 2.0 License can be found in
-/usr/share/common-licenses/Apache-2.0.
+Chef Solr is already installed in /var/chef/solr
+Do you want to overwrite the current install? All existing Solr data will be lost\. [y/n] y
+Removing the existing Chef Solr installation
+  rm \-rf /var/chef/solr
+  rm \-rf /var/chef/solr\-jetty
+  rm \-rf /var/chef/solr/data
+Creating Solr Home Directory
+  mkdir \-p /var/chef/solr
+  entering /var/chef/solr
+  tar zxvf /Users/ddeleo/opscode/chef/chef\-solr/solr/solr\-home\.tar\.gz
+Creating Solr Data Directory
+  mkdir \-p /var/chef/solr/data
+Unpacking Solr Jetty
+  mkdir \-p /var/chef/solr\-jetty
+  entering /var/chef/solr\-jetty
+  tar zxvf /Users/ddeleo/opscode/chef/chef\-solr/solr/solr\-jetty\.tar\.gz
+
+Successfully installed Chef Solr\.
+You can restore your search index using `knife index rebuild`
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+\fBchef\-expander\-cluster\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 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/markdown/man8/chef-client.mkd

@@ -0,0 +1,65 @@
+chef-client(8) -- Runs a client node connecting to a chef-server.
+========================================
+
+## SYNOPSIS
+
+__chef-client__ _(options)_
+
+  * `-S`, `--server CHEFSERVERURL`:
+    The chef server URL
+  * `-c`, `--config CONFIG`:
+    The configuration file to use
+  * `-d`, `--daemonize`:
+    Daemonize the process
+  * `-g`, `--group GROUP`:
+    Group to set privilege to
+  * `-i`, `--interval SECONDS`:
+    Run chef-client periodically, in seconds
+  * `-j`, `--json-attributes JSON_ATTRIBS`:
+    Load attributes from a JSON file or URL
+  * `-l`, `--log_level LEVEL`:
+    Set the log level (debug, info, warn, error, fatal)
+  * `-L`, `--logfile LOGLOCATION`:
+    Set the log file location, defaults to STDOUT - recommended for
+    daemonizing
+  * `-V`, `--verbose`:
+    Ensures logging goes to STDOUT as well as  to  other  configured
+    log location(s).
+  * `-N`, `--node-name NODE_NAME`:
+    The node name for this client
+  * `-s`, `--splay SECONDS`:
+    The splay time for running at intervals, in seconds
+  * `-u`, `--user USER`:
+    User to set privilege to
+  * `-v`, `--version`:
+    Show chef version
+  * `-h`, `--help`:
+    Show this message
+
+## 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.
+
+A Chef Client does work on behalf of a Node. A single Chef Client can
+run recipes for multiple Nodes.
+
+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.
+
+## SEE ALSO
+
+Full  documentation  for  Chef  and  chef-client is located on the Chef
+wiki, http://wiki.opscode.com/display/chef/Home.
+
+## AUTHOR
+
+Chef was written by Adam Jacob <adam@ospcode.com> of Opscode
+(http://www.opscode.com),  with contributions from the community.  This
+manual page was written by Joshua Timberman  <joshua@opscode.com>  with
+help2man.  Permission  is  granted  to copy, distribute and / or modify
+this document under the terms of the Apache 2.0 License.
+
+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/markdown/man8/chef-expander-cluster.mkd

@@ -0,0 +1,82 @@
+chef-expander-cluster(8) -- fetches messages from RabbitMQ, processes, and loads into chef-solr
+========================================
+
+## SYNOPSIS
+
+__chef-expander-cluster__ _(options)_
+
+  * `-c`, `--config CONFIG_FILE`:
+    a configuration file to use
+  * `-i`, `--index INDEX`:
+    the slot this node will occupy in the ring
+  * `-n`, `--node-count NUMBER`:
+    the number of nodes in the ring
+  * `-l`, `--log-level LOG_LEVEL`:
+    set the log level
+  * `-L`, `--logfile LOG_LOCATION`:
+    Logfile to use
+  * `-d`, `--daemonize`:
+    fork into the background
+  * `-P`, `--pid PIDFILE`:
+    PID file
+  * `-h`, `--help`:
+    show help message
+  * `-v`, `--version`:
+    show the version and exit
+
+## DESCRIPTION
+
+Chef Expander fetches messages from RabbitMQ, processes them into the
+correct format to be loaded into Solr and loads them into Solr.
+
+__Running Chef Expander__
+
+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:
+
+    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
+
+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
+
+__Design__
+
+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.
+
+__Chef Expander Operation and Troubleshooting__
+
+Chef Expander includes chef-expanderctl, a management program that allows
+you to get status information or change the logging verbosity (without
+restarting).
+
+See __chef-expanderctl__(8) for details.
+
+## SEE ALSO
+
+__chef-expanderctl__(8)
+__chef-solr__(8)
+
+Full documentation for Chef and chef-server is located on the Chef
+wiki, http://wiki.opscode.com/display/chef/Home.
+
+## AUTHOR
+
+Chef was written by Adam Jacob <adam@ospcode.com> of Opscode
+(http://www.opscode.com),  with contributions from the community. This
+manual page was created by Nuo Yan <nuo@opscode.com>. Permission is
+granted to copy, distribute and / or modify this document under the
+terms of the Apache 2.0 License.
+
+On Debian systems, the complete text of the Apache 2.0 License  can  be
+found in /usr/share/common-licenses/Apache-2.0.