Class: Deltacloud::Drivers::Fgcp::FgcpDriver

Inherits:
BaseDriver
  • Object
show all
Defined in:
lib/deltacloud/drivers/fgcp/fgcp_driver.rb

Constant Summary collapse

CERT_DIR =
ENV['FGCP_CERT_DIR'] || File::expand_path('~/.deltacloud/drivers/fgcp')

Constants inherited from BaseDriver

BaseDriver::MEMBER_SHOW_METHODS, BaseDriver::STATE_MACHINE_OPTS

Instance Method Summary collapse

Methods inherited from BaseDriver

#address, #api_provider, #blob, #bucket, #catched_exceptions_list, constraints, define_hardware_profile, define_instance_states, driver_name, feature, features, #filter_hardware_profiles, #filter_on, #find_hardware_profile, #firewall, #hardware_profile, hardware_profiles, #has_capability?, #has_feature?, has_feature?, #image, #instance, #instance_actions_for, instance_state_machine, #instance_state_machine, #key, #name, #realm, #storage_snapshot, #storage_volume, #supported_collections

Methods included from Exceptions

exception_from_status, exceptions, included, logger, #safely

Instance Method Details

#addresses(credentials, opts = {}) ⇒ Object

Addresses



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 646

def addresses(credentials, opts={})
  addrs_to_instance = {}
  ips_per_vsys = {}
  safely do
    client = new_client(credentials)
    opts ||= {}
    public_ips = client.list_public_ips(opts[:realm_id])['publicips']
    return [] if public_ips.nil? or public_ips[0]['publicip'].nil?

    # first discover the VSYS each address belongs to
    public_ips[0]['publicip'].each do |ip|
      if not opts[:id] or opts[:id] == ip['address'][0]

        ips_per_vsys[ip['vsysId'][0]] ||= []
        ips_per_vsys[ip['vsysId'][0]] << ip['address'][0]
      end
    end

    ips_per_vsys.each_pair do |vsys_id, ips|
      #nat rules show both mapped and unmapped IP addresses
      #may not have privileges to view nat rules on this vsys
      begin
        fw_id = "#{vsys_id}-S-0001"
        nat_rules = client.get_efm_configuration(fw_id, 'FW_NAT_RULE')['efm'][0]['firewall'][0]['nat'][0]['rules'][0]
      rescue RuntimeError => ex
        raise ex unless ex.message =~ /^(ACCESS_NOT_PERMIT).*/
      end

      if nat_rules and nat_rules['rule']
        # collect all associated IP addresses (pub->priv) in vsys
        associated_ips = {}

        nat_rules['rule'].each do |rule|
          if opts[:id].nil? or opts[:id] == rule['publicIp'][0] # filter on public IP if specified
            associated_ips[rule['publicIp'][0]] = rule['privateIp'][0] if rule['privateIp']
          end
        end

        # each associated target private IP belongs to either a vserver or SLB
        # 1. for vservers, obtain all ids from get_vsys_configuration in one call
        vsys = client.get_vsys_configuration(vsys_id)
        vsys['vsys'][0]['vservers'][0]['vserver'].each do |vserver|

          if determine_server_type(vserver) == 'vserver'
            vnic = vserver['vnics'][0]['vnic'][0]

            associated_ips.find do |pub,priv|
              addrs_to_instance[pub] = vserver['vserverId'][0] if priv == vnic['privateIp'][0]
            end if vnic['privateIp'] # when an instance is being created, the private ip is not known yet

          end
        end # of loop over vsys' vservers

        # 2. for slbs, obtain all ids from list_efm
        if addrs_to_instance.keys.size < associated_ips.keys.size # only if associated ips left to process

          if slbs = client.list_efm(vsys_id, 'SLB')['efms']
            slbs[0]['efm'].find do |slb|

              associated_ips.find do |pub,priv|
                addrs_to_instance[pub] = slb['efmId'][0] if priv == slb['slbVip'][0]
              end
              addrs_to_instance.keys.size < associated_ips.keys.size # stop if no associated ips left to process
            end
          end
        end
      end # of nat_rules has rules
    end # of ips_per_vsys.each
  end

  addresses = []
  ips_per_vsys.values.each do |pubs|
    addresses += pubs.collect do |pub|
      Address.new(:id => pub, :instance_id => addrs_to_instance[pub])
    end
  end
  addresses
end

#associate_address(credentials, opts = {}) ⇒ Object



802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 802

def associate_address(credentials, opts={})
  safely do
    client = new_client(credentials)
    vsys_id = client.extract_vsys_id(opts[:instance_id])

    begin
      # enable IP in case not enabled already
      client.attach_public_ip(vsys_id, opts[:id])
      sleep(8)
    rescue Exception => ex
      raise ex unless ex.message =~ /^ALREADY_ATTACHED.*/
    end

    # retrieve private address
    # use get_vsys_configuration (instead of get_vserver_configuration) to also know if instance is an SLB
    vsys_config = client.get_vsys_configuration(vsys_id)
    vserver = vsys_config['vsys'][0]['vservers'][0]['vserver'].find { |e| e['vserverId'][0] == opts[:instance_id] }

    case determine_server_type(vserver)
    when 'vserver'
      private_ip = vserver['vnics'][0]['vnic'][0]['privateIp'][0]
    when 'SLB'
      if slbs = client.list_efm(vsys_id, 'SLB')['efms']
        private_ip = slbs[0]['efm'].find { |slb| slb['slbVip'][0] if slb['efmId'][0] == opts[:instance_id] }
      end
    end if vserver

    fw_id = "#{vsys_id}-S-0001"
    nat_rules = client.get_efm_configuration(fw_id, 'FW_NAT_RULE')['efm'][0]['firewall'][0]['nat'][0]['rules'][0]

	# TODO: if no IP address enabled yet
    if nat_rules and not nat_rules.empty? and nat_rules['rule'].find { |rule| rule['publicIp'][0] == opts[:id] }

      nat_rules['rule'].each do |rule|

        if rule['publicIp'][0] == opts[:id]
          rule['privateIp'] = [ private_ip ]
          rule['snapt'] = [ 'true' ]
        else
          rule['snapt'] = [ 'false' ]
        end
      end
    end

    new_rules = {
      'configuration' => [
        'firewall_nat'  => [nat_rules]
    ]}

    # create FW configuration xml file with new rules
    conf_xml_new = XmlSimple.xml_out(new_rules,
      'RootName' => 'Request'
    )
    client.update_efm_configuration(fw_id, 'FW_NAT_RULE', conf_xml_new)

    Address.new(:id => opts[:id], :instance_id => opts[:instance_id])
  end
