vagrant-hp 0.1.0

data/.gitignore

@@ -0,0 +1,60 @@
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+Icon?
+ehthumbs.db
+Thumbs.db
+
+# Ruby file #
+#############
+Gemfile.lock
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1 (March 31, 2013)
+* Vagrant-Hp
+* Initial release.

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem "vagrant", :git => "git://github.com/mohitsethi/vagrant.git"
+end

data/README.md

@@ -0,0 +1,167 @@
+# Vagrant HP Provider
+
+This is a [Vagrant](http://www.vagrantup.com) 1.1+ plugin that adds an [HP](http://www.hpcloud.com)
+provider to Vagrant, allowing Vagrant to control and provision machines on HP Cloud.
+
+**NOTE:** This plugin requires Vagrant 1.1+,
+
+## Features
+
+* Boot Servers on HP Cloud
+* SSH into the instances.
+* Provision the instances with any built-in Vagrant provisioner.
+* Minimal synced folder support via `rsync`.
+
+## Usage
+
+Install using standard Vagrant 1.1+ plugin installation methods. After
+installing, `vagrant up` and specify the `hp` provider. An example is
+shown below.
+
+```
+$ vagrant plugin install vagrant-hp
+...
+$ vagrant up --provider=hp
+...
+```
+
+Of course prior to doing this, you'll need to obtain an HP-compatible
+box file for Vagrant.
+
+## Quick Start
+
+After installing the plugin (instructions above), the quickest way to get
+started is to actually use a dummy HP box and specify all the details
+manually within a `config.vm.provider` block. So first, add the dummy
+box using any name you want:
+
+```
+$ vagrant box add dummy https://github.com/mohitsethi/vagrant-hp/raw/master/dummy_hp.box
+...
+```
+
+And then make a Vagrantfile that looks like the following, filling in
+your information where necessary.
+
+```
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+
+  config.vm.provider :hp do |rs|
+    rs.access_key  = "<hp_access_key>"
+    rs.secret_key = "<hp_secret_key>"
+    rs.flavor   = "standard.xsmall"
+    rs.tenant_id = "<hp_tenant_id>"
+    rs.server_name = "<server_name>"
+    rs.image    = "Ubuntu Precise 12.04 LTS Server 64-bit 20121026 (b)"
+    rs.keypair_name = "<your_key_pair_name_on_hpcloud>"
+    rs.ssh_private_key_path = "<private_key_location>"
+    rs.ssh_username = "<ssh_username>"
+    rs.availability_zone = "az1"
+  end
+end
+```
+
+And then run `vagrant up --provider=hp`.
+
+This will start an Ubuntu 12.04 instance in the az1 availability zone within
+your HP Cloud account. And assuming your SSH information was filled in properly
+within your Vagrantfile, SSH and provisioning will work as well.
+
+Note that normally a lot of this boilerplate is encoded within the box
+file, but the box file used for the quick start, the "dummy" box, has
+no preconfigured defaults.
+
+## Box Format
+
+Every provider in Vagrant must introduce a custom box format. This
+provider introduces `hp` boxes. You can view an example box in
+the [example_box/ directory](https://github.com/mohitsethi/vagrant-hp/tree/master/example_box).
+That directory also contains instructions on how to build a box.
+
+The box format is basically just the required `metadata.json` file
+along with a `Vagrantfile` that does default settings for the
+provider-specific configuration for this provider.
+
+## Configuration
+
+This provider exposes quite a few provider-specific configuration options:
+
+* `access_key` - The access key for accessing HP Cloud
+* `image` - The Image-id  or Image-Name to boot, such as 
+    "Ubuntu Precise 12.04 LTS Server 64-bit 20121026 (b)"
+* `availability_zone` - The availability zone to launch the server. 
+    If nil, it will use 'az1'.
+* `flavor` - The type of flavor, such as "standard.xsmall"
+* `keypair_name` - The name of the keypair to use to bootstrap image
+   which support it.
+* `secret_key` - The secret access key for accessing HP Cloud.
+* `ssh_private_key_path` - The path to the SSH private key. This overrides
+  `config.ssh.private_key_path`.
+* `ssh_username` - The SSH username, which overrides `config.ssh.username`.
+* `server_name` - The name of the server provisioned on HP Cloud.
+* `tenant_id` - The tenant_id to launch the server.
+
+These can be set like typical provider-specific configuration:
+
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :hp do |rs|
+    rs.access_key  = "<hp_access_key>"
+    rs.secret_key = "<hp_secret_key>"
+    rs.flavor   = "standard.xsmall"
+    rs.tenant_id = "<hp_tenant_id>"
+    rs.server_name = "<server_name>"
+    rs.image    = "Ubuntu Precise 12.04 LTS Server 64-bit 20121026 (b)"
+    rs.keypair_name = "<your_key_pair_name_on_hpcloud>"
+    rs.ssh_private_key_path = "<private_key_location>"
+    rs.ssh_username = "<ssh_username>"
+    rs.availability_zone = "az1"
+  end
+
+end
+```
+
+## Networks
+
+Networking features in the form of `config.vm.network` are not
+supported with `vagrant-hp`, currently. If any of these are
+specified, Vagrant will emit a warning, but will otherwise boot
+the HP machine.
+
+## Synced Folders
+
+There is minimal support for synced folders. Upon `vagrant up`,
+`vagrant reload`, and `vagrant provision`, the HP provider will use
+`rsync` (if available) to uni-directionally sync the folder to
+the remote machine over SSH.
+
+This is good enough for all built-in Vagrant provisioners (shell,
+chef, and puppet) to work!
+
+## Development
+
+To work on the `vagrant-hp` plugin, clone this repository out, and use
+[Bundler](http://gembundler.com) to get the dependencies:
+
+```
+$ bundle
+```
+
+Once you have the dependencies, verify the unit tests pass with `rake`:
+
+```
+$ bundle exec rake
+```
+
+If those pass, you're ready to start developing the plugin. You can test
+the plugin without installing it into your Vagrant environment by just
+creating a `Vagrantfile` in the top level of this directory (it is gitignored)
+that uses it, and uses bundler to execute Vagrant:
+
+```
+$ bundle exec vagrant up --provider=hp
+```

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+# This installs the tasks that help with gem creation and
+# publishing.
+Bundler::GemHelper.install_tasks
+
+# Install the `spec` task so that we can run tests.
+RSpec::Core::RakeTask.new
+
+# Default task is to run the unit tests
+task :default => "spec"

data/example_box/README.md

@@ -0,0 +1,13 @@
+# Vagrant HP Example Box
+
+Vagrant providers each require a custom provider-specific box format.
+This folder shows the example contents of a box for the `hp` provider.
+To turn this into a box:
+
+```
+$ tar cvzf hp.box ./metadata.json ./Vagrantfile
+```
+
+This box works by using Vagrant's built-in Vagrantfile merging to setup
+defaults for HP. These defaults can easily be overwritten by higher-level
+Vagrantfiles (such as project root Vagrantfiles).

data/example_box/Vagrantfile

@@ -0,0 +1,7 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.provider :hp do |rs|
+  end
+end

data/example_box/metadata.json

@@ -0,0 +1,3 @@
+{
+    "provider": "hp"
+}

data/lib/vagrant-hp.rb

@@ -0,0 +1,18 @@
+require "pathname"
+
+require "vagrant-hp/plugin"
+
+module VagrantPlugins
+  module HP
+    lib_path = Pathname.new(File.expand_path("../vagrant-hp", __FILE__))
+    autoload :Action, lib_path.join("action")
+    autoload :Errors, lib_path.join("errors")
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/lib/vagrant-hp/action.rb

@@ -0,0 +1,110 @@
+#
+# Author:: Mohit Sethi (<mohit@sethis.in>)
+# Copyright:: Copyright (c) 2013 Mohit Sethi.
+#
+
+require "pathname"
+require "vagrant/action/builder"
+
+module VagrantPlugins
+  module HP
+    module Action
+      # Include the built-in modules so we can use them as top-level things.
+      include Vagrant::Action::Builtin
+
+      # This action is called to terminate the remote machine.
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectHP
+          b.use DeleteServer
+        end
+      end
+
+      # This action is called when `vagrant provision` is called.
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            b2.use SyncFolders
+            b2.use Provision
+          end
+        end
+      end
+
+      # This action is called to read the SSH info of the machine. The
+      # resulting state is expected to be put into the `:machine_ssh_info`
+      # key.
+      def self.action_read_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectHP
+          b.use ReadSSHInfo
+        end
+      end
+
+      # This action is called to read the state of the machine. The
+      # resulting state is expected to be put into the `:machine_state_id`
+      # key.
+      def self.action_read_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectHP
+          b.use ReadState
+        end
+      end
+
+      # This action is called to SSH into the machine.
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use SSHExec
+          end
+        end
+      end
+
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if env[:result]
+              b2.use MessageAlreadyCreated
+              next
+            end
+
+            b2.use ConnectHP
+            b2.use Provision
+            b2.use SyncFolders
+            b2.use WarnNetworks
+            b2.use CreateServer
+          end
+        end
+      end
+
+      # The autoload farm
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :ConnectHP, action_root.join("connect_hp")
+      autoload :IsCreated, action_root.join("is_created")
+      autoload :MessageAlreadyCreated, action_root.join("message_already_created")
+      autoload :MessageNotCreated, action_root.join("message_not_created")
+      autoload :ReadSSHInfo, action_root.join("read_ssh_info")
+      autoload :ReadState, action_root.join("read_state")
+      autoload :RunInstance, action_root.join("run_instance")
+      autoload :SyncFolders, action_root.join("sync_folders")
+      autoload :TimedProvision, action_root.join("timed_provision")
+      autoload :WarnNetworks, action_root.join("warn_networks")
+      autoload :CreateServer, action_root.join("create_server")
+      autoload :DeleteServer, action_root.join("delete_server")
+    end
+  end
+end

data/lib/vagrant-hp/action/connect_hp.rb

@@ -0,0 +1,54 @@
+#
+# Author:: Mohit Sethi (<mohit@sethis.in>)
+# Copyright:: Copyright (c) 2013 Mohit Sethi.
+#
+
+require "fog"
+require "log4r"
+
+module VagrantPlugins
+  module HP
+    module Action
+      # This action connects to HP, verifies credentials work, and
+      # puts the HP connection object into the `:hp_compute` key
+      # in the environment.
+      class ConnectHP
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_hp::action::connect_hp")
+        end
+
+        def call(env)
+          # Get the configs
+          config = env[:machine].provider_config
+          access_key = config.access_key
+          secret_key = config.secret_key
+          tenant_id = config.tenant_id
+          availability_zone = availability_zone(config.availability_zone)
+
+          @logger.info("Connecting to HP...")
+          env[:hp_compute] = Fog::Compute.new({
+            :provider => :hp,
+            :hp_access_key => access_key,
+            :hp_secret_key => secret_key,
+            :hp_tenant_id => tenant_id,
+            :hp_avl_zone => availability_zone,
+          })
+
+          @app.call(env)
+        end
+
+        def availability_zone(availability_zone)
+          case availability_zone
+          when 'az3'
+            return 'az-3.region-a.geo-1'
+          when 'az2'
+            return 'az-2.region-a.geo-1'
+          else
+            return 'az-1.region-a.geo-1'
+          end
+        end
+      end
+    end
+  end
+end