fog-openstack 0.3.10 → 1.0.0

data/lib/fog/openstack/compute/models/key_pair.rb

@@ -0,0 +1,56 @@
+require 'fog/openstack/models/model'
+
+module Fog
+  module OpenStack
+    class Compute
+      class KeyPair < Fog::OpenStack::Model
+        identity  :name
+
+        attribute :fingerprint
+        attribute :public_key
+        attribute :private_key
+        attribute :user_id
+        attribute :id
+
+        attr_accessor :public_key
+
+        def destroy
+          requires :name
+
+          service.delete_key_pair(name)
+          true
+        end
+
+        def save
+          requires :name
+
+          data = if public_key
+                   service.create_key_pair(name, public_key, user_id).body['keypair']
+                 else
+                   service.create_key_pair(name, nil, user_id).body['keypair']
+                 end
+          new_attributes = data.reject { |key, _value| !['fingerprint', 'public_key', 'name', 'private_key', 'user_id'].include?(key) }
+          merge_attributes(new_attributes)
+          true
+        end
+
+        def write(path = "#{ENV['HOME']}/.ssh/fog_#{Fog.credential}_#{name}.pem")
+          if writable?
+            split_private_key = private_key.split(/\n/)
+            File.open(path, "w") do |f|
+              split_private_key.each { |line| f.puts line }
+              f.chmod 0600
+            end
+            "Key file built: #{path}"
+          else
+            "Invalid private key"
+          end
+        end
+
+        def writable?
+          !!(private_key && ENV.key?('HOME'))
+        end
+      end
+    end
+  end
+end

data/lib/fog/openstack/compute/models/key_pairs.rb

@@ -0,0 +1,29 @@
+require 'fog/openstack/models/collection'
+require 'fog/openstack/compute/models/key_pair'
+
+module Fog
+  module OpenStack
+    class Compute
+      class KeyPairs < Fog::OpenStack::Collection
+        model Fog::OpenStack::Compute::KeyPair
+
+        def all(options = {})
+          items = []
+          service.list_key_pairs(options).body['keypairs'].each do |kp|
+            items += kp.values
+          end
+          # TODO: convert to load_response?
+          load(items)
+        end
+
+        def get(key_pair_name)
+          if key_pair_name
+            all.select { |kp| kp.name == key_pair_name }.first
+          end
+        rescue Fog::OpenStack::Compute::NotFound
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/fog/openstack/compute/models/metadata.rb

@@ -0,0 +1,65 @@
+require 'fog/openstack/models/collection'
+require 'fog/openstack/models/meta_parent'
+require 'fog/openstack/compute/models/metadatum'
+require 'fog/openstack/compute/models/image'
+require 'fog/openstack/compute/models/server'
+
+module Fog
+  module OpenStack
+    class Compute
+      class Metadata < Fog::OpenStack::Collection
+        model Fog::OpenStack::Compute::Metadatum
+
+        include Fog::OpenStack::Compute::MetaParent
+
+        def all
+          requires :parent
+          metadata = service.list_metadata(collection_name, @parent.id).body['metadata']
+          metas = []
+          metadata.each_pair { |k, v| metas << {"key" => k, "value" => v} } unless metadata.nil?
+          # TODO: convert to load_response?
+          load(metas)
+        end
+
+        def get(key)
+          requires :parent
+          data = service.get_metadata(collection_name, @parent.id, key).body["meta"]
+          metas = []
+          data.each_pair { |k, v| metas << {"key" => k, "value" => v} }
+          new(metas[0])
+        rescue Fog::OpenStack::Compute::NotFound
+          nil
+        end
+
+        def update(data = nil)
+          requires :parent
+          service.update_metadata(collection_name, @parent.id, to_hash(data))
+        end
+
+        def set(data = nil)
+          requires :parent
+          service.set_metadata(collection_name, @parent.id, to_hash(data))
+        end
+
+        def new(attributes = {})
+          requires :parent
+          super({:parent => @parent}.merge!(attributes))
+        end
+
+        def to_hash(data = nil)
+          if data.nil?
+            data = {}
+            each do |meta|
+              if meta.kind_of?(Fog::OpenStack::Compute::Metadatum)
+                data.store(meta.key, meta.value)
+              else
+                data.store(meta["key"], meta["value"])
+              end
+            end
+          end
+          data
+        end
+      end
+    end
+  end
+end

