Client Tools Omnibus project
This project creates full-stack platform-specific packages for the following projects:
- Push Jobs Client
You must have a sane Ruby 1.9+ environment with Bundler installed. Ensure all the required gems are installed:
$ bundle install --without development
You create a platform-specific package using the
build project command:
$ bundle exec omnibus build <PROJECT>
The platform/architecture type of the package created will match the platform
build project command is invoked. For example, running this command
on a MacBook Pro will generate a Mac OS X package. After the build completes
packages will be available in the
You can clean up all temporary files generated during the build process with
$ bundle exec omnibus clean <PROJECT>
--purge purge option removes ALL files generated during the
build including the project install directory (
the package cache directory (
$ bundle exec omnibus clean <PROJECT> --purge
Omnibus has a built-in mechanism for releasing to a variety of "backends", such
as Amazon S3 and Artifactory. You must set the proper credentials in your
config file or specify them via the command line.
$ bundle exec omnibus publish path/to/*.deb --backend s3
Full help for the Omnibus command line interface can be accessed with the
$ bundle exec omnibus help
Kitchen-based Build Environment
Every Omnibus project ships will a project-specific
Berksfile that will allow you to build your omnibus projects on all of the projects listed
.kitchen.yml. You can add/remove additional platforms as needed by
changing the list found in the
platforms YAML stanza.
This build environment is designed to get you up-and-running quickly. However, there is nothing that restricts you to building on other platforms. Simply use the omnibus cookbook to setup your desired platform and execute the build steps listed above.
The default build environment requires Test Kitchen and VirtualBox for local development. Test Kitchen also exposes the ability to provision instances using various cloud providers like AWS, DigitalOcean, or OpenStack. For more information, please see the Test Kitchen documentation.
Once you have tweaked your
.kitchen.local.yml) to your
liking, you can bring up an individual build environment using the
$ bundle exec kitchen converge <PROJECT>-ubuntu-1204
Then login to the instance and build the project as described in the Usage section:
$ bundle exec kitchen login <PROJECT>-ubuntu-1204 [vagrant@ubuntu...] $ cd omnibus-chef [vagrant@ubuntu...] $ bundle install --without development # Don't install dev tools! [vagrant@ubuntu...] $ ... [vagrant@ubuntu...] $ bundle exec omnibus build <PROJECT> -l internal
You can also login to Windows instances but will have to manually call the
load-omnibus-toolchain.bat script which initializes the build environment.
Please note the mounted code directory is also at
as opposed to
$ bundle exec kitchen login <PROJECT>-windows-81-professional Last login: Sat Sep 13 10:19:04 2014 from 172.16.27.1 Microsoft Windows [Version 6.3.9600] (c) 2013 Microsoft Corporation. All rights reserved. C:\Users\vagrant>load-omnibus-toolchain.bat C:\Users\vagrant>cd C:\home\vagrant\omnibus-chef C:\home\vagrant\omnibus-chef>bundle install --without development C:\home\vagrant\omnibus-chef>bundle exec omnibus build <PROJECT> -l internal
For a complete list of all commands and platforms, run
kitchen list or
Copyright 2012-2014 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 http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.