vagrant-vrealize 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad1b04231e2f9e5bef5be02d82619f23c1e58e92
+  data.tar.gz: 6ff3de905eba3c5c8cb89faecf8adad6e16d4590
+SHA512:
+  metadata.gz: cb6148f910dd75743a66f56dfcfb1c30dcb619a23392974b21b5c739a80acb3c73832d2e5d91a061a403f0e65456d02da23af5cee3acd060242f4f892a425113
+  data.tar.gz: 3e270ef65ac5aabf2592ea3cdf84c7c346db9a5c122010bab161cead76254c9908a2b3e825c043df6faa82765774a84f138eb12f07e87a02fa7504ff26d02f50

data/CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# How To Contribute
+
+We want your patches!  `vagrant-vrealize` isn't done yet, and anything
+you've got to contribute will be gratefully received.
+
+If there's something you want to add:
+
+1. Make a local branch, give it a meaningful name
+2. Make your change
+3. Push the branch to github
+4. Make a pull request to `master`.
+5. It'll be reviewed, QA'd, and hopefully merged.
+
+If you're contributing a complete feature or a bug-fix, this will
+probably trigger a version bump and a release of the gem, but I'll
+take care of that.

data/LICENSE

@@ -0,0 +1,55 @@
+Copyright (c) 2016 Sky UK Ltd
+Copyright (c) 2014 Mitchell Hashimoto
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+This is a derived work, based upon
+https://github.com/mitchellh/vagrant-aws, which was conveyed under the
+following license:
+
+The MIT License (MIT)
+
+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,132 @@
+# Vagrant VRealize Provider
+
+This is a [Vagrant](http://www.vagrantup.com) 1.2+ plugin that adds a VDC
+provider to Vagrant, allowing Vagrant to control and provision machines in
+VRealize.
+
+**NOTE:** This plugin requires Vagrant 1.2+,
+
+**NOTE MORE:** This plugin is a work in progress.  The basics work, but it's
+not as fully-featured as the `vagrant-aws` plugin it's largely based on.
+
+## What works
+
+* Boot VRealize instances.
+* 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 `vrealize` provider. An
+example is shown below.
+
+```
+$ vagrant plugin install vagrant-vrealize
+...
+$ vagrant up --provider=vrealize
+...
+```
+
+Of course, prior to doing this, you'll need to obtain a
+VRealize-compatible box file for Vagrant.
+
+## Quick Start
+
+After installing the plugin (instructions above), the quickest way to get
+started is to actually use the dummy VRealize box and specify all the details
+manually within a `config.vm.provider` block. So first, build the box:
+
+```
+$ rake box
+$ vagrant box add --provider vrealize example_box/vrealize.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 = "vrealize"
+
+  config.vm.provider :vrealize do |vrealize, override|
+    # Note: you'll need to make sure your environment variables
+    # are set up correctly for this bit...
+    vrealize.vra_username = ENV['USER']
+    vrealize.vra_password = ENV['PASSWORD']
+    vrealize.vra_tenant   = ENV['VRA_TENANT']
+    vrealize.vra_base_url = ENV['VRA_BASE_URL']
+
+    # From here on are configuration settings for the specific VM
+    # we're creating
+
+    vrealize.requested_for = ENV['VRA_AD_USER']
+
+    vrealize.subtenant_id = SOME_GUID
+    vrealize.catalog_item_id = SOME_CATALOG_ID
+
+    vrealize.add_entries do |extras|
+      # This isn't actually needed, it's just here to show how to set custom
+      # request data
+      extras.string('provider-Vrm.DataCenter.Location', '')
+    end
+
+
+    override.ssh.username = "root"
+    override.ssh.password = SOMETHING_SENSIBLE_HERE
+  end
+end
+```
+
+And then run `vagrant up --provider=vrealize`.
+
+## Networks
+
+Networking features in the form of `config.vm.network` are not
+supported with `vagrant-vrealize`, currently. If any of these are
+specified, Vagrant will emit a warning, but will otherwise boot
+the VRealize machine.
+
+## Synced Folders
+
+There is minimal support for synced folders. Upon `vagrant up`,
+`vagrant reload`, and `vagrant provision`, the Vrealize provider will
+use `rsync` (if available) to uni-directionally sync the folder to the
+remote machine over SSH.
+
+See [Vagrant Synced folders: rsync](https://docs.vagrantup.com/v2/synced-folders/rsync.html)
+
+
+## Development
+
+To work on the `vagrant-vrealize` plugin, clone this repository out, and use
+[Bundler](http://gembundler.com) to get the dependencies:
+
+```
+$ bundle
+```
+
+If those install, 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)
+and add the following line to your `Vagrantfile`
+
+```ruby
+Vagrant.require_plugin "vagrant-vrealize"
+```
+Use bundler to execute Vagrant:
+```
+$ bundle exec vagrant up --provider=vrealize
+```
+
+## And Finally
+
+This plugin is an unfinished work-in-progress. It (and large parts of
+this document) are based on Mitchell Hashimoto's `vagrant-aws` plugin,
+which can be found here: https://github.com/mitchellh/vagrant-aws.
+
+## Author
+
+Alex Young <Alexander.Young@sky.uk>
+Please get in touch, raise issues, make pull requests, if you're trying to use this and running into problems.

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rake/testtask'
+
+# 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
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'vagrant-vrealize'
+  ARGV.clear
+  IRB.start
+end
+
+desc "Rebuild the boxfile."
+task :box do
+  sh "cd example_box && bash ./mkbox.sh"
+  puts "Created example_box/vrealize.box"
+end

data/example_box/README.md

@@ -0,0 +1,13 @@
+# Vagrant AWS Example Box
+
+Vagrant providers each require a custom provider-specific box format.
+This folder shows the example contents of a box for the `aws` provider.
+To turn this into a box:
+
+```
+$ tar cvzf aws.box ./metadata.json ./Vagrantfile
+```
+
+This box works by using Vagrant's built-in Vagrantfile merging to setup
+defaults for AWS. 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 :vrealize do |vrealize|
+  end
+end

data/example_box/metadata.json

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

data/example_box/mkbox.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+tar cvzf vrealize.box ./metadata.json ./Vagrantfile

data/lib/vagrant-vrealize/action/connect_vrealize.rb

@@ -0,0 +1,65 @@
+require "log4r"
+require 'vra'
+
+require 'vagrant-vrealize/vra_client'
+
+module VagrantPlugins
+  module Vrealize
+    module Action
+
+      # This action connects to VRealize, and sticks a :vra object
+      # into the environment.
+      class ConnectVrealize
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_vrealize::action::connect_vrealize")
+        end
+
+
+        def call(env)
+          vra = client(env)
+
+          log_connecting(env)
+          authorized = (vra.authorize!; true) rescue false
+
+          if authorized
+            store(env, vra)
+          else
+            env[:ui].warn("Authorisation failed")
+          end
+          @app.call(env)
+        end
+
+
+        protected
+
+        def client(env)
+          vra_conf = vra_conf(env)
+          VraClient.build(username:   vra_conf.vra_username,
+                          password:   vra_conf.vra_password,
+                          tenant:     vra_conf.vra_tenant,
+                          base_url:   vra_conf.vra_base_url,
+                          verify_ssl: true)
+        end
+
+
+        def vra_conf(env)
+          env[:machine].provider_config
+        end
+
+
+        def store(env, client)
+          env[:vra] = client
+        end
+
+
+        def log_connecting(env)
+          @logger.info("Connecting to #{env[:machine].provider_config.vra_base_url}")
+        end
+
+      end # class ConnectVrealize
+
+
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module VagrantPlugins
+  module Vrealize
+    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
+
+        NotCreatedStatuses = %i{
+          not_created
+          DELETED
+        }
+
+        def call(env)
+          env[:result] = created?(env[:machine])
+          @app.call(env)
+        end
+
+        private
+        def created?(machine)
+          !NotCreatedStatuses.include?(machine.state.id)
+        end
+
+
+
+      end # class IsCreated
+
+
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module Vrealize
+    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-vrealize/action/message_already_created.rb

@@ -0,0 +1,18 @@
+require 'i18n'
+
+module VagrantPlugins
+  module Vrealize
+    module Action
+      class MessageAlreadyCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t("vagrant_vrealize.already_status", status: "created"))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,28 @@
+require "log4r"
+
+module VagrantPlugins
+  module Vrealize
+    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_vrealize::action::read_ssh_info")
+        end
+
+        def call(env)
+         env[:machine_ssh_info] = read_ssh_info(env[:vra], env[:machine])
+
+         @app.call(env)
+        end
+
+        def read_ssh_info(vra, machine)
+          if machine.id
+            vra.ssh_info(machine.id)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require "log4r"
+
+module VagrantPlugins
+  module Vrealize
+    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_vrealize::action::read_state")
+        end
+
+        def call(env)
+          env[:machine_state_id] = read_state(env[:vra],env[:machine])
+        end
+
+        def read_state(vra, machine)
+          return :not_created if machine.id.nil?
+
+          resource = vra.resources.by_id(machine.id)
+
+          return resource.status.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vrealize/action/run_instance.rb

@@ -0,0 +1,111 @@
+require "log4r"
+require 'json'
+
+require 'vagrant/util/retryable'
+
+require 'vagrant-vrealize/util/timer'
+
+module VagrantPlugins
+  module Vrealize
+    module Action
+      # This runs the configured instance.
+      class RunInstance
+        include Vagrant::Util::Retryable
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_vrealize::action::run_instance")
+        end
+
+        # There are more literal types than this, but we don't support them yet
+
+        def create_resource(env)
+          env[:ui].info("Creating machine")
+
+          config = env[:machine].provider_config
+          vra = env[:vra]
+
+          EntitledItemsCollection.fetch(env[:vra])
+            .find_by_id(config.catalog_item_id)
+            .request(cpus:          config.cpus,
+                     memory:        config.memory,
+                     requested_for: config.requested_for,
+                     subtenant_id:  config.subtenant_id,
+                     lease_days:    config.lease_days) { |req|
+              config.extra_entries.types.each do |type|
+                config.extra_entries.of_type(type).each do |k,v|
+                  req.set_parameter(k, type, v)
+                end
+              end
+            }
+            .join
+            .machine
+        end
+
+        def wait_for_ssh(env)
+          if !env[:interrupted]
+            env[:metrics]["instance_ssh_time"] = Util::Timer.time do
+              # Wait for SSH to be ready.
+              env[:ui].info(I18n.t("vagrant_vrealize.waiting_for_ssh"))
+              network_ready_retries = 0
+              network_ready_retries_max = 10
+              loop do
+                # If we're interrupted then just back out
+                break if env[:interrupted]
+                begin
+                  break if env[:machine].communicate.ready?
+                rescue => e
+                  if network_ready_retries < network_ready_retries_max then
+                    network_ready_retries += 1
+                    @logger.warn(I18n.t("vagrant_vrealize.waiting_for_ssh, retrying"))
+                  else
+                    raise e
+                  end
+                end
+                sleep 2
+              end
+            end
+          end
+        end
+
+        def save_ip_address(env, resource)
+          env[:machine].data_dir.join('elastic_ip').open("w+") do |f|
+            f.write({:public_ip => resource.ip_addresses.first}.to_json)
+          end
+        end
+
+        def call(env)
+          vra = env[:vra] or fail "No VRA client instance!"
+
+          # Initialize metrics if they haven't been
+          env[:metrics] ||= {}
+
+          created_resource = create_resource(env)
+          env[:machine].id = created_resource.id
+          save_ip_address(env, created_resource)
+          wait_for_ssh(env)
+          terminate(env) if env[:interrupted]
+
+          @app.call(env)
+        end
+
+        def recover(env)
+          return if env["vagrant.error"].is_a?(Vagrant::Errors::VagrantError)
+
+          if env[:machine].provider.state.id != :not_created
+            # Undo the import
+            terminate(env)
+          end
+        end
+
+        def terminate(env)
+          destroy_env = env.dup
+          destroy_env.delete(:interrupted)
+          destroy_env[:config_validate] = false
+          destroy_env[:force_confirm_destroy] = true
+          env[:action_runner].run(Action.action_destroy, destroy_env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vrealize/action/start_instance.rb

@@ -0,0 +1,25 @@
+require "log4r"
+
+require 'vagrant/util/retryable'
+
+require 'vagrant-vrealize/util/timer'
+
+module VagrantPlugins
+  module Vrealize
+    module Action
+      # This starts a stopped instance.
+      class StartInstance
+        include Vagrant::Util::Retryable
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_vrealize::action::start_instance")
+        end
+
+        def call(env)
+          fail NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vrealize/action/stop_instance.rb

@@ -0,0 +1,19 @@
+require "log4r"
+
+module VagrantPlugins
+  module Vrealize
+    module Action
+      # This stops the running instance.
+      class StopInstance
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_vrealize::action::stop_instance")
+        end
+
+        def call(env)
+          fail NotImplementedError
+        end
+      end
+    end
+  end
+end