end

#attach_storage_volume(credentials, opts = {}) ⇒ Object



546
547
548
549
550
551
552
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 546

def attach_storage_volume(credentials, opts={})
  safely do
    client = new_client(credentials)
    client.attach_vdisk(opts[:instance_id], opts[:id])
  end
  storage_volumes(credentials, opts).first
end

#configured_providersObject

following method enables region drop-down box on GUI



1402
1403
1404
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 1402

def configured_providers
  Deltacloud::Drivers::driver_config[:fgcp][:entrypoints]['default'].keys.sort
end

#create_address(credentials, opts = {}) ⇒ Object

allocates (and enables) new ip in specified vsys/network



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 726

def create_address(credentials, opts={})
  safely do
    client = new_client(credentials)
    opts ||= {}
    if opts[:realm_id]
      # just in case a network realm was passed in
      opts[:realm_id] = client.extract_vsys_id(opts[:realm_id])
    else
      # get first vsys
      xml = client.list_vsys['vsyss']
      opts[:realm_id] = xml[0]['vsys'][0]['vsysId'][0] if xml
    end

    old_ips = []
    xml = client.list_public_ips(opts[:realm_id])['publicips']
    old_ips = xml[0]['publicip'].collect { |ip| ip['address'][0]} if xml and xml[0]['publicip']

    client.allocate_public_ip(opts[:realm_id])
    # new address not returned immediately:
    # Seems to take 15-30s. to appear in list, so poll for a while
    # prepare dummy id in case new ip does not appear soon.
    id = 'PENDING-xxx.xxx.xxx.xxx'
    sleep(8)
    10.times {

      sleep(5)
      xml = client.list_public_ips(opts[:realm_id])['publicips']
      if xml and xml[0]['publicip'] and xml[0]['publicip'].size > old_ips.size

        new_ips = xml[0]['publicip'].collect { |ip| ip['address'][0]}
        new_ip = (new_ips - old_ips).first
        # enable IP address
        client.attach_public_ip(opts[:realm_id], new_ip)
        id = new_ip
        break
      end
    }
    Address.new(:id => id)
  end
end

#create_firewall(credentials, opts = {}) ⇒ Object



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 1016

def create_firewall(credentials, opts={})
  safely do
    client = new_client(credentials)
    begin
      # using 'description' as vsysDescriptor
      vsys_id = client.create_vsys(opts['description'], opts['name'])['vsysId'][0]
    rescue Exception => ex
      raise ex unless ex.message =~ /Template does not exist.*/
      descriptors = client.list_vsys_descriptor['vsysdescriptors'][0]['vsysdescriptor'].collect { |desc| desc['vsysdescriptorId'][0] }
      raise "Descriptor [#{opts['name']}] does not exist. Specify one of [#{descriptors.join(', ')}] as firewall description"
    end
    fw_id = vsys_id + '-S-0001'
    Firewall.new({
      :id           => fw_id,
      :name         => opts['name'],
      :description  => opts['description'],
      :owner_id     => '',
      :rules        => []
    })
  end
end

#create_image(credentials, opts = {}) ⇒ Object

Create a new image from the given instance, with optionally provided name and description



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 134

def create_image(credentials, opts={})
  safely do
    client = new_client(credentials)

    if opts[:name].nil?
      # default to instance name
      instance = client.get_vserver_attributes(opts[:id])
      opts[:name] ||= instance['vserver'][0]['vserverName']
      opts[:description] ||= opts[:name]
    end

    client.register_private_disk_image(opts[:id], opts[:name], opts[:description])
    hwps = hardware_profiles(credentials)

    #can't retrieve image info until it's completed
    Image.new(
      :id                => "PENDING-#{opts[:name]}", #TODO: add check to create_instance to raise error for this image ID?
      :name              => opts[:name],
      :description       => opts[:description],
      :state             => 'PENDING',
      :hardware_profiles => hwps
    )
  end
end

#create_instance(credentials, image_id, opts = {}) ⇒ Object

Create a new instance, given an image id opts can include an optional name for the instance, hardware profile (hwp_id) and realm_id



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 346

def create_instance(credentials, image_id, opts={})
  name = (opts[:name] && opts[:name].length > 0)? opts[:name] : "server_#{Time.now.to_s}"
  # default to 'economy' or obtain latest hardware profiles and pick the lowest spec profile?
  hwp = opts[:hwp_id] || 'economy'
  network_id = opts[:realm_id]
  safely do
    client = new_client(credentials)
    if not network_id
      xml = client.list_vsys['vsyss']

      # use first returned system's DMZ as realm
      network_id = xml ? xml[0]['vsys'][0]['vsysId'][0] + '-N-DMZ' : nil
    end
    if opts[:instance_count] and opts[:instance_count].to_i > 1

      vservers = Array.new(opts[:instance_count].to_i) { |n|
        {
          'vserverName' => "#{name}_#{n+1}",
          'vserverType' => hwp,
          'diskImageId' => image_id,
          'networkId'   => network_id
        }
      }
      new_vservers = { 'vservers' => { 'vserver' => vservers } }
      vservers_xml = XmlSimple.xml_out(new_vservers,
        'RootName' => 'Request',
        'NoAttr' => true
      )

      xml = client.create_vservers(client.extract_vsys_id(network_id), vservers_xml)
      vserver_ids = xml['vservers'][0]['vserver'].collect { |vserver| vserver['vserverId'][0] }
      # returns vservers' details using filter
      instances(credentials, {:realm_id => network_id}).select { |instance|
        vserver_ids.include? instance.id
      }
    else
      xml = client.create_vserver(name, hwp, image_id, network_id)
      # returns vserver details
      instances(credentials, {:id => xml['vserverId'][0]}).first
    end
  end
