chef 0.10.0.beta.8 → 0.10.0.beta.9

data/distro/common/man/man1/knife-environment.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "KNIFE\-ENVIRONMENT" "1" "April 2011" "Chef 0.10.0.beta.8" "Chef Manual"
+.TH "KNIFE\-ENVIRONMENT" "1" "April 2011" "Chef 0.10.0.beta.9" "Chef Manual"
 .
 .SH "NAME"
 \fBknife\-environment\fR \- Define cookbook policies for the environments in your infrastructure
@@ -9,5 +9,170 @@
 .SH "SYNOPSIS"
 \fBknife\fR \fBenvironment\fR \fIsub\-command\fR \fI(options)\fR
 .
-.SH "ENVIRONMENT SUBCOMMANDS"
+.SH "SUBCOMMANDS"
+Environment subcommands follow a basic create, read, update, delete (CRUD) pattern\. The following subcommands are available:
+.
+.SH "CREATE"
+\fBknife environment create\fR \fIenvironment\fR \fI(options)\fR
+.
+.TP
+\fB\-d\fR, \fB\-\-description DESCRIPTION\fR
+The value of the description field\.
+.
+.P
+Create a new environment object on the Chef Server\. The envrionment will be opened in the text editor for editing prior to creation if the \-n option is not present\.
+.
+.SH "DELETE"
+\fBknife environment delete\fR \fIenvironment\fR \fI(options)\fR
+.
+.P
+Destroy an environment on the Chef Server\. A prompt for confirmation will be displayed if the \-y options is not given\.
+.
+.SH "EDIT"
+\fBknife environment edit\fR \fIenvironment\fR \fI(options)\fR
+.
+.P
+Fetch \fIenvironment\fR and display it in the text editor for editing\. The environment will be saved to the Chef Server when the editing session exits\.
+.
+.SH "FROM FILE"
+\fBknife environment from file\fR \fIfile\fR \fI(options)\fR
+.
+.P
+Create or update an environment from the JSON or Ruby format \fIfile\fR\. See \fBformat\fR for the proper format of this file\.
+.
+.SH "LIST"
+\fBknife environment list\fR \fI(options)\fR * \fB\-w\fR, \fB\-\-with\-uri\fR:
+.
+.IP "" 4
+.
+.nf
+
+Show the resource URI for each environment
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SHOW"
+\fBknife environment show\fR \fIenvironment\fR \fI(options)\fR
+.
+.SH "DESCRIPTION"
+Environments provide a means to apply policies to hosts in your infrastructure based on business function\. For example, you may have a separate copy of your infrastructure called "dev" that runs the latest version of your application and should use the newest versions of your cookbooks when configuring systems, and a production instance of your infrastructure where you wish to update code and cookbooks in a more controlled fashion\. In Chef, this function is implemented with \fIenvironments\fR\.
+.
+.P
+Environments contain two major components: a set of cookbook version constraints and environment attributes\.
+.
+.SH "SYNTAX"
+A cookbook version constraint is comprised of a \fIcookbook name\fR and a \fIversion constraint\fR\. The \fIcookbook name\fR is the name of a cookbook in your system, and the \fIversion constraint\fR is a String describing the version(s) of that cookbook allowed in the environment\. Only one \fIversion constraint\fR is supported for a given \fIcookbook name\fR\.
+.
+.P
+The exact syntax used to define a cookbook version constraint varies depending on whether you use the JSON format or the Ruby format\. In the JSON format, the cookbook version constraints for an environment are represented as a single JSON object, like this:
+.
+.IP "" 4
+.
+.nf
+
+{"apache2": ">= 1\.5\.0"}
+.
+.fi
+.
+.IP "" 0
+.
+.P
+In the Ruby format, the cookbook version contraints for an environment are represented as a Ruby Hash, like this:
+.
+.IP "" 4
+.
+.nf
 
