Orchestration and configuration of the code development life-cycle.
build help for a complete enumeration of Builderator's commands.
local [PROFILE = default]
Provision a local VM using Vagrant and, by default, VirtualBox. Uses Berkshelf to fetch cookbooks, and Chef to provision the VM.
ec2 [PROFILE = default]
Provision an EC2 VM using Vagrant. Same workflow as
local using the
image [PROFILE = default]
Use Packer to build an image(s) for the specified profile.
By default, the generated images are copied to their respective
ami_regions and tagged. Supply the
--no-copy flag to keep the new image from being automatically copied to its configured regions.
Configuration can be loaded from DSL files as well as JSON and command line arguments. By default, Builderator searches in your home directory (
$HOME/.builderator/Buildfile) and the working directory (
./Builderator) for DSL files. Configuration sources are layered and flattened into a single DSL in the following order:
- Global defaults defined in the Builderator sources
Config.defaultsset by plugins, tasks, etc. in code
Config.overridesset by plugins, tasks, etc. in code
- CLI arguments loaded from Thor
Additional documentation describes the configuration DSL interface.
Builderator integrates with other tools, including Berkshelf, Vagrant, and Packer, to orchestrate workflows by generating
Vagrantfiles, and JSON strings for Packer. This means that you can replace all of these files in your project with a single
The Berkshelf integration generates a Berksfile. The following configuration values are supported.
The generated Berksfile uses the
:gecode dependency resolver by default. To
:ruby solver, add this snippet to your Buildfile.
berkshelf do |berks| berks.solver :ruby end
For help debugging cookbook dependency issues, you can set the
environment variable and use the
--debug flag when running
export DEBUG_RESOLVER=1 build berks vendor --debug
The Packer integration generates a Packer JSON configuration and passes it to STDIN of
packer build -.
Builderator shells out to Vagrant to provision VMs on demand. Run
build vagrant plugins
to install required plugins for Builderator.
Builderator can automatically detect versions from SCM tags, increment the latest version of an SCM branch by a variety of steps, and create new SCM tags for new versions.
If the SCM has no version tags, Builderator will try to read the version from a VERSION file in the repository.
Additional documentation describes CLI commands, configuration, and detailed behavior.
Builderator includes a task to generate common project trees from configuration definitions and templates.
Each type of project is configurable via the project collection in the
generator.project :default do |default| default.ruby.version '2.1.5' default.builderator.version '~> 1.0' default.vagrant do |vagrant| vagrant.install false vagrant.version 'v1.8.0' vagrant.plugin 'vagrant-aws' vagrant.plugin 'vagrant-omnibus' end default.resource :berksfile do |berksfile| berksfile.path 'Berksfile', 'Berksfile.lock' berksfile.action :rm end default.resource :buildfile do |buildfile| buildfile.path 'Buildfile' buildfile.action :create buildfile.template 'template/Buildfile.erb' end # ... end
Valid actions for resources include
:create (update only if missing),
:sync (create or update with prompt), and
:sync actions require a valid template source.
By default, the
generator subcommand includes a
default project which removes Vagrant, Berkshelf, and Packer configurations.
Builderator includes two utilities to search for and clean up EC2 resources.
build-clean command prunes old EC2 resources in a region. The cleaner utility has configurable limits. For complete usage, run
build-data utility is a command line interface for Builderator's internal resource lookup API. It has a limited query interface that allows filters to be constructed from a trailing list of argument:
build-data image architecture x86_64 virtualization-type hvm ...
Pre-defined filters can also be applied with the
-f FILTER flag. These currently include
build-data help for a complete listing of commands and arguments.