end

#create_load_balancer(credentials, opts = {}) ⇒ Object



1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 1255

def create_load_balancer(credentials, opts={})
  safely do
    client = new_client(credentials)
    # if opts['realm_id'].nil? network id specified, pick first vsys' DMZ
    # if realm has SLB already, use that, else create
    # CreateEFM -vsysId vsysId -efmType SLB -efmName opts['name'] -networkId opts['realm_id']
    # if not started already, start
    # add group and return :id => efmId_groupId
    network_id = opts[:realm_id]
    if not network_id
      xml = client.list_vsys['vsyss']

      # use first returned system's DMZ as realm
      network_id = xml ? xml[0]['vsys'][0]['vsysId'][0] + '-N-DMZ' : nil
    end
    efm = client.create_efm('SLB', opts[:name], network_id)
#        [{:load_balancer_port => opts['listener_balancer_port'],
#          :instance_port => opts['listener_instance_port'],
#          :protocol => opts['listener_protocol']}]
#      )
    load_balancer(credentials, {:id => efm['efmId'][0]})
  end
end

#create_storage_snapshot(credentials, opts = {}) ⇒ Object



621
622
623
624
625
626
627
628
629
630
631
632
633
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 621

def create_storage_snapshot(credentials, opts={})
  safely do
    client = new_client(credentials)
    client.backup_vdisk(opts[:volume_id])
  end

  StorageSnapshot.new(
    :id                 => "PENDING-#{opts[:volume_id]}", # don't know id until backup completed
    :state              => 'PENDING', # OK to make up a state like that?
    :storage_volume_id  => opts[:volume_id],
    :created            => Time.now.to_s
  )
end

#create_storage_volume(credentials, opts = {}) ⇒ Object



503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 503

def create_storage_volume(credentials, opts={})
  opts ||= {}
  opts[:name]     ||= Time.now.to_s
  opts[:capacity] ||= '1' # DC default
  #size has to be a multiple of 10: round up.
  opts[:capacity] = ((opts[:capacity].to_f / 10.0).ceil * 10.0).to_s

  safely do
    client = new_client(credentials)

    if opts[:realm_id]
      # just in case the user got confused and specified a network id
      opts[:realm_id] = client.extract_vsys_id(opts[:realm_id])
    elsif xml = client.list_vsys['vsyss']

      # use first vsys returned as realm
      opts[:realm_id] = xml[0]['vsys'][0]['vsysId'][0] if xml
    end

    vdisk_id = client.create_vdisk(opts[:realm_id], opts[:name], opts[:capacity])['vdiskId'][0]

    StorageVolume.new(
      :id          => vdisk_id,
      :created     => Time.now.to_s,
      :name        => opts[:name],
      :capacity    => opts[:capacity],
      :realm_id    => client.extract_vsys_id(opts[:realm_id]),
      :instance_id => nil,
      :state       => 'DEPLOYING',
      # aligning with rhevm, which returns 'system' or 'data'
      :kind        => 'data',
      :actions     => []
    )
  end
end

#delete_firewall(credentials, opts = {}) ⇒ Object



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 1038

def delete_firewall(credentials, opts={})
  safely do
    client = new_client(credentials)
    begin
      # try to stop FW first
      opts[:id] =~ /^(.*-S-)\d\d\d\d/
      fw_id = $1 + '0001'
      client.stop_efm(fw_id)
    rescue Exception => ex
      raise ex if not ex.message =~ /ALREADY_STOPPED.*/
      client.destroy_vsys(client.extract_vsys_id(opts[:id]))
      return
    end

    Thread.new {
      attempts = 0
      begin
        sleep 30
        # this may fail if the FW is still stopping
        client.destroy_vsys(client.extract_vsys_id(opts[:id]))
      rescue Exception => ex
        raise unless attempts < 20 and ex.message =~ /SERVER_RUNNING.*/
        # Stopping takes a few minutes, so keep trying for a while
        attempts += 1
        retry
      end
    }
    raise 'Firewall will be deleted once it has stopped'
  end
end

#delete_firewall_rule(credentials, opts = {}) ⇒ Object

FW rule creation not supported: fgcp backend requires a mandatory rule id to create (insert) a new rule into the existing accept/deny rules. Also, the first two digits of the five digit rule identify what from and to network segment (e.g. Internet to DMZ, or Secure2 to Secure1) the rule applies to. The current Deltacloud firewall collection API does not cover such functionality so it was deemed not suitable to implement.

def create_firewall_rule(credentials, opts={})
  p opts
end


1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 1080

def delete_firewall_rule(credentials, opts={})
  # retrieve current FW rules, delete rule, send back to API server
  safely do
    client = new_client(credentials)
    conf_xml_old = <<-"eofwopxml"
<?xml version="1.0" encoding ="UTF-8"?>
<Request>
<configuration>
  <firewall_policy>
  </firewall_policy>
</configuration>
</Request>
eofwopxml

    # retrieve current rules
    fw = client.get_efm_configuration(opts[:firewall], 'FW_POLICY', conf_xml_old)
    rule50000_log = 'On'

    # delete specified rule and special rule 50000 (handled later)
    fw['efm'][0]['firewall'][0]['directions'][0]['direction'].reject! do |direction|

      direction['policies'][0]['policy'].reject! do |policy|

        rule_id = policy['id'][0]
        # need to use (final) 3 digit id
        policy['id'][0] = rule_id[2..4]
        # storage rule 50000's log attribute for later
        rule50000_log = policy['log'][0] if rule_id == '50000'
        # some elements not allowed if service is NTP, DNS, etc.
        if not policy['dstService'][0] == 'NONE'
          policy.delete('dstType')
          policy.delete('dstPort')
          policy.delete('protocol')
        end
        rule_id == opts[:rule_id] or rule_id == '50000'
      end

      direction['policies'][0]['policy'].empty?
    end

    # add entry for 50000 special rule
    fw['efm'][0]['firewall'][0]['directions'][0]['direction'] << {
      'policies' => [
        'policy' => [
          'log' => [ rule50000_log ]
        ]
      ]
    }

    new_rules = {
      'configuration'   => [
        'firewall_policy' => [
          'directions'      => fw['efm'][0]['firewall'][0]['directions']
      ]
    ]}

    # create FW configuration xml file with new rules
    conf_xml_new = XmlSimple.xml_out(new_rules,
      'RootName' => 'Request'
      )
    conf_xml_new.gsub!(/(<(to|from)>).+(INTERNET|INTRANET)/, '\1\3')

    client.update_efm_configuration(opts[:firewall], 'FW_POLICY', conf_xml_new)
  end
