vagrant-cloudstack 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b01a67b4a7935d8218e0fd82422bd38dc5dc0c9
-  data.tar.gz: bc847f6a39372eb7ab370bc811974a63c3e36af1
+  metadata.gz: 1bb87274b9c5ad3a39e17fb4ddefece7076ae0cb
+  data.tar.gz: 9b6256bec79396f96659d72d1c1650d53a6883ee
 SHA512:
-  metadata.gz: 0b6ca31291fc783ed3abc0ef42573af04563d8b77db8f9366973e94f3186a651feddd3d8218ef459449fe5135370ff4b1519d0dd1f2db00dc06328ab5618df7c
-  data.tar.gz: 9190c62333d247ec463b79a7b8645378e1afa23d83a62599fc8b2c6b9cee6c4a71a95e1de8bb7688ebb9b520c81bb21b3d1b5f1ee5f662bf0482c71ad41a61cc
+  metadata.gz: 5903a1a4b92be3dbdddf37198428fc7a647dc21d65e078d2b3f922a6154a3394785522f4acb63695cdcf7742af8e13d84fc62d684cc6bb7c2f16d952d7ea3fbb
+  data.tar.gz: 73831bed97569ed058aa4001e491f4e729526f671bc1157f12335884cd1ef1ded8d5c8a80f4628a6559bf116de46ab5d910c55a252395f037c670eba5d3c49d3

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.8.0 (Jun 24, 2014)
+* Remove unused code.
+* Add support for specifying most resources by name. Where applicable there is
+  a matching _name config for the _id configs.
+  Note: in this release there were no support for the project apis in fog,
+  therefore there is no project_name config.
+
 # 0.7.0 (Jun 17, 2014)
 * Change the resolution order of how we discover the scheme to talk to the cloud.
   This is a possibly breaking change.

data/README.md

