.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "MB" "1" "September 2013" "" ""
.
.SH "NAME"
\fBmb\fR \- command and control clusters of machines with Chef
.
.SH "SYNOPSIS"
\fBmb\fR configure
.
.br
\fBmb\fR console
.
.br
\fBmb\fR purge HOST
.
.br
\fBmb\fR version
.
.br
\fBmb\fR template NAME PATH_OR_URL
.
.br
\fBmb\fR environment
.
.br
\fBmb\fR plugin
.
.br
\fBmb\fR \fBenvironment\fR configure ENVIRONMENT FILE
.
.br
\fBmb\fR \fBenvironment\fR destroy ENVIRONMENT
.
.br
\fBmb\fR \fBenvironment\fR list
.
.br
\fBmb\fR \fBenvironment\fR lock ENVIRONMENT
.
.br
\fBmb\fR \fBenvironment\fR unlock ENVIRONMENT
.
.br
\fBmb\fR \fBenvironment\fR create ENVIRONMENT
.
.br
\fBmb\fR \fBenvironment\fR help [COMMAND]
.
.br
\fBmb\fR \fBplugin\fR init [PATH]
.
.br
\fBmb\fR \fBplugin\fR install NAME
.
.br
\fBmb\fR \fBplugin\fR list
.
.br
\fBmb\fR \fBplugin\fR show NAME
.
.br
\fBmb\fR \fBplugin\fR uninstall NAME \-\-version=VERSION
.
.br
\fBmb\fR \fBplugin\fR help [COMMAND]
.
.br
\fBmb\fR \fB<plugin>\fR nodes
.
.br
\fBmb\fR \fB<plugin>\fR bootstrap MANIFEST
.
.br
\fBmb\fR \fB<plugin>\fR provision MANIFEST
.
.br
\fBmb\fR \fB<plugin>\fR upgrade
.
.br
\fBmb\fR \fB<plugin>\fR \fB<component>\fR \fB<command>\fR
.
.br
.
.SH "DESCRIPTION"
motherbrain is an orchestration framework for Chef\. In the same way that you would use Chef\'s Knife command to create a single node, you can use motherbrain to create and control an entire application environment\.
.
.P
With the exception of a few top\-level commands, most motherbrain interactions use the commands defined in the selected plugin\.
.
.SH "FILES"
Provisioning and bootstrapping nodes require manifests\. Insert manifest documentation\.
.
.SH "OPTIONS"
The following global options can be used on any motherbrain command to change the behavior\.
.
.TP
\fB\-c\fR, \fB\-\-config\fR
Path to a motherbrain JSON configuration file\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Increase verbosity of output\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Output all log messages\.
.
.TP
\fB\-L\fR, \fB\-\-logfile\fR
Set the log file location\.
.
.TP
\fB\-p\fR, \fB\-\-plugin_version\fR
Plugin version to use
.
.TP
\fB\-e\fR, \fB\-\-environment\fR
Chef environment
.
.TP
\fB\-\-on_environment_missing\fR
What to do when the environment doesn\'t exist (Default: prompt)Possible values: prompt, create, quit
.
.SH "COMMANDS"
\fBmb\fR configure
.
.br
create a new configuration file based on a set of interactive questions
.
.TP
\-f, \-\-force
create a new configuration file even if one already exists\.
.
.br

.
.P
\fBmb\fR console
.
.br
Start an interactive motherbrain console
.
.P
\fBmb\fR purge HOST
.
.br
Remove Chef from node and purge it\'s data from the Chef server
.
.TP
\-\-skip\-chef
Skip removing the Chef installation from the node
.
.br

.
.P
\fBmb\fR version
.
.br
Display version and license information
.
.P
\fBmb\fR template NAME PATH_OR_URL
.
.br
Download and install a bootstrap template
.
.P
\fBmb\fR environment
.
.br
Environment level commands
.
.P
\fBmb\fR plugin
.
.br
Plugin level commands
.
.P
\fBmb\fR \fBenvironment\fR configure ENVIRONMENT FILE
.
.br
configure a Chef environment
.
.TP
\-f, \-\-force
perform the configuration even if the environment is locked
.
.br

.
.P
\fBmb\fR \fBenvironment\fR destroy ENVIRONMENT
.
.br
Destroy a provisioned environment
.
.TP
\-y, \-\-yes
Don\'t confirm, just destroy the environment
.
.br

.
.TP
\-f, \-\-force
Force destruction of a locked environment
.
.br

.
.TP
\-\-provisioner=PROVISIONER
Provisioner to use for destroying the environment
.
.br

