vagrant-openstack-provider 0.3.4.pre → 0.4.0

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# 0.4.0 (September 23, 2014)
+
+FEATURES:
+
+  - Enable "metadata" in config for nova create server [#25](https://github.com/ggiamarchi/vagrant-openstack-provider/issues/25)
+  - Enable "user_data" in config for nova create server [#78](https://github.com/ggiamarchi/vagrant-openstack-provider/issues/78)
+  - Enable "security_groups" in config for nova create server [#82](https://github.com/ggiamarchi/vagrant-openstack-provider/issues/82)
+  - Enable "scheduler_hints" in config for nova create server [#83](https://github.com/ggiamarchi/vagrant-openstack-provider/issues/83)
+  - Allow attaching an existing volume to the vagrant instance [#24](https://github.com/ggiamarchi/vagrant-openstack-provider/issues/24)
+  - Allow booting instance from volume [#44](https://github.com/ggiamarchi/vagrant-openstack-provider/issues/44)
+  - Add subcommand volume-list [#75](https://github.com/ggiamarchi/vagrant-openstack-provider/issues/75)
+
+IMPROVEMENTS:
+
+  - Add config param floating_ip_pool_always_allocate [#61](https://github.com/ggiamarchi/vagrant-openstack-provider/issues/61)
+
+BUG FIXES:
+
+  - Enable config option to override SSH port [#88](https://github.com/ggiamarchi/vagrant-openstack-provider/issues/88)
+
+
 # 0.3.3 (September 19, 2014)
 
 BUG FIXES:
@@ -11,6 +32,10 @@ BUG FIXES:
    - The provider fails to load colorize gem [#76](https://github.com/ggiamarchi/vagrant-openstack-provider/issues/76)
    - Sub-command arguments management have change in vagrant 1.5 [#77](https://github.com/ggiamarchi/vagrant-openstack-provider/issues/77)
 
+IMPROVEMENTS:
+
+   - Show more informations for command flavor-list [#52](https://github.com/ggiamarchi/vagrant-openstack-provider/issues/52) 
+
 # 0.3.0 (August 29, 2014)
 
 FEATURES:

data/Gemfile

@@ -18,5 +18,8 @@ group :development do
   # gem dependency because we expect to be installed within the
   # Vagrant environment itself using `vagrant plugin`.
   gem 'coveralls', require: false
+end
+
+group :debug do
   gem 'debugger'
 end

data/Vagrantfile

@@ -4,6 +4,7 @@ Vagrant.configure('2') do |config|
 
   config.vm.box = 'dummy-openstack'
   config.vm.box_url = 'https://github.com/ggiamarchi/vagrant-openstack/raw/master/source/dummy.box'
+  config.ssh.username = 'stack'
 
   config.vm.provider :openstack do |os|
     os.username = ENV['OS_USERNAME']
@@ -13,6 +14,5 @@ Vagrant.configure('2') do |config|
     os.image = ENV['OS_IMAGE']
     os.openstack_auth_url = ENV['OS_AUTH_URL']
     os.tenant_name = ENV['OS_TENANT_NAME']
-    os.ssh_username = 'stack'
   end
 end

data/lib/vagrant-openstack-provider/action/connect_openstack.rb

@@ -67,6 +67,7 @@ module VagrantPlugins
           config = env[:machine].provider_config
           client.session.endpoints[:compute] = config.openstack_compute_url unless config.openstack_compute_url.nil?
           client.session.endpoints[:network] = config.openstack_network_url unless config.openstack_network_url.nil?
+          client.session.endpoints[:volume] = config.openstack_volume_url unless config.openstack_volume_url.nil?
         end
 
         def log_endpoint_catalog(env)

data/lib/vagrant-openstack-provider/action/create_server.rb

@@ -19,15 +19,27 @@ module VagrantPlugins
         def call(env)
           @logger.info 'Start create server action'
 
+          config = env[:machine].provider_config
+
+          fail Errors::MissingBootOption if config.image.nil? && config.volume_boot.nil?
+          fail Errors::ConflictBootOption unless config.image.nil? || config.volume_boot.nil?
+
           nova = env[:openstack_client].nova
 
           options = {
             flavor: resolve_flavor(env),
             image: resolve_image(env),
+            volume_boot: resolve_volume_boot(env),
             networks: resolve_networks(env),
+            volumes: resolve_volumes(env),
             keypair_name: resolve_keypair(env),
-            availability_zone: env[:machine].provider_config.availability_zone
+            availability_zone: env[:machine].provider_config.availability_zone,
+            scheduler_hints: env[:machine].provider_config.scheduler_hints,
+            security_groups: env[:machine].provider_config.security_groups,
+            user_data: env[:machine].provider_config.user_data,
+            metadata: env[:machine].provider_config.metadata
           }
+
           server_id = create_server(env, options)
 
           # Store the ID right away so we can track it
@@ -42,13 +54,15 @@ module VagrantPlugins
             nova.add_floating_ip(env, server_id, floating_ip)
           end
 
+          attach_volumes(env, server_id, options[:volumes]) unless options[:volumes].empty?
+
           unless env[:interrupted]
             # Clear the line one more time so the progress is removed
             env[:ui].clear_line
 
             # Wait for SSH to become available
             ssh_timeout = env[:machine].provider_config.ssh_timeout
-            unless port_open?(env, floating_ip, 22, ssh_timeout)
+            unless port_open?(env, floating_ip, resolve_ssh_port(env), ssh_timeout)
               env[:ui].error(I18n.t('vagrant_openstack.timeout'))
               fail Errors::SshUnavailable, host: floating_ip, timeout: ssh_timeout
             end
@@ -62,6 +76,12 @@ module VagrantPlugins
 
         private
 
+        def resolve_ssh_port(env)
+          machine_config = env[:machine].config
+          return machine_config.ssh.port if machine_config.ssh.port
+          22
+        end
+
         # 1. if floating_ip is set, use it
         # 2. if floating_ip_pool is set
         #    GET v2/{{tenant_id}}/os-floating-ips
@@ -79,7 +99,7 @@ module VagrantPlugins
           if config.floating_ip_pool
             floating_ips.each do |single|
               return single.ip if single.pool == config.floating_ip_pool && single.instance_id.nil?
-            end
+            end unless config.floating_ip_pool_always_allocate
             return nova.allocate_floating_ip(env, config.floating_ip_pool).ip
           else
             floating_ips.each do |ip|
@@ -101,9 +121,7 @@ module VagrantPlugins
           key = SSHKey.generate
           nova = env[:openstack_client].nova
           generated_keyname = nova.import_keypair(env, key.ssh_public_key)
-          file_path = "#{env[:machine].data_dir}/#{generated_keyname}"
-          File.write(file_path, key.private_key)
-          File.chmod(0600, file_path)
+          File.write("#{env[:machine].data_dir}/#{generated_keyname}", key.private_key)
           generated_keyname
         end
 
@@ -122,6 +140,7 @@ module VagrantPlugins
         def resolve_image(env)
           @logger.info 'Resolving image'
           config = env[:machine].provider_config
+          return nil if config.image.nil?
           nova = env[:openstack_client].nova
           env[:ui].info(I18n.t('vagrant_openstack.finding_image'))
           images = nova.get_all_images(env)
@@ -158,41 +177,129 @@ module VagrantPlugins
           networks
         end
 
+        def resolve_volume_boot(env)
+          @logger.info 'Resolving image'
+          config = env[:machine].provider_config
+          return nil if config.volume_boot.nil?
+
+          volume_list = env[:openstack_client].cinder.get_all_volumes(env)
+          volume_ids = volume_list.map { |v| v.id }
+
+          @logger.debug(volume_list)
+
+          volume = resolve_volume(config.volume_boot, volume_list, volume_ids)
+          device = volume[:device].nil? ? 'vda' : volume[:device]
+
+          { id: volume[:id], device: device }
+        end
+
+        def resolve_volumes(env)
+          @logger.info 'Resolving volume(s)'
+          config = env[:machine].provider_config
+          return [] if config.volumes.nil? || config.volumes.empty?
+          env[:ui].info(I18n.t('vagrant_openstack.finding_volumes'))
+
+          volume_list = env[:openstack_client].cinder.get_all_volumes(env)
+          volume_ids = volume_list.map { |v| v.id }
+
+          @logger.debug(volume_list)
+
+          volumes = []
+          config.volumes.each do |volume|
+            volumes << resolve_volume(volume, volume_list, volume_ids)
+          end
+          @logger.debug("Resolved volumes : #{volumes.to_json}")
+          volumes
+        end
+
+        def resolve_volume(volume, volume_list, volume_ids)
+          return resolve_volume_from_string(volume, volume_list) if volume.is_a? String
+          return resolve_volume_from_hash(volume, volume_list, volume_ids) if volume.is_a? Hash
+          fail Errors::InvalidVolumeObject, volume: volume
+        end
+
+        def resolve_volume_from_string(volume, volume_list)
+          found_volume = find_matching(volume_list, volume)
+          fail Errors::UnresolvedVolume, volume: volume if found_volume.nil?
+          { id: found_volume.id, device: nil }
+        end
+
+        def resolve_volume_from_hash(volume, volume_list, volume_ids)
+          device = nil
+          device = volume[:device] if volume.key?(:device)
+          if volume.key?(:id)
+            fail Errors::ConflictVolumeNameId, volume: volume if volume.key?(:name)
+            volume_id = volume[:id]
+            fail Errors::UnresolvedVolumeId, id: volume_id unless volume_ids.include? volume_id
+          elsif volume.key?(:name)
+            volume_list.each do |v|
+              next unless v.name.eql? volume[:name]
+              fail Errors::MultipleVolumeName, name: volume[:name] unless volume_id.nil?
+              volume_id = v.id
+            end
+            fail Errors::UnresolvedVolumeName, name: volume[:name] unless volume_ids.include? volume_id
+          else
+            fail Errors::ConflictVolumeNameId, volume: volume
+          end
+          { id: volume_id, device: device }
+        end
+
         def create_server(env, options)
           config = env[:machine].provider_config
           nova = env[:openstack_client].nova
           server_name = config.server_name || env[:machine].name
 
           env[:ui].info(I18n.t('vagrant_openstack.launching_server'))
-          env[:ui].info(" -- Tenant         : #{config.tenant_name}")
-          env[:ui].info(" -- Name           : #{server_name}")
-          env[:ui].info(" -- Flavor         : #{options[:flavor].name}")
-          env[:ui].info(" -- FlavorRef      : #{options[:flavor].id}")
-          env[:ui].info(" -- Image          : #{options[:image].name}")
-          env[:ui].info(" -- ImageRef       : #{options[:image].id}")
-          env[:ui].info(" -- KeyPair        : #{options[:keypair_name]}")
+          env[:ui].info(" -- Tenant          : #{config.tenant_name}")
+          env[:ui].info(" -- Name            : #{server_name}")
+          env[:ui].info(" -- Flavor          : #{options[:flavor].name}")
+          env[:ui].info(" -- FlavorRef       : #{options[:flavor].id}")
+          unless options[:image].nil?
+            env[:ui].info(" -- Image           : #{options[:image].name}")
+            env[:ui].info(" -- ImageRef        : #{options[:image].id}")
+          end
+          env[:ui].info(" -- Boot volume     : #{options[:volume_boot][:id]} (#{options[:volume_boot][:device]})") unless options[:volume_boot].nil?
+          env[:ui].info(" -- KeyPair         : #{options[:keypair_name]}")
+
           unless options[:networks].empty?
             if options[:networks].size == 1
-              env[:ui].info(" -- Network        : #{options[:networks][0]}")
+              env[:ui].info(" -- Network         : #{options[:networks][0]}")
             else
-              env[:ui].info(" -- Networks       : #{options[:networks]}")
+              env[:ui].info(" -- Networks        : #{options[:networks]}")
+            end
+          end
+
+          unless options[:volumes].empty?
+            options[:volumes].each do |volume|
+              device = volume[:device]
+              device = :auto if device.nil?
+              env[:ui].info(" -- Volume attached : #{volume[:id]} => #{device}")
             end
           end
 
           log = "Lauching server '#{server_name}' in project '#{config.tenant_name}' "
           log << "with flavor '#{options[:flavor].name}' (#{options[:flavor].id}), "
-          log << "image '#{options[:image].name}' (#{options[:image].id}) "
+          unless options[:image].nil?
+            log << "image '#{options[:image].name}' (#{options[:image].id}) "
+          end
           log << "and keypair '#{options[:keypair_name]}'"
 
           @logger.info(log)
 
+          image_ref = options[:image].id unless options[:image].nil?
+
           create_opts = {
             name: server_name,
-            image_ref: options[:image].id,
+            image_ref: image_ref,
+            volume_boot: options[:volume_boot],
             flavor_ref: options[:flavor].id,
             keypair: options[:keypair_name],
             availability_zone: options[:availability_zone],
-            networks: options[:networks]
+            networks: options[:networks],
+            scheduler_hints: options[:scheduler_hints],
+            security_groups: options[:security_groups],
+            user_data: options[:user_data],
+            metadata: options[:metadata]
           }
 
           nova.create_server(env, create_opts)
@@ -210,6 +317,15 @@ module VagrantPlugins
           end
         end
 
+        def attach_volumes(env, server_id, volumes)
+          @logger.info("Attaching volumes #{volumes} to server #{server_id}")
+          nova = env[:openstack_client].nova
+          volumes.each do |volume|
+            @logger.debug("Attaching volumes #{volume}")
+            nova.attach_volume(env, server_id, volume[:id], volume[:device])
+          end
+        end
+
         def port_open?(env, ip, port, timeout)
           start_time = Time.now
           current_time = start_time
@@ -243,7 +359,7 @@ module VagrantPlugins
             return single if single.name == name
             return single if name.is_a?(Regexp) && name =~ single.name
           end
-          @logger.error "Flavor '#{name}' not found"
+          @logger.error "Element '#{name}' not found in collection #{collection}"
           nil
         end
       end

data/lib/vagrant-openstack-provider/action/read_ssh_info.rb

@@ -24,13 +24,27 @@ module VagrantPlugins
           config = env[:machine].provider_config
           hash = {
             host: get_ip_address(env),
-            port: 22,
-            username: config.ssh_username
+            port: resolve_ssh_port(env),
+            username: resolve_ssh_username(env)
           }
           hash[:private_key_path] = "#{env[:machine].data_dir}/#{get_keypair_name(env)}" unless config.keypair_name || config.public_key_path
           hash
         end
 
+        def resolve_ssh_port(env)
+          machine_config = env[:machine].config
+          return machine_config.ssh.port if machine_config.ssh.port
+          22
+        end
+
+        def resolve_ssh_username(env)
+          config = env[:machine].provider_config
+          machine_config = env[:machine].config
+          return machine_config.ssh.username if machine_config.ssh.username
+          return config.ssh_username if config.ssh_username
+          fail Errors::NoMatchingSshUsername
+        end
+
         def get_ip_address(env)
           return env[:machine].provider_config.floating_ip unless env[:machine].provider_config.floating_ip.nil?
           details = env[:openstack_client].nova.get_server_details(env, env[:machine].id)

data/lib/vagrant-openstack-provider/client/cinder.rb

@@ -0,0 +1,40 @@
+require 'log4r'
+require 'restclient'
+require 'json'
+
+require 'vagrant-openstack-provider/client/http_utils'
+require 'vagrant-openstack-provider/client/domain'
+
+module VagrantPlugins
+  module Openstack
+    class CinderClient
+      include Singleton
+      include VagrantPlugins::Openstack::HttpUtils
+      include VagrantPlugins::Openstack::Domain
+
+      def initialize
+        @logger = Log4r::Logger.new('vagrant_openstack::cinder')
+        @session = VagrantPlugins::Openstack.session
+      end
+
+      def get_all_volumes(env)
+        volumes_json = get(env, "#{@session.endpoints[:volume]}/volumes/detail")
+        JSON.parse(volumes_json)['volumes'].map do |volume|
+          name = volume['display_name']
+          name = volume['name'] if name.nil? # To be compatible with cinder api v1 and v2
+          case volume['attachments'].size
+          when 0
+            @logger.debug "No attachment found for volume #{volume['id']}"
+          else
+            attachment = volume['attachments'][0]
+            server_id = attachment['server_id']
+            device = attachment['device']
+            @logger.warn "Found #{attachment.size} attachments for volume #{volume['id']} : " if attachment.size > 1
+            @logger.debug "Attachment found for volume #{volume['id']} : #{attachment.to_json}"
+          end
+          Volume.new(volume['id'], name, volume['size'], volume['status'], volume['bootable'], server_id, device)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-provider/client/domain.rb

@@ -11,6 +11,14 @@ module VagrantPlugins
           @id = id
           @name = name
         end
+
+        def ==(other)
+          other.class == self.class && other.state == state
+        end
+
+        def state
+          [@id, @name]
+        end
       end
 
       class Flavor < Item
@@ -36,10 +44,6 @@ module VagrantPlugins
           super(id, name)
         end
 
-        def ==(other)
-          other.class == self.class && other.state == state
-        end
-
         protected
 
         def state
@@ -55,6 +59,62 @@ module VagrantPlugins
           @instance_id = instance_id
         end
       end
+
+      class Volume < Item
+        #
+        # Size in Gigaoctet
+        #
+        attr_accessor :size
+
+        #
+        # Status (e.g. 'Available', 'In-use')
+        #
+        attr_accessor :status
+
+        #
+        # Whether volume is bootable or not
+        #
+        attr_accessor :bootable
+
+        #
+        # instance id volume is attached to
+        #
+        attr_accessor :instance_id
+
+        #
+        # device (e.g. /dev/sdb) if attached
+        #
+        attr_accessor :device
+
+        # rubocop:disable Style/ParameterLists
+        def initialize(id, name, size, status, bootable, instance_id, device)
+          @size = size
+          @status = status
+          @bootable = bootable
+          @instance_id = instance_id
+          @device = device
+          super(id, name)
+        end
+        # rubocop:enable Style/ParameterLists
+
+        def to_s
+          {
+            id: @id,
+            name: @name,
+            size: @size,
+            status: @status,
+            bootable: @bootable,
+            instance_id: @instance_id,
+            device: @device
+          }.to_json
+        end
+
+        protected
+
+        def state
+          [@id, @name, @size, @status, @bootable, @instance_id, @device]
+        end
+      end
     end
   end
 end