+{"apache2" => ">= 1\.5\.0"}
+.
+.fi
+.
+.IP "" 0
+.
+.P
+A \fIversion number\fR is a String comprised of two or three digits separated by a dot (\.) character, or in other words, strings of the form "major\.minor" or "major\.minor\.patch"\. "1\.2" and "1\.2\.3" are examples of valid version numbers\. Version numbers containing more than three digits or alphabetic characters are not supported\.
+.
+.P
+A \fIversion constraint\fR String is composed of an \fIoperator\fR and a \fIversion number\fR\. The following operators are available:
+.
+.TP
+\fB= VERSION\fR
+Equality\. Only the exact version specified may be used\.
+.
+.TP
+\fB> VERSION\fR
+Greater than\. Only versions greater than \fBVERSION\fR may be used\.
+.
+.TP
+\fB>= VERSION\fR
+Greater than or equal to\. Only versions equal to VERSION or greater may be used\.
+.
+.TP
+\fB< VERSION\fR
+Less than\. Only versions less than VERSION may be used\.
+.
+.TP
+\fB<= VERSION\fR
+Less than or equal to\. Only versions lesser or equal to VERSION may be used\.
+.
+.TP
+\fB~> VERSION\fR
+Pessimistic greater than\. Depending on the number of components in the given VERSION, the constraint will be optimistic about future minor or patch revisions only\. For example, \fB~> 1\.1\fR will match any version less than \fB2\.0\fR and greater than or equal to \fB1\.1\.0\fR, whereas \fB~> 2\.0\.5\fR will match any version less than \fB2\.1\.0\fR and greater than or equal to \fB2\.0\.5\fR\.
+.
+.SH "FORMAT"
+The JSON format of an envioronment is as follows:
+.
+.IP "" 4
+.
+.nf
+
+{
+  "name": "dev",
+  "description": "The development environment",
+  "cookbook_versions": {
+    "couchdb": "= 11\.0\.0"
+  },
+  "json_class": "Chef::Environment",
+  "chef_type": "environment",
+  "default_attributes": {
+    "apache2": { "listen_ports": [ "80", "443" ] }
+  },
+  "override_attributes": {
+    "aws_s3_bucket": "production"
+  }
+}
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The Ruby format of an environment is as follows:
+.
+.IP "" 4
+.
+.nf
+
+name "dev"
+description "The development environment"
+cookbook_versions  "couchdb" => "= 11\.0\.0"
+default_attributes "apache2" => { "listen_ports" => [ "80", "443" ] }
+override_attributes "aws_s3_bucket" => "production"
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+\fBknife\-node(1)\fR \fBknife\-cookbook(1)\fR \fBknife\-role(1)\fR \fIhttp://wiki\.opscode\.com/display/chef/Environments\fR \fIhttp://wiki\.opscode\.com/display/chef/Version+Constraints\fR
+.
+.SH "AUTHOR"
+Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\.
+.
+.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"
+Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR

data/distro/common/man/man1/knife-exec.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "KNIFE\-EXEC" "1" "April 2011" "Chef 0.10.0.beta.8" "Chef Manual"
+.TH "KNIFE\-EXEC" "1" "April 2011" "Chef 0.10.0.beta.9" "Chef Manual"
 .
 .SH "NAME"
 \fBknife\-exec\fR \- Run user scripts using the Chef API DSL
@@ -9,5 +9,38 @@
 .SH "SYNOPSIS"
 \fBknife\fR \fBexec\fR \fI(options)\fR
 .
-.SH "EXEC SUBCOMMAND"
-
+.TP
+\fB\-E\fR, \fB\-\-exec CODE\fR
+Provide a snippet of code to evaluate on the command line
+.
+.SH "DESCRIPTION"
+\fBknife exec\fR runs arbitrary ruby scripts in a context similar to that of the shef(1) DSL\. See the shef documentation for a description of the commands available\.
+.
+.SH "EXAMPLES"
+.
+.TP
+Make an API call against an arbitrary endpoint
+knife exec \-E \'api\.get("nodes/fluke\.localdomain/cookbooks")\'
+.
+.br
+=> list of cookbooks for the node \fIfluke\.localdomain\fR
+.
+.TP
+Remove the role \fIobsolete\fR from all nodes
+knife exec \-E \'nodes\.transform(:all){|n| n\.run_list\.delete("role[obsolete]")}\'
+.
+.TP
+Generate the expanded run list for hosts in the \fBwebserver\fR role
+knife exec \-E \'nodes\.find(:roles => "webserver") {|n| n\.expand!; n[:recipes]}\'
+.
+.SH "SEE ALSO"
+\fBshef(1)\fR
+.
+.SH "AUTHOR"
+Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\.
+.
+.SH "DOCUMENTATION"
+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\.
+.
+.SH "CHEF"
+Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR

