vagrant-vcloud 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2225b21d3d39c0bbd8be864bff61450e04989570
+  data.tar.gz: 0bb584b49730dcc825f6ee31cdce2f6c3026748c
+SHA512:
+  metadata.gz: c8ad741705b3c4d1761f7b6e9a96fd8e48c953dc4f212108d066d31179b1a0aa104821fd7a2b0768199a9b7606665c88a511f787b0d5a1c6046fed7793d8d4ab
+  data.tar.gz: ed8bb6a2e30c4217d43592c8eac7b4ab076d7d8b27992ff57561f1ac3b35c1997410716f679edfa15fd544df2e5a63ff8bfdd3bbbf8d4fac4a04c79a52e21ea8

data/.gitignore

@@ -0,0 +1,3 @@
+.vagrant/*
+pkg/*
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'vagrant', :git => 'git://github.com/mitchellh/vagrant.git'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Fabio Rapposelli
+
+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,80 @@
+[Vagrant](http://www.vagrantup.com) provider for VMware vCloud Director®
+=============
+
+[Version 0.1.0](https://github.com/frapposelli/vagrant-vcloud/releases/tag/v0.1.0) has been released!
+-------------
+
+Please note that this software is still Alpha/Beta quality and is not recommended for production usage.
+
+Right now a [Precise32](http://vagrant.tsugliani.fr/precise32.box) is available for use, or you can roll your own as you please, make sure to install VMware tools in it.
+
+Features of Version 0.1.0 are:
+
+- Basic Create/Provision/Destroy lifecycle.
+- Rsync-based provisioning (working on alternatives for that).
+- Use a single vApp as a container for Multi-VM Vagrantfiles.
+- Use a vApp vShield Edge to perform DNAT/SNAT on a single IP for Multi-VM Vagrantfiles.
+- Automatically create NAT rules on a fronting Organization Edge.
+- Automatic upload of the Vagrant box to the specified catalog.
+- Works on [vCloud® Hybrid Service™](http://www.vmware.com/products/vcloud-hybrid-service)!
+
+What is still missing:
+
+- TEST SUITES! (working on that).
+- Speed, the code is definitely not optimized.
+- Permission checks, make sure you have at least Catalog Admin privileges if you want to upload boxes to vCloud.
+- Thorough testing.
+- Error checking is absymal.
+- Some spaghetti code here and there.
+- Bugs, bugs and BUGS!.
+
+If you're a developer and want to lend us a hand, head over to our ```develop``` branch and get busy!
+
+A Sample Multi-VM Vagrantfile: 
+
+```ruby
+precise32_vm_box_url = "http://vagrant.tsugliani.fr/precise32.box"
+
+nodes = [
+  { :hostname => "web-vm",  :box => "precise32", :box_url => precise32_vm_box_url},
+  { :hostname => "ssh-vm",  :box => "precise32" , :box_url => precise32_vm_box_url},
+  { :hostname => "sql-vm",  :box => "precise32", :box_url => precise32_vm_box_url },
+  { :hostname => "lb-vm",  :box => "precise64", :box_url => precise32_vm_box_url },
+  { :hostname => "app-vm",  :box => "precise32", :box_url => precise32_vm_box_url },
+]
+
+Vagrant.configure("2") do |config|
+
+  # vCloud Director provider settings
+  config.vm.provider :vcloud do |vcloud|
+    vcloud.hostname = "https://my.cloudprovider.com"
+    vcloud.username = "MyUserName"
+    vcloud.password = "MySup3rS3cr3tPassw0rd!"
+ 
+    vcloud.org_name = "OrganizationName"
+    vcloud.vdc_name = "vDC_Name"
+
+    vcloud.catalog_name = "Vagrant"
+    vcloud.ip_subnet = "172.16.32.125/255.255.255.240"
+    
+    vcloud.vdc_network_name = "MyNetwork"
+
+    vcloud.vdc_edge_gateway = "MyOrgEdgeGateway"
+    vcloud.vdc_edge_gateway_ip = "10.10.10.10"
+  end
+
+  nodes.each do |node|
+    config.vm.define node[:hostname] do |node_config|
+      node_config.vm.box = node[:box]
+      node_config.vm.hostname = node[:hostname]
+      node_config.vm.box_url = node[:box_url]
+      node_config.vm.network :forwarded_port, guest: 80, host: 8080, auto_correct: true
+      # node_config.vm.provision :puppet do |puppet|
+      #   puppet.manifests_path = 'puppet/manifests'
+      #   puppet.manifest_file = 'site.pp'
+      #   puppet.module_path = 'puppet/modules'
+      # end
+    end
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,17 @@
+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__))
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new
+
+task :default => 'spec'

data/example_box/README.md

@@ -0,0 +1,13 @@
+# vagrant-vcloud box specifications [WIP]
+
+*Note that vagrant-vcloud currently supports only single VM vApp boxes*
+
+BOX package should contain:
+
+- `metadata.json` -- Vagrant metadata file
+- `<boxname>.ovf` -- OVF descriptor of the vApp.
+- `<boxname>.mf` -- OVF manifest file containing file hashes.
+- `<boxname>-disk-<#>.vmdk` -- Associated VMDK files.
+- `Vagrantfile`-- vagrant-vcloud default Vagrantfile
+
+A [task is open](https://github.com/frapposelli/vagrant-vcloud/issues/12) for creating a veewee plugin to facilitate Box creation

data/example_box/Vagrantfile

@@ -0,0 +1,6 @@
+Vagrant::Config.run do |config|
+  config.vm.base_mac = "<mac address>"
+end
+
+include_vagrantfile = File.expand_path("../include/_Vagrantfile", __FILE__)
+load include_vagrantfile if File.exist?(include_vagrantfile)

data/example_box/metadata.json

@@ -0,0 +1 @@
+{"provider": "vagrant-vcloud"}

data/lib/vagrant-vcloud.rb

@@ -0,0 +1,65 @@
+require "pathname"
+require "vagrant-vcloud/plugin"
+
+module VagrantPlugins
+  module VCloud
+    lib_path = Pathname.new(File.expand_path("../vagrant-vcloud", __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
+
+module Vagrant
+  class Machine
+  
+    attr_reader :vappid
+
+    def vappid=(value)
+      @logger.info("New vApp ID: #{value.inspect}")
+
+      # The file that will store the id if we have one. This allows the
+      # ID to persist across Vagrant runs.
+
+      id_file = @data_dir.join("../../../vcloud_vappid")
+
+      ### this should be ./.vagrant/vcloud_vappid
+
+      if value
+        # Write the "id" file with the id given.
+        id_file.open("w+") do |f|
+          f.write(value)
+        end
+      else
+        # Delete the file, since the machine is now destroyed
+        id_file.delete if id_file.file?
+      end
+
+      # Store the ID locally
+      @vappid = value
+
+      # Notify the provider that the ID changed in case it needs to do
+      # any accounting from it.
+      #@provider.machine_id_changed
+    end
+
+    # This returns the vCloud Director vApp ID.
+    #
+    # @return [vAppId]
+    def get_vapp_id
+      vappid_file = @data_dir.join("../../../vcloud_vappid")
+      if vappid_file.file?
+        @vappid = vappid_file.read
+      else
+        nil
+      end
+    end
+
+  end
+end

data/lib/vagrant-vcloud/action.rb

@@ -0,0 +1,226 @@
+require "pathname"
+require "vagrant/action/builder"
+
+module VagrantPlugins
+  module VCloud
+    module Action
+      include Vagrant::Action::Builtin
+
+      # Vagrant commands
+      # This action boots the VM, assuming the VM is in a state that requires
+      # a bootup (i.e. not saved).
+      def self.action_boot
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use PowerOn
+          b.use HandleNATPortCollisions
+          b.use ForwardPorts
+          b.use Provision
+          b.use SyncFolders
+        end
+      end
+
+      def self.action_reload
+        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 action_halt
+            b2.use action_start
+            b2.use DisconnectVCloud
+          end
+        end
+      end
+
+      # This action starts a VM, assuming it is already imported and exists.
+      # A precondition of this action is that the VM exists.
+      def self.action_start
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectVCloud
+          b.use Call, IsRunning do |env, b2|
+            # If the VM is running, then our work here is done, exit
+            if env[:result]
+              b2.use MessageAlreadyRunning
+              next
+            end
+            b2.use Call, IsPaused do |env2, b3|
+              if env2[:result]
+                b3.use Resume
+                next
+              end
+              b3.use action_boot
+            end
+          end
+        end
+      end
+
+      def self.action_halt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConnectVCloud
+          b.use Call, IsPaused do |env, b2|
+            if env[:result]
+              b2.use Resume
+            end
+            b2.use UnmapPortForwardings
+            b2.use PowerOff
+          end
+        end
+      end
+
+      def self.action_suspend
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConnectVCloud
+          b.use Call, IsRunning do |env, b2|
+            # If the VM is stopped, can't suspend
+            if !env[:result]
+              b2.use MessageCannotSuspend
+            else
+              b2.use Suspend
+            end
+          end
+        end
+      end
+
+      def self.action_resume
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConnectVCloud
+          b.use Resume
+        end
+      end
+
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Call, DestroyConfirm do |env, b2|
+            if env[:result]
+              b2.use ConfigValidate
+              b2.use ConnectVCloud
+              b2.use Call, IsRunning do |env2, b3|
+              # If the VM is running, must power off
+                if env2[:result]
+                 b3.use action_halt
+                end
+                b3.use Destroy
+              end 
+            else
+              b2.use MessageWillNotDestroy
+            end
+          end
+        end
+      end
+
+      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 Provision
+            b2.use SyncFolders
+          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 ConnectVCloud
+          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 ConnectVCloud
+          b.use ReadState
+        end
+      end
+
+      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
+            # This calls our helper that announces the IP used to connect
+            # to the VM, either directly to the vApp vShield or to the Org Edge.
+            b2.use AnnounceSSHExec
+          end
+        end
+      end
+
+      def self.action_ssh_run
+        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 SSHRun
+          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 HandleBoxUrl
+            end
+          end
+          b.use ConnectVCloud
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use InventoryCheck
+              b2.use BuildVApp
+            end
+          end
+          b.use action_start
+          b.use DisconnectVCloud
+        end
+      end
+
+      # The autoload farm
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :AnnounceSSHExec, action_root.join("announce_ssh_exec")
+      autoload :BuildVApp, action_root.join("build_vapp")
+      autoload :ConnectVCloud, action_root.join("connect_vcloud")
+      autoload :Destroy, action_root.join("destroy")
+      autoload :DisconnectVCloud, action_root.join("disconnect_vcloud")
+      autoload :ForwardPorts, action_root.join("forward_ports")
+      autoload :HandleNATPortCollisions, action_root.join("handle_nat_port_collisions")
+      autoload :InventoryCheck, action_root.join("inventory_check")
+      autoload :IsCreated, action_root.join("is_created")
+      autoload :IsPaused, action_root.join("is_paused")
+      autoload :IsRunning, action_root.join("is_running")
+      autoload :MessageAlreadyRunning, action_root.join("message_already_running")
+      autoload :MessageCannotSuspend, action_root.join("message_cannot_suspend")
+      autoload :MessageNotCreated, action_root.join("message_not_created")
+      autoload :MessageWillNotDestroy, action_root.join("message_will_not_destroy")
+      autoload :PowerOff, action_root.join("power_off")
+      autoload :PowerOn, action_root.join("power_on")
+      autoload :ReadSSHInfo, action_root.join("read_ssh_info")
+      autoload :ReadState, action_root.join("read_state")
+      autoload :Resume, action_root.join("resume")
+      autoload :Suspend, action_root.join("suspend")
+      autoload :SyncFolders, action_root.join("sync_folders")
+      autoload :UnmapPortForwardings, action_root.join("unmap_port_forwardings")      
+    end
+  end
+end