Skip to content

Latest commit

 

History

History
125 lines (94 loc) · 3.95 KB

README.md

File metadata and controls

125 lines (94 loc) · 3.95 KB
Raw

just-ruby Omnibus project

This project creates full-stack platform-specific packages for just-ruby!

Installation

You must have a sane Ruby 2.0.0+ environment with Bundler installed. Ensure all the required gems are installed:

$ bundle install --binstubs

Usage

Build

You create a platform-specific package using the build project command:

$ bin/omnibus build just-ruby

The platform/architecture type of the package created will match the platform where the 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 pkg/ folder.

Clean

You can clean up all temporary files generated during the build process with the clean command:

$ bin/omnibus clean just-ruby

Adding the --purge purge option removes ALL files generated during the build including the project install directory (/opt/just-ruby) and the package cache directory (/var/cache/omnibus/pkg):

$ bin/omnibus clean just-ruby --purge

Publish

Omnibus has a built-in mechanism for releasing to a variety of "backends", such as Amazon S3. You must set the proper credentials in your omnibus.rb config file or specify them via the command line.

$ bin/omnibus publish path/to/*.deb --backend s3

Help

Full help for the Omnibus command line interface can be accessed with the help command:

$ bin/omnibus help

Version Manifest

Git-based software definitions may specify branches as their default_version. In this case, the exact git revision to use will be determined at build-time unless a project override (see below) or external version manifest is used. To generate a version manifest use the omnibus manifest command:

omnibus manifest PROJECT -l warn

This will output a JSON-formatted manifest containing the resolved version of every software definition.

Kitchen-based Build Environment

Every Omnibus project ships with a project-specific Berksfile that will allow you to build your omnibus projects on all of the platforms listed in the .kitchen.yml. You can add/remove additional platforms as needed by changing the list found in the .kitchen.yml platforms YAML stanza.

This build environment is designed to get you up-and-running quickly. However, there is nothing that restricts you from 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.yml (or .kitchen.local.yml) to your liking, you can bring up an individual build environment using the kitchen command.

$ bin/kitchen converge ubuntu-1804

Then login to the instance and build the project as described in the Usage section:

$ bin/kitchen login ubuntu-1804
[vagrant@ubuntu...] $ .  load-omnibus-toolchain.sh
[vagrant@ubuntu...] $ [ -e .bundle ] && sudo chown -R vagrant:vagrant .bundle
[vagrant@ubuntu...] $ cd just-ruby   # or 'cd just-ruby/omnibus' if your omnibus project is embedded in your main project
[vagrant@ubuntu...] $ bundle install
[vagrant@ubuntu...] $ bin/omnibus build just-ruby

For a complete list of all commands and platforms, run kitchen list or kitchen help.

omnibus-just-ruby