Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

a simple Chef cookbook manager

branch: develop

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 examples
Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 whisk.gemspec
README.md

Whisk

Build Status

Whisk is a simple cookbook manager for Chef, inspired by librarian and berkshelf.

Unlike these tools, Whisk only concerns itself with fetching and preparing exactly what you tell it, and will not resolve dependencies for you or make any decisions about which code gets downloaded for you.

Whisk has been designed to work with git only and tries to help automating the more tedious aspects of working with the 'single git repository per cookbook' model.

Configuration

Whisk will prepare one or multiple 'bowls' of cookbooks as specified in your Whiskfile.

Example Whiskfile

whisk_dir = "#{ENV['HOME']}/whisk"
github = "git://github.com/opscode-cookbooks/%s.git"

bowl "testing" do
  path File.join(whisk_dir, "testing")
  ingredient 'openssh' do
    source github % 'openssh'
  end

  ingredient 'ntp' do
    source github % 'ntp'
  end
end

bowl "production" do
  path File.join(whisk_dir, "production")
  ingredient 'openssh' do
    source github % 'openssh'
    ref '1.0.0'
  end
end

Additionally, whisk can take advantage of knife to upload cookbooks. Whisk requires that the following code be added to your knife.rb

cookbook_path ENV['WHISK_COOKBOOK_PATH']

Commands

whisk destroy

Whisk destroys deletes the specified bowls or cookbooks from your filesystem. Use with care.

whisk diff

Whisk diff simply runs 'git diff' in each of the ingredients specified. It currently has no support for running diff with anything other than the default arguments

whisk list

The list subcommand will list the short name of all of the configured ingredients. This short name consists of the bowl and ingredient names separated by a forward slash. These short names maybe be used as filters for most other subcommands

$ whisk list
testing/openssh
testing/ntp
production/openssh

whisk prepare

The prepare subcommand allows you to clone your ingredients and optional checkout a specified ref.

$ whisk prepare
Creating bowl 'testing' with path /home/msf/whisk/testing
Preparing bowl 'testing' with path /home/msf/whisk/testing
Cloning ingredient 'openssh', from url
git://github.com/opscode-cookbooks/openssh.git
Cloning into 'openssh'...
Cloning ingredient 'ntp', from url
git://github.com/opscode-cookbooks/ntp.git
Cloning into 'ntp'...
Creating bowl 'production' with path /home/msf/whisk/production
Preparing bowl 'production' with path /home/msf/whisk/production
Cloning ingredient 'openssh', from url
git://github.com/opscode-cookbooks/openssh.git
Cloning into 'openssh'...
Checking out ref '1.0.0' for ingredient 'openssh'

You can also use specify a filter to run whisk subcommands on a subset of cookbooks by specifying the bowl and ingredient separated by a forward slash. Wildcards or optional matches can be specified by using ruby syntax.

# Given the Whiskfile as described earlier in the documentation
# prepare the 'development' bowl
$ whisk prepare 'dev.*'

# prepare the ntp cookbook in all configured bowls'
$ whisk prepare '.*/ntp'

# prepare a list of cookbooks
$ whisk prepare 'dev/(ssh|ntp)'

whisk status

Whisk status calls 'git status' on the specified set of ingredients.

You can use the same filter mechanisms as described in 'whisk prepare' to run update on a subset of ingredients

# show status for all configured bowls
$ whisk status
Status for bowl 'testing' with path /home/msf/whisk/testing
Status for ingredient 'openssh'
# On branch master
nothing to commit (working directory clean)
Status for ingredient 'ntp'
# On branch master
nothing to commit (working directory clean)
Status for bowl 'production' with path /home/msf/whisk/production
Status for ingredient 'openssh'
# Not currently on any branch.
nothing to commit (working directory clean)

whisk update

Whisk update calls 'git remote update' on the specified set of ingredients on them. It does not attempt to merge any code from your remotes.

You can use the same filter mechanisms as described in 'whisk prepare' to run update on a subset of ingredients

# update all ingredients, in all bowls
$ whisk update

# only update the 'development bowl'
$ whisk update dev

whisk upload

Whisk upload will upload all bowls specified by the Whiskfile to a chef server

# upload all bowls to the chef server
$ whisk upload
$ ruby bin/whisk upload
Uploading ingredients in bowl 'testing'
Uploading ntp                 [1.2.0]
Uploading openssh             [1.0.0]
Uploaded 2 cookbooks.
Uploading ingredients in bowl 'production'
Uploading openssh             [1.0.0]
Uploaded 1 cookbook.
Something went wrong with that request. Please try again.