tylerrick-chef 0.10.8

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" "December 2011" "Chef 0.10.8" "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,280 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "KNIFE\-SEARCH" "1" "December 2011" "Chef 0.10.8" "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\-q\fR, \fB\-\-query QUERY\fR
+The search query; useful to protect queries starting with \-
+.
+.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 is a feature of the Chef Server that allows you to use a full\-text search engine to query information about your infrastructure and applications\. You can utilize this service via search calls in a recipe or the knife search command\. The search syntax is based on Lucene\.
+.
+.SH "INDEXES"
+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:
+.
+.IP "\(bu" 4
+\fInode\fR
+.
+.IP "\(bu" 4
+\fIrole\fR
+.
+.IP "\(bu" 4
+\fIenvironment\fR
+.
+.IP "\(bu" 4
+\fIclients\fR
+.
+.IP "\(bu" 4
+\fIdata bag\fR
+.
+.IP "" 0
+.
+.P
+Data bags are indexed by the data bag\'s name\. For example, to search a data bag named "admins":
+.
+.IP "" 4
+.
+.nf
+
+knife search admins "field:search_pattern"
+.
+.fi
+.
+.IP "" 0
+.
+.SH "QUERY SYNTAX"
+Queries have the form \fBfield:search_pattern\fR where \fBfield\fR is a key in the JSON description of the relevant objects (nodes, roles, environments, or data bags)\. Both \fBfield\fR and \fBsearch_pattern\fR are case\-sensitive\. \fBsearch_pattern\fR can be an exact, wildcard, range, or fuzzy match (see below)\. The \fBfield\fR supports exact matching and limited wildcard matching\.
+.
+.P
+Searches will return the relevant objects (nodes, roles, environments, or data bags) where the \fBsearch_pattern\fR matches the object\'s value of \fBfield\fR\.
+.
+.SS "FIELD NAMES"
+Field names are the keys within the JSON description of the object being searched\. Nested Keys can be searched by placing an underscore ("_") between key names\.
+.
+.SS "WILDCARD MATCHING FOR FIELD NAMES"
+The field name also has limited support for wildcard matching\. Both the "*" and "?" wildcards (see below) can be used within a field name; however, they cannot be the first character of the field name\.
+.
+.SS "EXACT MATCHES"
+Without any search modifiers, a search returns those fields for which the \fBsearch_pattern\fR exactly matches the value of \fBfield\fR in the JSON description of the object\.
+.
+.SS "WILDCARD MATCHES"
+Search support both single\- and multi\-character wildcard searches within a search pattern\.
+.
+.P
+\'?\' matches exactly one character\.
+.
+.P
+\'*\' matches zero or more characters\.
+.
+.SS "RANGE MATCHES"
+Range searches allows one to match values between two given values\. To match values between X and Y, inclusively, use square brackets:
+.
+.IP "" 4
+.
+.nf
+
+knife search INDEX \'field:[X TO Y]
+.
+.fi
+.
+.IP "" 0
+.
+.P
+To match values between X and Y, exclusively, use curly brackets:
+.
+.IP "" 4
+.
+.nf
+
+knife search INDEX \'field:{X TO Y}\'
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Values are sorted in lexicographic order\.
+.
+.SS "FUZZY MATCHES"
+Fuzzy searches allows one to match values based on the Levenshtein Distance algorithm\. To perform a fuzzy match, append a tilda (~) to the search term:
+.
+.IP "" 4
+.
+.nf
+
+knife search INDEX \'field:term~\'
+.
+.fi
+.
+.IP "" 0
+.
+.P
+This search would return nodes whose \fBfield\fR was \'perm\' or \'germ\'\.
+.
+.SS "BOOLEAN OPERATORS"
+The boolean operators NOT, AND, and OR are supported\. To find values of \fBfield\fR that are not X:
+.
+.IP "" 4
+.
+.nf
+
+knife search INDEX \'field:(NOT X)\'
+.
+.fi
+.
+.IP "" 0
+.
+.P
+To find records where \fBfield1\fR is X and \fBfield2\fR is Y:
+.
+.IP "" 4
+.
+.nf
+
+knife search INDEX \'field1:X AND field2:Y\'
+.
+.fi
+.
+.IP "" 0
+.
+.P
+To find records where \fBfield\fR is X or Y:
+.
+.IP "" 4
+.
+.nf
+
+knife search INDEX \'field:X OR field:Y\'
+.
+.fi
+.
+.IP "" 0
+.
+.SS "QUOTING AND SPECIAL CHARACTERS"
+In order to avoid having special characters and escape sequences within your search term interpreted by either Ruby or the shell, enclose them in single quotes\.
+.
+.P
+Search terms that include spaces should be enclosed in double\-quotes:
+.
+.IP "" 4
+.
+.nf
+
+knife search INDEX \'field:"term with spaces"\'
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The following characters must be escaped:
+.
+.IP "" 4
+.
+.nf
+
++ \- && || ! ( ) { } [ ] ^ " ~ * ? : \e
+.
+.fi
+.
+.IP "" 0
+.
+.SH "EXAMPLES"
+Find the nodes with the fully\-qualified domain name (FQDN) www\.example\.com:
+.
+.IP "" 4
+.
+.nf
+
+knife search node \'fqdn:www\.example\.com\'
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Find the nodes running a version of Ubuntu:
+.
+.IP "" 4
+.
+.nf
+
+knife search node \'platform:ubuntu*\'
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Find all nodes running CentOS in the production environment:
+.
+.IP "" 4
+.
+.nf
+
+knife search node \'chef_environment:production AND platform:centos\'
+.
+.fi
+.
+.IP "" 0
+.
+.SH "KNOWN BUGS"
+.
+.IP "\(bu" 4
+Searches against the client index return no results in most cases\. (CHEF\-2477)
+.
+.IP "\(bu" 4
+Searches using the fuzzy match operator (~) produce an error\. (CHEF\-2478)
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+\fBknife\-ssh\fR(1) \fIhttp://wiki\.opscode\.com/display/chef/Attributes\fR Lucene Query Parser Syntax \fIhttp://lucene\.apache\.org/java/2_3_2/queryparsersyntax\.html\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,83 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "KNIFE\-SSH" "1" "December 2011" "Chef 0.10.8" "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
+.
+.TP
+\fB\-i\fR, \fB\-\-identity\-file IDENTITY_FILE\fR
+The SSH identity file used for authentication
+.
+.TP
+\fB\-p\fR, \fB\-\-ssh\-port PORT\fR
+The ssh port
+.
+.TP
+\fB\-i\fR, \fB\-\-identity\-file IDENTITY_FILE\fR
+The SSH identity file used for authentication
+.
+.TP
+\fB\-\-no\-host\-key\-verify\fR
+Disable host key verification
+.
+.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:
+.
+.TP
+\fBinteractive\fR
+A built\-in multiplexer\. \fBinteractive\fR supports running commands on a subset of the connected hosts in parallel
+.
+.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