microwave 1.0.2 → 1.0.3

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

@@ -1,189 +0,0 @@
-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

@@ -1,74 +0,0 @@
-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
-  * `-E`, `--environment ENVIRONMENT`:
-    Set the Chef Environment on the node
-  * `-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
-  * `-N`, `--node-name NODE_NAME`:
-    The node name for this client
-  * `-o`, `--override-runlist`:
-    Replace current run list with specified items
-  * `-K`, `--validation_key KEY_FILE`:
-    Set the validation key file location, used for registering new clients
-  * `-k`, `--client_key KEY_FILE`:
-    Set the client key file location
-  * `-s`, `--splay SECONDS`:
-    The splay time for running at intervals, in seconds
-  * `-u`, `--user USER`:
-    User to set privilege to
-  * `-P`, `--pid PIDFILE`:
-    Set the PID file location, defaults to /tmp/chef-client.pid
-  * `--once`:
-    Cancel any interval or splay options, run chef once and exit
-  * `-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.

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

@@ -1,82 +0,0 @@
-chef-expander(8) -- fetches messages from RabbitMQ, processes, and loads into chef-solr
-========================================
-
-## SYNOPSIS
-
-__chef-expander__ _(options)_
-
-  * `-c`, `--config CONFIG_FILE`:
-    a configuration file to use
-  * `-i`, `--index INDEX`:
-    the slot this node will occupy in the ring
-  * `-n`, `--node-count NUMBER`:
-    the number of nodes in the ring
-  * `-l`, `--log-level LOG_LEVEL`:
-    set the log level
-  * `-L`, `--logfile LOG_LOCATION`:
-    Logfile to use
-  * `-d`, `--daemonize`:
-    fork into the background
-  * `-P`, `--pid PIDFILE`:
-    PID file
-  * `-h`, `--help`:
-    show help message
-  * `-v`, `--version`:
-    show the version and exit
-
-## DESCRIPTION
-
-Chef Expander fetches messages from RabbitMQ, processes them into the
-correct format to be loaded into Solr and loads them into Solr.
-
-__Running Chef Expander__
-
-Chef Expander is designed for clustered operation, though small
-installations will only need one worker process. To run Chef
-Expander with one worker process, run chef-expander -n 1.
-You will then have a master and worker process, which looks like
-this in ps:
-
-    your-shell> ps aux|grep expander
-    you   52110   0.1  0.7  2515476  62748 s003  S+    3:49PM   0:00.80 chef-expander worker #1 (vnodes 0-1023)
-    you   52108   0.1  0.5  2492880  41696 s003  S+    3:49PM   0:00.91 ruby bin/chef-expander -n 1
-
-Workers are single threaded and therefore cannot use more than 100%
-of a single CPU. If you find that your queues are getting backlogged,
-increase the number of workers
-
-__Design__
-
-Chef Expander uses 1024 queues (called vnodes in some places) to allow
-you to scale the number of Chef Expander workers to meet the needs of
-your infrastructure. When objects are saved in the API server, they are
-added to queues based on their database IDs. These queues can be assigned
-to different Chef Expander workers to distribute the load of processing
-the index updates.
-
-__Chef Expander Operation and Troubleshooting__
-
-Chef Expander includes chef-expanderctl, a management program that allows
-you to get status information or change the logging verbosity (without
-restarting).
-
-See __chef-expanderctl__(8) for details.
-
-## SEE ALSO
-
-__chef-expanderctl__(8)
-__chef-solr__(8)
-
-Full documentation for Chef and chef-server 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 created by Nuo Yan <nuo@opscode.com>. 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.

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

@@ -1,58 +0,0 @@
-chef-expanderctl(8) -- management program for chef-expander
-========================================
-
-## SYNOPSIS
-
-__chef-expanderctl__ _COMMAND_
-
-__Commands:__
-
-  * `help`:
-    Show help message
-  * `queue-depth`:
-    display the aggregate queue backlog
-  * `queue-status`:
-    show the backlog and consumer count for each vnode queue
-  * `node-status`:
-    show the status of the nodes in the cluster
-  * `log-level`:
-    sets the log level of all nodes in the cluster
-
-## DESCRIPTION
-
-Chef-expanderctl is a management program that allows
-you to get status information or change the logging
-verbosity (without restarting). chef-expanderctl has
-the following commands:
-
-* __chef-expanderctl help__
-prints usage.
-* __chef-expanderctl queue-depth__
-Shows the total number of messages in the queues.
-* __chef-expanderctl queue-status__
-Show the number of messages in each queue. This is mainly of use when
-debugging a Chef Expander cluster.
-* __chef-expanderctl log-level LEVEL__
-Sets the log level on a running Chef Expander or cluster.
-If you suspect that a worker process is stuck, as long as you are using
-clustered operation, you can simply kill the worker process and it will
-be restarted by the master process.
-
-## SEE ALSO
-
-__chef-expander-cluster__(8)
-__chef-solr__(8)
-
-Full documentation for Chef and chef-server 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 created by Nuo Yan <nuo@opscode.com>. 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.