.
.P
\fBmb\fR \fBenvironment\fR list
.
.br
List all environments
.
.P
\fBmb\fR \fBenvironment\fR lock ENVIRONMENT
.
.br
Lock an environment
.
.P
\fBmb\fR \fBenvironment\fR unlock ENVIRONMENT
.
.br
Unlock an environment
.
.P
\fBmb\fR \fBenvironment\fR create ENVIRONMENT
.
.br
Create an empty environment
.
.P
\fBmb\fR \fBenvironment\fR help [COMMAND]
.
.br
Describe subcommands or one specific subcommand
.
.P
\fBmb\fR \fBplugin\fR init [PATH]
.
.br
Generate a new motherbrain plugin in the target cookbook
.
.P
\fBmb\fR \fBplugin\fR install NAME
.
.br
Install a plugin from the remote Chef server
.
.TP
\-\-version=VERSION
The version of the plugin to install
.
.br

.
.P
\fBmb\fR \fBplugin\fR list
.
.br
List all installed plugins
.
.TP
\-\-remote
search the remote Chef server and include plugins from the results
.
.br

.
.P
\fBmb\fR \fBplugin\fR show NAME
.
.br
Show information about a plugin
.
.TP
\-\-version=VERSION
The version of the plugin to display information for
.
.br

.
.TP
\-\-remote
Include plugins found on the remote Chef server
.
.br

.
.P
\fBmb\fR \fBplugin\fR uninstall NAME \-\-version=VERSION
.
.br
Uninstall a plugin from your Berkshelf
.
.TP
\-\-version=VERSION (REQUIRED)
The version of the plugin to install
.
.br

.
.P
\fBmb\fR \fBplugin\fR help [COMMAND]
.
.br
Describe subcommands or one specific subcommand
.
.P
\fBmb\fR \fB<plugin>\fR nodes
.
.br
List all nodes grouped by Component and Group
.
.P
\fBmb\fR \fB<plugin>\fR bootstrap MANIFEST
.
.br
Bootstrap a manifest of node groups
.
.TP
\-\-chef\-version=CHEF_VERSION
The version of Chef to bootstrap the node(s) with
.
.br

.
.TP
\-\-components, \-\-component\-versions=key:value
The component versions to set with default attributes
.
.br

.
.TP
\-\-cookbooks, \-\-cookbook\-versions=key:value
The cookbook versions to set on the environment
.
.br

.
.TP
\-\-attributes, \-\-environment\-attributes=key:value
Any additional attributes to set on the environment
.
.br

.
.TP
\-\-attributes\-file, \-\-environment\-attributes\-file=ENVIRONMENT_ATTRIBUTES_FILE
Any additional attributes to set on the environment via a json file\.
.
.br

.
.TP
\-\-template=TEMPLATE
Path to bootstrap template (ERB)
.
.br

.
.TP
\-f, \-\-force
Perform bootstrap even if the environment is locked
.
.br

.
.P
\fBmb\fR \fB<plugin>\fR provision MANIFEST
.
.br
Create a cluster of nodes and add them to a Chef environment
.
.TP
\-\-chef\-version=CHEF_VERSION
The version of Chef to bootstrap the node(s) with
.
.br

.
.TP
\-\-components, \-\-component\-versions=key:value
The component versions to set with default attributes
.
.br

.
.TP
\-\-cookbooks, \-\-cookbook\-versions=key:value
The cookbook versions to set on the environment
.
.br

.
.TP
\-\-attributes, \-\-environment\-attributes=key:value
Any additional attributes to set on the environment
.
.br

.
.TP
\-\-attributes\-file, \-\-environment\-attributes\-file=ENVIRONMENT_ATTRIBUTES_FILE
Any additional attributes to set on the environment via a json file\.
.
.br

.
.TP
\-\-skip\-bootstrap
Nodes will be created and added to the Chef environment but not bootstrapped
.
.br

.
.TP
\-\-template=TEMPLATE
Path to bootstrap template (ERB)
.
.br

.
.TP
\-\-force
Perform bootstrap even if the environment is locked
.
.br

.
.P
\fBmb\fR \fB<plugin>\fR upgrade
.
.br
Upgrade an environment to the specified versions
.
.TP
\-\-components, \-\-component\-versions=key:value
The component versions to set with default attributes
.
.br

.
.TP
\-\-cookbooks, \-\-cookbook\-versions=key:value
The cookbook versions to set on the environment
.
.br

.
.TP
\-\-attributes, \-\-environment\-attributes=key:value
Any additional attributes to set on the environment
.
.br

.
.TP
\-\-attributes\-file, \-\-environment\-attributes\-file=ENVIRONMENT_ATTRIBUTES_FILE
Any additional attributes to set on the environment via a json file\.
.
.br

.
.TP
\-f, \-\-force
Perform upgrade even if the environment is locked
.
.br

.
.P
\fBmb\fR \fB<plugin>\fR \fB<component>\fR \fB<command>\fR
.
.br
Run a command defined in a component in the specified plugin\. Options and usage are plugin\-defined\.
.
.SH "COPYRIGHT"
motherbrain is Copyright (C) 2012\-2013 Riot Games, Inc\.