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

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

@@ -0,0 +1,130 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "KNIFE\-DATA\-BAG" "1" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
+.
+.SH "NAME"
+\fBknife\-data\-bag\fR \- Store arbitrary data on a Chef Server
+.
+.SH "SYNOPSIS"
+\fBknife\fR \fBdata bag\fR \fIsub\-command\fR \fI(options)\fR
+.
+.SH "DESCRIPTION"
+Data bags are stores of arbitrary JSON data\. Each data bag is a collection that may contain many items\. Data Bag Items are indexed by the Chef Server and can be searched via \fBknife\-search\fR(1)\.
+.
+.P
+Data bags are available to all nodes configured by \fBchef\-client\fR(8), and are therefore a convenient mechanism to store global information, such as lists of administrative accounts that should be configured on all hosts\.
+.
+.SH "DATA BAG SUB\-COMMANDS"
+.
+.SH "CREATE"
+\fBknife data bag create\fR \fIbag name\fR [item id] \fI(options)\fR
+.
+.TP
+\fB\-s\fR, \fB\-\-secret SECRET\fR
+A secret key used to encrypt the data bag item\. See \fBencryption support\fR below\.
+.
+.TP
+\fB\-\-secret\-file SECRET_FILE\fR
+The path to a file containing the secret key to be used to encrypt the data bag item\.
+.
+.P
+If \fIitem id\fR is given, creates a new, empty data bag item and opens it for editing in your editor\. The data bag will be created if it does not exist\.
+.
+.P
+If \fIitem id\fR is not given, the data bag will be created\.
+.
+.SH "DELETE"
+\fBknife data bag delete\fR \fIbag name\fR [item id] \fI(options)\fR
+.
+.P
+Delete a data bag, or an item from a data bag\.
+.
+.SH "EDIT"
+\fBknife data bag edit\fR \fIbag name\fR \fIitem id\fR \fI(options)\fR
+.
+.TP
+\fB\-s\fR, \fB\-\-secret SECRET\fR
+A secret key used to encrypt the data bag item\. See \fBencryption support\fR below\.
+.
+.TP
+\fB\-\-secret\-file SECRET_FILE\fR
+The path to a file containing the secret key to be used to encrypt the data bag item\.
+.
+.P
+Edit an item in a data bag\.
+.
+.SH "FROM FILE"
+\fBknife data bag from file\fR \fIbag name\fR \fIfile\fR \fI(options)\fR
+.
+.TP
+\fB\-s\fR, \fB\-\-secret SECRET\fR
+A secret key used to encrypt the data bag item\. See \fBencryption support\fR below\.
+.
+.TP
+\fB\-\-secret\-file SECRET_FILE\fR
+The path to a file containing the secret key to be used to encrypt the data bag item\.
+.
+.P
+Load a data bag item from a JSON file\. If \fIfile\fR is a relative or absolute path to the file, that file will be used\. Otherwise, the \fIfile\fR parameter is treated as the base name of a data bag file in a Chef repository, and \fBknife\fR will search for the file in \fB\./data_bags/bag_name/file\fR\. For example \fBknife data bag from file users dan\.json\fR would attempt to load the file \fB\./data_bags/users/dan\.json\fR\.
+.
+.SH "LIST"
+\fBknife data bag list\fR \fI(options)\fR
+.
+.TP
+\fB\-w\fR, \fB\-\-with\-uri\fR
+Show corresponding URIs
+.
+.P
+Lists the data bags that exist on the Chef Server\.
+.
+.SH "SHOW"
+\fBknife data bag show BAG [ITEM]\fR \fI(options)\fR
+.
+.TP
+\fB\-s\fR, \fB\-\-secret SECRET\fR
+A secret key used to encrypt the data bag item\. See \fBencryption support\fR below\.
+.
+.TP
+\fB\-\-secret\-file SECRET_FILE\fR
+The path to a file containing the secret key to be used to encrypt the data bag item\.
+.
+.P
+Show a specific data bag or an item in a data bag\. The output will be formatted according to the \-\-format option\.
+.
+.SH "ENCRYPTION SUPPORT"
+Data Bag Items may be encrypted to keep their contents secret\. This may be desireable when storing sensitive information such as database passwords, API keys, etc\.
+.
+.P
+Data Bag Item encryption uses the AES\-256 CBC symmetric key algorithm\.
+.
+.P
+\fBCAVEATS:\fR Keys are not encrypted; only values are encrypted\. The "id" of a Data Bag Item is not encrypted, since it is used by Chef Server to store the item in its database\. For example, given the following data bag item:
+.
+.IP "" 4
+.
+.nf
+
+{"id": "important_passwords", "secret_password": "opensesame"}
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The key "secret_password" will be visible to an evesdropper, but the value "opensesame" will be protected\. Both the key "id" and its value "important_passwords" will be visible to an evesdropper\.
+.
+.P
+Chef Server does not provide a secure mechanism for distributing encryption keys\.
+.
+.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\. http://wiki\.opscode\.com/display/chef/Home

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