end

#destroy_address(credentials, opts = {}) ⇒ Object



767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 767

def destroy_address(credentials, opts={})
  opts ||= {}
  safely do
    client = new_client(credentials)
    if opts[:realm_id]
      opts[:realm_id] = client.extract_vsys_id(opts[:realm_id])
    else
      xml = client.list_public_ips['publicips']
      if xml
        xml[0]['publicip'].find do |ip|
          opts[:realm_id] = ip['vsysId'][0] if opts[:id] == ip['address'][0]
        end
      end
    end
    begin
      # disable IP if still enabled
      client.detach_public_ip(opts[:realm_id], opts[:id])
      sleep(8)
    rescue Exception => ex
      raise ex unless ex.message =~ /^ALREADY_DETACHED.*/
    end
    attempts = 0
    begin
      # this may fail if the ip is still detaching, hence retry for a while
      client.free_public_ip(opts[:realm_id], opts[:id])
    rescue Exception => ex
      raise unless attempts < 10 and ex.message =~ /^ILLEGAL_CONDITION.*/
      # Detaching seems to take 15-30s, so keep trying for a while
      sleep(5)
      attempts += 1
      retry
    end
  end
end

#destroy_image(credentials, image_id) ⇒ Object



159
160
161
162
163
164
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 159

def destroy_image(credentials, image_id)
  safely do
    client = new_client(credentials)
    client.unregister_disk_image(image_id)
  end
end

#destroy_instance(credentials, id) ⇒ Object

Destroy an instance, given its id.



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 390

def destroy_instance(credentials, id)
  safely do
    client = new_client(credentials)
    vsys_id = client.extract_vsys_id(id)
    if id == "#{vsys_id}-S-0001" # if FW
      client.destroy_vsys(vsys_id)
    else
      # vserver or SLB (no way to tell which from id)
      begin
        client.destroy_vserver(id)
      rescue Exception => ex
        # if not found, try destroying as SLB
        if not ex.message =~ /VALIDATION_ERROR.*/
          raise ex
        else
          begin
            client.destroy_efm(id)
          rescue
            # if that fails as well, just raise the original error
            raise ex
          end
        end
      end
    end
  end
end

#destroy_load_balancer(credentials, id) ⇒ Object



1279
1280
1281
1282
1283
1284
1285
1286
1287
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 1279

def destroy_load_balancer(credentials, id)
  safely do
    client = new_client(credentials)
    # remove group from SLB
    # if no groups left, stop and destroy SLB
    # destroy in new thread? May fail if public IP associated?
    client.destroy_efm(id)
  end
end

#destroy_storage_snapshot(credentials, opts = {}) ⇒ Object



635
636
637
638
639
640
641
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 635

def destroy_storage_snapshot(credentials, opts={})
  vdisk_id, backup_id = split_snapshot_id(opts[:id])
  safely do
    client = new_client(credentials)
    client.destroy_vdisk_backup(client.extract_vsys_id(opts[:id]), backup_id)
  end
end

#destroy_storage_volume(credentials, opts = {}) ⇒ Object



539
540
541
542
543
544
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 539

def destroy_storage_volume(credentials, opts={})
  safely do
    client = new_client(credentials)
    client.destroy_vdisk(opts[:id])
  end
end

#detach_storage_volume(credentials, opts = {}) ⇒ Object



554
555
556
557
558
559
560
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 554

def detach_storage_volume(credentials, opts={})
  safely do
    client = new_client(credentials)
    client.detach_vdisk(opts[:instance_id], opts[:id])
  end
  storage_volumes(credentials, opts)
end

#disassociate_address(credentials, opts = {}) ⇒ Object



861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 861

def disassociate_address(credentials, opts={})
  safely do
    client = new_client(credentials)

    if not opts[:realm_id]

      if public_ips = client.list_public_ips['publicips']

        public_ips[0]['publicip'].find do |ip|
          opts[:realm_id] = ip['vsysId'][0] if opts[:id] == ip['address'][0]
        end
      end
    end

    vsys_id = client.extract_vsys_id(opts[:realm_id])
    fw_id = "#{vsys_id}-S-0001"
    nat_rules = client.get_efm_configuration(fw_id, 'FW_NAT_RULE')['efm'][0]['firewall'][0]['nat'][0]['rules'][0]

    if nat_rules and not nat_rules.empty? # happens only if no enabled IP address?

      nat_rules['rule'].reject! { |rule| rule['publicIp'][0] == opts[:id] }
    end

    new_rules = {
      'configuration' => [
        'firewall_nat'  => [nat_rules]
    ]}

    # create FW configuration xml file with new rules
    conf_xml_new = XmlSimple.xml_out(new_rules,
      'RootName' => 'Request'
    )

    client.update_efm_configuration(fw_id, 'FW_NAT_RULE', conf_xml_new)
  end
end

#firewalls(credentials, opts = {}) ⇒ Object

Firewalls



901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 901

def firewalls(credentials, opts={})
  firewalls = []
  fw_name = 'Firewall' # currently always 'Firewall'

  safely do
    client = new_client(credentials)
    if opts and opts[:id]
      # get details incl. rules on single FW
      rules = []

      configuration_xml = <<-"eofwpxml"
<?xml version="1.0" encoding ="UTF-8"?>
<Request>
<configuration>
  <firewall_policy>
  </firewall_policy>
