chef 13.11.3 → 13.12.3

data/distro/common/man/man8/chef-solo.8

@@ -1,260 +0,0 @@
-.\" Man page generated from reStructuredText.
-.
-.TH "CHEF-SOLO" "8" "Chef 12.0" "" "chef-solo"
-.SH NAME
-chef-solo \- The man page for the chef-solo command line tool.
-.
-.nr rst2man-indent-level 0
-.
-.de1 rstReportMargin
-\\$1 \\n[an-margin]
-level \\n[rst2man-indent-level]
-level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
--
-\\n[rst2man-indent0]
-\\n[rst2man-indent1]
-\\n[rst2man-indent2]
-..
-.de1 INDENT
-.\" .rstReportMargin pre:
-. RS \\$1
-. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
-. nr rst2man-indent-level +1
-.\" .rstReportMargin post:
-..
-.de UNINDENT
-. RE
-.\" indent \\n[an-margin]
-.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
-.nr rst2man-indent-level -1
-.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
-.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
-..
-.sp
-chef\-solo is an open source version of the chef\-client that allows using cookbooks with nodes without requiring access to a Chef server\&. chef\-solo runs locally and requires that a cookbook (and any of its dependencies) be on the same physical disk as the node. chef\-solo is a limited\-functionality version of the chef\-client and \fBdoes not support\fP the following:
-.INDENT 0.0
-.IP \(bu 2
-Node data storage
-.IP \(bu 2
-Search indexes
-.IP \(bu 2
-Centralized distribution of cookbooks
-.IP \(bu 2
-A centralized API that interacts with and integrates infrastructure components
-.IP \(bu 2
-Authentication or authorization
-.IP \(bu 2
-Persistent attributes
-.UNINDENT
-.sp
-\fBNOTE:\fP
-.INDENT 0.0
-.INDENT 3.5
-chef\-solo can be run as a daemon.
-.UNINDENT
-.UNINDENT
-.sp
-The chef\-solo executable is run as a command\-line tool.
-.sp
-\fBOptions\fP
-.sp
-This command has the following syntax:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-chef\-solo OPTION VALUE OPTION VALUE ...
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-This command has the following options:
-.INDENT 0.0
-.TP
-.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP
-The configuration file to use.
-.TP
-.B \fB\-d\fP, \fB\-\-daemonize\fP
-Use to run the executable as a daemon.  This option may not be used in the same command with the \fB\-\-[no\-]fork\fP option.
-.sp
-This option is only available on machines that run in UNIX or Linux environments. For machines that are running Microsoft Windows that require similar functionality, use the \fBchef\-client::service\fP recipe in the \fBchef\-client\fP cookbook: \fI\%http://community.opscode.com/cookbooks/chef\-client\fP\&.  This will install a chef\-client service under Microsoft Windows using the Windows Service Wrapper\&.
-.TP
-.B \fB\-E ENVIRONMENT_NAME\fP, \fB\-\-environment ENVIRONMENT_NAME\fP
-The name of the environment.
-.TP
-.B \fB\-f\fP, \fB\-\-[no\-]fork\fP
-Use to contain the chef\-client run in a secondary process with dedicated RAM. When the chef\-client run is complete the RAM will be returned to the master process. This option helps ensure that a chef\-client will use a steady amount of RAM over time because the master process will not run recipes. This option will also help prevent memory leaks (such as those that can be introduced by the code contained within a poorly designed cookbook). Use \fB\-\-no\-fork\fP to disable running the chef\-client in fork node. Default value: \fB\-\-fork\fP\&. This option may not be used in the same command with the \fB\-\-daemonize\fP and \fB\-\-interval\fP options.
-.TP
-.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
-The output format: \fBdoc\fP (default) or \fBmin\fP\&.
-.sp
-Use \fBdoc\fP to print the progress of the chef\-client run using full strings that display a summary of updates as they occur.
-.sp
-Use \fBmin\fP to print the progress of the chef\-client run using single characters. A summary of updates is printed at the end of the chef\-client run. A dot (\fB\&.\fP) is printed for events that do not have meaningful status information, such as loading a file or synchronizing a cookbook. For resources, a dot (\fB\&.\fP) is printed when the resource is up to date, an \fBS\fP is printed when the resource is skipped by \fBnot_if\fP or \fBonly_if\fP, and a \fBU\fP is printed when the resource is updated.
-.sp
-Other formatting options are available when those formatters are configured in the client.rb file using the \fBadd_formatter\fP option.
-.TP
-.B \fB\-\-force\-formatter\fP
-Use to show formatter output instead of logger output.
-.TP
-.B \fB\-\-force\-logger\fP
-Use to show logger output instead of formatter output.
-.TP
-.B \fB\-g GROUP\fP, \fB\-\-group GROUP\fP
-The name of the group that owns a process. This is required when starting any executable as a daemon.
-.TP
-.B \fB\-h\fP, \fB\-\-help\fP
-Shows help for the command.
-.TP
-.B \fB\-i SECONDS\fP, \fB\-\-interval SECONDS\fP
-The frequency (in seconds) at which the chef\-client runs. When the chef\-client is run at intervals, \fB\-\-splay\fP and \fB\-\-interval\fP values are applied before the chef\-client run. This option may not be used in the same command with the \fB\-\-[no\-]fork\fP option.
-.TP
-.B \fB\-j PATH\fP, \fB\-\-json\-attributes PATH\fP
-The path to a file that contains JSON data.
-.sp
-Use this option to define a \fBrun_list\fP object. For example, a JSON file similar to:
-.INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-"run_list": [
-  "recipe[base]",
-  "recipe[foo]",
-  "recipe[bar]",
-  "role[webserver]"
-],
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-may be used by running \fBchef\-client \-j path/to/file.json\fP\&.
-.sp
-In certain situations this option may be used to update \fBnormal\fP attributes.
-.sp
-\fBWARNING:\fP
-.INDENT 7.0
-.INDENT 3.5
-Any other attribute type that is contained in this JSON file will be treated as a \fBnormal\fP attribute. For example, attempting to update \fBoverride\fP attributes using the \fB\-j\fP option:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-{
-  "name": "dev\-99",
-  "description": "Install some stuff",
-  "override_attributes": {
-    "apptastic": {
-      "enable_apptastic": "false",
-      "apptastic_tier_name": "dev\-99.bomb.com"
-    }
-  }
-}
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-will result in a node object similar to:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-{
-  "name": "maybe\-dev\-99",
-  "normal": {
-  "name": "dev\-99",
-    "description": "Install some stuff",
-    "override_attributes": {
-      "apptastic": {
-        "enable_apptastic": "false",
-        "apptastic_tier_name": "dev\-99.bomb.com"
-      }
-    }
-  }
-}
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.UNINDENT
-.UNINDENT
-.TP
-.B \fB\-l LEVEL\fP, \fB\-\-log_level LEVEL\fP
-The level of logging that will be stored in a log file.
-.TP
-.B \fB\-L LOGLOCATION\fP, \fB\-\-logfile c\fP
-The location in which log file output files will be saved. If this location is set to something other than \fBSTDOUT\fP, standard output logging will still be performed (otherwise there would be no output other than to a file). This is recommended when starting any executable as a daemon.
-.TP
-.B \fB\-\-[no\-]color\fP
-Use to view colored output. Default setting: \fB\-\-color\fP\&.
-.TP
-.B \fB\-N NODE_NAME\fP, \fB\-\-node\-name NODE_NAME\fP
-The name of the node.
-.TP
-.B \fB\-o RUN_LIST_ITEM\fP, \fB\-\-override\-runlist RUN_LIST_ITEM\fP
-Replace the current run list with the specified items.
-.TP
-.B \fB\-r RECIPE_URL\fP, \fB\-\-recipe\-url RECIPE_URL\fP
-The URL location from which a remote cookbook tar.gz will be downloaded.
-.TP
-.B \fB\-\-run\-lock\-timeout SECONDS\fP
-The amount of time (in seconds) to wait for a chef\-client run to finish. Default value: not set (indefinite). Set to \fB0\fP to cause a second chef\-client to exit immediately.
-.TP
-.B \fB\-s SECONDS\fP, \fB\-\-splay SECONDS\fP
-A number (in seconds) to add to the \fBinterval\fP that is used to determine the frequency of chef\-client runs. This number can help prevent server load when there are many clients running at the same time. When the chef\-client is run at intervals, \fB\-\-splay\fP and \fB\-\-interval\fP values are applied before the chef\-client run.
-.TP
-.B \fB\-u USER\fP, \fB\-\-user USER\fP
-The user that owns a process. This is required when starting any executable as a daemon.
-.TP
-.B \fB\-v\fP, \fB\-\-version\fP
-The version of the chef\-client\&.
-.TP
-.B \fB\-W\fP, \fB\-\-why\-run\fP
-Use to run the executable in why\-run mode, which is a type of chef\-client run that does everything except modify the system. Use why\-run mode to understand why the chef\-client makes the decisions that it makes and to learn more about the current and proposed state of the system.
-.UNINDENT
-.sp
-\fBExamples\fP
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ chef\-solo \-c ~/solo.rb \-j ~/node.json \-r http://www.example.com/chef\-solo.tar.gz
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-The tar.gz archived into the \fBfile_cache_path\fP, and then extracted to \fBcookbooks_path\fP\&.
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ chef\-solo \-c ~/solo.rb \-j ~/node.json
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.sp
-chef\-solo will look in the solo.rb file to determine the directory in which cookbooks are located.
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-$ chef\-solo \-c ~/solo.rb \-j http://www.example.com/node.json \-r http://www.example.com/chef\-solo.tar.gz
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.SH AUTHOR
-Chef
-.\" Generated by docutils manpage writer.
-.

data/distro/common/markdown/README

@@ -1,3 +0,0 @@
-This directory contains markdown documentation that is used in other places.
-For example, markdown (.mkd) documents that are generated as man pages
-with ronn.

data/distro/common/markdown/man1/chef-shell.mkd

@@ -1,195 +0,0 @@
-chef-shell(1) -- Interactive Chef Console
-=========================================
-
-## SYNOPSIS
-
-__chef-shell__ [_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 session
-  * `-a`, `--standalone`:
-    standalone session
-  * `-v`, `--version`:
-    Show chef version
-  * `-h`, `--help`:
-    Show command options
-
-When no --config option is specified, chef-shell attempts to load a
-default configuration file:
-
-* If a _named configuration_ is given, chef-shell will load ~/.chef/_named
-  configuration_/chef_shell.rb
-* If no _named configuration_ is given chef-shell will load
-  ~/.chef/chef_shell.rb if it exists
-* 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.
-* The --config option takes precedence over implicit configuration
-  paths.
-
-## DESCRIPTION
-
-`chef-shell` is an irb(1) (interactive ruby) session customized for Chef.
-`chef-shell` 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
-
-chef-shell 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 chef-shell session
-  * `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, 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 _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://docs.chef.io/resources.html>
-  * <http://docs.chef.io/recipes.html>
-
-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
-
-`chef-shell` often does not perfectly replicate the context in which
-chef-client(8) configures a host, which may lead to discrepancies in
-observed behavior.
-
-`chef-shell` 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://docs.chef.io/ctl_chef_shell.html>
-
-## AUTHOR
-
-   Chef was written by Adam Jacob <adam@opscode.com> with many
-   contributions from the community. chef-shell 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
-
-   chef-shell is distributed with Chef. <http://docs.chef.io>