@@ -0,0 +1,178 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "KNIFE\-ENVIRONMENT" "1" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
+.
+.SH "NAME"
+\fBknife\-environment\fR \- Define cookbook policies for the environments in your infrastructure
+.
+.SH "SYNOPSIS"
+\fBknife\fR \fBenvironment\fR \fIsub\-command\fR \fI(options)\fR
+.
+.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

@@ -0,0 +1,46 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "KNIFE\-EXEC" "1" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
+.
+.SH "NAME"
+\fBknife\-exec\fR \- Run user scripts using the Chef API DSL
+.
+.SH "SYNOPSIS"
+\fBknife\fR \fBexec\fR \fI(options)\fR
+.
+.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

@@ -0,0 +1,29 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "KNIFE\-INDEX" "1" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
+.
+.SH "NAME"
+\fBknife\-index\fR \- Rebuild the search index on a Chef Server
+.
+.SH "SYNOPSIS"
+\fBknife\fR \fBindex rebuild\fR \fI(options)\fR
+.
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+don\'t bother to ask if I\'m sure
+.
+.SH "DESCRIPTION"
+Rebuilds all the search indexes on the server\. This is accomplished by deleting all objects from the search index, and then forwarding each item in the database to \fBchef\-expander\fR(8) via \fBrabbitmq\-server\fR(1)\. Depending on the number of objects in the database, it may take some time for all objects to be indexed and available for search\.
+.
+.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

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