data/distro/common/man/man1/knife-index.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "KNIFE\-INDEX" "1" "April 2011" "Chef 0.10.0.beta.8" "Chef Manual"
+.TH "KNIFE\-INDEX" "1" "April 2011" "Chef 0.10.0.beta.9" "Chef Manual"
 .
 .SH "NAME"
 \fBknife\-index\fR \- Rebuild the search index on a Chef Server

data/distro/common/man/man1/knife-node.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "KNIFE\-NODE" "1" "April 2011" "Chef 0.10.0.beta.8" "Chef Manual"
+.TH "KNIFE\-NODE" "1" "April 2011" "Chef 0.10.0.beta.9" "Chef Manual"
 .
 .SH "NAME"
 \fBknife\-node\fR \- Manage the hosts in your infrastructure
@@ -19,6 +19,7 @@ When a host communicates with a Chef Server, it authenticates using its \fBnode_
 By default \fBchef\-client\fR(8) will create a node using the FQDN of the host for the node name, though this may be overridden by configuration settings\.
 .
 .SH "NODE SUB\-COMMANDS"
+The following \fBnode\fR subcommands are available:
 .
 .SH "BULK DELETE"
 \fBknife node bulk delete\fR \fIregex\fR \fI(options)\fR

data/distro/common/man/man1/knife-role.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "KNIFE\-ROLE" "1" "April 2011" "Chef 0.10.0.beta.8" "Chef Manual"
+.TH "KNIFE\-ROLE" "1" "April 2011" "Chef 0.10.0.beta.9" "Chef Manual"
 .
 .SH "NAME"
 \fBknife\-role\fR \- Group common configuration settings
@@ -10,13 +10,30 @@
 \fBknife\fR \fBrole\fR \fIsub\-command\fR \fI(options)\fR
 .
 .SH "ROLE SUB\-COMMANDS"
-\fBrole bulk delete REGEX\fR \fI(options)\fR
+The following \fBrole\fR subcommands are available:
+.
+.SH "LIST"
+\fBknife role list\fR \fI(options)\fR
+.
+.TP
+\fB\-w\fR, \fB\-\-with\-uri\fR
+Show corresponding URIs
 .
 .P
-Delete roles on the Chef Server based on a regular expression\. The regular expression (\fIREGEX\fR) should be in quotes, not in //\'s\.
+List roles\.
+.
+.SH "SHOW"
+\fBknife role show ROLE\fR \fI(options)\fR
+.
+.TP
+\fB\-a\fR, \fB\-\-attribute ATTR\fR
+Show only one attribute
 .
 .P
-\fBrole create ROLE\fR \fI(options)\fR
+Show a specific role\.
+.
+.SH "CREATE"
+\fBknife role create ROLE\fR \fI(options)\fR
 .
 .TP
 \fB\-d\fR, \fB\-\-description\fR
@@ -25,40 +42,47 @@ The role description
 .P
 Create a new role\.
 .
-.P
-\fBrole delete ROLE\fR \fI(options)\fR
+.SH "EDIT"
+\fBknife role edit ROLE\fR \fI(options)\fR
 .
 .P
-Delete a role\.
+Edit a role\.
 .
-.P
-\fBrole edit ROLE\fR \fI(options)\fR
+.SH "FROM FILE"
+\fBknife role from file FILE\fR \fI(options)\fR
 .
 .P
-Edit a role\.
+Create or update a role from a role Ruby DSL (\fB\.rb\fR) or JSON file\.
 .
-.P
-\fBrole from file FILE\fR \fI(options)\fR
+.SH "DELETE"
+\fBknife role delete ROLE\fR \fI(options)\fR
 .
 .P
-Create or update a role from a role Ruby DSL (\fB\.rb\fR) or JSON file\.
+Delete a role\.
+.
+.SH "BULK DELETE"
+\fBknife role bulk delete REGEX\fR \fI(options)\fR
 .
 .P
-\fBrole list\fR \fI(options)\fR
+Delete roles on the Chef Server based on a regular expression\. The regular expression (\fIREGEX\fR) should be in quotes, not in //\'s\.
 .
-.TP
-\fB\-w\fR, \fB\-\-with\-uri\fR
-Show corresponding URIs
+.SH "DESCRIPTION"
+Roles provide a mechanism to group repeated configuration settings\. Roles are data structures that contain \fBdefault_attributes\fR, and \fBoverride_attributes\fR, which are nested hashes of configuration settings, and a \fBrun_list\fR, which is an ordered list of recipes and roles that should be applied to a host by chef\-client\.
 .
 .P
