fog 1.15.0 → 1.16.0

data/lib/fog/vcloud_director/generators/compute/customization.rb

@@ -0,0 +1,105 @@
+module Fog
+  module Generators
+    module Compute
+      module VcloudDirector
+        # This is the data structure it accepts, this is the output of
+        # #get_vm_customization:
+        #
+        #   {:type=>"application/vnd.vmware.vcloud.guestCustomizationSection+xml",
+        #    :href=>
+        #     "https://example.com/api/vApp/vm-2bbbf556-55dc-4974-82e6-aa6e814f0b64/guestCustomizationSection/",
+        #    :id=>"vm-2bbbf556-55dc-4974-82e6-aa6e814f0b64",
+        #    :enabled=>false,
+        #    :change_sid=>false,
+        #    :virtual_machine_id=>"2bbbf556-55dc-4974-82e6-aa6e814f0b64",
+        #    :join_domain_enabled=>false,
+        #    :use_org_settings=>false,
+        #    :admin_password_enabled=>false,
+        #    :admin_password_auto=>true,
+        #    :reset_password_required=>false,
+        #    :customization_script=>"hola\nmundo",
+        #    :has_customization_script=>true,
+        #    :computer_name=>"DEVWEB-001"}
+        #
+        # This is what it generates:
+        #
+        #   <vcloud:GuestCustomizationSection
+        #     xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
+        #     xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
+        #     href="https://vcloud.example.com/api/vApp/vm-55cc91f2-7e12-48d4-ad90-6f637a51fd88/guestCustomizationSection/"
+        #     ovf:required="false"
+        #     type="application/vnd.vmware.vcloud.guestCustomizationSection+xml">
+        #     <ovf:Info>Specifies Guest OS Customization Settings</ovf:Info>
+        #     <vcloud:Enabled>true</vcloud:Enabled>
+        #     <vcloud:ChangeSid>true</vcloud:ChangeSid>
+        #     <vcloud:VirtualMachineId>55cc91f2-7e12-48d4-ad90-6f637a51fd88</vcloud:VirtualMachineId>
+        #     <vcloud:JoinDomainEnabled>false</vcloud:JoinDomainEnabled>
+        #     <vcloud:UseOrgSettings>false</vcloud:UseOrgSettings>
+        #     <vcloud:AdminPasswordEnabled>true</vcloud:AdminPasswordEnabled>
+        #     <vcloud:AdminPasswordAuto>true</vcloud:AdminPasswordAuto>
+        #     <vcloud:ResetPasswordRequired>false</vcloud:ResetPasswordRequired>
+        #     <vcloud:ComputerName>DEVWEB-001</vcloud:ComputerName>
+        #   </vcloud:GuestCustomizationSection>
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/types/GuestCustomizationSectionType.html
+        class Customization
+          def initialize(attrs={})
+            @attrs = attrs
+          end
+
+          def generate_xml
+            output = ""
+            output << header
+            output << body(@attrs)
+            output << tail
+            output
+          end
+
+          private
+
+          def header
+            <<-END
+            <GuestCustomizationSection xmlns="http://www.vmware.com/vcloud/v1.5"
+              xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
+              type="application/vnd.vmware.vcloud.guestCustomizationSection+xml">
+            END
+          end
+
+          # The order matters: http://communities.vmware.com/thread/448760?start=0&tstart=0
+          #
+          # CustomizationScript: Script to run on guest customization. You
+          # could use XML escape sequence &#13; to make multiple lines script.
+          # The script could contain any UNICODE symbol by specifying its
+          # number in format &#xxxx; where xxxx is the number. The predefined
+          # symbols in the XML are:
+          #   * & &amp;
+          #   * < &lt;
+          #   * > &gt;
+          #   * " &quot;
+          #   * ' &apos;
+          def body(opts={})
+            <<-END
+              <ovf:Info>Specifies Guest OS Customization Settings</ovf:Info>
+              <Enabled>#{opts[:enabled]}</Enabled>
+              <ChangeSid>#{opts[:change_sid]}</ChangeSid>
+              <VirtualMachineId>#{opts[:virtual_machine_id]}</VirtualMachineId>
+              <JoinDomainEnabled>#{opts[:join_domain_enabled]}</JoinDomainEnabled>
+              <UseOrgSettings>#{opts[:use_org_settings]}</UseOrgSettings>
+              <AdminPasswordEnabled>#{opts[:admin_password_enabled]}</AdminPasswordEnabled>
+              <AdminPasswordAuto>#{opts[:admin_password_auto]}</AdminPasswordAuto>
+              <ResetPasswordRequired>#{opts[:reset_password_required]}</ResetPasswordRequired>
+              <CustomizationScript>#{CGI::escapeHTML(opts[:customization_script]).gsub(/\r/, "&#13;")}</CustomizationScript>
+              <ComputerName>#{opts[:computer_name]}</ComputerName>
+            END
+          end
+
+          def tail
+            <<-END
+            </GuestCustomizationSection>
+            END
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/generators/compute/disks.rb

