rmm-chef 0.10.0.rc.0

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

@@ -0,0 +1,88 @@
+.\" 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.rc.0" "Chef Manual"
+.
+.SH "NAME"
+\fBknife\-role\fR \- Group common configuration settings
+.
+.SH "SYNOPSIS"
+\fBknife\fR \fBrole\fR \fIsub\-command\fR \fI(options)\fR
+.
+.SH "ROLE SUB\-COMMANDS"
+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
+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
+Show a specific role\.
+.
+.SH "CREATE"
+\fBknife role create ROLE\fR \fI(options)\fR
+.
+.TP
+\fB\-d\fR, \fB\-\-description\fR
+The role description
+.
+.P
+Create a new role\.
+.
+.SH "EDIT"
+\fBknife role edit ROLE\fR \fI(options)\fR
+.
+.P
+Edit a role\.
+.
+.SH "FROM FILE"
+\fBknife role from file FILE\fR \fI(options)\fR
+.
+.P
+Create or update a role from a role Ruby DSL (\fB\.rb\fR) or JSON file\.
+.
+.SH "DELETE"
+\fBknife role delete ROLE\fR \fI(options)\fR
+.
+.P
+Delete a role\.
+.
+.SH "BULK DELETE"
+\fBknife role bulk delete REGEX\fR \fI(options)\fR
+.
+.P
+Delete roles on the Chef Server based on a regular expression\. The regular expression (\fIREGEX\fR) should be in quotes, not in //\'s\.
+.
+.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
+\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
+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\.
+.
+.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
+.
+.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

@@ -0,0 +1,61 @@
+.\" 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.rc.0" "Chef Manual"
+.
+.SH "NAME"
+\fBknife\-search\fR \- Find objects on a Chef Server by query
+.
+.SH "SYNOPSIS"
+\fBknife\fR \fBsearch INDEX QUERY\fR \fI(options)\fR
+.
+.TP
+\fB\-a\fR, \fB\-\-attribute ATTR\fR
+Show only one attribute
+.
+.TP
+\fB\-i\fR, \fB\-\-id\-only\fR
+Show only the ID of matching objects
+.
+.TP
+\fB\-R\fR, \fB\-\-rows INT\fR
+The number of rows to return
+.
+.TP
+\fB\-r\fR, \fB\-\-run\-list\fR
+Show only the run list
+.
+.TP
+\fB\-o\fR, \fB\-\-sort SORT\fR
+The order to sort the results in
+.
+.TP
+\fB\-b\fR, \fB\-\-start ROW\fR
+The row to start returning results at
+.
+.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

@@ -0,0 +1,74 @@
+.\" 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.rc.0" "Chef Manual"
+.
+.SH "NAME"
+\fBknife\-ssh\fR \- Run a command or interactive session on multiple remote hosts
+.
+.SH "SYNOPSIS"
+\fBknife\fR \fBssh QUERY COMMAND\fR \fI(options)\fR
+.
+.TP
+\fB\-a\fR, \fB\-\-attribute ATTR\fR
+The attribute to use for opening the connection \- default is fqdn
+.
+.TP
+\fB\-C\fR, \fB\-\-concurrency NUM\fR
+The number of concurrent connections
+.
+.TP
+\fB\-m\fR, \fB\-\-manual\-list\fR
+QUERY is a space separated list of servers
+.
+.TP
+\fB\-P\fR, \fB\-\-ssh\-password PASSWORD\fR
+The ssh password
+.
+.TP
+\fB\-x\fR, \fB\-\-ssh\-user USERNAME\fR
+The ssh username
+.
+.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

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

@@ -0,0 +1,29 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "KNIFE\-STATUS" "1" "April 2011" "Chef 0.10.0.rc.0" "Chef Manual"
+.
+.SH "NAME"
+\fBknife\-status\fR \- Display status information for the nodes in your infrastructure
+.
+.SH "SYNOPSIS"
+\fBknife\fR \fBstatus\fR \fI(options)\fR
+.
+.TP
+\fB\-r\fR, \fB\-\-run\-list RUN_LIST\fR
+Show the run list
+.
+.SH "DESCRIPTION"
+The \fIstatus\fR sub\-command searches the Chef Server for all nodes and displays information about the last time the node checked into the server and executed a \fBnode\.save\fR\. The fields displayed are the relative checkin time, the node name, it\'s operating system platform and version, the fully\-qualified domain name and the default IP address\. If the \fB\-r\fR option is given, the node\'s run list will also be displayed\. Note that depending on the configuration of the nodes, the FQDN and IP displayed may not be publicly reachable\.
+.
+.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-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" "April 2011" "Chef 0.10.0.rc.0" "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" "April 2011" "Chef 0.10.0.rc.0" "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