Prepares a machine to be an Omnibus builder. ┬──┬◡ノ(° -°ノ)
Latest commit 2b17e34 Jul 31, 2017 @schisamo schisamo committed on GitHub Merge pull request #214 from legal90/fix-chef13
omnibus_build: Duplicate an immutable property

omnibus Cookbook

Cookbook Build Status

Prepares a machine to be an Omnibus builder.

This project is managed by the CHEF Release Engineering team. For more information on the Release Engineering team's contribution, triage, and release process, please consult the CHEF Release Engineering OSS Management Guide.


Starting with omnibus cookbook version 4.0.0:

  • Chef 11 is no longer supported, since 12.5.1 is required to use chef-ingredient. If needed, you can pin to omnibus version 3.2.x to preserve the old functionality.
  • Instead of compiling everything from source in this cookbook, the omnibus-toolchain package will be installed. This package contains patch, bash, make, git, ruby, rubygems, and bundler (built from omnibus-software definitions).


This cookbook requires Chef 12.5.1+.

For a full list of supported platforms and external cookbook requirements, please see the metadata.rb file at the root of the cookbook.


The default recipe is the main entrypoint for the cookbook and does the following:

  • Ensures all required Omnibus-related directories are created and owned by the build user.
  • Ensures a sane build tool-chain is installed and configured (using the build-essential cookbook)
  • Ensures the necessary tools to run an Omnibus project (ruby, git, etc) are installed (using the omnibus-toolchain package)
  • Includes a platform-specific recipe to apply additional tweaks as appropriate.

All other recipes should be treated as "private" and are not meant to be used individually. They only exist to support the default recipe.


Attribute Default Description
build_user omnibus The user to execute Omnibus builds as
base_dir Windows: C:/omnibus-ruby *nix: /var/cache/omnibus The "base" directory where Omnibus will store its data.



This resource is used to execute a build of an Omnibus project.


Attribute Default Description
project_name The name of the Omnibus project to build
project_dir The directory to install Omnibus
install_dir /opt/<PROJECT> The installation of the project being built
base_dir Windows: C:/omnibus-ruby *nix: /var/cache/omnibus The base directory for Omnibus
log_level :internal Log level used during the build. Valid values include: :internal, :debug, :info, :warn, :error, :fatal
config_file <PROJECT_DIR>/omnibus.rb Omnibus configuration file used for the build.
config_overrides {} Overrides for one or more Omnibus config options
expire_cache false Indicates the Omnibus cache (including git cache) should be wiped before building.
build_user node['omnibus']['build_user'] The user to execute the Omnibus build as.
environment {} Environment variables to set in the underlying build process.
live_stream false Indicates output of build process should be logged to Chef event stream.

Example Usage

omnibus_build 'harmony' do
  project\_dir ''
  log_level :internal
    append_timestamp: true


Include the omnibus::default recipe in your node's run list and override the cookbook's default attributes as desired. At the very least you will want to override node['omnibus']['install_dir'] to match the installation directory of your Omnibus project.

Using Test Kitchen with Docker

The following assumes you are on a Mac OS X workstation and have installed and started Kitematic.

  1. Set environment variables to point kitchen-docker at your local Kitematic instance:


export DOCKER_HOST=tcp://
export DOCKER_CERT_PATH=$HOME/.docker/machine/certs


set -gx DOCKER_HOST "tcp://"
set -gx DOCKER_CERT_PATH "$HOME/.docker/machine/certs"
  1. Run Test Kitchen with the provided .kitchen.docker.yml: kitchen verify languages-ruby-ubuntu-1204

License & Authors

Copyright:: 2012-2016, Chef Software, Inc. (<>)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.