@@ -72,6 +72,32 @@ Vagrant.configure("2") do |config|
 end
 ```
 
+Or with names instead of ids:
+
+```
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+
+  config.vm.provider :cloudstack do |cloudstack, override|
+    cloudstack.host = "cloudstack.local"
+    cloudstack.path = "/client/api"
+    cloudstack.port = "8080"
+    cloudstack.scheme = "http"
+    cloudstack.api_key = "AAAAAAAAAAAAAAAAAAA"
+    cloudstack.secret_key = "AAAAAAAAAAAAAAAAAAA"
+
+    cloudstack.template_name = "GENERIC-Awesome-Linux"
+    cloudstack.service_offering_name = "THE-BESTEST"
+    cloudstack.network_name = "WOW-SUCH-FAST-OFFERING"
+    cloudstack.zone_name = "District-9"
+    # Sadly there is currently no support for the project api in fog.
+    cloudstack.project_id = "AAAAAAAAAAAAAAAAAAA"
+    cloudstack.network_type = "Advanced" # or "Basic"
+  end
+end
+```
+
+
 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.
@@ -96,7 +122,11 @@ provider-specific configuration for this provider.
 
 ## Configuration
 
-This provider exposes quite a few provider-specific configuration options:
+This provider exposes quite a few provider-specific configuration options. Most of the settings
+have both an id and a name setting and you can chose to use either (i.e network_id or network_name).
+This gives the possibility to use the easier to remember name instead of the UUID,
+this will also enable you to upgrade the different settings in your cloud without having
+to update UUIDs in your Vagrantfile. If both are specified, the id parameter takes precedence.
 
 * `host` - Cloudstack api host
 * `path` - Cloudstack api path
@@ -108,11 +138,15 @@ This provider exposes quite a few provider-specific configuration options:
   to become "ready" in Cloudstack. Defaults to 120 seconds.
 * `domain_id` - Domain id to launch the instance into
 * `network_id` - Network uuid that the instance should use
+* `network_name` - Network name that the instance should use
 * `network_type` - CloudStack Network Type(default: Advanced)
 * `project_id` - Project uuid that the instance should belong to 
 * `service_offering_id`- Service offering uuid to use for the instance
+* `service_offering_name`- Service offering name to use for the instance
 * `template_id` - Template uuid to use for the instance
+* `template_name` - Template name to use for the instance
 * `zone_id` - Zone uuid to launch the instance into
+* `zone_name` - Zone uuid to launch the instance into
 * `keypair` - SSH keypair name
 * `pf_ip_address_id` - IP address ID for port forwarding rule
 * `pf_public_port` - Public port for port forwarding rule

data/build_rpm.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-VERSION=0.7.0
+VERSION=0.8.0
 mkdir -p /tmp/vagrant-cloudstack-build_rpm.$$/vagrant-cloudstack-$VERSION
 cp -r . /tmp/vagrant-cloudstack-build_rpm.$$/vagrant-cloudstack-$VERSION/
 tar -C /tmp/vagrant-cloudstack-build_rpm.$$/ -czf ~/rpmbuild/SOURCES/vagrant-cloudstack-$VERSION.tar.gz vagrant-cloudstack-$VERSION

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

@@ -1,5 +1,5 @@
 require "log4r"
-require 'pp'   # XXX FIXME REMOVE WHEN NOT NEEDED
+require 'pp' # XXX FIXME REMOVE WHEN NOT NEEDED
 
 require 'vagrant/util/retryable'
 
@@ -19,30 +19,62 @@ module VagrantPlugins
 
         def call(env)
           # Initialize metrics if they haven't been
-          env[:metrics] ||= {}
+          env[:metrics]        ||= {}
 
           # Get the domain we're going to booting up in
-          domain = env[:machine].provider_config.domain_id
+          domain               = env[:machine].provider_config.domain_id
 
           # Get the configs
-          domain_config         = env[:machine].provider_config.get_domain_config(domain)
-          zone_id               = domain_config.zone_id
-          network_id            = domain_config.network_id
-          network_type          = domain_config.network_type
-          project_id            = domain_config.project_id
-          service_offering_id   = domain_config.service_offering_id
-          template_id           = domain_config.template_id
-          keypair               = domain_config.keypair
-          pf_ip_address_id      = domain_config.pf_ip_address_id
-          pf_public_port        = domain_config.pf_public_port
-          pf_private_port       = domain_config.pf_private_port
-          security_group_ids    = domain_config.security_group_ids
-          display_name          = domain_config.display_name
-          group                 = domain_config.group
-          security_group_ids    = domain_config.security_group_ids
-          security_group_names  = domain_config.security_group_names
-          security_groups       = domain_config.security_groups
-          user_data             = domain_config.user_data
+          domain_config        = env[:machine].provider_config.get_domain_config(domain)
+          zone_id              = domain_config.zone_id
+          zone_name            = domain_config.zone_name
+          network_id           = domain_config.network_id
+          network_name         = domain_config.network_name
+          network_type         = domain_config.network_type
+          #TODO: Fog currently does not support the project apis, when that is fixed we should add that here too.
+          project_id           = domain_config.project_id
+          service_offering_id  = domain_config.service_offering_id
+          service_offering_name  = domain_config.service_offering_name
+          template_id          = domain_config.template_id
+          template_name        = domain_config.template_name
+          keypair              = domain_config.keypair
+          pf_ip_address_id     = domain_config.pf_ip_address_id
+          pf_public_port       = domain_config.pf_public_port
+          pf_private_port      = domain_config.pf_private_port
+          display_name         = domain_config.display_name
+          group                = domain_config.group
+          security_group_ids   = domain_config.security_group_ids
+          security_group_names = domain_config.security_group_names
+          security_groups      = domain_config.security_groups
+          user_data            = domain_config.user_data
+
+          # If for some reason the user have specified both network_name and network_id, take the id since that is
+          # more specific than the name. But always try to fetch the name of the network to present to the user.
+          if network_id.nil? and network_name
+            network_id = name_to_id(env, network_name, "network")
+          elsif network_id
+            network_name = id_to_name(env, network_id, "network")
+          end
+
+          if zone_id.nil? and zone_name
+            zone_id = name_to_id(env, zone_name, "zone", {'available' => true})
+          elsif zone_id
+            zone_name = id_to_name(env, zone_id, "zone", {'available' => true})
+          end
+
+          if service_offering_id.nil? and service_offering_name
+            service_offering_id   = name_to_id(env, service_offering_name, "service_offering")
+          elsif service_offering_id
+            service_offering_name = id_to_name(env, service_offering_id, "service_offering")
+          end
+
+          if template_id.nil? and template_name
+            template_id = name_to_id(env, template_name, "template", {'zoneid' => zone_id,
+                                                                      'templatefilter' => 'executable'})
+          elsif template_id
+            template_name = id_to_name(env, template_id, "template", {'zoneid' => zone_id,
+                                                                      'templatefilter' => 'executable'})
+          end
 
           # If there is no keypair then warn the user
           if !keypair
@@ -80,11 +112,11 @@ module VagrantPlugins
           env[:ui].info(I18n.t("vagrant_cloudstack.launching_instance"))
           env[:ui].info(" -- Display Name: #{display_name}")
           env[:ui].info(" -- Group: #{group}") if group
-          env[:ui].info(" -- Service offering UUID: #{service_offering_id}")
-          env[:ui].info(" -- Template UUID: #{template_id}")
+          env[:ui].info(" -- Service offering: #{service_offering_name} (#{service_offering_id})")
+          env[:ui].info(" -- Template: #{template_name} (#{template_id})")
           env[:ui].info(" -- Project UUID: #{project_id}") if project_id != nil
-          env[:ui].info(" -- Zone UUID: #{zone_id}")
-          env[:ui].info(" -- Network UUID: #{network_id}") if network_id
+          env[:ui].info(" -- Zone: #{zone_name} (#{zone_id})")
+          env[:ui].info(" -- Network: #{network_name} (#{network_id})") if !network_id.nil? or !network_name.nil?
           env[:ui].info(" -- Keypair: #{keypair}") if keypair
           env[:ui].info(" -- User Data: Yes") if user_data
           if !security_group_ids.nil?
@@ -98,7 +130,7 @@ module VagrantPlugins
             security_group_names.each do |security_group_name|
               env[:ui].info(" -- Security Group Name: #{security_group_name}")
               # since we can't access Security Groups by name, we grab the ID and add it to the security_group_ids
-              sg = env[:cloudstack_compute].list_security_groups["listsecuritygroupsresponse"]["securitygroup"].select{|sgrp| sgrp["name"] == security_group_name }
+              sg = env[:cloudstack_compute].list_security_groups["listsecuritygroupsresponse"]["securitygroup"].select { |sgrp| sgrp["name"] == security_group_name }
               security_group_ids.push(sg[0]["id"])
             end
           end
@@ -109,13 +141,13 @@ module VagrantPlugins
               # Creating the security group and retrieving it's ID
               sgid = nil
               begin
-                sgid = env[:cloudstack_compute].create_security_group(:name => sg[:name],
+                sgid = env[:cloudstack_compute].create_security_group(:name        => sg[:name],
                                                                       :description => sg[:description])["createsecuritygroupresponse"]["securitygroup"]["id"]
                 env[:ui].info(" -- Security Group #{sg[:name]} created with ID: #{sgid}")
               rescue Exception => e
                 if e.message =~ /already exis/
-                  existingGroup = env[:cloudstack_compute].list_security_groups["listsecuritygroupsresponse"]["securitygroup"].select {|secgrp| secgrp["name"] == sg[:name] }
-                  sgid = existingGroup[0]["id"]
+                  existingGroup = env[:cloudstack_compute].list_security_groups["listsecuritygroupsresponse"]["securitygroup"].select { |secgrp| secgrp["name"] == sg[:name] }
+                  sgid          = existingGroup[0]["id"]
                   env[:ui].info(" -- Security Group #{sg[:name]} found with ID: #{sgid}")
                 end
               end
@@ -124,20 +156,20 @@ module VagrantPlugins
               # so we add the rules... Does it really matter if they already exist ? CLoudstack seems to take care of that!
               sg[:rules].each do |rule|
                 case rule[:type]
-                when "ingress"
-                  env[:cloudstack_compute].authorize_security_group_ingress(:securityGroupId => sgid,
-                                                                            :protocol => rule[:protocol],
-                                                                            :startport => rule[:startport],
-                                                                            :endport => rule[:endport],
-                                                                            :cidrlist => rule[:cidrlist])
-                  env[:ui].info(" --- Ingress Rule added: #{rule[:protocol]} from #{rule[:startport]} to #{rule[:endport]} (#{rule[:cidrlist]})")
-                when "egress"
-                  env[:cloudstack_compute].authorize_security_group_egress(:securityGroupId => sgid,
-                                                                           :protocol => rule[:protocol],
-                                                                           :startport => rule[:startport],
-                                                                           :endport => rule[:endport],
-                                                                           :cidrlist => rule[:cidrlist])
-                  env[:ui].info(" --- Egress Rule added: #{rule[:protocol]} from #{rule[:startport]} to #{rule[:endport]} (#{rule[:cidrlist]})")
+                  when "ingress"
+                    env[:cloudstack_compute].authorize_security_group_ingress(:securityGroupId => sgid,
+                                                                              :protocol        => rule[:protocol],
+                                                                              :startport       => rule[:startport],
+                                                                              :endport         => rule[:endport],
+                                                                              :cidrlist        => rule[:cidrlist])
+                    env[:ui].info(" --- Ingress Rule added: #{rule[:protocol]} from #{rule[:startport]} to #{rule[:endport]} (#{rule[:cidrlist]})")
+                  when "egress"
+                    env[:cloudstack_compute].authorize_security_group_egress(:securityGroupId => sgid,
+                                                                             :protocol        => rule[:protocol],
+                                                                             :startport       => rule[:startport],
+                                                                             :endport         => rule[:endport],
+                                                                             :cidrlist        => rule[:cidrlist])
+                    env[:ui].info(" --- Egress Rule added: #{rule[:protocol]} from #{rule[:startport]} to #{rule[:endport]} (#{rule[:cidrlist]})")
                 end
               end
 
@@ -154,34 +186,34 @@ module VagrantPlugins
 
           begin
             case network_type
-            when "Advanced"
-              options = {
-                :display_name       => display_name,
-                :group              => group,
-                :zone_id            => zone_id,
-                :flavor_id          => service_offering_id,
-                :image_id           => template_id,
-                :network_ids        => [network_id]
-              }
-            when "Basic"
-              options = {
-                :display_name       => display_name,
-                :group              => group,
-                :zone_id            => zone_id,
-                :flavor_id          => service_offering_id,
-                :image_id           => template_id,
-                :security_group_ids => security_group_ids
-              }
+              when "Advanced"
+                options = {
+                    :display_name => display_name,
+                    :group        => group,
+                    :zone_id      => zone_id,
+                    :flavor_id    => service_offering_id,
+                    :image_id     => template_id,
+                    :network_ids  => [network_id]
+                }
+              when "Basic"
+                options = {
+                    :display_name       => display_name,
+                    :group              => group,
+                    :zone_id            => zone_id,
+                    :flavor_id          => service_offering_id,
+                    :image_id           => template_id,
+                    :security_group_ids => security_group_ids
+                }
             end
 
             options['project_id'] = project_id if project_id != nil
-            options['key_name'] = keypair if keypair != nil
+            options['key_name']   = keypair if keypair != nil
 
             if user_data != nil
               options['user_data'] = Base64.encode64(user_data)
               if options['user_data'].length > 2048
                 raise Errors::UserdataError,
-                  :userdataLength => options['user_data'].length
+                      :userdataLength => options['user_data'].length
               end
             end
 
@@ -192,7 +224,7 @@ module VagrantPlugins
             # XXX FIXME vpc?
             if e.message =~ /subnet ID/
               raise Errors::FogError,
-                :message => "Subnet ID not found: #{network_id}"
+                    :message => "Subnet ID not found: #{network_id}"
             end
 
             raise
@@ -203,7 +235,7 @@ module VagrantPlugins
           # Immediately save the ID since it is created at this point.
           # XXX FIXME does cloudstack+fog return the job id rather than
           # server id?
-          env[:machine].id = server.id
+          env[:machine].id                     = server.id
 
           # Wait for the instance to be ready first
           env[:metrics]["instance_ready_time"] = Util::Timer.time do
@@ -224,7 +256,7 @@ module VagrantPlugins
 
               # Notify the user
               raise Errors::InstanceReadyTimeout,
-                timeout: domain_config.instance_ready_timeout
+                    timeout: domain_config.instance_ready_timeout
             end
           end
 
@@ -291,12 +323,12 @@ module VagrantPlugins
           env[:ui].info(" -- Private port: #{pf_private_port}")
 
           options = {
-            :ipaddressid      => pf_ip_address_id,
-            :publicport       => pf_public_port,
-            :privateport      => pf_private_port,
-            :protocol         => "tcp",
-            :virtualmachineid => env[:machine].id,
-            :openfirewall     => "true"
+              :ipaddressid      => pf_ip_address_id,
+              :publicport       => pf_public_port,
+              :privateport      => pf_private_port,
+              :protocol         => "tcp",
+              :virtualmachineid => env[:machine].id,
+              :openfirewall     => "true"
           }
 
           begin
@@ -304,7 +336,7 @@ module VagrantPlugins
             while true
               response = env[:cloudstack_compute].query_async_job_result({:jobid => job_id})
               if response["queryasyncjobresultresponse"]["jobstatus"] != 0
-                port_forwarding_rule =  response["queryasyncjobresultresponse"]["jobresult"]["portforwardingrule"]
+                port_forwarding_rule = response["queryasyncjobresultresponse"]["jobresult"]["portforwardingrule"]
                 break
               else
                 sleep 2
@@ -324,10 +356,32 @@ module VagrantPlugins
         def terminate(env)
           destroy_env = env.dup
           destroy_env.delete(:interrupted)
-          destroy_env[:config_validate] = false
+          destroy_env[:config_validate]       = false
           destroy_env[:force_confirm_destroy] = true
           env[:action_runner].run(Action.action_destroy, destroy_env)
         end
+
+        private
+
+        def translate_from_to(env, resource_type, options)
+          pluralised_type = "#{resource_type}s"
+          full_response = env[:cloudstack_compute].send("list_#{pluralised_type}".to_sym, options)
+          full_response["list#{pluralised_type.tr('_','')}response"][resource_type.tr('_','')]
+        end
+
+        def name_to_id(env, resource_name, resource_type, options={})
+          env[:ui].info("Fetching UUID for #{resource_type} named '#{resource_name}'")
+          full_response = translate_from_to(env, resource_type, options)
+          result = full_response.find { |type| type["name"] == resource_name }
+          result['id']
+        end
+
+        def id_to_name(env, resource_id, resource_type, options={})
+          env[:ui].info("Fetching name for #{resource_type} with UUID '#{resource_id}'")
+          options.merge({'id' => resource_id})
+          full_response   =  translate_from_to(env, resource_type, options)
+          full_response[0]['name']
+        end
       end
     end
   end

data/lib/vagrant-cloudstack/config.rb

@@ -48,6 +48,11 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :network_id
 
+      # Network name that the instance should use
+      #
+      # @return [String]
+      attr_accessor :network_name
+
       # Network Type
       #
       # @return [String]
@@ -63,17 +68,33 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :service_offering_id
 
+      # Service offering name to use for the instance
+      #
+      # @return [String]
+      attr_accessor :service_offering_name
+
       # Template uuid to use for the instance
       #
       # @return [String]
       attr_accessor :template_id
 
+      # Template name to use for the instance
+      #
+      # @return [String]
+      attr_accessor :template_name
+
       # Zone uuid to launch the instance into. If nil, it will
       # launch in default project.
       #
       # @return [String]
       attr_accessor :zone_id
 
+      # Zone name to launch the instance into. If nil, it will
+      # launch in default project.
+      #
+      # @return [String]
+      attr_accessor :zone_name
+
       # The name of the keypair to use.
       #
       # @return [String]
@@ -139,11 +160,15 @@ module VagrantPlugins
         @instance_ready_timeout = UNSET_VALUE
         @domain_id              = UNSET_VALUE
         @network_id             = UNSET_VALUE
+        @network_name           = UNSET_VALUE
         @network_type           = UNSET_VALUE
         @project_id             = UNSET_VALUE
         @service_offering_id    = UNSET_VALUE
+        @service_offering_name  = UNSET_VALUE
         @template_id            = UNSET_VALUE
+        @template_name          = UNSET_VALUE
         @zone_id                = UNSET_VALUE
+        @zone_name              = UNSET_VALUE
         @keypair                = UNSET_VALUE
         @pf_ip_address_id       = UNSET_VALUE
         @pf_public_port         = UNSET_VALUE
@@ -252,6 +277,9 @@ module VagrantPlugins
         # Network uuid must be nil, since we can't default that
         @network_id = nil if @network_id == UNSET_VALUE
 
+        # Network uuid must be nil, since we can't default that
+        @network_name = nil if @network_name == UNSET_VALUE
+
         # NetworkType is 'Advanced' by default
         @network_type = "Advanced" if @network_type == UNSET_VALUE
 
@@ -261,12 +289,21 @@ module VagrantPlugins
         # Service offering uuid must be nil, since we can't default that
         @service_offering_id = nil if @service_offering_id == UNSET_VALUE
 
+        # Service offering name must be nil, since we can't default that
+        @service_offering_name = nil if @service_offering_name == UNSET_VALUE
+
         # Template uuid must be nil, since we can't default that
         @template_id = nil if @template_id == UNSET_VALUE
 
+        # Template name must be nil, since we can't default that
+        @template_name = nil if @template_name == UNSET_VALUE
+
         # Zone uuid must be nil, since we can't default that
         @zone_id = nil if @zone_id == UNSET_VALUE
 
+        # Zone uuid must be nil, since we can't default that
+        @zone_name = nil if @zone_name == UNSET_VALUE
+
         # Keypair defaults to nil
         @keypair = nil if @keypair == UNSET_VALUE
 
@@ -336,8 +373,6 @@ module VagrantPlugins
             errors << I18n.t("vagrant_cloudstack.config.secret_key_required") if \
               config.secret_access_key.nil?
           end
-
-          errors << I18n.t("vagrant_cloudstack.config.ami_required") if config.ami.nil?
         end
 
         { "Cloudstack Provider" => errors }

data/lib/vagrant-cloudstack/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Cloudstack
-    VERSION = "0.7.0"
+    VERSION = "0.8.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-cloudstack
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Mitchell Hashimoto
@@ -18,7 +18,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog