vagrant-gq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 246a2947e46f054d53627c48b086bb9f576f9d50
+  data.tar.gz: 41b65e5ac21205edad25dc2026ee200939b25e65
+SHA512:
+  metadata.gz: c8a88b10952c45f78d1b65137f56aff9edef248a8847d32f3a6b22e12d30a6add2840d671e2d1bd97d0ac9ce81bece5b3204cad73ff1da5445dfb3f2e2c6e023
+  data.tar.gz: f25b9712c369852078109fcc5e74495ae47e05eca05305a34489b36c51b9390b0e42da2612777620624005c82cfd189750ec47f523f355727a19e549a524ebe5

data/.gitignore

@@ -0,0 +1,21 @@
+# OS-specific
+.DS_Store
+
+# editors
+*.swp
+
+# Bundler/Rubygems
+*.gem
+.bundle
+pkg/*
+tags
+Gemfile.lock
+
+# Vagrant
+.vagrant
+Vagrantfile
+!example_box/Vagrantfile
+
+# RVM files for gemset/ruby setting
+.ruby-*
+.rvmrc

data/Gemfile

@@ -0,0 +1,14 @@
+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/mitchellh/vagrant.git"
+end
+
+group :plugins do
+    gem "vagrant-gq", :path => "."
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+Copyright (c) 2014 GreenQloud
+
+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.
+
+
+
+Vagrant-gq is a fork of vagrant-aws, which bears the following license:
+
+
+The MIT License (MIT)
+Copyright (c) 2014 Mitchell Hashimoto
+
+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.

data/README.md

@@ -0,0 +1,169 @@
+# Vagrant GQ Provider 
+
+This is a [Vagrant](http://www.vagrantup.com) 1.2+ plugin that adds a [GreenQloud](http://www.greenqloud.com)
+provider to Vagrant, allowing Vagrant to control and provision machines in GreenQloud.
+
+**NOTE:** This plugin requires Vagrant 1.2+,
+
+## Features
+
+* Boot GreenQloud instances.
+* SSH into the instances.
+* Provision the instances with any built-in Vagrant provisioner.
+* Minimal synced folder support via `rsync`.
+* Define region-specifc configurations so Vagrant can manage machines
+  in multiple regions.
+
+## Usage
+
+Install using standard Vagrant 1.1+ plugin installation methods. After
+installing, `vagrant up` and specify the `gq` provider. An example is
+shown below.
+
+```
+$ vagrant plugin install vagrant-gq
+...
+$ vagrant up --provider=gq
+...
+```
+
+Of course prior to doing this, you'll need to obtain an GreenQloud compatible
+box file for Vagrant.
+
+## Quick Start
+
+After installing the plugin (instructions above), the quickest way to get
+started is to actually use a generic GreenQloud box and specify all the details
+manually within a `config.vm.provider` block, in your Vagrantfile:
+
+```
+Vagrant.configure("2") do |config|
+  config.vm.box = "greenqloud-generic"
+  config.vm.box_url = "https://vagrant.s.greenqloud.com/greenqloud-generic.box"
+
+  config.vm.provider :gq do |gq, override|
+    gq.access_key_id = "YOUR KEY"
+    gq.secret_access_key = "YOUR SECRET KEY"
+    gq.keypair_name = "KEYPAIR NAME"
+
+    gq.qmi = "qmi-60ce3bb8"
+
+    override.ssh.username = "ubuntu"
+    override.ssh.private_key_path = "PATH TO YOUR PRIVATE KEY"
+  end
+end
+```
+
+And then run `vagrant up --provider=gq`.
+
+This will start an Ubuntu 14.04 instance in the within your 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 "generic" box, has
+no preconfigured defaults.
+
+If you have issues with SSH connecting, make sure that the instances
+are being launched with a security group that allows SSH access.
+
+## Box Format
+
+Every provider in Vagrant must introduce a custom box format. This
+provider introduces `gq` boxes. You can view an example box in
+the [example_box/ directory](https://github.com/greenqloud/vagrant-gq/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_id` - The access key for accessing GreenQloud
+* `qmi` - The QMI id to boot, such as "qmi-12345678"
+* `availability_zone` - The availability zone within the region to launch
+  the instance. If nil, it will use the default set by Amazon.
+* `instance_ready_timeout` - The number of seconds to wait for the instance
+  to become "ready" in GreenQloud. Defaults to 120 seconds.
+* `instance_type` - The type of instance, such as "m1.small". The default
+  value of this if not specified is "m1.small".
+* `keypair_name` - The name of the keypair to use to bootstrap QMIs
+   which support it.
+* `secret_access_key` - The secret access key for accessing GreenQloud
+* `security_groups` - An array of security groups for the instance.
+* `tags` - A hash of tags to set on the machine.
+
+These can be set like typical provider-specific configuration:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :gq do |gq|
+    gq.access_key_id = "foo"
+    gq.secret_access_key = "bar"
+  end
+end
+```
+
+## Networks
+
+Networking features in the form of `config.vm.network` are not
+supported with `vagrant-gq`, currently. If any of these are
+specified, Vagrant will emit a warning, but will otherwise boot
+the GreenQloud machine.
+
+## Synced Folders
+
+There is minimal support for synced folders. Upon `vagrant up`,
+`vagrant reload`, and `vagrant provision`, the GreenQloud 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!
+
+## Other Examples
+
+### Tags
+
+To use tags, simply define a hash of key/value for the tags you want to associate to your instance, like:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :gq do |gq|
+    gq.tags = {
+	  'Name' => 'Some Name',
+	  'Some Key' => 'Some Value'
+    }
+  end
+end
+```
+
+### User data
+
+You can specify user data for the instance being booted.
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :gq do |gq|
+    # Option 1: a single string
+    gq.user_data = "#!/bin/bash\necho 'got user data' > /tmp/user_data.log\necho"
+
+    # Option 2: use a file
+    gq.user_data = File.read("user_data.txt")
+  end
+end
+```
+
+## Acknowledgements
+
+Vagrant-gq is a fork of vagrant-aws, copyright Mitchell Hashimoto. See the LICENSE file for further details.
+

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 GreenQloud Example Box
+
+Vagrant providers each require a custom provider-specific box format.
+This folder shows the example contents of a box for the `gq` provider.
+To turn this into a box:
+
+```
+$ tar cvzf gq.box ./metadata.json ./Vagrantfile
+```
+
+This box works by using Vagrant's built-in Vagrantfile merging to setup
+defaults for GreenQloud. These defaults can easily be overwritten by higher-level
+Vagrantfiles (such as project root Vagrantfiles).

data/example_box/metadata.json

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

data/lib/vagrant-gq/action/connect_gq.rb

@@ -0,0 +1,47 @@
+require "fog"
+require "log4r"
+
+module VagrantPlugins
+  module GQ
+    module Action
+      # This action connects to GQ, verifies credentials work, and
+      # puts the GQ connection object into the `:gq_compute` key
+      # in the environment.
+      class ConnectGQ
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_gq::action::connect_gq")
+        end
+
+        def call(env)
+          # Get the region we're going to booting up in
+          region = env[:machine].provider_config.region
+
+          # Get the configs
+          region_config = env[:machine].provider_config.get_region_config(region)
+
+          # Build the fog config
+          fog_config = {
+            :provider => :aws,
+          }
+          if region_config.use_iam_profile
+            fog_config[:use_iam_profile] = true
+          else
+            fog_config[:aws_access_key_id] = region_config.access_key_id
+            fog_config[:aws_secret_access_key] = region_config.secret_access_key
+          end
+
+          fog_config[:endpoint] = "https://api.greenqloud.com/"
+
+          # fog_config[:endpoint] = region_config.endpoint if region_config.endpoint
+          # fog_config[:version]  = region_config.version if region_config.version
+
+          @logger.info("Connecting to GQ...")
+          env[:gq_compute] = Fog::Compute.new(fog_config)
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-gq/action/is_created.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module GQ
+    module Action
+      # This can be used with "Call" built-in to check if the machine
+      # is created and branch in the middleware.
+      class IsCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id != :not_created
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-gq/action/is_stopped.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module GQ
+    module Action
+      # This can be used with "Call" built-in to check if the machine
+      # is stopped and branch in the middleware.
+      class IsStopped
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id == :stopped
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-gq/action/message_already_created.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module GQ
+    module Action
+      class MessageAlreadyCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t("vagrant_gq.already_status", :status => "created"))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-gq/action/message_not_created.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module GQ
+    module Action
+      class MessageNotCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t("vagrant_gq.not_created"))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-gq/action/message_will_not_destroy.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module GQ
+    module Action
+      class MessageWillNotDestroy
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t("vagrant_gq.will_not_destroy", name: env[:machine].name))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-gq/action/read_ssh_info.rb

@@ -0,0 +1,53 @@
+require "log4r"
+
+module VagrantPlugins
+  module GQ
+    module Action
+      # This action reads the SSH info for the machine and puts it into the
+      # `:machine_ssh_info` key in the environment.
+      class ReadSSHInfo
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_gq::action::read_ssh_info")
+        end
+
+        def call(env)
+          env[:machine_ssh_info] = read_ssh_info(env[:gq_compute], env[:machine])
+
+          @app.call(env)
+        end
+
+        def read_ssh_info(gq, machine)
+          return nil if machine.id.nil?
+
+          # Find the machine
+          server = gq.servers.get(machine.id)
+          if server.nil?
+            # The machine can't be found
+            @logger.info("Machine couldn't be found, assuming it got destroyed.")
+            machine.id = nil
+            return nil
+          end
+
+          # read attribute override
+          ssh_host_attribute = machine.provider_config.
+              get_region_config(machine.provider_config.region).ssh_host_attribute
+          # default host attributes to try. NOTE: Order matters!
+          ssh_attrs = [:public_ip_address, :dns_name, :private_ip_address]
+          ssh_attrs = (Array(ssh_host_attribute) + ssh_attrs).uniq if ssh_host_attribute
+          # try each attribute, get out on first value
+          host_value = nil
+          while !host_value and attr_name = ssh_attrs.shift
+            begin
+              host_value = server.send(attr_name)
+            rescue NoMethodError
+              @logger.info("SSH host attribute not found #{attr_name}")
+            end
+          end
+
+          return { :host => host_value, :port => 22 }
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-gq/action/read_state.rb

@@ -0,0 +1,38 @@
+require "log4r"
+
+module VagrantPlugins
+  module GQ
+    module Action
+      # This action reads the state of the machine and puts it in the
+      # `:machine_state_id` key in the environment.
+      class ReadState
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_gq::action::read_state")
+        end
+
+        def call(env)
+          env[:machine_state_id] = read_state(env[:gq_compute], env[:machine])
+
+          @app.call(env)
+        end
+
+        def read_state(gq, machine)
+          return :not_created if machine.id.nil?
+
+          # Find the machine
+          server = gq.servers.get(machine.id)
+          if server.nil? || [:"shutting-down", :terminated].include?(server.state.to_sym)
+            # The machine can't be found
+            @logger.info("Machine not found or terminated, assuming it got destroyed.")
+            machine.id = nil
+            return :not_created
+          end
+
+          # Return the state
+          return server.state.to_sym
+        end
+      end
+    end
+  end
+end