@@ -0,0 +1,154 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "KNIFE\-NODE" "1" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
+.
+.SH "NAME"
+\fBknife\-node\fR \- Manage the hosts in your infrastructure
+.
+.SH "SYNOPSIS"
+\fBknife\fR \fBnode\fR \fIsub\-command\fR \fI(options)\fR
+.
+.SH "DESCRIPTION"
+Nodes are data structures that represent hosts configured with Chef\. Nodes have a \fBname\fR, a String that uniquely identifies the node, \fBattributes\fR, a nested Hash of properties that describe how the host should be configured, a \fBchef_environment\fR, a String representing the environment to which the node belongs, and a \fBrun_list\fR, an ordered list of \fBrecipes\fR or \fBroles\fR that chef\-client should apply when configuring a host\.
+.
+.P
+When a host communicates with a Chef Server, it authenticates using its \fBnode_name\fR for identification and signs its reqests with a private key\. The Server validates the request by looking up a \fBclient\fR object with a name identical to the \fBnode_name\fR submitted with the request and verifes the signature using the public key for that \fBclient\fR object\. \fBNOTE\fR that the \fBclient\fR is a different object in the system\. It is associated with a node by virtue of having a matching name\.
+.
+.P
+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
+.
+.P
+Deletes nodes for which the name matches the regular expression \fIregex\fR on the Chef Server\. The regular expression should be given in quotes, and should not be surrounded with forward slashes (as is typical of regular expression literals in scripting languages)\.
+.
+.SH "CREATE"
+\fBknife node create\fR \fIname\fR \fI(options)\fR
+.
+.P
+Create a new node\. Unless the \-\-no\-editor option is given, an empty node object will be created and displayed in your text editor\. If the editor exits with a successful exit status, the node data will be posted to the Chef Server to create the node\.
+.
+.SH "DELETE"
+\fBknife node delete\fR \fIname\fR \fI(options)\fR
+.
+.P
+Deletes the node identified by \fIname\fR on the Chef Server\.
+.
+.SH "EDIT"
+\fBknife node edit\fR \fIname\fR \fI(options)\fR
+.
+.TP
+\fB\-a\fR, \fB\-\-all\fR
+Display all node data in the editor\. By default, default, override, and automatic attributes are not shown\.
+.
+.P
+Edit the node identified by \fIname\fR\. Like \fBknife node create\fR, the node will be displayed in your text editor unless the \-n option is present\.
+.
+.SH "FROM FILE"
+\fBknife node from file\fR \fIfile\fR \fI(options)\fR
+.
+.P
+Create a node from a JSON format \fIfile\fR\.
+.
+.SH "LIST"
+\fBknife node list\fR \fI(options)\fR
+.
+.TP
+\fB\-w\fR, \fB\-\-with\-uri\fR
+Show corresponding URIs
+.
+.P
+List all nodes\.
+.
+.SH "RUN_LIST ADD"
+\fBknife node run_list add\fR \fIname\fR \fIrun list item\fR \fI(options)\fR
+.
+.TP
+\fB\-a\fR, \fB\-\-after ITEM\fR
+Place the ENTRY in the run list after ITEM
+.
+.P
+Add the \fIrun list item\fR to the node\'s \fBrun_list\fR\. See Run list
+.
+.SH "RUN_LIST REMOVE"
+\fBknife node run_list remove\fR \fInode name\fR \fIrun list item\fR \fI(options)\fR
+.
+.P
+Remove the \fIrun list item\fR from the node\'s \fBrun_list\fR\.
+.
+.SH "SHOW"
+\fBknife node show\fR \fInode name\fR \fI(options)\fR
+.
+.TP
+\fB\-a\fR, \fB\-\-attribute [ATTR]\fR
+Show only one attribute
+.
+.TP
+\fB\-r\fR, \fB\-\-run\-list\fR
+Show only the run list
+.
+.TP
+\fB\-F\fR, \fB\-\-format FORMAT\fR
+Display the node in a different format\.
+.
+.TP
+\fB\-m\fR, \fB\-\-medium\fR
+Display more, but not all, of the node\'s data when using the default \fIsummary\fR format
+.
+.P
+Displays the node identified by \fInode name\fR on stdout\. The amount of content displayed and the output format are modified by the \-\-format option\. If no alternate format is selected, the default is summary\. Valid formats are:
+.
+.IP "\(bu" 4
+summary: displays the node in a custom, summarized format (default)
+.
+.IP "\(bu" 4
+text displays the node data in its entirety using the colorized tree display
+.
+.IP "\(bu" 4
+json: displays the node in JSON format
+.
+.IP "\(bu" 4
+yaml: displays the node in YAML format
+.
+.IP "\(bu" 4
+pp displays the node using Ruby\'s pretty printer\.
+.
+.IP "" 0
+.
+.P
+For brevity, only the first character of the format is required, for example, \-Fj will produce JSON format output\.
+.
+.SH "RUN LIST ITEM FORMAT"
+Run list items may be either roles or recipes\. When adding a role to a run list, the correct syntax is "role[ROLE_NAME]"
+.
+.P
+When adding a recipe to a run list, there are several valid formats:
+.
+.TP
+Fully Qualified Format
+"recipe[COOKBOOK::RECIPE_NAME]", for example, "recipe[chef::client]"
+.
+.TP
+Cookbook Recipe Format
+For brevity, the recipe part of the fully qualified format may be omitted, and recipes specified as "COOKBOOK::RECIPE_NAME", e\.g\., "chef::client"
+.
+.TP
+Default Recipe Format
+When adding the default recipe of a cookbook to a run list, the recipe name may be omitted as well, e\.g\., "chef::default" may be written as just "chef"
+.
+.SH "SEE ALSO"
+\fBknife\-client\fR(1) \fBknife\-search\fR(1) \fBknife\-role\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