rmm-chef 0.10.0.rc.0

data/distro/common/markdown/man1/knife-tag.mkd

@@ -0,0 +1,39 @@
+knife-tag(1) -- Apply tags to nodes on a Chef Server
+========================================
+
+## SYNOPSIS
+
+__knife__ __tag__ _subcommand_ _(options)_
+
+## TAG SUBCOMMANDS
+The following `tag` subcommands are available:
+
+## CREATE
+__knife tag create__ _node_ _tag_ [_..._]
+
+Adds one or more tags to _node_
+
+## DELETE
+__knife tag delete__ _node_ _tag_ [_..._]
+
+Removes one or more tags from _node_
+
+## LIST
+__knife tag list__ _node_
+
+Lists the tags applied to _node_
+
+
+## SEE ALSO
+   __knife-node(1)__
+
+## AUTHOR
+   Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
+
+## DOCUMENTATION
+   This manual page was written by Daniel DeLeo <dan@opscode.com>.
+   Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
+
+## CHEF
+   Knife is distributed with Chef. <http://wiki.opscode.com/display/chef/Home>
+

data/distro/common/markdown/man1/knife.mkd

@@ -0,0 +1,189 @@
+knife(1) -- Chef Server API client utility
+========================================
+
+## SYNOPSIS
+
+__knife__ _sub-command_ [_argument_...] _(options)_
+
+## 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:
+
+  * bootstrap
+  * client
+  * configure
+  * cookbook-site
+  * cookbook
+  * data-bag
+  * environment
+  * exec
+  * index
+  * node
+  * recipe
+  * role
+  * search
+  * ssh
+  * status
+  * tag
+
+If the knife manuals are in your `MANPATH`, you can access help for the
+above topics using `man knife-TOPIC`; otherwise, you can view the
+documentation using `knife help TOPIC`.
+
+## OPTIONS
+  * `-s`, `--server-url` URL:
+    Chef Server URL, corresponds to `Chef::Config` `chef_server_url`.
+  * `-k`, `--key` KEY:
+    API Client Key, corresponds to `Chef::Config` `client_key`.
+  * `-c`, `--config` CONFIG:
+    The configuration file to use
+  * `-e`, `--editor` EDITOR:
+    Set the editor to use for interactive commands
+  * `-F`, `--format` FORMAT:
+    Which format to use for output
+  * `-l`, `--log_level` LEVEL:
+    Set the log level (debug, info, warn, error, fatal), corresponds to `Chef::Config` `log_level`.
+  * `-L`, `--logfile` LOGLOCATION:
+    Set the log file location, defaults to STDOUT, corresponds to `Chef::Config` `log_location`.
+  * `-n`, `--no-editor`:
+    Do not open EDITOR, just accept the data as is
+  * `-u`, `--user` USER:
+    API Client Username, corresponds to `Chef::Config` `node_name`.
+  * `-p`, `--print-after`:
+    Show the data after a destructive operation
+  * `-v`, `--version`:
+    Show chef version
+  * `-y`, `--yes`:
+    Say yes to all prompts for confirmation
+  * `-h`, `--help`:
+    Show the available options for a command.
+
+## SUB-COMMANDS
+
+Sub-commands that operate on the basic Chef data types are structured as
+_NOUN verb NOUN (options)_. For all data types, the following commands
+are available:
+
+* create (create)
+* list and show (read)
+* edit (update)
+* delete (destroy)
+
+Knife also includes commands that take actions other than displaying or
+modifying data on the Chef Server, such as __knife-ssh(1)__.
+
+## CONFIGURATION
+
+The knife configuration file is a Ruby DSL to set configuration
+parameters for Knife's __GENERAL OPTIONS__. The default location for the
+config file is `~/.chef/knife.rb`. If managing multiple Chef
+repositories, per-repository config files can be created. The file must
+be `.chef/knife.rb` in the current directory of the repository.
+
+If the config file exists, knife uses these settings for __GENERAL OPTIONS__ defaults.
+
+  * `node_name`:
+    User or client identity (i.e., _name_) to use for authenticating
+    requests to the Chef Server.
+  * `client_key`:
+    Private key file to authenticate to the Chef server. Corresponds to the
+    `-k` or `--key` option.
+  * `chef_server_url`:
+    URL of the Chef server. Corresponds to the `-s` or `--server-url`
+    option. This is requested from the user when running this sub-command.
+  * `cache_type`:
+    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.
+  * `cache_options`:
+    Specifies various options to use for caching. These options are
+    dependent on the `cache_type`.
+  * `validation_client_name`:
+    Specifies the name of the client used to validate new clients.
+  * `validation_key`:
+    Specifies the private key file to use when bootstrapping new hosts.
+    See knife-client(1) for more information about the validation
+    client.
+  * `cookbook_copyright`, `cookbook_email`, `cookbook_license`
+    Used by `knife cookbook create` 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.
+
+## FILES
+
+_~/.chef/knife.rb_
+
+Ruby DSL configuration file for knife. See __CONFIGURATION__.
+
+## CHEF WORKFLOW
+
+When working with Chef and Knife in the local repository, the recommended workflow outline looks like:
+
+* Create repository. A skeleton sample is provided at _http://github.com/opscode/chef-repo/_.
+* Configure knife, see __CONFIGURATION__.
+* Download cookbooks from the Opscode cookbooks site, see __COOKBOOK SITE SUB-COMMANDS__.
+* Or, create new cookbooks, see `cookbook create` sub-command.
+* Commit changes to the version control system. See your tool's documentation.
+* Upload cookbooks to the Chef Server, see __COOKBOOK SUB-COMMANDS__.
+* Launch instances in the Cloud, OR provision new hosts; see __CLOUD COMPUTING SUB-COMMANDS__ and __BOOTSTRAP SUB-COMMANDS__.
+* Watch Chef configure systems!
+
+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 `cookbook site vendor`
+sub-command, as it uses git directly. Version control is strongly
+recommended though, and git fits with a lot of the workflow paradigms.
+
+## EXAMPLES
+
+
+## ENVIRONMENT
+  * `EDITOR`:
+    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.
+
+## SEE ALSO
+  __chef-client(8)__ __chef-server(8)__ __shef(1)__
+
+  __knife-bootstrap(1)__ __knife-client(1)__ __knife-configure(1)__
+  __knife-cookbook-site(1)__ __knife-cookbook(1)__ __knife-data-bag(1)__
+  __knife-environment(1)__ __knife-exec(1)__ __knife-index(1)__
+  __knife-node(1)__ __knife-recipe(1)__ __knife-role(1)__
+  __knife-search(1)__ __knife-ssh(1)__ __knife-tag(1)__
+
+  Complete Chef documentation is available online: <http://wiki.opscode.com/display/chef/Home/>
+
+  JSON is JavaScript Object Notation <http://json.org/>
+
+  SOLR is an open source search engine. <http://lucene.apache.org/solr/>
+
+  __git(1)__ is a version control system <http://git-scm.com/>
+
+  This manual page was generated from Markdown with __ronn(1)__ <http://rtomayko.github.com/ronn/ronn.1.html>
+
+## AUTHOR
+   Chef was written by Adam Jacob <adam@opscode.com> of Opscode
+   (<http://www.opscode.com>), with contributions from the community.
+
+## DOCUMENTATION
+   This manual page was written by Joshua Timberman <joshua@opscode.com>.
+
+## LICENSE
+   Both Chef and this documentation are released under the terms of the
+   Apache 2.0 License. You may view the license online: <http://www.apache.org/licenses/LICENSE-2.0.html>
+   On some systems, the complete text of the Apache 2.0 License may be found in `/usr/share/common-licenses/Apache-2.0`.
+
+## CHEF
+   Knife is distributed with Chef. <http://wiki.opscode.com/display/chef/Home>
+

data/distro/common/markdown/man1/shef.mkd

@@ -0,0 +1,189 @@
+shef(1) -- Interactive Chef Console
+========================================
+
+## SYNOPSIS
+
+__shef__ [_named configuration_] _(options)_
+
+  * `-S`, `--server CHEF_SERVER_URL`:
+    The chef server URL
+  * `-z`, `--client`:
+    chef-client mode
+  * `-c`, `--config CONFIG`:
+    The configuration file to use
+  * `-j`, `--json-attributes JSON_ATTRIBS`:
+    Load attributes from a JSON file or URL
+  * `-l`, `--log-level LOG_LEVEL`:
+    Set the logging level
+  * `-s`, `--solo`:
+    chef-solo shef session
+  * `-a`, `--standalone`:
+    standalone shef session
+  * `-v`, `--version`:
+    Show chef version
+  * `-h`, `--help`:
+    Show command options
+
+When no --config option is specified, shef attempts to load a default configuration file:
+
+* If a _named configuration_ is given, shef will load ~/.chef/_named
+  configuration_/shef.rb
+* If no _named configuration_ is given shef will load ~/.chef/shef.rb if it exists
+* 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.
+* The --config option takes precedence over implicit configuration
+  paths.
+
+## DESCRIPTION
+
+`shef` is an irb(1) (interactive ruby) session customized for Chef.
+`shef` 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.
+
+## SYNTAX
+Shef uses irb's subsession feature to provide multiple modes of
+interaction. In addition to the primary mode which is entered on start,
+`recipe` and `attributes` modes are available.
+
+## PRIMARY MODE
+The following commands are available in the primary
+session:
+
+  * `help`:
+    Prints a list of available commands
+  * `version`:
+    Prints the Chef version
+  * `recipe`:
+    Switches to `recipe` mode
+  * `attributes`:
+    Switches to `attributes` mode
+  * `run_chef`:
+    Initiates a chef run
+  * `reset`:
+    reinitializes shef
+  * `echo :on|:off`:
+    Turns irb's echo function on or off. Echo is _on_ by default.
+  * `tracing :on|:off`:
+    Turns irb's function tracing feature on or off. Tracing is extremely
+    verbose and expected to be of interest primarily to developers.
+  * `node`:
+    Returns the _node_ object for the current host. See knife-node(1)
+    for more information about nodes.
+  * `ohai`:
+    Prints the attributes of _node_
+
+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 _object type_._operation_, where _object type_ is in
+plural form. The following object types are available:
+
+  * `nodes`
+  * `roles`
+  * `data_bags`
+  * `clients`
+  * `cookbooks`
+
+For each _object type_ the following operations are available:
+
+  * _object type_.all(_&block_):
+    Loads all items from the server. If the optional code _block_ is
+    given, each item will be passed to the block and the results
+    returned, similar to ruby's `Enumerable#map` method.
+  * _object type_.show(_object name_):
+    Aliased as _object type_.load
+
+    Loads the singular item identified by _object name_.
+  * _object type_.search(_query_, _&block_):
+    Aliased as _object type_.find
+
+    Runs a search against the server and returns the matching items. If
+    the optional code _block_ is given each item will be passed to the
+    block and the results returned.
+
+    The _query_ 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.
+  * _object type_.transform(:all|_query_, _&block_):
+    Aliased as _object type_.bulk_edit
+
+    Bulk edit objects by processing them with the (required) code _block_.
+    You can edit all objects of the given type by passing the Symbol
+    `:all` as the argument, or only a subset by passing a _query_ as the
+    argument. The _query_ is evaluated in the same way as with
+    __search__.
+
+    The return value of the code _block_ is used to alter the behavior
+    of `transform`. If the value returned from the block is `nil` or
+    `false`, 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.
+
+## 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:
+
+  * <http://wiki.opscode.com/display/chef/Resources>
+  * <http://wiki.opscode.com/display/chef/Recipes>
+
+Once you have defined resources in the recipe, you can trigger a
+convergence run via `run_chef`
+
+## EXAMPLES
+
+* A "Hello World" interactive recipe
+
+  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"]  
+
+* Search for _nodes_ by role, and print their IP addresses
+
+  chef > nodes.find(:roles => 'monitoring-server') {|n| n[:ipaddress] }  
+  => ["10.254.199.5"]  
+
+* Remove the role _obsolete_ from every node in the system
+
+  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]]  
+
+
+## BUGS
+The name `shef` is clever in print but is confusing when spoken aloud.
+Pronouncing `shef` as `chef console` is an imperfect workaround.
+
+`shef` often does not perfectly replicate the context in which
+chef-client(8) configures a host, which may lead to discrepancies in
+observed behavior.
+
+`shef` has to duplicate much code from chef-client's internal libraries
+and may become out of sync with the behavior of those libraries.
+
+## SEE ALSO
+  chef-client(8) knife(1)
+  <http://wiki.opscode.com/display/chef/Shef>
+
+## AUTHOR
+   Chef was written by Adam Jacob <adam@opscode.com> with many
+   contributions from the community. Shef was written by Daniel DeLeo.
+
+## DOCUMENTATION
+   This manual page was written by Daniel DeLeo <dan@opscode.com>.
+   Permission is granted to copy, distribute and / or modify this
+   document under the terms of the Apache 2.0 License.
+
+## CHEF
+   Shef is distributed with Chef. <http://wiki.opscode.com/display/chef/Home>
+
+
+