</configuration>
</Request>
eofwpxml

      begin
        fw = client.get_efm_configuration(opts[:id], 'FW_POLICY', configuration_xml)
      rescue Exception => ex
        return [] if ex.message =~ /RESOURCE_NOT_FOUND/
        raise
      end
      fw_name = fw['efm'][0]['efmName'][0] # currently always 'Firewall'
      fw_owner_id = fw['efm'][0]['creator'][0]
      rule50000_log = true

      if fw['efm'][0]['firewall'][0]['directions'] and fw['efm'][0]['firewall'][0]['directions'][0]['direction']
        fw['efm'][0]['firewall'][0]['directions'][0]['direction'].each do |direction|

          direction['policies'][0]['policy'].each do |policy|

            sources = []
            ['src', 'dst'].each do |e|

              if policy[e] and policy[e][0] and not policy[e][0].empty?

                ip_address_type = policy["#{e}Type"][0]
                address = policy[e][0]
                address.sub!('any', '0.0.0.0/0') if ip_address_type == 'IP'
                address += '/32' if ip_address_type == 'IP' and not address =~ /.*\/.*/

                sources << {
                  :type    => 'address',
                  :family  => 'ipv4',
                  :address => address.split('/').first,
                  :prefix  => ip_address_type == 'IP' ? address.split('/').last : nil
                }
              end
            end

            # defining ingress as access going from Internet/Intranet -> DMZ -> SECURE1 -> SECURE2
            ingress = policy['id'][0] =~ /[13].*/ ? 'ingress' : 'egress'

            rules << FirewallRule.new({
              :id             => policy['id'][0],
              :rule_action    => policy['action'][0].downcase,
              :log_rule       => policy['log'][0] == 'On',
              :allow_protocol => policy['protocol'][0],
              :port_from      => policy['srcPort'] ? policy['srcPort'][0] : nil, # not set for e.g. ICMP
              :port_to        => policy['dstPort'] ? policy['dstPort'][0] : nil, # not set for e.g. ICMP
              :direction      => ingress,
              :sources        => sources
            }) unless policy['id'][0] == '50000' # special case added later

            rule50000_log = (policy['log'][0] == 'On') if policy['id'][0] == '50000'
          end
        end
      end

      # add "all deny" rule 50000
      source_any = {
        :type    => 'address',
        :family  => 'ipv4',
        :address => '0.0.0.0',
        :prefix  => '0'
      }
      rules << FirewallRule.new({
        :id             => '50000',
        :rule_action    => 'deny',
        :log_rule       => rule50000_log,
        :sources        => [source_any]
      })

      vsys = client.get_vsys_attributes(client.extract_vsys_id(opts[:id]))['vsys'][0]
      firewalls << Firewall.new({
        :id       => opts[:id],
        :name     => fw_name,
        :description => "#{vsys['vsysName'][0]} [#{vsys['baseDescriptor'][0]}]",
        :owner_id => fw_owner_id,
        :rules    => rules
      })
    else
      xml = client.list_vsys['vsyss']
      return [] if xml.nil?

      firewalls = xml[0]['vsys'].collect do |vsys|

        Firewall.new({
          :id => vsys['vsysId'][0] + '-S-0001',
          :name => fw_name,
          :description => "#{vsys['vsysName'][0]} [#{vsys['baseDescriptor'][0]}]",
          :rules => [],
          :owner_id => vsys['creator'][0]
        })
      end
    end
  end

  firewalls
end

#hardware_profiles(credentials, opts = nil) ⇒ Object

Hardware profiles



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 68

def hardware_profiles(credentials, opts=nil)
  safely do
    client = new_client(credentials)
    xml = client.list_server_types

    @hardware_profiles = []
    if xml['servertypes']
      xml['servertypes'][0]['servertype'].each do |type|

        arch = type['cpu'][0]['cpuArch'][0] # returns 'IA' or 'SPARC'. IA currently offered is x86_64
        cpu = type['cpu'][0]['cpuPerf'][0].to_f * type['cpu'][0]['numOfCpu'][0].to_i

        @hardware_profiles << ::Deltacloud::HardwareProfile.new(type['name'][0]) {
          cpu          cpu.to_f == cpu.to_f.floor ? cpu.to_i : cpu.to_f # omit '.0' if whole number
          memory       (type['memory'][0]['memorySize'][0].to_f * 1024) # converted to MB
          architecture (arch == 'IA') ? 'x86_64' : arch
          #storage <- defined by image, not hardware profile
          #if 'storage' is not added, displays 'storage:0' in GUI
          #storage ''
        }
      end
    end
  end
  filter_hardware_profiles(@hardware_profiles, opts)
end

#images(credentials, opts = {}) ⇒ Object

Images



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 97

def images(credentials, opts={})
  images = []

  safely do
    client = new_client(credentials)
    xml = client.list_disk_images
    hwps = hardware_profiles(credentials)

    # use client to get a list of images from the back-end cloud and then create
    # a Deltacloud Image object for each of these. Filter the result
    # (eg specific image requested) and return to user
    if xml['diskimages'] # not likely to not be so, but just in case
      xml['diskimages'][0]['diskimage'].each do |img|

        images << Image.new(
          :id => img['diskimageId'][0],
          :name => img['diskimageName'][0].to_s,
          :description => img['description'][0].to_s,
          :owner_id => img['registrant'][0].to_s, # or 'creatorName'?
          :state => 'AVAILABLE', #server keeps no particular state. If it's listed, it's available for use.
          # This will determine image architecture using OS name.
          # Usually the OS name includes '64bit' or '32bit'. If not,
          # it will fall back to 64 bit.
          :architecture => img['osName'][0].to_s =~ /.*32.?bit.*/ ? 'i386' : 'x86_64',
          :hardware_profiles => hwps
        ) if opts[:id].nil? or opts[:id] == img['diskimageId'][0]
      end
    end
  end

  images = filter_on( images, :id, opts )
  images = filter_on( images, :architecture, opts )
  images = filter_on( images, :owner_id, opts )
  images.sort_by{|e| [e.owner_id, e.architecture, e.name, e.description]}
end

#instances(credentials, opts = {}) ⇒ Object

Instances



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 227

