path: root/distro/common/man/man8/chef-solo.8

.\" 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.
.