data/distro/common/markdown/man8/chef-server-webui.mkd

@@ -1,121 +0,0 @@
-chef-server-webui(8) -- Start the Chef Server merb application slice providing Web User Interface (Management Console).
-========================================
-
-## SYNOPSIS
-
-__chef-server-webui__ _(options)_
-
-  * `-u`, `--user USER`:
-    This  flag  is  for having chef-server-webui run as a user other than the
-    one currently logged in. Note: if you set this you must also provide a
-    --group option for it to take effect.
-  * `-G`, `--group GROUP`:
-    This flag is for having chef-server-webui run as a group other than the
-    one currently logged in. Note: if you set this you  must also provide a
-    --user option for it to take effect.
-  * `-d`, `--daemonize`:
-    This will run a single chef-server-webui in the background.
-  * `-N`, `--no-daemonize`:
-    This will allow you to run a cluster in console mode.
-  * `-c`, `--cluster-nodes NUM_MERBS`:
-    Number of merb daemons to run for chef-server-webui.
-  * `-I`, `--init-file FILE`:
-    File to use for initialization on load, defaults to config/init.rb.
-  * `-p`, `--port PORTNUM`:
-    Port to run chef-server-webui on, defaults to 4040. Additional nodes (-c)
-    listen on incrementing port numbers.
-  * `-o`, `--socket-file FILE`:
-    Socket  file  to  run  chef-server-webui on, defaults to
-    [Merb.root]/log/merb.sock. This is for web servers, like thin, that use
-    sockets. Specify this *only* if you *must*.
-  * `-s`, `--socket SOCKNUM`:
-    Socket number to run chef-server-webui on, defaults to 0.
-  * `-n`, `--name NAME`:
-    Set the name of the application. This is used in the process title and
-    log file names.
-  * `-P`, `--pid PIDFILE`:
-    PID file, defaults to [Merb.root]/log/merb.main.pid for the master
-    process and[Merb.root]/log/merb.[port number].pid for  worker processes.
-    For clusters, use %s to specify where in the file chef-server-webui
-    should place the port number. For instance: -P myapp.%s.pid.
-  * `-h`, `--host HOSTNAME`:
-    Host to bind to (default is 0.0.0.0).
-  * `-m`, `--merb-root PATH_TO_APP_ROOT`:
-    The path to the Merb.root for the app you want to run
-    (default is current working directory).
-  * `-a`, `--adapter ADAPTER`:
-    The rack adapter to use to run chef-server-webui (default is mongrel)
-    [mongrel, emongrel, thin, ebb, fastcgi, webrick].
-  * `-R`, `--rackup FILE`:
-    Load an alternate Rack config file (default is config/rack.rb).
-  * `-i`, `--irb-console`:
-    This flag will start chef-server-webui in irb console mode. All your models
-    and other classes will be available for you in an irb session.
-  * `-S`, `--sandbox`:
-    This flag will enable a sandboxed irb console. If your ORM supports
-    transactions, all edits will be rolled back on exit.
-  * `-l`, `--log-level LEVEL`:
-    Log levels can be set to any of these options:
-    debug < info < warn < error < fatal (default is info).
-  * `-L`, `--log LOGFILE`:
-    A string representing the logfile to use. Defaults to
-    [Merb.root]/log/merb.[main].log for the master process and
-    [Merb.root]/log/merb[port number].logfor worker processes.
-  * `-e`, `--environment STRING`:
-    Environment to run Merb under [development, production, testing]
-    (default is development).
-  * `-r`, `--script-runner ['RUBY CODE'| FULL_SCRIPT_PATH]`:
-    Command-line option to run scripts and/or code in the chef-server-webui
-    app.
-  * `-K`, `-graceful PORT or all`:
-    Gracefully kill chef-server-webui proceses by port number.
-    Use chef-server -K all to gracefully kill all merbs.
-  * `-k`, `--kill PORT`:
-    Force kill one merb worker by port number. This will cause the worker
-    to be respawned.
-  * `--fast-deploy`:
-    Reload the code, but not yourinit.rb or gems.
-  * `-X`, `--mutex on/off`:
-    This flag is for turning the mutex lock on and off.
-  * `-D`, `--debugger`:
-    Run chef-server-webui using rDebug.
-  * `-V`, `--verbose`:
-    Print extra information.
-  * `-C`, `--console-trap`:
-    Enter an irb console on ^C.
-  * `-?`, `-H`, `--help`:
-    Show this help message.
-
-## DESCRIPTION
-
-The Chef Server WebUI (Management Console) is a Merb application slice.
-The default listen port is 4040.
-
-The Management Console is Chef Server's web interface. Nodes, roles,
-cookbooks, data bags, and API clients can be managed through the Management
-Console. Search can also be done on the console.
-
-In order to start using the Management Console, you need to first create
-a user or change the default password on the "admin" user.
-
-The default credentials are:
-
-- `Username`: admin
-- `Password`: p@ssw0rd1
-
-## SEE ALSO
-
-Full documentation for Chef and chef-server-webui (Management Console)
-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 for the Debian project (but may be used by others). 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.