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

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

@@ -0,0 +1,43 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "KNIFE\-TAG" "1" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
+.
+.SH "NAME"
+\fBknife\-tag\fR \- Apply tags to nodes on a Chef Server
+.
+.SH "SYNOPSIS"
+\fBknife\fR \fBtag\fR \fIsubcommand\fR \fI(options)\fR
+.
+.SH "TAG SUBCOMMANDS"
+The following \fBtag\fR subcommands are available:
+.
+.SH "CREATE"
+\fBknife tag create\fR \fInode\fR \fItag\fR [\fI\.\.\.\fR]
+.
+.P
+Adds one or more tags to \fInode\fR
+.
+.SH "DELETE"
+\fBknife tag delete\fR \fInode\fR \fItag\fR [\fI\.\.\.\fR]
+.
+.P
+Removes one or more tags from \fInode\fR
+.
+.SH "LIST"
+\fBknife tag list\fR \fInode\fR
+.
+.P
+Lists the tags applied to \fInode\fR
+.
+.SH "SEE ALSO"
+\fBknife\-node(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 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.1

@@ -0,0 +1,251 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "KNIFE" "1" "August 2011" "Chef 0.10.4.rc.5" "Chef Manual"
+.
+.SH "NAME"
+\fBknife\fR \- Chef Server API client utility
+.
+.SH "SYNOPSIS"
+\fBknife\fR \fIsub\-command\fR [\fIargument\fR\.\.\.] \fI(options)\fR
+.
+.SH "DESCRIPTION"
+Knife is a command\-line utility used to manage data on a Chef server through the HTTP(S) API\. Knife is organized into groups of subcommands centered around the various object types in Chef\. Each category of subcommand is documented in its own manual page\. Available topics are:
+.
+.IP "\(bu" 4
+bootstrap
+.
+.IP "\(bu" 4
+client
+.
+.IP "\(bu" 4
+configure
+.
+.IP "\(bu" 4
+cookbook\-site
+.
+.IP "\(bu" 4
+cookbook
+.
+.IP "\(bu" 4
+data\-bag
+.
+.IP "\(bu" 4
+environment
+.
+.IP "\(bu" 4
+exec
+.
+.IP "\(bu" 4
+index
+.
+.IP "\(bu" 4
+node
+.
+.IP "\(bu" 4
+recipe
+.
+.IP "\(bu" 4
+role
+.
+.IP "\(bu" 4
+search
+.
+.IP "\(bu" 4
+ssh
+.
+.IP "\(bu" 4
+status
+.
+.IP "\(bu" 4
+tag
+.
+.IP "" 0
+.
+.P
+If the knife manuals are in your \fBMANPATH\fR, you can access help for the above topics using \fBman knife\-TOPIC\fR; otherwise, you can view the documentation using \fBknife help TOPIC\fR\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-s\fR, \fB\-\-server\-url\fR URL
+Chef Server URL, corresponds to \fBChef::Config\fR \fBchef_server_url\fR\.
+.
+.TP
+\fB\-k\fR, \fB\-\-key\fR KEY
+API Client Key, corresponds to \fBChef::Config\fR \fBclient_key\fR\.
+.
+.TP
+\fB\-c\fR, \fB\-\-config\fR CONFIG
+The configuration file to use
+.
+.TP
+\fB\-e\fR, \fB\-\-editor\fR EDITOR
+Set the editor to use for interactive commands
+.
+.TP
+\fB\-F\fR, \fB\-\-format\fR FORMAT
+Which format to use for output
+.
+.TP
+\fB\-l\fR, \fB\-\-log_level\fR LEVEL
+Set the log level (debug, info, warn, error, fatal), corresponds to \fBChef::Config\fR \fBlog_level\fR\.
+.
+.TP
+\fB\-L\fR, \fB\-\-logfile\fR LOGLOCATION
+Set the log file location, defaults to STDOUT, corresponds to \fBChef::Config\fR \fBlog_location\fR\.
+.
+.TP
+\fB\-n\fR, \fB\-\-no\-editor\fR
+Do not open EDITOR, just accept the data as is
+.
+.TP
+\fB\-u\fR, \fB\-\-user\fR USER
+API Client Username, corresponds to \fBChef::Config\fR \fBnode_name\fR\.
+.
+.TP
+\fB\-p\fR, \fB\-\-print\-after\fR
+Show the data after a destructive operation
+.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Show chef version
+.
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Say yes to all prompts for confirmation
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show the available options for a command\.
+.
+.SH "SUB\-COMMANDS"
+Sub\-commands that operate on the basic Chef data types are structured as \fINOUN verb NOUN (options)\fR\. For all data types, the following commands are available:
+.
+.IP "\(bu" 4
+create (create)
+.
+.IP "\(bu" 4
+list and show (read)
+.
+.IP "\(bu" 4
+edit (update)
+.
+.IP "\(bu" 4
+delete (destroy)
+.
+.IP "" 0
+.
+.P
+Knife also includes commands that take actions other than displaying or modifying data on the Chef Server, such as \fBknife\-ssh(1)\fR\.
+.
+.SH "CONFIGURATION"
+The knife configuration file is a Ruby DSL to set configuration parameters for Knife\'s \fBGENERAL OPTIONS\fR\. The default location for the config file is \fB~/\.chef/knife\.rb\fR\. If managing multiple Chef repositories, per\-repository config files can be created\. The file must be \fB\.chef/knife\.rb\fR in the current directory of the repository\.
+.
+.P
+If the config file exists, knife uses these settings for \fBGENERAL OPTIONS\fR defaults\.
+.
+.IP "\(bu" 4
+\fBnode_name\fR: User or client identity (i\.e\., \fIname\fR) to use for authenticating requests to the Chef Server\.
+.
+.IP "\(bu" 4
+\fBclient_key\fR: Private key file to authenticate to the Chef server\. Corresponds to the \fB\-k\fR or \fB\-\-key\fR option\.
+.
+.IP "\(bu" 4
+\fBchef_server_url\fR: URL of the Chef server\. Corresponds to the \fB\-s\fR or \fB\-\-server\-url\fR option\. This is requested from the user when running this sub\-command\.
+.
+.IP "\(bu" 4
+\fBcache_type\fR: The type of cache to use\. Default is BasicFile\. This can be any type of Cache that moneta supports: BasicFile, Berkeley, Couch, DataMapper, File, LMC, Memcache, Memory, MongoDB, Redis, Rufus, S3, SDBM, Tyrant, Xattr, YAML\.
+.
+.IP "\(bu" 4
+\fBcache_options\fR: Specifies various options to use for caching\. These options are dependent on the \fBcache_type\fR\.
+.
+.IP "\(bu" 4
+\fBvalidation_client_name\fR: Specifies the name of the client used to validate new clients\.
+.
+.IP "\(bu" 4
+\fBvalidation_key\fR: Specifies the private key file to use when bootstrapping new hosts\. See knife\-client(1) for more information about the validation client\.
+.
+.IP "\(bu" 4
+\fBcookbook_copyright\fR, \fBcookbook_email\fR, \fBcookbook_license\fR Used by \fBknife cookbook create\fR sub\-command to specify the copyright holder, maintainer email and license (respectively) for new cookbooks\. The copyright holder is listed as the maintainer in the cookbook\'s metadata and as the Copyright in the comments of the default recipe\. The maintainer email is used in the cookbook metadata\. The license determines what preamble to put in the comment of the default recipe, and is listed as the license in the cookbook metadata\. Currently supported licenses are "apachev2" and "none"\. Any other values will result in an empty license in the metadata (needs to be filled in by the author), and no comment preamble in the default recipe\.
+.
+.IP "" 0
+.
+.SH "FILES"
+\fI~/\.chef/knife\.rb\fR
+.
+.P
+Ruby DSL configuration file for knife\. See \fBCONFIGURATION\fR\.
+.
+.SH "CHEF WORKFLOW"
+When working with Chef and Knife in the local repository, the recommended workflow outline looks like:
+.
+.IP "\(bu" 4
+Create repository\. A skeleton sample is provided at \fIhttp://github\.com/opscode/chef\-repo/\fR\.
+.
+.IP "\(bu" 4
+Configure knife, see \fBCONFIGURATION\fR\.
+.
+.IP "\(bu" 4
+Download cookbooks from the Opscode cookbooks site, see \fBCOOKBOOK SITE SUB\-COMMANDS\fR\.
+.
+.IP "\(bu" 4
+Or, create new cookbooks, see \fBcookbook create\fR sub\-command\.
+.
+.IP "\(bu" 4
+Commit changes to the version control system\. See your tool\'s documentation\.
+.
+.IP "\(bu" 4
+Upload cookbooks to the Chef Server, see \fBCOOKBOOK SUB\-COMMANDS\fR\.
+.
+.IP "\(bu" 4
+Launch instances in the Cloud, OR provision new hosts; see \fBCLOUD COMPUTING SUB\-COMMANDS\fR and \fBBOOTSTRAP SUB\-COMMANDS\fR\.
+.
+.IP "\(bu" 4
+Watch Chef configure systems!
+.
+.IP "" 0
+.
+.P
+A note about git: Opscode and many folks in the Chef community use git, but it is not required, except in the case of the \fBcookbook site vendor\fR sub\-command, as it uses git directly\. Version control is strongly recommended though, and git fits with a lot of the workflow paradigms\.
+.
+.SH "EXAMPLES"
+.
+.SH "ENVIRONMENT"
+.
+.TP
+\fBEDITOR\fR
+The text editor to use for editing data\. The \-\-editor option takes precedence over this value, and the \-\-no\-editor option supresses data editing entirely\.
+.
+.SH "SEE ALSO"
+\fBchef\-client(8)\fR \fBchef\-server(8)\fR \fBshef(1)\fR
+.
+.P
+\fBknife\-bootstrap(1)\fR \fBknife\-client(1)\fR \fBknife\-configure(1)\fR \fBknife\-cookbook\-site(1)\fR \fBknife\-cookbook(1)\fR \fBknife\-data\-bag(1)\fR \fBknife\-environment(1)\fR \fBknife\-exec(1)\fR \fBknife\-index(1)\fR \fBknife\-node(1)\fR \fBknife\-recipe(1)\fR \fBknife\-role(1)\fR \fBknife\-search(1)\fR \fBknife\-ssh(1)\fR \fBknife\-tag(1)\fR
+.
+.P
+Complete Chef documentation is available online: \fIhttp://wiki\.opscode\.com/display/chef/Home/\fR
+.
+.P
+JSON is JavaScript Object Notation \fIhttp://json\.org/\fR
+.
+.P
+SOLR is an open source search engine\. \fIhttp://lucene\.apache\.org/solr/\fR
+.
+.P
+\fBgit(1)\fR is a version control system \fIhttp://git\-scm\.com/\fR
+.
+.P
+This manual page was generated from Markdown with \fBronn(1)\fR \fIhttp://rtomayko\.github\.com/ronn/ronn\.1\.html\fR
+.
+.SH "AUTHOR"
+Chef was written by Adam Jacob \fIadam@opscode\.com\fR of Opscode (\fIhttp://www\.opscode\.com\fR), with contributions from the community\.
+.
+.SH "DOCUMENTATION"
+This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\.
+.
+.SH "LICENSE"
+Both Chef and this documentation are released under the terms of the Apache 2\.0 License\. You may view the license online: \fIhttp://www\.apache\.org/licenses/LICENSE\-2\.0\.html\fR On some systems, the complete text of the Apache 2\.0 License may be found in \fB/usr/share/common\-licenses/Apache\-2\.0\fR\.
+.
+.SH "CHEF"
+Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR

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" "August 2011" "Chef 0.10.4.rc.5" "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