def instances(credentials, opts={})
  instances = []

  safely do
    client = new_client(credentials)

    if opts and opts[:id] or opts[:realm_id]
      vsys_id = client.extract_vsys_id(opts[:id] || opts[:realm_id])
      vsys_config = client.get_vsys_configuration(vsys_id)
      vsys_config['vsys'][0]['vservers'][0]['vserver'].each do |vserver|
        network_id = vserver['vnics'][0]['vnic'][0]['networkId'][0]
        # :realm_id can point to system or network
        if vsys_id == opts[:realm_id] or vserver['vserverId'][0] == opts[:id] or network_id == opts[:realm_id]

          # skip firewall if filtering by realm
          unless opts[:realm_id] and determine_server_type(vserver) == 'FW'
            # check state first as it may be filtered on
            state_data = instance_state_data(vserver, client)
            if opts[:state].nil? or opts[:state] == state_data[:state]

              instance = convert_to_instance(client, vserver, state_data)
              add_instance_details(instance, client, vserver)

              instances << instance
            end
          end
        end
      end
    elsif xml = client.list_vsys['vsyss']

      return [] if xml.nil?
      xml[0]['vsys'].each do |vsys|

        # use get_vsys_configuration (instead of get_vserver_configuration) to retrieve all vservers in one call
        vsys_config = client.get_vsys_configuration(vsys['vsysId'][0])
        vsys_config['vsys'][0]['vservers'][0]['vserver'].each do |vserver|

          # skip firewalls - they probably don't belong here and their new type ('firewall' instead of 
          # 'economy') causes errors when trying to map to available profiles)
          unless determine_server_type(vserver) == 'FW'
            # to keep the response time of this method acceptable, retrieve state
            # only if required because state is filtered on
            state_data = opts[:state] ? instance_state_data(vserver, client) : nil
            # filter on state
            if opts[:state].nil? or opts[:state] == state_data[:state]
              instances << convert_to_instance(client, vserver, state_data)
            end
          end
        end
      end
    end
  end
  instances = filter_on( instances, :state, opts )
  filter_on( instances, :id, opts )
end

#load_balancer(credentials, opts = {}) ⇒ Object



1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 1186

def load_balancer(credentials, opts={})
  balancer = nil
  safely do
    client = new_client(credentials)

    # use get_vsys_configuration (instead of list_efm) to retrieve all SLBs incl. realms in one call?
    vsys_id = client.extract_vsys_id(opts[:id])
    vsys_config = client.get_vsys_configuration(vsys_id)

    vsys_config['vsys'][0]['vservers'][0]['vserver'].each do |vserver|

      if vserver['vserverId'][0] == opts[:id]
        vserver['vnics'][0]['vnic'][0]['networkId'][0] =~ /^.*\b(\w+)$/
        realm_name = vsys_id + ' [' + $1 + ']' # vsys name + network [DMZ/SECURE1/SECURE2]
        realm = Realm::new(
          :id => vserver['vnics'][0]['vnic'][0]['networkId'][0],
          :name => realm_name,
          :limit => '[Network]',
          :state => 'AVAILABLE' # map to state of FW/VSYS (reconfiguring = unavailable)?
        )
        balancer = LoadBalancer.new({
          :id               => vserver['vserverId'][0],
          :realms           => [realm],
          :listeners        => [],
          :instances        => [],
          :public_addresses => []
        })
        begin
          slb_rule = client.get_efm_configuration(opts[:id], 'SLB_RULE')
          if slb_rule['efm'][0]['loadbalancer'][0]['groups']

            slb_rule['efm'][0]['loadbalancer'][0]['groups'][0]['group'].each do |group|

              group['targets'][0]['target'].each do |server|

                balancer.instances << Instance::new(
                  :id                => server['serverId'][0],
                  :name              => server['serverName'][0],
                  :realm_id          => realm,
                  :private_addresses => [InstanceAddress.new(server['ipAddress'][0])]
                )

                balancer.add_listener({
                  :protocol           => slb_rule['efm'][0]['loadbalancer'][0]['groups'][0]['group'][0]['protocol'][0],
                  :load_balancer_port => slb_rule['efm'][0]['loadbalancer'][0]['groups'][0]['group'][0]['port1'][0],
                  :instance_port      => server['port1'][0]
                })
              end
            end
          end

          slb_vip = slb_rule['efm'][0]['slbVip'][0]
          opts[:id] =~ /^(.*-S-)\d\d\d\d/
          fw_id = $1 + '0001'
          nat_rules = client.get_efm_configuration(fw_id, 'FW_NAT_RULE')['efm'][0]['firewall'][0]['nat'][0]['rules'][0]
          if nat_rules and not nat_rules.empty?
            nat_rules['rule'].each do |rule|
              balancer.public_addresses << InstanceAddress.new(rule['publicIp'][0]) if rule['privateIp'] and rule['privateIp'][0] == slb_vip
            end
          end
        rescue Exception => ex
          raise ex unless ex.message =~ /(ACCESS_NOT_PERMIT|ILLEGAL_STATE).*/
        end
      end
    end
  end
  balancer
end

#load_balancers(credentials, opts = {}) ⇒ Object

Load Balancers



1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 1149

def load_balancers(credentials, opts={})
  balancers = []
  safely do
    client = new_client(credentials)
    xml = client.list_vsys['vsyss']
    return [] if xml.nil?

    xml[0]['vsys'].each do |vsys|

      # use get_vsys_configuration (instead of list_efm) to retrieve all SLBs incl. realms in one call
      vsys_config = client.get_vsys_configuration(vsys['vsysId'][0])
      vsys_config['vsys'][0]['vservers'][0]['vserver'].each do |vserver|

        if determine_server_type(vserver) == 'SLB'
          vserver['vnics'][0]['vnic'][0]['networkId'][0] =~ /^.*\b(\w+)$/
          realm_name = vsys['vsysId'][0] + ' [' + $1 + ']' # vsys name + network [DMZ/SECURE1/SECURE2]
          realm = Realm::new(
            :id => vserver['vnics'][0]['vnic'][0]['networkId'][0],
            :name => realm_name,
            :limit => '[Network]',
            :state => 'AVAILABLE' # map to state of FW/VSYS (reconfiguring = unavailable)?
          )
          balancer = LoadBalancer.new({
            :id               => vserver['vserverId'][0],
            :realms           => [realm],
            :listeners        => [],
            :instances        => [],
            :public_addresses => []
          })
          balancers << balancer
        end
      end
    end
  end
  balancers
