microwave 11.400.5 → 11.400.6

data/distro/common/man/man1/chef-shell.1

@@ -1,220 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "CHEF\-SHELL" "1" "February 2013" "Chef 11.2.0" "Chef Manual"
-.
-.SH "NAME"
-\fBchef\-shell\fR \- Interactive Chef Console
-.
-.SH "SYNOPSIS"
-\fBchef\-shell\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 session
-.
-.TP
-\fB\-a\fR, \fB\-\-standalone\fR
-standalone 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, chef\-shell attempts to load a default configuration file:
-.
-.IP "\(bu" 4
-If a \fInamed configuration\fR is given, chef\-shell will load ~/\.chef/\fInamed configuration\fR/chef_shell\.rb
-.
-.IP "\(bu" 4
-If no \fInamed configuration\fR is given chef\-shell will load ~/\.chef/chef_shell\.rb if it exists
-.
-.IP "\(bu" 4
-chef\-shell falls back to loading /etc/chef/client\.rb or /etc/chef/solo\.rb if \-z or \-s options are given and no chef_shell\.rb can be found\.
-.
-.IP "\(bu" 4
-The \-\-config option takes precedence over implicit configuration paths\.
-.
-.IP "" 0
-.
-.SH "DESCRIPTION"
-\fBchef\-shell\fR is an irb(1) (interactive ruby) session customized for Chef\. \fBchef\-shell\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"
-chef\-shell 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 chef\-shell session
-.
-.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, chef\-shell provides a DSL for accessing data on the Chef Server\. When working with remote data in chef\-shell, 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 chef:recipe > echo :off chef:recipe > file "/tmp/hello_world" chef:recipe > run_chef [Sat, 09 Apr 2011 08:56:56 \-0700] INFO: Processing file[/tmp/hello_world] action create ((irb#1) line 2) [Sat, 09 Apr 2011 08:56:56 \-0700] INFO: file[/tmp/hello_world] created file /tmp/hello_world chef:recipe > pp ls \'/tmp\' ["\.", "\.\.", "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] } => ["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]\') } => [node[chef098b2\.opschef\.com], node[ree\-woot], node[graphite\-dev], node[fluke\.localdomain], node[ghost\.local], node[kallistec]]
-.
-.IP "" 0
-.
-.SH "BUGS"
-\fBchef\-shell\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
-\fBchef\-shell\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/Chef+Shell\fR
-.
-.SH "AUTHOR"
-Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\. chef\-shell 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"
-chef\-shell is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR

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

@@ -1,201 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "KNIFE\-BOOTSTRAP" "1" "February 2013" "Chef 11.2.0" "Chef Manual"
-.
-.SH "NAME"
-\fBknife\-bootstrap\fR \- Install Chef Client on a remote host
-.
-.SH "SYNOPSIS"
-\fBknife\fR \fBbootstrap\fR \fI(options)\fR
-.
-.TP
-\fB\-i\fR, \fB\-\-identity\-file IDENTITY_FILE\fR
-The SSH identity file used for authentication
-.
-.TP
-\fB\-N\fR, \fB\-\-node\-name NAME\fR
-The Chef node name for your new node
-.
-.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\-p\fR, \fB\-\-ssh\-port PORT\fR
-The ssh port
-.
-.TP
-\fB\-\-bootstrap\-version VERSION\fR
-The version of Chef to install
-.
-.TP
-\fB\-\-bootstrap\-proxy PROXY_URL\fR
-\fBThe proxy server for the node being bootstrapped\fR
-.
-.TP
-\fB\-\-prerelease\fR
-Install pre\-release Chef gems
-.
-.TP
-\fB\-r\fR, \fB\-\-run\-list RUN_LIST\fR
-Comma separated list of roles/recipes to apply
-.
-.TP
-\fB\-\-template\-file TEMPLATE\fR
-Full path to location of template to use
-.
-.TP
-\fB\-\-sudo\fR
-Execute the bootstrap via sudo
-.
-.TP
-\fB\-d\fR, \fB\-\-distro DISTRO\fR
-Bootstrap a distro using a template
-.
-.TP
-\fB\-\-[no\-]host\-key\-verify\fR
-Enable host key verification, which is the default behavior\.
-.
-.TP
-\fB\-\-hint HINT_NAME[=HINT_FILE]\fR
-Provide the name of a hint (with option JSON file) to set for use by Ohai plugins\.
-.
-.SH "DESCRIPTION"
-Performs a Chef Bootstrap on the target node\. The goal of the bootstrap is to get Chef installed on the target system so it can run Chef Client with a Chef Server\. The main assumption is a baseline OS installation exists\. This sub\-command is used internally by some cloud computing plugins\.
-.
-.P
-The bootstrap sub\-command supports supplying a template to perform the bootstrap steps\. If the distro is not specified (via \fB\-d\fR or \fB\-\-distro\fR option), an Ubuntu 10\.04 host bootstrapped with RubyGems is assumed\. The \fBDISTRO\fR value corresponds to the base filename of the template, in other words \fBDISTRO\fR\.erb\. A template file can be specified with the \fB\-\-template\-file\fR option in which case the \fBDISTRO\fR is not used\. The sub\-command looks in the following locations for the template to use:
-.
-.IP "\(bu" 4
-\fBbootstrap\fR directory in the installed Chef Knife library\.
-.
-.IP "\(bu" 4
-\fBbootstrap\fR directory in the \fB$PWD/\.chef\fR\.
-.
-.IP "\(bu" 4
-\fBbootstrap\fR directory in the users \fB$HOME/\.chef\fR\.
-.
-.IP "" 0
-.
-.P
-The default bootstrap templates are scripts that get copied to the target node (FQDN)\. The following distros are supported:
-.
-.IP "\(bu" 4
-centos5\-gems
-.
-.IP "\(bu" 4
-fedora13\-gems
-.
-.IP "\(bu" 4
-ubuntu10\.04\-gems
-.
-.IP "\(bu" 4
-ubuntu10\.04\-apt
-.
-.IP "" 0
-.
-.P
-The gems installations will use RubyGems 1\.3\.6 and Chef installed as a gem\. The apt installation will use the Opscode APT repository\.
-.
-.P
-In addition to handling the software installation, these bootstrap templates do the following:
-.
-.IP "\(bu" 4
-Write the validation\.pem per the local knife configuration\.
-.
-.IP "\(bu" 4
-Write a default config file for Chef (\fB/etc/chef/client\.rb\fR) using values from the \fBknife\.rb\fR\.
-.
-.IP "\(bu" 4
-Create a JSON attributes file containing the specified run list and run Chef\.
-.
-.IP "" 0
-.
-.P
-In the case of the RubyGems, the \fBclient\.rb\fR will be written from scratch with a minimal set of values; see \fBEXAMPLES\fR\. In the case of APT Package installation, \fBclient\.rb\fR will have the \fBvalidation_client_name\fR appended if it is not set to \fBchef\-validator\fR (default config value), and the \fBnode_name\fR will be added if \fBchef_node_name\fR option is specified\.
-.
-.P
-When this is complete, the bootstrapped node will have:
-.
-.IP "\(bu" 4
-Latest Chef version installed from RubyGems or APT Packages from Opscode\. This may be a later version than the local system\.
-.
-.IP "\(bu" 4
-Be validated with the configured Chef Server\.
-.
-.IP "\(bu" 4
-Have run Chef with its default run list if one is specfied\.
-.
-.IP "" 0
-.
-.P
-Additional custom bootstrap templates can be created and stored in \fB\.chef/bootstrap/DISTRO\.erb\fR, replacing \fBDISTRO\fR with the value passed with the \fB\-d\fR or \fB\-\-distro\fR option\. See \fBEXAMPLES\fR for more information\.
-.
-.SH "EXAMPLES"
-Setting up a custom bootstrap is fairly straightforward\. Create a \fB\.chef/bootstrap\fR directory in your Chef Repository or in \fB$HOME/\.chef/bootstrap\fR\. Then create the ERB template file\.
-.
-.IP "" 4
-.
-.nf
-
-mkdir ~/\.chef/bootstrap
-vi ~/\.chef/bootstrap/debian5\.0\-apt\.erb
-.
-.fi
-.
-.IP "" 0
-.
-.P
-For example, to create a new bootstrap template that should be used when setting up a new Debian node\. Edit the template to run the commands, set up the validation certificate and the client configuration file, and finally to run chef\-client on completion\. The bootstrap template can be called with:
-.
-.IP "" 4
-.
-.nf
-
-knife bootstrap mynode\.example\.com \-\-template\-file ~/\.chef/bootstrap/debian5\.0\-apt\.erb
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Or,
-.
-.IP "" 4
-.
-.nf
-
-knife bootstrap mynode\.example\.com \-\-distro debian5\.0\-apt
-.
-.fi
-.
-.IP "" 0
-.
-.P
-The \fB\-\-distro\fR parameter will automatically look in the \fB~/\.chef/bootstrap\fR directory for a file named \fBdebian5\.0\-apt\.erb\fR\.
-.
-.P
-Templates provided by the Chef installation are located in \fBBASEDIR/lib/chef/knife/bootstrap/*\.erb\fR, where \fIBASEDIR\fR is the location where the package or Gem installed the Chef client libraries\.
-.
-.SH "BUGS"
-\fBknife bootstrap\fR is not capable of bootstrapping multiple hosts in parallel\.
-.
-.P
-The bootstrap script is passed as an argument to sh(1) on the remote system, so sensitive information contained in the script will be visible to other users via the process list using tools such as ps(1)\.
-.
-.SH "SEE ALSO"
-\fBknife\-ssh\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-client.1

@@ -1,99 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "KNIFE\-CLIENT" "1" "February 2013" "Chef 11.2.0" "Chef Manual"
-.
-.SH "NAME"
-\fBknife\-client\fR \- Manage Chef API Clients
-.
-.SH "SYNOPSIS"
-\fBknife\fR \fBclient\fR \fIsub\-command\fR \fI(options)\fR
-.
-.SH "SUB\-COMMANDS"
-Client subcommands follow a basic create, read, update, delete (CRUD) pattern\. The Following subcommands are available:
-.
-.SH "BULK DELETE"
-\fBknife client bulk delete\fR \fIregex\fR \fI(options)\fR
-.
-.P
-Delete clients where the client name matches the regular expression \fIregex\fR on the Chef Server\. The regular expression should be given as a quoted string, and not surrounded by forward slashes\.
-.
-.SH "CREATE"
-\fBknife client create\fR \fIclient name\fR \fI(options)\fR
-.
-.TP
-\fB\-a\fR, \fB\-\-admin\fR
-Create the client as an admin
-.
-.TP
-\fB\-f\fR, \fB\-\-file FILE\fR
-Write the key to a file
-.
-.P
-Create a new client\. This generates an RSA keypair\. The private key will be displayed on \fISTDOUT\fR or written to the named file\. The public half will be stored on the Server\. For \fIchef\-client\fR systems, the private key should be copied to the system as \fB/etc/chef/client\.pem\fR\.
-.
-.P
-Admin clients should be created for users that will use \fIknife\fR to access the API as an administrator\. The private key will generally be copied to \fB~/\.chef/client\e_name\.pem\fR and referenced in the \fBknife\.rb\fR configuration file\.
-.
-.SH "DELETE"
-\fBknife client delete\fR \fIclient name\fR \fI(options)\fR
-.
-.P
-Deletes a registered client\.
-.
-.SH "EDIT"
-\fBclient edit\fR \fIclient name\fR \fI(options)\fR
-.
-.P
-Edit a registered client\.
-.
-.SH "LIST"
-\fBclient list\fR \fI(options)\fR
-.
-.TP
-\fB\-w\fR, \fB\-\-with\-uri\fR
-Show corresponding URIs
-.
-.P
-List all registered clients\.
-.
-.SH "REREGISTER"
-\fBclient reregister\fR \fIclient name\fR \fI(options)\fR
-.
-.TP
-\fB\-f\fR, \fB\-\-file FILE\fR
-Write the key to a file
-.
-.P
-Regenerate the RSA keypair for a client\. The public half will be stored on the server and the private key displayed on \fISTDOUT\fR or written to the named file\. This operation will invalidate the previous keypair used by the client, preventing it from authenticating with the Chef Server\. Use care when reregistering the validator client\.
-.
-.SH "SHOW"
-\fBclient show\fR \fIclient name\fR \fI(options)\fR
-.
-.TP
-\fB\-a\fR, \fB\-\-attribute ATTR\fR
-Show only one attribute
-.
-.P
-Show a client\. Output format is determined by the \-\-format option\.
-.
-.SH "DESCRIPTION"
-Clients are identities used for communication with the Chef Server API, roughly equivalent to user accounts on the Chef Server, except that clients only communicate with the Chef Server API and are authenticated via request signatures\.
-.
-.P
-In the typical case, there will be one client object on the server for each node, and the corresponding client and node will have identical names\.
-.
-.P
-In the Chef authorization model, there is one special client, the "validator", which is authorized to create new non\-administrative clients but has minimal privileges otherwise\. This identity is used as a sort of "guest account" to create a client identity when initially setting up a host for management with Chef\.
-.
-.SH "SEE ALSO"
-\fBknife\-node\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