data/lib/fog/openstack/compute/models/metadatum.rb

@@ -0,0 +1,27 @@
+require 'fog/openstack/models/model'
+require 'fog/openstack/models/meta_parent'
+
+module Fog
+  module OpenStack
+    class Compute
+      class Metadatum < Fog::OpenStack::Model
+        include Fog::OpenStack::Compute::MetaParent
+
+        identity :key
+        attribute :value
+
+        def destroy
+          requires :identity
+          service.delete_meta(collection_name, @parent.id, key)
+          true
+        end
+
+        def save
+          requires :identity, :value
+          service.update_meta(collection_name, @parent.id, key, value)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fog/openstack/compute/models/network.rb

@@ -0,0 +1,13 @@
+require 'fog/openstack/models/model'
+
+module Fog
+  module OpenStack
+    class Compute
+      class Network < Fog::OpenStack::Model
+        identity  :id
+        attribute :name
+        attribute :addresses
+      end
+    end
+  end
+end

data/lib/fog/openstack/compute/models/networks.rb

@@ -0,0 +1,30 @@
+require 'fog/openstack/models/collection'
+require 'fog/openstack/compute/models/network'
+
+module Fog
+  module OpenStack
+    class Compute
+      class Networks < Fog::OpenStack::Collection
+        model Fog::OpenStack::Compute::Network
+
+        attribute :server
+
+        def all
+          requires :server
+
+          networks = []
+          server.addresses.each_with_index do |address, index|
+            networks << {
+              :id        => index + 1,
+              :name      => address[0],
+              :addresses => address[1].map { |a| a['addr'] }
+            }
+          end
+
+          # TODO: convert to load_response?
+          load(networks)
+        end
+      end
+    end
+  end
+end

data/lib/fog/openstack/compute/models/os_interface.rb

@@ -0,0 +1,15 @@
+require 'fog/openstack/models/model'
+
+module Fog
+  module OpenStack
+    class Compute
+      class OsInterface < Fog::OpenStack::Model
+        identity  :port_id
+        attribute :fixed_ips, :type => :array
+        attribute :mac_addr
+        attribute :net_id
+        attribute :port_state
+      end
+    end
+  end
+end

data/lib/fog/openstack/compute/models/os_interfaces.rb

@@ -0,0 +1,28 @@
+require 'fog/openstack/models/collection'
+require 'fog/openstack/compute/models/os_interface'
+
+module Fog
+  module OpenStack
+    class Compute
+      class OsInterfaces < Fog::OpenStack::Collection
+        model Fog::OpenStack::Compute::OsInterface
+
+        attribute :server
+
+        def all
+          requires :server
+
+          data = service.list_os_interfaces(server.id)
+          load_response(data, 'interfaceAttachments')
+        end
+
+        def get(port_id)
+          requires :server
+
+          data = service.get_os_interface(server.id,port_id)
+          load_response(data, 'interfaceAttachment')
+        end
+      end
+    end
+  end
+end

data/lib/fog/openstack/compute/models/security_group.rb