data/distro/common/markdown/man8/chef-client.mkd

@@ -0,0 +1,65 @@
+chef-client(8) -- Runs a client node connecting to a chef-server.
+========================================
+
+## SYNOPSIS
+
+__chef-client__ _(options)_
+
+  * `-S`, `--server CHEFSERVERURL`:
+    The chef server URL
+  * `-c`, `--config CONFIG`:
+    The configuration file to use
+  * `-d`, `--daemonize`:
+    Daemonize the process
+  * `-g`, `--group GROUP`:
+    Group to set privilege to
+  * `-i`, `--interval SECONDS`:
+    Run chef-client periodically, in seconds
+  * `-j`, `--json-attributes JSON_ATTRIBS`:
+    Load attributes from a JSON file or URL
+  * `-l`, `--log_level LEVEL`:
+    Set the log level (debug, info, warn, error, fatal)
+  * `-L`, `--logfile LOGLOCATION`:
+    Set the log file location, defaults to STDOUT - recommended for
+    daemonizing
+  * `-V`, `--verbose`:
+    Ensures logging goes to STDOUT as well as  to  other  configured
+    log location(s).
+  * `-N`, `--node-name NODE_NAME`:
+    The node name for this client
+  * `-s`, `--splay SECONDS`:
+    The splay time for running at intervals, in seconds
+  * `-u`, `--user USER`:
+    User to set privilege to
+  * `-v`, `--version`:
+    Show chef version
+  * `-h`, `--help`:
+    Show this message
+
+## DESCRIPTION
+
+The Chef Client is where almost all of the work in Chef is done. It
+communicates with the Chef Server via REST, authenticates via Signed
+Header Authentication, and compiles and executes Cookbooks.
+
+A Chef Client does work on behalf of a Node. A single Chef Client can
+run recipes for multiple Nodes.
+
+Clients are where all the action happens - the Chef Server and Chef Expander
+are largely services that exist only to provide the Client with information.
+
+## SEE ALSO
+
+Full  documentation  for  Chef  and  chef-client is located on the Chef
+wiki, http://wiki.opscode.com/display/chef/Home.
+
+## AUTHOR
+
+Chef was written by Adam Jacob <adam@ospcode.com> of Opscode
+(http://www.opscode.com),  with contributions from the community.  This
+manual page was written by Joshua Timberman  <joshua@opscode.com>  with
+help2man.  Permission  is  granted  to copy, distribute and / or modify
+this document under the terms of the Apache 2.0 License.
+
+On Debian systems, the complete text of the Apache 2.0 License  can  be
+found in /usr/share/common-licenses/Apache-2.0.