Giter VIP home page Giter VIP logo

ruby-buildpack's Introduction

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

ruby-buildpack's People

Contributors

hone avatar schneems avatar ddollar avatar danfinnie avatar danp avatar catsby avatar wuputah avatar squeedee avatar jordi-pivotal avatar buddhistpirate avatar yangchenyun avatar rcs avatar icco avatar crohr avatar araher avatar siong1987 avatar stevenh512 avatar sumbach avatar oguzbilgic avatar mikehale avatar mmcgrana avatar jkrall avatar jvanbaarsen avatar gabrielg avatar xentek avatar dgrizzanti avatar cjolly avatar benizi avatar arthurnn avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.