Cloud Foundry buildpack: Ruby

A Cloud Foundry buildpack for Ruby based apps.

This is based on the [Heroku buildpack] (https://github.com/heroku/heroku-buildpack-ruby).

Additional information can be found at CloudFoundry.org.

Usage

This buildpack will be used if your app has a Gemfile and Gemfile.lock in the root directory. It will then use Bundler to install your dependencies.

cf push my_app -b https://github.com/cloudfoundry/buildpack-ruby.git

Cloud Foundry Extensions - Offline Mode

The primary purpose of extending the heroku buildpack is to cache system dependencies for firewalled or other non-internet accessible environments. This is called 'offline' mode.

'offline' buildpacks can be used in any environment where you would prefer the dependencies to be cached instead of fetched from the internet.

The list of what is cached is maintained in bin/package.

Using cached system dependencies is accomplished by monkey-patching the heroku buildpack. See lib/cloud_foundry/language_pack.

App Dependencies in Offline Mode

Offline mode expects each app to vendor its dependencies using Bundler. The alternative is to set up a local rubygems server.

Building

1. Make sure you have fetched submodules

git submodule update --init

1. Build the buildpack

bin/package [ online | offline ]

1. Use in Cloud Foundry

   Either:

   Fork the repository, push your changes and specify the path when deploying your app

   cf push my_app --buildpack <new buildpack repository>

   OR

   Upload the buildpack to your Cloud Foundry and specify it by name

   cf create-buildpack custom_ruby_buildpack ruby_buildpack-offline-custom.zip 1

Contributing

Run the Tests

There are Machete based integration tests available in cf_spec.

The test script is included in machete and can be run as follows:

BUNDLE_GEMFILE=cf.Gemfile bundle install
git submodule update --init
`BUNDLE_GEMFILE=cf.Gemfile bundle show machete`/scripts/buildpack-build [mode]

buildpack-build will create a buildpack in one of two modes and upload it to your local bosh-lite based Cloud Foundry installations.

Valid modes:

online : Dependencies can be fetched from the internet.

offline : Dependencies, such as ruby, are installed from a cache included in the buildpack.

The tests expect two Cloud Foundry installations to be present, an online one at 10.244.0.34 and an offline one at 10.245.0.34.

We use bosh-lite for the online instance and bosh-lite-2nd-instance for the offline instance.

Pull Requests

1. Fork the project
2. Submit a pull request

Reporting Issues

Open an issue on this project

Active Development

The project backlog is on Pivotal Tracker