@@ -0,0 +1,57 @@
+require 'fog/openstack/models/model'
+
+module Fog
+  module OpenStack
+    class Compute
+      class SecurityGroup < Fog::OpenStack::Model
+        identity  :id
+
+        attribute :name
+        attribute :description
+        attribute :security_group_rules, :aliases => "rules"
+        attribute :tenant_id
+
+        def security_group_rules
+          Fog::OpenStack::Compute::SecurityGroupRules.new(:service => service).load(attributes[:security_group_rules])
+        end
+
+        def rules
+          Fog::Logger.deprecation('#rules is deprecated. Use #security_group_rules instead')
+          attributes[:security_group_rules]
+        end
+
+        # no one should be calling this because it doesn't do anything
+        # useful but we deprecated the rules attribute and need to maintain the API
+        def rules=(new_rules)
+          Fog::Logger.deprecation('#rules= is deprecated. Use the Fog::OpenStack::Compute::SecurityGroupRules collection to create new rules.')
+          attributes[:security_group_rules] = new_rules
+        end
+
+        def save
+          requires :name, :description
+          data = service.create_security_group(name, description)
+          merge_attributes(data.body['security_group'])
+          true
+        end
+
+        def destroy
+          requires :id
+          service.delete_security_group(id)
+          true
+        end
+
+        def create_security_group_rule(min, max, ip_protocol = "tcp", cidr = "0.0.0.0/0", group_id = nil)
+          Fog::Logger.deprecation('#create_security_group_rule is deprecated. Use the Fog::OpenStack::Compute::SecurityGroupRules collection to create new rules.')
+          requires :id
+          service.create_security_group_rule(id, ip_protocol, min, max, cidr, group_id)
+        end
+
+        def delete_security_group_rule(rule_id)
+          Fog::Logger.deprecation('#create_security_group_rule is deprecated. Use the Fog::OpenStack::Compute::SecurityGroupRule objects to destroy rules.')
+          service.delete_security_group_rule(rule_id)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fog/openstack/compute/models/security_group_rule.rb

@@ -0,0 +1,32 @@
+require 'fog/openstack/models/model'
+
+module Fog
+  module OpenStack
+    class Compute
+      class SecurityGroupRule < Fog::OpenStack::Model
+        identity :id
+
+        attribute :from_port
+        attribute :group
+        attribute :ip_protocol
+        attribute :to_port
+        attribute :parent_group_id
+        attribute :ip_range
+
+        def save
+          requires :ip_protocol, :from_port, :to_port, :parent_group_id
+          cidr = ip_range && ip_range["cidr"]
+          if rule = service.create_security_group_rule(parent_group_id, ip_protocol, from_port, to_port, cidr, group).data[:body]
+            merge_attributes(rule["security_group_rule"])
+          end
+        end
+
+        def destroy
+          requires :id
+          service.delete_security_group_rule(id)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fog/openstack/compute/models/security_group_rules.rb

@@ -0,0 +1,21 @@
+require 'fog/openstack/models/collection'
+require 'fog/openstack/compute/models/security_group_rule'
+
+module Fog
+  module OpenStack
+    class Compute
+      class SecurityGroupRules < Fog::OpenStack::Collection
+        model Fog::OpenStack::Compute::SecurityGroupRule
+
+        def get(security_group_rule_id)
+          if security_group_rule_id
+            body = service.get_security_group_rule(security_group_rule_id).body
+            new(body['security_group_rule'])
+          end
+        rescue Fog::OpenStack::Compute::NotFound
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/fog/openstack/compute/models/security_groups.rb

@@ -0,0 +1,24 @@
+require 'fog/openstack/models/collection'
+require 'fog/openstack/compute/models/security_group'
+
+module Fog
+  module OpenStack
+    class Compute
+      class SecurityGroups < Fog::OpenStack::Collection
+        model Fog::OpenStack::Compute::SecurityGroup
+
+        def all(options = {})
+          load_response(service.list_security_groups(options), 'security_groups')
+        end
+
+        def get(security_group_id)
+          if security_group_id
+            new(service.get_security_group(security_group_id).body['security_group'])
+          end
+        rescue Fog::OpenStack::Compute::NotFound
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/fog/openstack/compute/models/server.rb