@@ -0,0 +1,186 @@
+module Fog
+  module Generators
+    module Compute
+      module VcloudDirector
+        # This is the data structure it accepts, this is the output of
+        # #get_vm_disks:
+        #
+        #   {:disks=>
+        #    [{:address=>0,
+        #      :description=>"SCSI Controller",
+        #      :name=>"SCSI Controller 0",
+        #      :id=>2,
+        #      :resource_sub_type=>"VirtualSCSI",
+        #      :resource_type=>6},
+        #     {:address_on_parent=>0,
+        #      :description=>"Hard disk",
+        #      :name=>"Hard disk 1",
+        #      :id=>2000,
+        #      :parent=>2,
+        #      :resource_type=>17,
+        #      :capacity=>16384,
+        #      :bus_sub_type=>"VirtualSCSI",
+        #      :bus_type=>6},
+        #     {:address=>0,
+        #      :description=>"IDE Controller",
+        #      :name=>"IDE Controller 0",
+        #      :id=>3,
+        #      :resource_type=>5}]}
+        #
+        # This is what it generates:
+        #
+        #   <vcloud:RasdItemsList xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
+        #     xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
+        #     type="application/vnd.vmware.vcloud.rasdItemsList+xml">
+        #     <vcloud:Item>
+        #       <rasd:Address>0</rasd:Address>
+        #       <rasd:Description>SCSI Controller</rasd:Description>
+        #       <rasd:ElementName>SCSI Controller 0</rasd:ElementName>
+        #       <rasd:InstanceID>2</rasd:InstanceID>
+        #       <rasd:ResourceSubType>VirtualSCSI</rasd:ResourceSubType>
+        #       <rasd:ResourceType>6</rasd:ResourceType>
+        #     </vcloud:Item>
+        #     <vcloud:Item>
+        #       <rasd:AddressOnParent>0</rasd:AddressOnParent>
+        #       <rasd:Description>Hard disk</rasd:Description>
+        #       <rasd:ElementName>Hard disk 1</rasd:ElementName>
+        #       <rasd:HostResource vcloud:capacity="16384" vcloud:busSubType="VirtualSCSI" vcloud:busType="6"></rasd:HostResource>
+        #       <rasd:InstanceID>2000</rasd:InstanceID>
+        #       <rasd:Parent>2</rasd:Parent>
+        #       <rasd:ResourceType>17</rasd:ResourceType>
+        #     </vcloud:Item>
+        #     <vcloud:Item>
+        #       <rasd:Address>0</rasd:Address>
+        #       <rasd:Description>IDE Controller</rasd:Description>
+        #       <rasd:ElementName>IDE Controller 0</rasd:ElementName>
+        #       <rasd:InstanceID>3</rasd:InstanceID>
+        #       <rasd:ResourceType>5</rasd:ResourceType>
+        #     </vcloud:Item>
+        #   </vcloud:RasdItemsList>
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/types/RasdItemsListType.html
+        class Disks
+          def initialize(items=[])
+            @items = items[:disks]
+          end
+
+          def modify_hard_disk_size(disk_number, new_size)
+            found = false
+            @items.each do |item|
+              if item[:resource_type] == 17
+                if item[:name] == "Hard disk #{disk_number}"
+                  found = true
+                  raise "Hard disk size can't be reduced" if item[:capacity].to_i > new_size.to_i
+                  item[:capacity] = new_size
+                end
+              end
+            end
+            raise "Hard disk #{disk_number} not found" unless found
+            true
+          end
+
+          def add_hard_disk(size)
+            new_hard_disk = last_hard_disk.dup
+            new_hard_disk[:capacity] = size
+            new_hard_disk[:name] = increase_hard_disk_name(new_hard_disk[:name])
+            new_hard_disk[:address_on_parent] += 1
+            new_hard_disk[:id] += 1
+            @items << new_hard_disk
+          end
+
+          def delete_hard_disk(disk_number)
+            @items.delete_if {|item| item[:resource_type] == 17 && item[:name] =~ /#{disk_number}$/ }
+          end
+
+          def disks
+            { :disks => @items }
+          end
+
+          def generate_xml
+            output = ""
+            output << header
+            @items.each do |item|
+              output << case item[:resource_type]
+                        when 6
+                          scsi_controller(item)
+                        when 17
+                          hard_disk_item(item)
+                        when 5
+                          ide_controller_item(item)
+                        end
+            end
+            output << tail
+            output
+          end
+
+          def header
+            <<-END
+            <vcloud:RasdItemsList xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
+              xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
+              type="application/vnd.vmware.vcloud.rasdItemsList+xml">
+            END
+          end
+
+          def tail
+            <<-END
+            </vcloud:RasdItemsList>
+            END
+          end
+
+          def hard_disk_item(opts={})
+            <<-END
+            <vcloud:Item>
+              <rasd:AddressOnParent>#{opts[:address_on_parent]}</rasd:AddressOnParent>
+              <rasd:Description>#{opts[:description]}</rasd:Description>
+              <rasd:ElementName>#{opts[:name]}</rasd:ElementName>
+              <rasd:HostResource vcloud:capacity=\"#{opts[:capacity]}\" vcloud:busSubType=\"#{opts[:bus_sub_type]}\" vcloud:busType=\"#{opts[:bus_type]}\"></rasd:HostResource>
+              <rasd:InstanceID>#{opts[:id]}</rasd:InstanceID>
+              <rasd:Parent>#{opts[:parent]}</rasd:Parent>
+              <rasd:ResourceType>17</rasd:ResourceType>
+            </vcloud:Item>
+            END
+          end
+
+          def ide_controller_item(opts={})
+            <<-END
+            <vcloud:Item>
+              <rasd:Address>#{opts[:address]}</rasd:Address>
+              <rasd:Description>#{opts[:description]}</rasd:Description>
+              <rasd:ElementName>#{opts[:name]}</rasd:ElementName>
+              <rasd:InstanceID>#{opts[:id]}</rasd:InstanceID>
+              <rasd:ResourceType>5</rasd:ResourceType>
+            </vcloud:Item>
+            END
+          end
+
+          def scsi_controller(opts={})
+            <<-END
+            <vcloud:Item>
+              <rasd:Address>#{opts[:address]}</rasd:Address>
+              <rasd:Description>#{opts[:description]}</rasd:Description>
+              <rasd:ElementName>#{opts[:name]}</rasd:ElementName>
+              <rasd:InstanceID>#{opts[:id]}</rasd:InstanceID>
+              <rasd:ResourceSubType>#{opts[:resource_sub_type]}</rasd:ResourceSubType>
+              <rasd:ResourceType>6</rasd:ResourceType>
+            </vcloud:Item>
+            END
+          end
+
+          # helpers
+
+          def last_hard_disk
+             hard_disks = @items.select{|item| item[:resource_type] == 17}
+             names = hard_disks.map{|item| item[:name] }
+             only_numbers = names.map{|b| b.scan(/\d+/).first.to_i} # extract numbers
+             last_number = only_numbers.sort.last # get the last number
+             hard_disks.detect{|hard_disk| hard_disk[:name] =~ /#{last_number}$/  }
+          end
+
+          def increase_hard_disk_name(hard_disk_name)
+            hard_disk_name.gsub(/(\d+)$/) { $1.to_i + 1 }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/generators/compute/edge_gateway.rb

@@ -0,0 +1,156 @@
+module Fog
+  module Generators
+    module Compute
+      module VcloudDirector
+        class EdgeGateway
+          def initialize(configuration={})
+            @configuration = configuration
+          end
+
+          def generate_xml
+            Nokogiri::XML::Builder.new do |xml|
+              xml.EdgeGatewayServiceConfiguration('xmlns' => "http://www.vmware.com/vcloud/v1.5"){
+                build_firewall_service(xml)
+                build_nat_service(xml)
+                build_load_balancer_service(xml)
+              }
+            end.to_xml
+          end
+
+          private
+
+          def build_load_balancer_service(xml)
+            lb_config = @configuration[:LoadBalancerService]
+            return unless lb_config
+
+            xml.LoadBalancerService {
+              xml.IsEnabled lb_config[:IsEnabled] if lb_config.key?(:IsEnabled)
+              lb_config[:Pool].each do |pool|
+                xml.Pool {
+                  xml.Name pool[:Name]
+
+                  pool[:ServicePort].each do |service_port|
+                    xml.ServicePort {
+                      xml.IsEnabled service_port[:IsEnabled]
+                      xml.Protocol service_port[:Protocol]
+                      xml.Algorithm service_port[:Algorithm]
+                      xml.Port service_port[:Port]
+                      xml.HealthCheckPort service_port[:HealthCheckPort]
+                      xml.HealthCheck {
+                        xml.Mode service_port[:HealthCheck][:Mode]
+                        xml.HealthThreshold service_port[:HealthCheck][:HealthThreshold]
+                        xml.UnhealthThreshold service_port[:HealthCheck][:UnhealthThreshold]
+                        xml.Interval service_port[:HealthCheck][:Interval]
+                        xml.Timeout service_port[:HealthCheck][:Timeout]
+                      }
+                    }
+                  end
+                  pool[:Member].each do |member|
+                    xml.Member {
+                      xml.IpAddress member[:IpAddress]
+                      xml.Weight member[:Weight]
+                      member[:ServicePort].each do |member_service_port|
+                        xml.ServicePort {
+                          xml.Protocol member_service_port[:Protocol]
+                          xml.Port member_service_port[:Port]
+                          xml.HealthCheckPort member_service_port[:HealthCheckPort]
+                        }
+                      end
+                    }
+                  end
+
+                }
+              end
+              lb_config[:VirtualServer].each do |virtual_server|
+                xml.VirtualServer {
+                  xml.IsEnabled virtual_server[:IsEnabled]
+                  xml.Name virtual_server[:Name]
+                  xml.Description virtual_server[:Description]
+                  xml.Interface(:href => virtual_server[:Interface][:href], :name => virtual_server[:Interface][:name])
+                  xml.IpAddress virtual_server[:IpAddress]
+                  virtual_server[:ServiceProfile].each do |service_profile|
+                    xml.ServiceProfile {
+                      xml.IsEnabled service_profile[:IsEnabled]
+                      xml.Protocol service_profile[:Protocol]
+                      xml.Port service_profile[:Port]
+                      xml.Persistence {
+                        xml.Method service_profile[:Persistence][:method]
+                        if service_profile[:Persistence][:Method] == 'COOKIE'
+                          xml.CookieName service_profile[:Persistence][:CookieName]
+                          xml.CookieMode service_profile[:Persistence][:CookieMode]
+                        end
+                      }
+                    }
+                  end
+                  xml.Logging virtual_server[:Logging]
+                  xml.Pool virtual_server[:Pool]
+                }
+              end
+            }
+          end
+
+          def build_nat_service(xml)
+            nat_config = @configuration[:NatService]
+            return unless nat_config
+
+            xml.NatService {
+              xml.IsEnabled nat_config[:IsEnabled]
+
+              nat_config[:NatRule].each do |rule|
+                xml.NatRule {
+                  xml.RuleType rule[:RuleType]
+                  xml.IsEnabled rule[:IsEnabled]
+                  xml.Id rule[:Id]
+                  gateway_nat_rule = rule[:GatewayNatRule]
+                  xml.GatewayNatRule {
+                    xml.Interface(:name => gateway_nat_rule[:Interface][:name], :href => gateway_nat_rule[:Interface][:href])
+                    xml.OriginalIp gateway_nat_rule[:OriginalIp]
+                    xml.OriginalPort gateway_nat_rule[:OriginalPort] if gateway_nat_rule.key?(:OriginalPort)
+                    xml.TranslatedIp gateway_nat_rule[:TranslatedIp]
+                    xml.TranslatedPort gateway_nat_rule[:TranslatedPort] if gateway_nat_rule.key?(:TranslatedPort)
+                    xml.Protocol gateway_nat_rule[:Protocol] if rule[:RuleType] == "DNAT"
+                  }
+                }
+              end
+            }
+          end
+
+          def build_firewall_service(xml)
+            firewall_config = @configuration[:FirewallService]
+            return unless firewall_config
+
+            xml.FirewallService {
+              xml.IsEnabled firewall_config[:IsEnabled]
+              xml.DefaultAction firewall_config[:DefaultAction] if firewall_config.key?(:DefaultAction)
+              xml.LogDefaultAction firewall_config[:LogDefaultAction] if firewall_config.key?(:LogDefaultAction)
+              firewall_config[:FirewallRule].each do |rule|
+                xml.FirewallRule {
+                  xml.Id rule[:Id]
+                  xml.IsEnabled rule[:IsEnabled] if rule.key?(:IsEnabled)
+                  xml.MatchOnTranslate rule[:MatchOnTranslate] if rule.key?(:MatchOnTranslate)
+                  xml.Description rule[:Description]
+                  xml.Policy rule[:Policy]
+
+                  xml.Protocols {
+                    rule[:Protocols].each do |protocol, is_enabled|
+                      xml.send(protocol.to_s.capitalize, is_enabled)
+                    end
+                  }
+                  xml.IcmpSubType "any" if (rule[:Protocols].include?(:Icmp)  && rule[:Protocols][:Icmp] == true )
+                  xml.Port rule[:Port] == "Any" ? "-1" : rule[:Port]
+                  xml.DestinationPortRange rule[:DestinationPortRange]
+                  xml.DestinationIp rule[:DestinationIp]
+                  xml.SourcePort rule[:SourcePort] == "Any" ? "-1" : rule[:SourcePort]
+                  xml.SourcePortRange rule[:SourcePortRange]
+                  xml.SourceIp rule[:SourceIp]
+                }
+
+              end
+            }
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/fog/vcloud_director/generators/compute/metadata.rb

@@ -0,0 +1,104 @@
+module Fog
+  module Generators
+    module Compute
+      module VcloudDirector
+        #   {:metadata=>
+        #    {"buenas si"=>"no tanto ya",
+        #     "hola"=>"adios"},
+        #    :type=>"application/vnd.vmware.vcloud.metadata+xml",
+        #    :href=>
+        #     "https://example.com/api/vApp/vm-18545e82-d919-4071-ae7e-d1300d9d8112/metadata",
+        #    :id=>"vm-18545e82-d919-4071-ae7e-d1300d9d8112"}
+        #
+        # This is what it generates:
+        #
+        #   <Metadata xmlns="http://www.vmware.com/vcloud/v1.5" type="application/vnd.vmware.vcloud.metadata+xml"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 http://10.194.1.65/api/v1.5/schema/master.xsd">
+        #     <MetadataEntry>
+        #       <Key>buenas si</Key>
+        #       <Value>no tanto ya</Value>
+        #     </MetadataEntry>
+        #     <MetadataEntry">
+        #       <Key>hola</Key>
+        #       <Value>adios</Value>
+        #     </MetadataEntry>
+        #   </Metadata>
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/types/MetadataType.html
+        class MetadataBase
+          attr_reader :attrs
+
+          def initialize(attrs={})
+            @attrs = attrs
+          end
+
+          def generate_xml
+            output = ""
+            output << header
+            attrs[:metadata].each_pair do |k,v|
+              output << metadata_entry(k,v)
+            end
+            output << tail
+            output
+          end
+
+          def add_item(k,v)
+            @attrs[:metadata].merge!(Hash[k,v])
+          end
+
+          # 1.5
+          def header
+            <<-END
+            <Metadata
+              xmlns="http://www.vmware.com/vcloud/v1.5"
+              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+              type="application/vnd.vmware.vcloud.metadata+xml">
+            END
+          end
+
+          def metadata_entry
+            raise "This is an abstract class. Use the appropriate subclass"
+          end
+
+          # 5.1
+          #def header
+          #  '<Metadata xmlns="http://www.vmware.com/vcloud/v1.5"
+          #    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          #    type="application/vnd.vmware.vcloud.metadata+xml"
+          #    href="https://devlab.mdsol.com/api/vApp/vm-345c3619-edcd-4a8c-a8b9-c69ace3f89d1/metadata"
+          #    xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 http://10.194.1.65/api/v1.5/schema/master.xsd">'
+          #end
+
+          def tail
+            <<-END
+            </Metadata>
+            END
+          end
+        end
+
+        class MetadataV51 < MetadataBase
+          def metadata_entry(key, value)
+            <<-END
+            <MetadataEntry type="application/vnd.vmware.vcloud.metadata.value+xml">
+              <Key>#{key}</Key>
+              <TypedValue xsi:type="MetadataStringValue">
+                <Value>#{value}</Value>
+              </TypedValue>
+            </MetadataEntry>
+            END
+          end
+        end
+
+        class MetadataV15 < MetadataBase
+          def metadata_entry(key, value)
+            <<-END
+            <MetadataEntry>
+              <Key>#{key}</Key>
+              <Value>#{value}</Value>
+            </MetadataEntry>
+            END
+          end
+        end
+      end
+    end
+  end
+end