-List roles\.
+\fBdefault_attributes\fR will be overridden if they conflict with a value on a node that includes the role\. Conversely, \fBoverride_attributes\fR will override any values set on nodes that apply them\.
 .
 .P
-\fBrole show ROLE\fR \fI(options)\fR
+When \fBchef\-client\fR(8) configures a host, it will "expand" the \fBrun_list\fR included in that host\'s node data\. The expansion process will recursively replace any roles in the run_list with that role\'s run_list\.
 .
-.TP
-\fB\-a\fR, \fB\-\-attribute ATTR\fR
-Show only one attribute
+.SH "SEE ALSO"
+\fBknife\-node(1)\fR \fBknife\-environment(1)\fR \fIhttp://wiki\.opscode\.com/display/chef/Roles\fR \fIhttp://wiki\.opscode\.com/display/chef/Attributes\fR
 .
-.P
-Show a specific role\.
+.SH "AUTHOR"
+Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\.
+.
+.SH "DOCUMENTATION"
+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\.
+.
+.SH "CHEF"
+Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR

data/distro/common/man/man1/knife-search.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "KNIFE\-SEARCH" "1" "April 2011" "Chef 0.10.0.beta.8" "Chef Manual"
+.TH "KNIFE\-SEARCH" "1" "April 2011" "Chef 0.10.0.beta.9" "Chef Manual"
 .
 .SH "NAME"
 \fBknife\-search\fR \- Find objects on a Chef Server by query
@@ -33,5 +33,29 @@ The order to sort the results in
 \fB\-b\fR, \fB\-\-start ROW\fR
 The row to start returning results at
 .
-.P
-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\.
+.TP
+\fB\-m\fR, \fB\-\-medium\fR
+Display medium sized output when searching nodes using the default summary format
+.
+.TP
+\fB\-l\fR, \fB\-\-long\fR
+Display long output when searching nodes using the default summary format
+.
+.SH "DESCRIPTION"
+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 * \fIenvironment\fR * \fIdata bag\fR
+.
+.SH "SYNTAX"
+.
+.SH "EXAMPLES"
+.
+.SH "SEE ALSO"
+\fBknife\-ssh\fR(1) \fIhttp://wiki\.opscode\.com/display/chef/Attributes\fR
+.
+.SH "AUTHOR"
+Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\.
+.
+.SH "DOCUMENTATION"
+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\.
+.
+.SH "CHEF"
+Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR

data/distro/common/man/man1/knife-ssh.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "KNIFE\-SSH" "1" "April 2011" "Chef 0.10.0.beta.8" "Chef Manual"
+.TH "KNIFE\-SSH" "1" "April 2011" "Chef 0.10.0.beta.9" "Chef Manual"
 .
 .SH "NAME"
 \fBknife\-ssh\fR \- Run a command or interactive session on multiple remote hosts
@@ -29,5 +29,46 @@ The ssh password
 \fB\-x\fR, \fB\-\-ssh\-user USERNAME\fR
 The ssh username
 .
-.P
+.SH "DESCRIPTION"
 The \fIssh\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)\.
+.
+.SH "TERMINAL MULTIPLEXING AND TERMINAL TAB SUPPORT"
+\fBknife ssh\fR integrates with several terminal multiplexer programs to provide a more convenient means of managing multiple ssh sessions\. When the \fICOMMAND\fR option matches one of these, \fBknife ssh\fR will create multiple interactive ssh sessions running locally in the terminal multiplexer instead of invoking the command on the remote host\.
+.
+.P
+The available multiplexers are: * \fBinteractive\fR:
+.
+.IP "" 4
+.
+.nf
+
+A built\-in multiplexer\. `interactive` supports running commands on a
+subset of the connected hosts in parallel
+.
+.fi
+.
+.IP "" 0
+.
+.TP
+\fBscreen\fR(1)
+Runs ssh interactively inside \fBscreen\fR\. ~/\.screenrc will be sourced if it exists\.
+.
+.TP
+\fBtmux\fR(1)
+Runs ssh interactively inside tmux\.
+.
+.TP
+\fBmacterm\fR (Mac OS X only)
+Opens a Terminal\.app window and creates a tab for each ssh session\. You must install the rb\-appscript gem before you can use this option\.
+.
+.SH "SEE ALSO"
+\fBknife\-search\fR(1)
+.
+.SH "AUTHOR"
+Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\.
+.
+.SH "DOCUMENTATION"
+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\.
+.
+.SH "CHEF"
+Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR