chef-metal 0.14.2 → 0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5749137daded5cf0892f7b9644a8ff02cc583dee
-  data.tar.gz: 71de4e147d8293f3ef2926782267ccd6a1b1b661
+  metadata.gz: 2f221c28948b41a195d4361334eb08a0fa9d8dd2
+  data.tar.gz: b93820c3fb7e4d855c4a77de770ca85de9bc567d
 SHA512:
-  metadata.gz: 139a845c49f82f68dbe825e3a979bc9089409dac57da88c3f882a3d29ebc502a3f01eddcd6b904a2f865cd9c1fc37051dc27dc612e80c32b1287ad9df1feac73
-  data.tar.gz: 16563847c88a20311a09aebc7c5aa565c49316cf5e19d95de5f8bea01f3d10f05fa5c907476ae03762d51bb1f561b01f37be9e92230be52499c3be0211161341
+  metadata.gz: bbd80f5ce21ea1fade973624fa8aee45cc7ad657d3ac15e410570bf62ad37e3e4b684be0978ddbe3e007b2ecd38ae916c04c781027fe0e925f217a02d3affc78
+  data.tar.gz: 98ff89fc7405ee116144e8cb3aa3bddf2d8ab6fd7f2968af4603196d7f57dd2efdf893473d1ec8c31b092bf1064d296a7df80b95784d9ec361733b9983660bf5

data/CHANGELOG.md

@@ -1,9 +1,13 @@
 # Chef Metal Changelog
 
+## 0.15 (9/28/2014)
+
+- Rename chef-metal to chef-provisioning
+
 ## 0.14.2 (9/2/2014)
 
 - Disable auto batching
-- Fix for with_machine_options context hash 
+- Fix for with_machine_options context hash
 - Pass timeout from execution_options to winrm set_timeout
 - Add better error message when driver does not specify driver_url
 - Add info that location.driver_url is required

data/README.md

@@ -1,258 +1,3 @@
-[![Stories in Ready](https://badge.waffle.io/opscode/chef-metal.png?label=ready&title=Ready)](https://waffle.io/opscode/chef-metal)
-Chef Metal
-==========
+This gem exists to provide a backwards-compatible link to `chef-provisioning`.
 
-This library solves the problem of repeatably creating machines and infrastructures in Chef.  It has a plugin model that lets you write bootstrappers for your favorite infrastructures, including VirtualBox, EC2, LXC, bare metal, and many more!
-
-[This video](https://www.youtube.com/watch?v=Yb8QdL30WgM) explains the basics of chef-metal (though provisioners are now called drivers).  Slides (more up to date) are [here](http://slides.com/jkeiser/chef-metal).
-
-Date       | Blog
------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------
-6/3/2014   | [machine_batch and parallelization](https://github.com/opscode/chef-metal/blob/master/docs/blogs/2012-05-28-machine_batch.html.markdown#chef-metal-parallelization)
-6/3/2014   | [Chef Metal, Configuration and Drivers](https://github.com/opscode/chef-metal/blob/master/docs/blogs/2012-05-22-new-driver-interface.html.markdown#chef-metal-configuration-and-drivers)
-3/4/2014   | [Chef Metal 0.2: Overview](http://www.getchef.com/blog/2014/03/04/chef-metal-0-2-release/) - this is a pretty good overview (though dated).
-12/20/2013 | [Chef Metal Alpha](http://www.getchef.com/blog/2013/12/20/chef-metal-alpha/)
-
-Documentation
--------------
-* [Configuration](https://github.com/opscode/chef-metal/blob/master/docs/configuration.md#configuring-and-using-metal-drivers)
-* [Writing Drivers](https://github.com/opscode/chef-metal/blob/master/docs/building_drivers.md#writing-drivers)
-* [Embedding](https://github.com/opscode/chef-metal/blob/master/docs/embedding.md)
-* [Providers](https://github.com/opscode/chef-metal/blob/master/docs/providers)
-
-Try It Out
-----------
-
-You can try out Metal in many different flavors.
-
-### Vagrant
-
-To give it a spin, install Vagrant and VirtualBox and try this from the `chef-metal/docs/examples` directory:
-
-```
-gem install chef-metal chef-metal-vagrant
-export CHEF_DRIVER=vagrant
-chef-client -z vagrant_linux.rb simple.rb
-```
-
-This will create two vagrant precise64 linux boxes, "mario" and "luigi1", in `~/machinetest`, bootstrapped to an empty runlist.  For Windows, you can replace `myapp::linux` with `myapp::windows`, but you'll need your own Windows vagrant box to do that (licensing!).
-
-### AWS
-
-If you have an AWS account, you can spin up a machine there like this:
-
-```
-gem install chef-metal chef-metal-fog
-export CHEF_DRIVER=fog:AWS
-chef-client -z simple.rb
-```
-
-This will create two linux boxes in the AWS account referenced by your default profile in `~/.aws/config` (or your environment variables).
-
-### DigitalOcean
-
-If you are on DigitalOcean and using the `tugboat` gem, you can do this:
-
-```
-gem install chef-metal chef-metal-fog
-export CHEF_DRIVER=fog:DigitalOcean
-chef-client -z simple.rb
-```
-
-If you aren't using the `tugboat` gem, you can put `driver` and `driver_options` into your `.chef/knife.rb` file.
-
-This will use your tugboat settings to create whatever sort of instance you normally create.
-
-### Cleaning up
-
-When you are done with the examples, run this to clean up:
-
-```
-chef-client -z destroy_all.rb
-```
-
-What Is Chef Metal?
--------------------
-
-Chef Metal has two major abstractions: the machine resource, and drivers.
-
-### The `machine` resource
-
-You declare what your machines do (recipes, tags, etc.) with the `machine` resource, the fundamental unit of Chef Metal.  You will typically declare `machine` resources in a separate, OS/provisioning-independent file that declares the *topology* of your app--your machines and the recipes that will run on them.
-
-The machine resources from the example [myapp::small](https://github.com/opscode/chef-metal/blob/master/cookbooks/myapp/recipes/small.rb) are pretty straightforward.  Here's a copy/paste:
-
-```ruby
-machine 'mario' do
-  recipe 'postgresql'
-  recipe 'mydb'
-  tag 'mydb_master'
-end
-
-num_webservers = 1
-
-1.upto(num_webservers) do |i|
-  machine "luigi#{i}" do
-    recipe 'apache'
-    recipe 'mywebapp'
-  end
-end
-```
-
-You will notice the dynamic nature of the number of web servers.  It's all code, your imagination is the limit :)
-
-### Drivers
-
-Drivers handle the real work of getting those abstract definitions into real, physical form.  They handle the following tasks, idempotently (you can run the resource again and again and it will only create the machine once--though it may notice things are wrong and fix them!):
-
-* Acquiring machines from the cloud, creating containers or VMs, or grabbing bare metal
-* Connecting to those machines via ssh, winrm, or other transports
-* Bootstrapping chef onto the machines and converging the recipes you suggested
-
-The driver API is separated out so that new drivers can be made with minimal effort (without having to rewrite ssh, tunneling, bootstrapping, and OS support).  But to the user, they appear as a single thing, so that the machine acquisition can use its smarts to autodetect the other bits (transports, OS's, etc.).
-
-Drivers save their data in the Chef node itself, so that they will be accessible to everyone who is using the Chef server to manage the nodes.
-
-Drivers each have their own repository.  Current drivers:
-
-**Cloud:**
-- [FOG: EC2, DigitalOcean, OpenStack, etc.](https://github.com/opscode/chef-metal-fog)
-
-**Virtualization:**
-- [Vagrant: VirtualBox, VMWare Fusion, etc.](https://github.com/opscode/chef-metal-vagrant)
-- [VSphere](https://github.com/RallySoftware-cookbooks/chef-metal-vsphere) (not yet up to date with 0.11)
-
-**Containers:**
-- [LXC](https://github.com/opscode/chef-metal-lxc) (not yet up to date with 0.11)
-- [Docker](https://github.com/opscode/chef-metal-docker) (not yet up to date with 0.11)
-
-**Bare Metal:**
-- [SSH (no PXE)](https://github.com/double-z/chef-metal-ssh) (not yet up to date with 0.11)
-
-### Anatomy of a Recipe
-
-chef-zero comes with a provisioner for Vagrant, an abstraction that covers VirtualBox, VMWare and other Virtual Machine drivers. In docs/examples, you can run this to try it:
-
-```ruby
-export CHEF_DRIVER=vagrant
-chef-client -z vagrant_linux.rb simple.rb
-```
-
-This is a chef-client run, which runs multiple **recipes.** Chef Metal is nothing but resources you put in recipes.
-
-The driver is specified on the command line.  Drivers are URLs.  You could use `vagrant:~/vms` or `fog:AWS:default:us-east-1' as driver URLs.  More information [here.](https://github.com/opscode/chef-metal/blob/master/docs/configuration.md#setting-the-driver-with-a-driver-url)
-
-The `vagrant_linux.rb` recipe handles the physical specification of the machines and Vagrant box:
-
-```ruby
-require 'chef_metal_vagrant'
-
-vagrant_box 'precise64' do
-  url 'http://files.vagrantup.com/precise64.box'
-end
-
-with_machine_options :vagrant_options => {
-  'vm.box' => 'precise64'
-}
-```
-
-`require 'chef_metal_vagrant'` is how we bring in the `vagrant_box` resource.
-
-`vagrant_box` makes sure a particular vagrant box exists, and lets you specify `machine_options` for things like port forwarding, OS definitions, and any other vagrant-isms.
-
-Typically, you declare these in separate files from your machine resources.  Chef Metal picks up the drivers and machine_options you have declared, and uses them to instantiate the machines you request.  The actual machine definitions, in this case, are in `simple.rb`, and are generic--you could use them against Azure or EC2 as well:
-
-```ruby
-machine 'mario' do
-  tag 'itsame'
-end
-```
-
-Other directives, like `recipe 'apache'`, help you set run lists and other information about the machine.
-
-### Fog (EC2, Openstack and friends)
-
-chef-metal also comes with a [Fog](http://fog.io/) provisioner that handles provisioning to Openstack, Rackspace, Amazon's EC2 and other cloud drivers.  Before you begin, you will need to put your AWS credentials in ~/.aws/config in the format [mentioned in Option 1 here](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#d0e726).  There are other ways to specify your credentials, but this is the standard one for the Amazon CLI.
-
-Once your credentials are in, basic usage looks like this:
-
-```
-export CHEF_DRIVER=fog:AWS
-chef-client -z simple.rb
-```
-
-Other valid URLs include `fog:AWS:myprofilename` and `fog:AWS:profilename:us-west-2`.
-
-Most Chef Metal drivers try hard to provide reasonable defaults so you can get started easily.  Once you have specified your credentials, AMIs and other things are chosen for you.
-
-You will usually want to create or input a custom key pair for bootstrap. To customize, specify keys and AMI and other options, you can make recipes like this:
-
-```ruby
-require 'chef_metal_fog'
-
-fog_key_pair 'my_bootstrap_key'
-
-with_machine_options :bootstrap_options => {
-  :key_name => 'my_bootstrap_key',
-  :image_id => 'ami-59a4a230',
-  :flavor_id => 't1.micro'
-}
-```
-
-`fog_key_pair` creates a new key pair (if the files do not already exist) and uploads it to AWS (it will toss an error if the key pair already exists and does not match). By default, `fog_key_pair` will look for matching key files in .chef/keys, ~/.chef/keys and ~/.ssh.  If it does not find one, it will place the key in `.chef/keys`.  You can override this path in fog_key_pair, but if you do, you will want to modify `private_key_paths` in your configuration to match.
-
-`with_machine_options` specifies machine_options that will be applied to any `machine` resources chef-client encounters.
-
-You will notice that we are still using `simple.rb` here.  Machine definitions are generally driver-independent.  This is an important feature that allows you to spin up your clusters in different places to create staging, test or miniature dev environments.
-
-### Pointing Boxes at Chef Servers
-
-By default, Chef Metal will put your boxes on the same Chef server you started chef-client with (in the case of -z, that's a local chef-zero server). Sometimes you want to put your boxes on different servers.  There are a couple of ways to do that:
-
-```ruby
-with_chef_local_server :chef_repo_path => '~/repo'
-```
-
-`with_chef_local_server` is a generic directive that creates a chef-zero server pointed at the given repository.  nodes, clients, data bags, and all data will be stored here on your provisioner machine if you do this.
-
-You can use `with_chef_server` instead if you want to point at OSS, Hosted or Enterprise Chef, and if you don't specify a Chef server at all, it will use the one you are running chef-client against. Keep in mind when using `with_chef_server` and running `chef-client -z` on your workstation that you will also need to set the client name and signing key for the chef server. If you've already got knife.rb set up, then something like this will correctly create a client for the chef server on instance using your knife.rb configuration:
-
-```ruby
-with_chef_server "https://chef-server.example.org",
-  :client_name => Chef::Config[:node_name],
-  :signing_key_filename => Chef::Config[:client_key]
-```
-
-**Note for Hosted/Enterprise Chef Servers**
-
-Currently, you will need to add the 'clients' group to the 'admin' group in order for machine provisioning to work:
-
-```
-knife edit /groups/admin.json -e <editor>
-```
-Then add:
-```
-{
-  "users": [
-    "pivotal" # This is an internal superuser for Hosted/Enterprise Chef
-  ],
-  "groups": [
-    "clients" # This is what you need to add
-  ]
-}
-```
-
-This can also be done through the Chef Server web UI (Administration tab > Groups > select admins Group > Add 'clients'
-
-
-Kitchen
--------
-
-Chef Metal also works with Test Kitchen, allowing you to test entire clusters, not just machines!  The repository for the kitchen-metal gem is https://github.com/doubt72/kitchen-metal.
-
-Bugs and The Plan
------------------
-
-Please submit bugs, gripes and feature requests at [https://github.com/opscode/chef-metal/issues](https://twitter.com/jkeiser2), contact jkeiser on Twitter at @jkeiser2, email at [jkeiser@getchef.com](mailto:jkeiser@getchef.com)
-
-To contribute, just make a PR in the appropriate repo--also, make sure you've [signed the Chef Contributor License Agreement](https://secure.echosign.com/public/hostedForm?formid=PJIF5694K6L) (quick couple of minutes online), since this is going into core Chef eventually. It takes some time to process, so if you've just done it, let me know in the PR :)  If you already signed this for a Chef contribution, you don't need to do so again--if you're not sure, you can check for your name [here](https://wiki.opscode.com/display/chef/Approved+Contributors)!
+Please load `https://github.com/opscode/chef-provisioning` now.

data/Rakefile

@@ -1,6 +1,2 @@
 require 'bundler'
 require 'bundler/gem_tasks'
-
-task :spec do
-  require File.expand_path('spec/run')
-end

data/lib/chef_metal.rb

@@ -1,87 +1 @@
-# Include recipe basics so require 'chef_metal' will load everything
-require 'chef_metal/recipe_dsl'
-require 'chef/server_api'
-require 'cheffish/basic_chef_client'
-require 'cheffish/merged_config'
-
-module ChefMetal
-  def self.inline_resource(action_handler, &block)
-    events = ActionHandlerForward.new(action_handler)
-    Cheffish::BasicChefClient.converge_block(nil, events, &block)
-  end
-
-  class ActionHandlerForward < Chef::EventDispatch::Base
-    def initialize(action_handler)
-      @action_handler = action_handler
-    end
-
-    attr_reader :action_handler
-
-    def resource_update_applied(resource, action, update)
-      prefix = action_handler.should_perform_actions ? "" : "Would "
-      update = Array(update).flatten.map { |u| "#{prefix}#{u}"}
-      action_handler.performed_action(update)
-    end
-  end
-
-  # Helpers for driver inflation
-  @@registered_driver_classes = {}
-  def self.register_driver_class(name, driver)
-    @@registered_driver_classes[name] = driver
-  end
-
-  def self.default_driver(config = Cheffish.profiled_config)
-    driver_for_url(config[:driver], config)
-  end
-
-  def self.driver_for_url(driver_url, config = Cheffish.profiled_config, allow_different_config = false)
-    #
-    # Create and cache the driver
-    #
-    #
-    # Figure out the driver class
-    #
-    scheme = driver_url.split(':', 2)[0]
-    require "chef_metal/driver_init/#{scheme}"
-    driver_class = @@registered_driver_classes[scheme]
-
-    #
-    # Merge in any driver-specific config
-    #
-    if config[:drivers] && config[:drivers][driver_url]
-      config = Cheffish::MergedConfig.new(config[:drivers][driver_url], config)
-    end
-
-    #
-    # Canonicalize the URL
-    #
-    canonicalized_url, canonicalized_config = driver_class.canonicalize_url(driver_url, config)
-    config = canonicalized_config if canonicalized_config
-
-    #
-    # Merge in config from the canonicalized URL if it is different
-    #
-    if canonicalized_url != driver_url
-      if config[:drivers] && config[:drivers][canonicalized_url]
-        config = Cheffish::MergedConfig.new(config[:drivers][canonicalized_url], config)
-      end
-    end
-
-    driver_class.from_url(canonicalized_url, config)
-  end
-
-  def self.connect_to_machine(machine_spec, config = Cheffish.profiled_config)
-    chef_server = Cheffish.default_chef_server(config)
-    if machine_spec.is_a?(String)
-      machine_spec = ChefMachineSpec.get(machine_spec, chef_server)
-    end
-    driver = driver_for_url(machine_spec.driver_url, config)
-    if driver
-      machine_options = { :convergence_options => { :chef_server => chef_server } }
-      machine_options = Cheffish::MergedConfig.new(config[:machine_options], machine_options) if config[:machine_options]
-      driver.connect_to_machine(machine_spec, machine_options)
-    else
-      nil
-    end
-  end
-end
+require 'chef/provisioning'

data/lib/chef_metal/action_handler.rb

@@ -1,66 +1 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Douglas Triggs (<doug@getchef.com>)
-#
-# Copyright (C) 2014, Chef, Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# This is the generic action handler
-module ChefMetal
-  class ActionHandler
-
-    # This should be replaced with whatever records the update; by default it
-    # essentially does nothing here.
-    def updated!
-      @updated = true
-    end
-
-    def should_perform_actions
-      true
-    end
-
-    def report_progress(description)
-      Array(description).each { |d| puts d }
-    end
-
-    def performed_action(description)
-      Array(description).each { |d| puts d }
-    end
-
-    # This should perform the actual action (e.g., converge) if there is an
-    # action that needs to be done.
-    def perform_action(description)
-      if should_perform_actions
-        result = yield
-      else
-        result = nil
-      end
-      performed_action(description)
-      result
-    end
-
-    # Open a stream which can be printed to and closed
-    def open_stream(name)
-      if block_given?
-        yield STDOUT
-      else
-        STDOUT
-      end
-    end
-
-    # A URL identifying the host node. nil if no such node.
-    def host_node
-    end
-  end
-end
+require "chef/provisioning/action_handler"