1. mb(1)
  3. mb(1)

NAME

mb - command and control clusters of machines with Chef

SYNOPSIS

mb configure
mb console
mb purge HOST
mb version
mb template NAME PATH_OR_URL
mb environment
mb plugin
mb environment configure ENVIRONMENT FILE
mb environment destroy ENVIRONMENT
mb environment list
mb environment lock ENVIRONMENT
mb environment unlock ENVIRONMENT
mb environment create ENVIRONMENT
mb environment help [COMMAND]
mb plugin init [PATH]
mb plugin install NAME
mb plugin list
mb plugin show NAME
mb plugin uninstall NAME --version=VERSION
mb plugin help [COMMAND]
mb <plugin> nodes
mb <plugin> bootstrap MANIFEST
mb <plugin> provision MANIFEST
mb <plugin> upgrade
mb <plugin> <component> <command>

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.

With the exception of a few top-level commands, most motherbrain interactions use the commands defined in the selected plugin.

FILES

Provisioning and bootstrapping nodes require manifests. Insert manifest documentation.

OPTIONS

The following global options can be used on any motherbrain command to change the behavior.

-c, --config

Path to a motherbrain JSON configuration file.

-v, --verbose

Increase verbosity of output.

-d, --debug

Output all log messages.

-L, --logfile

Set the log file location.

-p, --plugin_version

Plugin version to use

-e, --environment

Chef environment

--on_environment_missing

What to do when the environment doesn't exist (Default: prompt)Possible values: prompt, create, quit

COMMANDS

mb configure
create a new configuration file based on a set of interactive questions

-f, --force
create a new configuration file even if one already exists.

mb console
Start an interactive motherbrain console

mb purge HOST
Remove Chef from node and purge it's data from the Chef server

--skip-chef
Skip removing the Chef installation from the node

mb version
Display version and license information

mb template NAME PATH_OR_URL
Download and install a bootstrap template

mb environment
Environment level commands

mb plugin
Plugin level commands

mb environment configure ENVIRONMENT FILE
configure a Chef environment

-f, --force
perform the configuration even if the environment is locked

mb environment destroy ENVIRONMENT
Destroy a provisioned environment

-y, --yes
Don't confirm, just destroy the environment
-f, --force
Force destruction of a locked environment
--provisioner=PROVISIONER
Provisioner to use for destroying the environment

mb environment list
List all environments

mb environment lock ENVIRONMENT
Lock an environment

mb environment unlock ENVIRONMENT
Unlock an environment

mb environment create ENVIRONMENT
Create an empty environment

mb environment help [COMMAND]
Describe subcommands or one specific subcommand

mb plugin init [PATH]
Generate a new motherbrain plugin in the target cookbook

mb plugin install NAME
Install a plugin from the remote Chef server

--version=VERSION
The version of the plugin to install

mb plugin list
List all installed plugins

--remote
search the remote Chef server and include plugins from the results

mb plugin show NAME
Show information about a plugin

--version=VERSION
The version of the plugin to display information for
--remote
Include plugins found on the remote Chef server

mb plugin uninstall NAME --version=VERSION
Uninstall a plugin from your Berkshelf

--version=VERSION (REQUIRED)
The version of the plugin to install

mb plugin help [COMMAND]
Describe subcommands or one specific subcommand

mb <plugin> nodes
List all nodes grouped by Component and Group

mb <plugin> bootstrap MANIFEST
Bootstrap a manifest of node groups

--chef-version=CHEF_VERSION
The version of Chef to bootstrap the node(s) with
--components, --component-versions=key:value
The component versions to set with default attributes
--cookbooks, --cookbook-versions=key:value
The cookbook versions to set on the environment
--attributes, --environment-attributes=key:value
Any additional attributes to set on the environment
--attributes-file, --environment-attributes-file=ENVIRONMENT_ATTRIBUTES_FILE
Any additional attributes to set on the environment via a json file.
--template=TEMPLATE
Path to bootstrap template (ERB)
-f, --force
Perform bootstrap even if the environment is locked

mb <plugin> provision MANIFEST
Create a cluster of nodes and add them to a Chef environment

--chef-version=CHEF_VERSION
The version of Chef to bootstrap the node(s) with
--components, --component-versions=key:value
The component versions to set with default attributes
--cookbooks, --cookbook-versions=key:value
The cookbook versions to set on the environment
--attributes, --environment-attributes=key:value
Any additional attributes to set on the environment
--attributes-file, --environment-attributes-file=ENVIRONMENT_ATTRIBUTES_FILE
Any additional attributes to set on the environment via a json file.
--skip-bootstrap
Nodes will be created and added to the Chef environment but not bootstrapped
--template=TEMPLATE
Path to bootstrap template (ERB)
--force
Perform bootstrap even if the environment is locked

mb <plugin> upgrade
Upgrade an environment to the specified versions

--components, --component-versions=key:value
The component versions to set with default attributes
--cookbooks, --cookbook-versions=key:value
The cookbook versions to set on the environment
--attributes, --environment-attributes=key:value
Any additional attributes to set on the environment
--attributes-file, --environment-attributes-file=ENVIRONMENT_ATTRIBUTES_FILE
Any additional attributes to set on the environment via a json file.
-f, --force
Perform upgrade even if the environment is locked

mb <plugin> <component> <command>
Run a command defined in a component in the specified plugin. Options and usage are plugin-defined.

motherbrain is Copyright (C) 2012-2013 Riot Games, Inc.

  2. September 2013
  3. mb(1)