end

#metric(credentials, opts = {}) ⇒ Object



1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 1341

def metric(credentials, opts={})
  safely do
    client = new_client(credentials)
    begin
      perf = client.get_performance_information(opts[:id], 'hour')
    rescue Exception => ex
      return nil if ex.message =~ /RESOURCE_NOT_FOUND/
      raise
    end

    metric = Metric.new(
      :id         => opts[:id],
      :entity     => perf['serverName'][0],
      :properties => []
    )
    # if instance hasn't been running for an hour, no info will be returned
    unless perf['performanceinfos'].nil? or perf['performanceinfos'][0].nil? or perf['performanceinfos'][0]['performanceinfo'].nil?

      perf['performanceinfos'][0]['performanceinfo'].each do |sample|

        timestamp = Time.at(sample['recordTime'][0].to_i / 1000)
        sample.each do |measure|

          measure_name = measure[0]
          unless measure_name == 'recordTime'

            unit = metric_unit_for(measure_name)
            average = (unit == 'Percent') ? measure[1][0].to_f * 100 : measure[1][0]

            properties = metric.add_property(measure_name).properties
            property = properties.find { |p| p.name == measure_name }
            property.values ||= []
            property.values << {
              :average   => average,
              :timestamp => timestamp,
              :unit      => unit
            }
          end
        end
        metric.properties.sort! {|a,b| a.name <=> b.name}
      end
    end
    metric
  end
end

#metrics(credentials, opts = {}) ⇒ Object



1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 1289

def metrics(credentials, opts={})
  opts ||= {}
  metrics_arr = []
  safely do
    client = new_client(credentials)
    realms = []

    # first check for cases of id or realm_id specified
    if opts[:id]
      metrics_arr << Metric.new(
        :id     => opts[:id],
        :entity => client.get_vserver_attributes(opts[:id])['vserver'][0]['vserverName'][0]
      )
    elsif opts[:realm_id]
      # if realm is set, list vservers in that realm (vsys/network ID), else list from all vsys
      realms << opts[:realm_id]
    else

      # list all vsys
      xml = client.list_vsys['vsyss']
      realms = xml[0]['vsys'].collect { |vsys| vsys['vsysId'][0] } if xml
    end

    # list all vservers
    realms.each do |realm_id|

      xml = client.list_vservers(client.extract_vsys_id(realm_id))['vservers']

      if xml and xml[0]['vserver']

        xml[0]['vserver'].each do |vserver|

          # should check whether vserver is actually in opts[:realm_id] if network segment?
          metrics_arr << Metric.new(
            :id     => vserver['vserverId'][0],
            :entity => vserver['vserverName'][0]
          )
        end
      end
    end

    # add metric names to metrics
    metrics_arr.each do |metric|
      @@METRIC_NAMES.each do |name|
        metric.add_property(name)
      end
      metric.properties.sort! {|a,b| a.name <=> b.name}
    end
  end
  metrics_arr
end

#providers(credentials, opts = {}) ⇒ Object

Providers

output of this method is used to list regions (id, url) under /api/drivers/fgcp



1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 1391

def providers(credentials, opts={})
  configured_providers.collect do |region|
    Provider.new(
      :id => "fgcp-#{region}",
      :name => "Fujitsu Global Cloud Platform - #{region.upcase}",
      :url => Deltacloud::Drivers::driver_config[:fgcp][:entrypoints]['default'][region]
    )
  end
end

#realms(credentials, opts = {}) ⇒ Object

Realms



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 169

def realms(credentials, opts={})
  realms = []
  safely do
    client = new_client(credentials)

    if opts and opts[:id]

      # determine id belongs to system or network
      vsys_id = client.extract_vsys_id(opts[:id])
      vsys = client.get_vsys_attributes(vsys_id)['vsys'][0]
      realm_name = vsys['vsysName'][0]
      limit = '[System]'
      if opts[:id] != vsys_id # network id specified
        opts[:id] =~ /^.*\b(\w+)$/
        realm_name += ' [' + $1 + ']' # system name or system name + network [DMZ/SECURE1/SECURE2]
        limit = '[Network]'
      end
      realms << Realm::new(
                  :id => opts[:id],
                  :name => realm_name,
                  #:limit => :unlimited,
                  :limit => limit,
                  :state => 'AVAILABLE' # map to state of FW/VSYS (reconfiguring = unavailable)?
                )
    elsif xml = client.list_vsys['vsyss']

      return [] if xml.nil?
      xml[0]['vsys'].each do |vsys|

        realms << Realm::new(
                    :id => vsys['vsysId'][0], # vsysId or networkId
                    :name => vsys['vsysName'][0], # system name or system name + network (DMZ/SECURE1/SECURE2)
                    #:limit => :unlimited,
                    :limit => '[System]',
                    :state => 'AVAILABLE' # map to state of FW/VSYS (reconfiguring = unavailable)?
                  )
        # then retrieve and add list of network segments
        client.get_vsys_configuration(vsys['vsysId'][0])['vsys'][0]['vnets'][0]['vnet'].each do |vnet|

          vnet['networkId'][0] =~ /^.*\b(\w+)$/
          realm_name = vsys['vsysName'][0].to_s + ' [' + $1 + ']' # vsys name or vsys name + network [DMZ/SECURE1/SECURE2]
          realms << Realm::new(
                      :id => vnet['networkId'][0], # vsysId or networkId
                      :name => realm_name,
                      #:limit => :unlimited,
                      :limit => '[Network]',
                      :state => 'AVAILABLE' # map to state of FW/VSYS (reconfiguring = unavailable)?
                    )
        end
      end
    end
  end
  filter_on(realms, :id, opts)
end

#run_on_instance(credentials, opts = {}) ⇒ Object



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 417

def run_on_instance(credentials, opts={})
  target = instance(credentials, opts)
  safely do
    param = {}
    param[:port] = opts[:port] || '22'
    param[:ip] = opts[:ip] || target.public_addresses.first.address
    param[:credentials] = { :username => target.username }

    if opts[:private_key] and opts[:private_key].length > 1
      param[:private_key] = opts[:private_key]
    else
      password = (opts[:password] and opts[:password].length > 0) ? opts[:password] : target.password
      param[:credentials].merge!({ :password => password })
    end

    Deltacloud::Runner.execute(opts[:cmd], param)
  end
