deploys and configures apps using heroku buildpacks
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
libraries
providers
resources
templates/default
test/fixtures/cookbooks/fake
.gitignore
.kitchen.yml
Berksfile
Berksfile.lock
Gemfile
Gemfile.lock
README.md
Rakefile
metadata.rb

README.md

application_buildpack

Description

This cookbook is designed to be able to deploy applications using heroku buildpacks.

The following buildpacks are tested and supported:

  • ruby
  • nodejs

Note that this cookbook is based on the application cookbook; you will find general documentation in that cookbook.

Requirements

Chef 11.0.0 or higher required (for Chef environment use).

The following Opscode cookbooks are dependencies:

Resources/Providers

The LWRP provided by this cookbook is not meant to be used by itself; make sure you are familiar with the application cookbook before proceeding.

compile

The compile sub-resource LWRP deals with compiling an app using a buildpack.

Attribute Parameters

  • buildpack: The buildpack to be used. Will be used to install dependencies and set the buildpack repository. Default: nil. Options: :ruby, :nodejs
  • buildpack_repository: A custom buildpack repository that should be used instead. Default: nil.
  • buildpack_revision: The revision of the buildpack to be used. Default: master.
  • buildpack_environmet: Additional ENV variables to be passed to the buidlpack compile script. Default: {}.

scale

The scale sub-resource LWRP deals with configuring monit to start processes described in your Procfile.

Attribute Parameters

You can pass any attribute combination to scale the name of the attribute will be matched to a process described in your Procfile.

scale do
  # scale with one process
  web 1
  
  # scale with multiple processes
  # PROCESS_NUM env variable will indicate the processes id
  worker 4
  
  # send a custom signal on reload to gracefully stop the process
  guard 1, reload: 'USR1'

  # override or define missing entry
  whatever 1, run: '/bin/app-that-is-missing'
end

Usage

A sample recipe that deploy a Ruby app:

application 'example' do
  path '/srv/example'

  owner 'ubuntu'
  group 'ubuntu'

  packages ['git']
  repository 'https://github.com/heroku/ruby-rails-sample.git'
  
  environment 'PORT' => 8000

  compile do
    buildpack :ruby
  end
  
  scale do
    web 1
  end
end

A sample recipe that deploys an scala app using a custom buildpack

application 'example' do
  path '/srv/example'

  owner 'ubuntu'
  group 'ubuntu'

  packages ['git']
  repository 'https://github.com/heroku/scala-sample.git'

  compile do
    buildpack_repository 'https://github.com/heroku/heroku-buildpack-scala.git'
  end
  
  scale do
    web 1
  end
end

Buildpack Tool

While on the server you can use the buildpack tool to run commands in the environment of your app:

$ cd /srv/app/current
$ ./buildpack rake -T

Troubleshoot

  • If the buildpack fails to compile because some packages are missing, just define the packages in your application LWRP: packages ['lib-imagemagick'].
  • If the buildpack fails to compile due to a missing /app directory then the buidlpack uses hardcoded heroku paths. Create an issue on the repository or fork it.

Credits

Thanks to:

License

The MIT License (MIT)

Copyright (c) 2014 Joël Gähwiler

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.