Umbrella Project: Chef Workstation
CookbookOmnifetch
provides library code for fetching Chef cookbooks
from an artifact server (usually https://supermarket.chef.io),
git/github, a local path, or a chef-server to a local cache for
developement.
Add this line to your application's Gemfile:
gem 'cookbook-omnifetch'
And then execute:
$ bundle
Or install it yourself as:
$ gem install cookbook-omnifetch
Cookbook Omnifetch is designed to work with utilities from both the Berkshelf and Chef Software ecosystems, so you have to configure it before you can use it. In ChefDK, we do this:
# Configure CookbookOmnifetch's dependency injection settings to use our classes and config.
CookbookOmnifetch.configure do |c|
c.cache_path = File.expand_path('~/.chefdk/cache')
c.storage_path = Pathname.new(File.expand_path('~/.chefdk/cache/cookbooks'))
c.shell_out_class = ChefDK::ShellOut
c.cached_cookbook_class = ChefDK::CookbookMetadata
end
To download a cookbook:
fetcher = CookbookOmnifetch.init(dependency, source_options)
fetcher.install
To specify the cookbook you want, you give CookbookOmnifetch a
dependency object that responds to #name
and #version_constraint
,
e.g.:
require 'semverse'
Dependency = Struct.new(:name, :version_constraint)
my_dep = Dependency.new("apache2", Semverse::Constraint.new("~> 1.0"))
The source options for the cookbook are given as a Hash; the keys and
values vary based on the kind of storage location. As with Bundler's
gem
options, one key specifies the type of upstream service for the
cookbook while other keys specify other options specific to that type.
For example:
CookbookOmnifetch.init(dependency, artifact_server: "https://supermarket.chef.io/api/v1/cookbooks/apache2/versions/3.0.1/download")
CookbookOmnifetch.init(dependency, git: "git@github.com:svanzoest/apache2-cookbook.git", tag: "v3.0.1")
CookbookOmnifetch.init(dependency, github: "svanzoest/apache2-cookbook", tag: "v3.0.1")
CookbookOmnifetch.init(dependency, path: "~/chef-cookbooks/apache2")
For information on contributing to this project, see https://github.com/chef/chef/blob/master/CONTRIBUTING.md
After that:
git checkout -b my-new-feature
)git commit -asm 'Add some feature'
)git push origin my-new-feature
)This code was initially extracted from Berkshelf. Thanks to the Berkshelf core teams and contributors.