end

#start_instance(credentials, id) ⇒ Object

Start an instance, given its id.



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 284

def start_instance(credentials, id)
  safely do
    client = new_client(credentials)
    if id =~ /^.*-S-0001/ # FW
      client.start_efm(id)
    else
      # vserver or SLB (no way to tell which from id)
      begin
        client.start_vserver(id)
      rescue Exception => ex
        # if not found, try starting as SLB
        if not ex.message =~ /VALIDATION_ERROR.*/
          raise ex
        else
          begin
            client.start_efm(id)
          rescue
            # if that fails as well, just raise the original error
            raise ex
          end
        end
      end
    end
  end
  instances(credentials, {:id => id}).first
end

#stop_instance(credentials, id) ⇒ Object

Stop an instance, given its id.



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 312

def stop_instance(credentials, id)
  safely do
    client = new_client(credentials)
    if id =~ /^.*-S-0001/ # FW
      client.stop_efm(id)
    else
      # vserver or SLB (no way to tell which from id)
      begin
        client.stop_vserver(id)
      rescue Exception => ex
        #if not found, try stopping as SLB
        if not ex.message =~ /VALIDATION_ERROR.*/
          raise ex
        else
          begin
            client.stop_efm(id)
          rescue
            # if that fails as well, just raise the original error
            raise ex
          end
        end
      end
    end
  end
  instances(credentials, {:id => id}).first
end

#storage_snapshots(credentials, opts = {}) ⇒ Object

Storage Snapshots



565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 565

def storage_snapshots(credentials, opts={})
  snapshots = []

  safely do
    client = new_client(credentials)
    if opts and opts[:id]
      vdisk_id, backup_id = split_snapshot_id(opts[:id])

      begin
        if backups = client.list_vdisk_backup(vdisk_id)['backups']

          backups[0]['backup'].each do |backup|

            snapshots << StorageSnapshot.new(
              :id => opts[:id],
              #:state => ?,
              :storage_volume_id => vdisk_id,
              :created => backup['backupTime'][0]
            ) if backup_id = backup['backupId'][0]
          end
        end
      rescue Exception => ex
        return [] if ex.message =~ /RESOURCE_NOT_FOUND/
        raise
      end

    elsif xml = client.list_vsys['vsyss']

      return [] if xml.nil?
      xml[0]['vsys'].each do |vsys|

        vdisks = client.list_vdisk(vsys['vsysId'][0])['vdisks'][0]
        if vdisks['vdisk']
          vdisks['vdisk'].each do |vdisk|

            backups = client.list_vdisk_backup(vdisk['vdiskId'][0])
            if backups['backups'] and backups['backups'][0]['backup']
              backups['backups'][0]['backup'].each do |backup|

                snapshots << StorageSnapshot.new(
                  :id => generate_snapshot_id(vdisk['vdiskId'][0], backup['backupId'][0]),
                  #:state => ?,
                  :storage_volume_id => vdisk['vdiskId'][0],
                  :created => backup['backupTime'][0]
                )
              end
            end
          end
        end
      end
    end
  end

  snapshots
end

#storage_volumes(credentials, opts = {}) ⇒ Object

Storage volumes



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 439

def storage_volumes(credentials, opts={})
  volumes = []
  safely do
    client = new_client(credentials)
    if opts and opts[:id]
      begin
        vdisk = client.get_vdisk_attributes(opts[:id])['vdisk'][0]
      rescue Exception => ex
        return [] if ex.message =~ /VALIDATION_ERROR.*t exist./
        raise
      end
      state = client.get_vdisk_status(opts[:id])['vdiskStatus'][0]
      actions = []
      if state == 'NORMAL'
        if vdisk['attachedTo'].nil?
          state = 'AVAILABLE'
          actions = [:attach, :destroy]
        else
          state = 'IN-USE'
          actions = [:detach]
        end
      end

      volumes << StorageVolume.new(
        :id          => opts[:id],
        :name        => vdisk['vdiskName'][0],
        :capacity    => vdisk['size'][0],
        :instance_id => vdisk['attachedTo'].nil? ? nil : vdisk['attachedTo'][0],
        :state       => state,
        :actions     => actions,
        # aligning with rhevm, which returns 'system' or 'data'
        :kind        => determine_storage_type(opts[:id]),
        :realm_id    => client.extract_vsys_id(opts[:id])
      )
    elsif xml = client.list_vsys['vsyss']

      return [] if xml.nil?
      xml[0]['vsys'].each do |vsys|

        vdisks = client.list_vdisk(vsys['vsysId'][0])['vdisks'][0]

        if vdisks['vdisk']
          vdisks['vdisk'].each do |vdisk|

            #state requires an additional call per volume. Only set if attached.
            #exclude system disks as they are not detachable?
            volumes << StorageVolume.new(
              :id          => vdisk['vdiskId'][0],
              :name        => vdisk['vdiskName'][0],
              :capacity    => vdisk['size'][0],
              :instance_id => vdisk['attachedTo'].nil? ? nil : vdisk['attachedTo'][0],
              :realm_id    => client.extract_vsys_id(vdisk['vdiskId'][0]),
              # aligning with rhevm, which returns 'system' or 'data'
              :kind        => determine_storage_type(vdisk['vdiskId'][0]),
              :state       => vdisk['attachedTo'].nil? ? nil : 'IN-USE'
            )
          end
        end
      end
    end
  end
  volumes
end

#valid_credentials?(credentials) ⇒ Boolean

Returns:

  • (Boolean)


39
40
41
42
43
44
45
46
47
48
49
# File 'lib/deltacloud/drivers/fgcp/fgcp_driver.rb', line 39

def valid_credentials?(credentials)
  begin
    client = new_client(credentials)
    # use a relativily cheap operation that is likely to succeed
    # (i.e. not requiring particular access privileges)
    client.list_server_types
  rescue
    return false
  end
  true
end