@@ -0,0 +1,410 @@
+require 'fog/compute/models/server'
+require 'fog/openstack/compute/models/metadata'
+
+module Fog
+  module OpenStack
+    class Compute
+      class Server < Fog::Compute::Server
+        identity :id
+        attribute :instance_name, :aliases => 'OS-EXT-SRV-ATTR:instance_name'
+
+        attribute :addresses
+        attribute :flavor
+        attribute :host_id, :aliases => 'hostId'
+        attribute :image
+        attribute :metadata
+        attribute :links
+        attribute :name
+
+        # @!attribute [rw] personality
+        # @note This attribute is only used for server creation. This field will be nil on subsequent retrievals.
+        # @return [Hash] Hash containing data to inject into the file system of the cloud server instance during
+        #                server creation.
+        # @example To inject fog.txt into file system
+        #   :personality => [{ :path => '/root/fog.txt',
+        #                      :contents => Base64.encode64('Fog was here!')
+        #                   }]
+        # @see #create
+        # @see http://docs.openstack.org/api/openstack-compute/2/content/Server_Personality-d1e2543.html
+        attribute :personality
+        attribute :progress
+        attribute :accessIPv4
+        attribute :accessIPv6
+        attribute :availability_zone, :aliases => 'OS-EXT-AZ:availability_zone'
+        attribute :user_data_encoded
+        attribute :state,       :aliases => 'status'
+        attribute :created,     :type => :time
+        attribute :updated,     :type => :time
+
+        attribute :tenant_id
+        attribute :user_id
+        attribute :key_name
+        attribute :fault
+        attribute :config_drive
+        attribute :os_dcf_disk_config, :aliases => 'OS-DCF:diskConfig'
+        attribute :os_ext_srv_attr_host, :aliases => 'OS-EXT-SRV-ATTR:host'
+        attribute :os_ext_srv_attr_hypervisor_hostname, :aliases => 'OS-EXT-SRV-ATTR:hypervisor_hostname'
+        attribute :os_ext_srv_attr_instance_name, :aliases => 'OS-EXT-SRV-ATTR:instance_name'
+        attribute :os_ext_sts_power_state, :aliases => 'OS-EXT-STS:power_state'
+        attribute :os_ext_sts_task_state, :aliases => 'OS-EXT-STS:task_state'
+        attribute :os_ext_sts_vm_state, :aliases => 'OS-EXT-STS:vm_state'
+
+        attr_reader :password
+        attr_writer :image_ref, :flavor_ref, :nics, :os_scheduler_hints
+        attr_accessor :block_device_mapping, :block_device_mapping_v2
+
+        # In some cases it's handy to be able to store the project for the record, e.g. swift doesn't contain project
+        # info in the result, so we can track it in this attribute based on what project was used in the request
+        attr_accessor :project
+
+        def initialize(attributes = {})
+          # Old 'connection' is renamed as service and should be used instead
+          prepare_service_value(attributes)
+
+          self.security_groups = attributes.delete(:security_groups)
+          self.min_count = attributes.delete(:min_count)
+          self.max_count = attributes.delete(:max_count)
+          self.nics = attributes.delete(:nics)
+          self.os_scheduler_hints = attributes.delete(:os_scheduler_hints)
+          self.block_device_mapping = attributes.delete(:block_device_mapping)
+          self.block_device_mapping_v2 = attributes.delete(:block_device_mapping_v2)
+
+          super
+        end
+
+        def metadata
+          @metadata ||= begin
+            Fog::OpenStack::Compute::Metadata.new(:service => service,
+                                                  :parent  => self)
+          end
+        end
+
+        def metadata=(new_metadata = {})
+          return unless new_metadata
+          metas = []
+          new_metadata.each { |k, v| metas << {"key" => k, "value" => v} }
+          @metadata = metadata.load(metas)
+        end
+
+        def user_data=(ascii_userdata)
+          self.user_data_encoded = [ascii_userdata].pack('m') if ascii_userdata
+        end
+
+        def destroy
+          requires :id
+          service.delete_server(id)
+          true
+        end
+
+        def images
+          requires :id
+          service.images(:server => self)
+        end
+
+        def all_addresses
+          # currently openstack API does not tell us what is a floating ip vs a fixed ip for the vm listing,
+          # we fall back to get all addresses and filter sadly.
+          # Only includes manually-assigned addresses, not auto-assigned
+          @all_addresses ||= service.list_all_addresses.body["floating_ips"].select { |data| data['instance_id'] == id }
+        end
+
+        def os_interfaces
+          requires :id
+          service.os_interfaces(:server => self)
+        end
+
+        def reload
+          @all_addresses = nil
+          super
+        end
+
+        # returns all ip_addresses for a given instance
+        # this includes both the fixed ip(s) and the floating ip(s)
+        def ip_addresses
+          addresses ? addresses.values.flatten.collect { |x| x['addr'] } : []
+        end
+
+        def floating_ip_addresses
+          all_floating = if addresses
+                           flattened_values = addresses.values.flatten
+                           flattened_values.select { |d| d["OS-EXT-IPS:type"] == "floating" }.collect { |a| a["addr"] }
+                         else
+                           []
+                         end
+
+          # Return them all, leading with manually assigned addresses
+          manual = all_addresses.collect { |addr| addr["ip"] }
+
+          all_floating.sort do |a, b|
+            a_manual = manual.include? a
+            b_manual = manual.include? b
+
+            if a_manual && !b_manual
+              -1
+            elsif !a_manual && b_manual
+              1
+            else
+              0
+            end
+          end
+          all_floating.empty? ? manual : all_floating
+        end
+
+        def public_ip_addresses
+          if floating_ip_addresses.empty?
+            if addresses
+              addresses.select { |s| s[0] =~ /public/i }.collect { |a| a[1][0]['addr'] }
+            else
+              []
+            end
+          else
+            floating_ip_addresses
+          end
+        end
+
+        def floating_ip_address
+          floating_ip_addresses.first
+        end
+
+        def public_ip_address
+          public_ip_addresses.first
+        end
+
+        def private_ip_addresses
+          rfc1918_regexp = /(^10\.|^172\.1[6-9]\.|^172\.2[0-9]\.|^172.3[0-1]\.|^192\.168\.)/
+          almost_private = ip_addresses - public_ip_addresses - floating_ip_addresses
+          almost_private.select { |ip| rfc1918_regexp.match ip }
+        end
+
+        def private_ip_address
+          private_ip_addresses.first
+        end
+
+        attr_reader :image_ref
+
+        attr_writer :image_ref
+
+        attr_reader :flavor_ref
+
+        attr_writer :flavor_ref
+
+        def ready?
+          state == 'ACTIVE'
+        end
+
+        def failed?
+          state == 'ERROR'
+        end
+
+        def change_password(admin_password)
+          requires :id
+          service.change_server_password(id, admin_password)
+          true
+        end
+
+        def rebuild(image_ref, name, admin_pass = nil, metadata = nil, personality = nil)
+          requires :id
+          service.rebuild_server(id, image_ref, name, admin_pass, metadata, personality)
+          true
+        end
+
+        def resize(flavor_ref)
+          requires :id
+          service.resize_server(id, flavor_ref)
+          true
+        end
+
+        def revert_resize
+          requires :id
+          service.revert_resize_server(id)
+          true
+        end
+
+        def confirm_resize
+          requires :id
+          service.confirm_resize_server(id)
+          true
+        end
+
+        def security_groups
+          if id
+            requires :id
+
+            groups = service.list_security_groups(:server_id => id).body['security_groups']
+
+            groups.map do |group|
+              Fog::OpenStack::Compute::SecurityGroup.new group.merge(:service => service)
+            end
+          else
+            service.security_groups.all
+          end
+        end
+
+        attr_writer :security_groups
+
+        def reboot(type = 'SOFT')
+          requires :id
+          service.reboot_server(id, type)
+          true
+        end
+
+        def stop
+          requires :id
+          service.stop_server(id)
+        end
+
+        def pause
+          requires :id
+          service.pause_server(id)
+        end
+
+        def suspend
+          requires :id
+          service.suspend_server(id)
+        end
+
+        def start
+          requires :id
+
+          case state.downcase
+          when 'paused'
+            service.unpause_server(id)
+          when 'suspended'
+            service.resume_server(id)
+          else
+            service.start_server(id)
+          end
+        end
+
+        def shelve
+          requires :id
+          service.shelve_server(id)
+        end
+
+        def unshelve
+          requires :id
+          service.unshelve_server(id)
+        end
+
+        def shelve_offload
+          requires :id
+          service.shelve_offload_server(id)
+        end
+
+        def create_image(name, metadata = {})
+          requires :id
+          service.create_image(id, name, metadata)
+        end
+
+        def console(log_length = nil)
+          requires :id
+          service.get_console_output(id, log_length)
+        end
+
+        def migrate
+          requires :id
+          service.migrate_server(id)
+        end
+
+        def live_migrate(host, block_migration, disk_over_commit)
+          requires :id
+          service.live_migrate_server(id, host, block_migration, disk_over_commit)
+        end
+
+        def evacuate(host = nil, on_shared_storage = nil, admin_password = nil)
+          requires :id
+          service.evacuate_server(id, host, on_shared_storage, admin_password)
+        end
+
+        def associate_address(floating_ip)
+          requires :id
+          service.associate_address id, floating_ip
+        end
+
+        def disassociate_address(floating_ip)
+          requires :id
+          service.disassociate_address id, floating_ip
+        end
+
+        def reset_vm_state(vm_state)
+          requires :id
+          service.reset_server_state id, vm_state
+        end
+
+        attr_writer :min_count
+
+        attr_writer :max_count
+
+        def networks
+          service.networks(:server => self)
+        end
+
+        def volumes
+          requires :id
+          service.volumes.select do |vol|
+            vol.attachments.find { |attachment| attachment["serverId"] == id }
+          end
+        end
+
+        def volume_attachments
+          requires :id
+          service.get_server_volumes(id).body['volumeAttachments']
+        end
+
+        def attach_volume(volume_id, device_name)
+          requires :id
+          service.attach_volume(volume_id, id, device_name)
+          true
+        end
+
+        def detach_volume(volume_id)
+          requires :id
+          service.detach_volume(id, volume_id)
+          true
+        end
+
+        def save
+          raise Fog::Errors::Error, 'Resaving an existing object may create a duplicate' if persisted?
+          requires :flavor_ref, :name
+          requires_one :image_ref, :block_device_mapping, :block_device_mapping_v2
+          options = {
+            'personality'             => personality,
+            'accessIPv4'              => accessIPv4,
+            'accessIPv6'              => accessIPv6,
+            'availability_zone'       => availability_zone,
+            'user_data'               => user_data_encoded,
+            'key_name'                => key_name,
+            'config_drive'            => config_drive,
+            'security_groups'         => @security_groups,
+            'min_count'               => @min_count,
+            'max_count'               => @max_count,
+            'nics'                    => @nics,
+            'os:scheduler_hints'      => @os_scheduler_hints,
+            'block_device_mapping'    => @block_device_mapping,
+            'block_device_mapping_v2' => @block_device_mapping_v2,
+          }
+          options['metadata'] = metadata.to_hash unless @metadata.nil?
+          options = options.reject { |_key, value| value.nil? }
+          data = service.create_server(name, image_ref, flavor_ref, options)
+          merge_attributes(data.body['server'])
+          true
+        end
+
+        def setup(credentials = {})
+          requires :ssh_ip_address, :identity, :public_key, :username
+          ssh = Fog::SSH.new(ssh_ip_address, username, credentials)
+          ssh.run([
+                    %(mkdir .ssh),
+                    %(echo "#{public_key}" >> ~/.ssh/authorized_keys),
+                    %(passwd -l #{username}),
+                    %(echo "#{Fog::JSON.encode(attributes)}" >> ~/attributes.json),
+                    %(echo "#{Fog::JSON.encode(metadata)}" >> ~/metadata.json)
+                  ])
+        rescue Errno::ECONNREFUSED
+          sleep(1)
+          retry
+        end
+      end
+    end
+  end
+end