Class: CORL::Plugin::Node

Inherits:
Object
  • Object
show all
Includes:
Parallel
Defined in:
lib/core/plugin/node.rb

Class Method Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &code) ⇒ Object 



48
49
50
51
52
 
# File 'lib/core/plugin/node.rb', line 48

def method_missing(method, *args, &code)  
  action(method, *args) do |op, data|
    code.call(op, data) if code
  end
end

Class Method Details

.build_info(namespace, plugin_type, data) ⇒ Object

Utilities



1260
1261
1262
1263
 
# File 'lib/core/plugin/node.rb', line 1260

def self.build_info(namespace, plugin_type, data)  
  data = data.split(/\s*,\s*/) if data.is_a?(String)
  super(namespace, plugin_type, data)
end

.translate(data) ⇒ Object 



1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
 
# File 'lib/core/plugin/node.rb', line 1267

def self.translate(data)
  options = super(data)
  
  case data        
  when String
    options = { :name => data }
  when Hash
    options = data
  end
  
  if options.has_key?(:name)
    if matches = translate_reference(options[:name])
      options[:provider] = matches[:provider]
      options[:name]     = matches[:name]
      
      logger.debug("Translating node options: #{options.inspect}")  
    end
  end
  options
end

.translate_reference(reference) ⇒ Object 



1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
 
# File 'lib/core/plugin/node.rb', line 1290

def self.translate_reference(reference)
  # ex: rackspace:::web1.staging.example.com
  if reference && reference.match(/^\s*([a-zA-Z0-9_-]+):::([^\s]+)\s*$/)
    provider = $1
    name     = $2
    
    logger.debug("Translating node reference: #{provider}  #{name}")
    
    info = {
      :provider => provider,
      :name     => name
    }
    
    logger.debug("Project reference info: #{info.inspect}")
    return info
  end
  nil
end

Instance Method Details

#action(provider, options = {}) ⇒ Object 



880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
 
# File 'lib/core/plugin/node.rb', line 880

def action(provider, options = {})
  codes :network_load_error
  
  config = Config.ensure(options).defaults({
    :log_level    => Nucleon.log_level,
    :net_remote   => :edit, 
    :net_provider => network.plugin_provider 
  })
  
  logger.info("Executing remote action #{provider} with encoded arguments: #{config.export.inspect}")
  
  encoded_config = Util::CLI.encode(Util::Data.clean(config.export))
  action_config  = extended_config(:action, {
    :command => provider.to_s.gsub('_', ' '), 
    :data    => { :encoded => encoded_config }
  })
  
  quiet  = config.get(:quiet, false)    
  result = command(:corl, { :subcommand => action_config, :as_admin => true, :quiet => quiet }) do |op, data|
    yield(op, data) if block_given?  
  end
  
  # Update local network configuration so we capture any updates
  if result.status == code.success && ! network.load({ :remote => config[:net_remote], :pull => true })
    result.status = code.network_load_error
  end
  result
end

#attach_keys(keypair) ⇒ Object 



564
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
 
# File 'lib/core/plugin/node.rb', line 564

def attach_keys(keypair)
  base_name   = "#{plugin_provider}-#{plugin_name}"
  save_config = { 
    :pull    => false, 
    :push    => false,
    :message => "Updating SSH keys for node #{plugin_provider} (#{plugin_name})" 
  }
  
  active  = machine && machine.running?
  result  = run.authorize({ :public_key => keypair.ssh_key }) if active
  success = false
  
  if ! active || result.status == code.success        
    private_key = network.attach_data(:keys, "#{base_name}-id_#{keypair.type}", keypair.encrypted_key)
    public_key  = network.attach_data(:keys, "#{base_name}-id_#{keypair.type}.pub", keypair.ssh_key)
  
    if private_key && public_key
      FileUtils.chmod(0600, private_key)
      FileUtils.chmod(0644, public_key)
      
      myself.keypair = Util::SSH.generate({ :private_key => keypair.private_key })
      myself.keypair.store(network.key_cache_directory, plugin_name)
    
      save_config[:files] = [ private_key, public_key ]
  
      myself.private_key = private_key
      myself.public_key  = public_key
  
      success = save(extended_config(:key_save, save_config))
    end
  end
  success
end

#bootstrap(local_path, options = {}) ⇒ Object 



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
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'lib/core/plugin/node.rb', line 949

def bootstrap(local_path, options = {})
  config      = Config.ensure(options)
  myself.status = code.unknown_status
  
  bootstrap_name = 'bootstrap'    
  bootstrap_path = config.get(:bootstrap_path, File.join(CORL.lib_path, '..', bootstrap_name))
  bootstrap_glob = config.get(:bootstrap_glob, '**/*.sh')
  bootstrap_init = config.get(:bootstrap_init, 'bootstrap.sh')
  
  user_home  = config[:home]
  auth_files = config.get_array(:auth_files)
  
  codes :local_path_not_found,
        :home_path_lookup_failure,
        :auth_upload_failure,
        :root_auth_copy_failure,
        :bootstrap_upload_failure,
        :bootstrap_exec_failure,
        :reload_failure
  
  if File.directory?(local_path)      
    if user_home || user_home = home(config.get(:home_env_var, 'HOME'), config.get(:force, false))
      myself.status = code.success
      
      # Transmit authorisation / credential files
      package_files = [ '.fog', '.netrc', '.google-privatekey.p12', '.vimrc' ]
      auth_files.each do |file|
        package_files << file.gsub(local_path + '/', '')
      end
      send_success = send_files(local_path, user_home, package_files, '0600') do |op, data|
        yield("send_#{op}".to_sym, data) if block_given?
        data
      end
      unless send_success
        myself.status = code.auth_upload_failure
      end
      
      if user.to_sym != config.get(:root_user, :root).to_sym
        auth_files     = package_files.collect { |path| "'#{path}'"}
        root_home_path = config.get(:root_home, '/root')
        
        result        = command("cp #{auth_files.join(' ')} #{root_home_path}", { :as_admin => true })
        myself.status = code.root_auth_copy_failure unless result.status == code.success  
      end
  
      # Send bootstrap package
      if status == code.success
        remote_bootstrap_path = File.join(user_home, bootstrap_name)
        
        cli.rm('-Rf', remote_bootstrap_path)
        send_success = send_files(bootstrap_path, remote_bootstrap_path, nil, '0700') do |op, data|
          yield("send_#{op}".to_sym, data) if block_given?
          data
        end
        unless send_success
          myself.status = code.bootstrap_upload_failure
        end
        
        # Execute bootstrap process
        if status == code.success
          remote_script = File.join(remote_bootstrap_path, bootstrap_init)
          
          myself.bootstrap_script = remote_script
          
          result = command("HOSTNAME='#{hostname}' #{remote_script}", { :as_admin => true }) do |op, data|
            yield("exec_#{op}".to_sym, data) if block_given?
            data
          end
          
          if result.status == code.success
            # Reboot the machine
            unless reload
              warn('corl.core.node.bootstrap.reload')
              myself.status = code.reload_failure 
            end
          else
            warn('corl.core.node.bootstrap.status', { :script => remote_script, :status => result.status })
            myself.status = code.bootstrap_exec_failure
          end
        end
      end
    else
      myself.status = code.home_path_lookup_failure            
    end
  else
    myself.status = code.local_path_not_found
  end
  status == code.success
end

#bootstrap_script ⇒ Object 



366
367
368
 
# File 'lib/core/plugin/node.rb', line 366

def bootstrap_script
  myself[:bootstrap]  
end

#bootstrap_script=(bootstrap) ⇒ Object 



362
363
364
 
# File 'lib/core/plugin/node.rb', line 362

def bootstrap_script=bootstrap
  myself[:bootstrap] = bootstrap
end

#build(options = {}) ⇒ Object

Machine operations



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
538
539
540
541
542
543
544
 
# File 'lib/core/plugin/node.rb', line 513

def build(options = {})
  config  = Config.ensure(options)
  success = true
  
  # TODO: Figure out what's going on with the parallel implementation here.
  parallel_original          = ENV['NUCLEON_NO_PARALLEL']
  ENV['NUCLEON_NO_PARALLEL'] = 'true'
  
  status  = parallel(:build_provider, network.builders, config)
  success = false if status.values.include?(false)
  
  if success
    status  = parallel(:build_provisioners, provisioners, config)
    success = false if status.values.include?(false)
  
    if success
      myself.build_time = Time.now.to_s if success
      
      if config.delete(:save, true)
        success("Saving successful build", { :i18n => false })    
       
        success = save(extended_config(:build, {
          :message => config.get(:message, "Built #{plugin_provider} node: #{plugin_name}"),
          :remote  => config.get(:remote, :edit)  
        }))
      end
    end
  end
  
  ENV['NUCLEON_NO_PARALLEL'] = parallel_original  
  success
end

#build_provider(provider, plugin, config) ⇒ Object 



546
547
548
549
 
# File 'lib/core/plugin/node.rb', line 546

def build_provider(provider, plugin, config)
  info("Building #{provider} components", { :i18n => false })
  plugin.build(myself, config)
end

#build_provisioner(name, plugin, provider, config) ⇒ Object 



557
558
559
560
 
# File 'lib/core/plugin/node.rb', line 557

def build_provisioner(name, plugin, provider, config)
  info("Building #{provider} #{name} provisioner components", { :i18n => false })
  plugin.build(myself, config) 
end

#build_provisioners(provider, collection, config) ⇒ Object 



551
552
553
554
555
 
# File 'lib/core/plugin/node.rb', line 551

def build_provisioners(provider, collection, config)
  info("Building #{provider} provisioner collection", { :i18n => false })
  status = parallel(:build_provisioner, collection, provider, config)
  status.values.include?(false) ? false : true  
end

#build_time ⇒ Object 



356
357
358
 
# File 'lib/core/plugin/node.rb', line 356

def build_time
  myself[:build]
end

#build_time=(time) ⇒ Object 



352
353
354
 
# File 'lib/core/plugin/node.rb', line 352

def build_time=time
  myself[:build] = time
end

#clear_remote_cache ⇒ Object 



506
507
508
 
# File 'lib/core/plugin/node.rb', line 506

def clear_remote_cache
  run.node_cache({ :clear => true }).status == code.success
end

#cli ⇒ Object 



846
847
848
 
# File 'lib/core/plugin/node.rb', line 846

def cli
  @cli_interface
end

#cli_capture(cli_command, *args) ⇒ Object

CLI utilities



1318
1319
1320
1321
1322
1323
1324
1325
1326
 
# File 'lib/core/plugin/node.rb', line 1318

def cli_capture(cli_command, *args)
  result = cli.send(cli_command, args)
           
  if result.status == code.success && ! result.output.empty? 
    result.output
  else
    nil
  end  
end

#cli_check(cli_command, *args) ⇒ Object 



1330
1331
1332
1333
 
# File 'lib/core/plugin/node.rb', line 1330

def cli_check(cli_command, *args)
  result = cli.send(cli_command, args)
  result.status == code.success ? true : false  
end

#command(command, options = {}) ⇒ Object 



852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/core/plugin/node.rb', line 852

def command(command, options = {})
  config         = Config.ensure(options)
  as_admin       = config.delete(:as_admin, false)
  remove_command = false
  
  unless command.is_a?(CORL::Plugin::Command)
    command        = CORL.command(Config.new({ :command => command }).import(config), :bash)
    remove_command = true
  end
  
  admin_command = ''
  if as_admin
    admin_command = 'sudo' if user.to_s != 'root'
    admin_command = extension_set(:admin_command, admin_command, config)
  end
  
  config[:commands] = [ "#{admin_command} #{command.to_s}".strip ]
  
  results = exec(config) do |op, data|
    yield(op, data) if block_given?  
  end
  
  CORL.remove_plugin(command) if remove_command    
  results.first 
end

#create(options = {}) ⇒ Object 



638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/core/plugin/node.rb', line 638

def create(options = {})
  success = true
  
  if machine
    config = Config.ensure(options)
    
    clear_cache
    
    if extension_check(:create, { :config => config })
      logger.info("Creating node: #{plugin_name}")
    
      yield(:config, config) if block_given?      
      success = machine.create(config.export)
      
      if success && block_given?
        process_success = yield(:process, config)
        success         = process_success if process_success == false        
      end
      
      if success
        extension(:create_success, { :config => config })
      end
    end
  else
    logger.warn("Node #{plugin_name} does not have an attached machine so cannot be created")
  end
  success
end

#create_facts_post(data, names) ⇒ Object 



422
423
424
425
426
427
428
429
430
 
# File 'lib/core/plugin/node.rb', line 422

def create_facts_post(data, names)
  fact_values = {}
  names.each do |name|
    name              = name.to_sym
    fact_values[name] = data[name]
  end
  ensure_custom_facts(fact_values)
  data
end

#create_image(options = {}) ⇒ Object 



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
 
# File 'lib/core/plugin/node.rb', line 1138

def create_image(options = {})
  success = true
  
  if machine && machine.running?
    config = Config.ensure(options)
    
    if extension_check(:create_image, { :config => config })
      logger.info("Executing node: #{plugin_name}")
    
      yield(:config, config) if block_given?      
      success = machine.create_image(config.export)
      success = save(config) if success
      
      if success && block_given?
        process_success = yield(:process, config)
        success         = process_success if process_success == false        
      end
      
      if success
        extension(:create_image_success, { :config => config })
      end
    end
  else
    logger.warn("Node #{plugin_name} does not have an attached machine or is not running so cannot create an image")
  end
  success   
end

#create_machine(name, provider, options = {}) ⇒ Object 



632
633
634
 
# File 'lib/core/plugin/node.rb', line 632

def create_machine(name, provider, options = {})
  CORL.create_plugin(:CORL, :machine, provider, extended_config(name, options).import({ :meta => { :parent => myself }}))
end

#custom_facts ⇒ Object 



297
298
299
 
# File 'lib/core/plugin/node.rb', line 297

def custom_facts
  search(:facts, {}, :hash)
end

#custom_facts=(facts) ⇒ Object 



293
294
295
 
# File 'lib/core/plugin/node.rb', line 293

def custom_facts=facts
  myself[:facts] = hash(facts)
end

#delete_facts_post(data, old_data) ⇒ Object 



434
435
436
437
 
# File 'lib/core/plugin/node.rb', line 434

def delete_facts_post(data, old_data)
  remove_custom_facts(*old_data.keys)
  data
end

#delete_keys ⇒ Object 



600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
 
# File 'lib/core/plugin/node.rb', line 600

def delete_keys
  private_key = myself[:private_key]
  public_key  = myself[:public_key]
  
  keys = []
  keys << private_key if private_key
  keys << public_key if public_key
  
  success = true
  
  unless keys.empty?
    files = network.delete_attachments(keys)
    
    if files && ! files.empty?
      delete_setting(:private_key)
      delete_setting(:public_key)
      
      success = save(extended_config(:key_delete, {
        :files   => [ private_key, public_key ], 
        :pull    => false, 
        :push    => false,
        :message => "Removing SSH keys for node #{plugin_provider} (#{plugin_name})"  
      }))
    else
      success = false
    end
  end
  success
end

#delete_remote_cache_setting(keys) ⇒ Object 



497
498
499
500
501
502
 
# File 'lib/core/plugin/node.rb', line 497

def delete_remote_cache_setting(keys)
  run.node_cache({ 
    :name   => keys.flatten.join('.'), 
    :delete => true 
  }).status == code.success
end

#destroy(options = {}) ⇒ Object 



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
1254
1255
 
# File 'lib/core/plugin/node.rb', line 1213

def destroy(options = {})    
  success = true
  
  if machine && machine.created?
    config = Config.ensure(options)
    
    if extension_check(:destroy, { :config => config })
      logger.info("Destroying node: #{plugin_name}")
    
      yield(:config, config) if block_given?
      
      # Shut down machine      
      success = machine.destroy(config.export)
      
      myself.machine = nil
      
      # Remove SSH keys
      if success && delete_keys
        # Remove node information
        network.delete_node(plugin_provider, plugin_name, false)
        
        network.save({
          :commit => true, 
          :remote => config.get(:remote, :edit), 
          :push   => true 
        })
      end      
      
      if success && block_given?
        process_success = yield(:process, config)
        success         = process_success if process_success == false        
      end
      
      if success
        extension(:destroy_success, { :config => config })
        clear_cache
      end
    end
  else
    logger.warn("Node #{plugin_name} does not have an attached machine or is not created so cannot be destroyed")
  end
  success    
end

#download(remote_path, local_path, options = {}) ⇒ Object 



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
 
# File 'lib/core/plugin/node.rb', line 669

def download(remote_path, local_path, options = {})
  success = false
  
  if machine && machine.running?
    config      = Config.ensure(options)
    hook_config = Config.new({ :local_path => local_path, :remote_path => remote_path, :config => config })
    
    if extension_check(:download, hook_config)
      logger.info("Downloading from #{plugin_name}")
    
      info("Starting download of #{remote_path} to #{local_path}", { :i18n => false }) 
      yield(:config, hook_config) if block_given?
      
      active_machine = local? ? local_machine : machine
      
      success = active_machine.download(remote_path, local_path, config.export) do |name, received, total|
        info("#{name}: Sent #{received} of #{total}", { :i18n => false })
        yield(:progress, { :name => name, :received => received, :total => total })
      end
      
      if success && block_given?
        info("Successfully finished download of #{remote_path} to #{local_path}", { :i18n => false })
        process_success = yield(:process, hook_config)
        success         = process_success if process_success == false        
      end
      
      if success
        extension(:download_success, hook_config)
      end
    end
  else
    logger.warn("Node #{plugin_name} does not have an attached machine or is not running so cannot download")
  end
  success
end

#ensure_custom_facts(facts) ⇒ Object 



301
302
303
304
305
 
# File 'lib/core/plugin/node.rb', line 301

def ensure_custom_facts(facts)
  hash(facts).each do |name, value|
    set_setting([ :facts, name ], value)
  end
end

#exec(options = {}) ⇒ Object 



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
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
 
# File 'lib/core/plugin/node.rb', line 778

def exec(options = {})
  default_error = Util::Shell::Result.new(:error, 255)
  results       = [ default_error ]
  
  if local? && local_machine || machine && machine.running?
    config = Config.ensure(options)
    
    if extension_check(:exec, { :config => config })
      logger.info("Executing node: #{plugin_name}")
            
      yield(:config, config) if block_given?
      
      if local? && local_machine
        active_machine = local_machine
      else
        active_machine = machine
      end
      
      if commands = config.get(:commands, nil)
        quiet = config.get(:quiet, false)
        
        begin
          test = active_machine.exec(commands, config.export) do |type, command, data|
            unless quiet
              unless local?
                if type == :error
                  warn(filter_output(type, data), { :i18n => false })
                else
                  info(filter_output(type, data), { :i18n => false })
                end
              end
              yield(:progress, { :type => type, :command => command, :data => data }) if block_given?
            end   
          end
          results = test if test
          
        rescue => error
          default_error.append_errors(error.message)   
        end
      else
        default_error.append_errors("No execution command")    
      end
      
      if results
        success = true
        results.each do |result|
          success = false if result.status != code.success  
        end
        if success
          yield(:process, config) if block_given?
          extension(:exec_success, { :config => config, :results => results }) 
        end
      else
        default_error.append_errors("No execution results")
      end
    else
      default_error.append_errors("Execution prevented by exec hook")
    end
  else
    default_error.append_errors("No attached machine")
    
    logger.warn("Node #{plugin_name} does not have an attached machine or is not running so cannot execute commands")
  end
  results 
end

#fact_var ⇒ Object

Machine information



385
386
387
 
# File 'lib/core/plugin/node.rb', line 385

def fact_var
  @facts
end

#fact_var=(facts) ⇒ Object 



389
390
391
 
# File 'lib/core/plugin/node.rb', line 389

def fact_var=facts
  @facts = facts
end

#facts(reset = false, clone = true) ⇒ Object 



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/core/plugin/node.rb', line 395

def facts(reset = false, clone = true)
  if reset || fact_var.nil?
    default_facts = extended_config(:hiera_default_facts, {
      :fqdn          => hostname, 
      :hostname      => hostname.gsub(/\..*$/, ''),
      :corl_provider => plugin_provider.to_s
    })
    
    unless local?
      result = run.node_facts({ :quiet => true })
    
      if result.status == code.success
        node_facts = Util::Data.symbol_map(Util::Data.parse_json(result.errors))
      end
    end
    unless node_facts
      node_facts = local? ? Util::Data.merge([ CORL.facts, custom_facts ]) : custom_facts
    end
    
    self.fact_var = Config.new(node_facts).defaults(default_facts).export
  end
  return fact_var.clone if clone
  fact_var
end

#filter_output(type, data) ⇒ Object 



1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'lib/core/plugin/node.rb', line 1337

def filter_output(type, data)
  if type == :output
    # Hide redundant Facter output
    if data =~ /^Already evaluated [a-z]+ at [^,]+, reevaluating anyways$/
      data = ''
    end  
  end
  data  
end

#hiera_override_dir ⇒ Object 



451
452
453
 
# File 'lib/core/plugin/node.rb', line 451

def hiera_override_dir
  network.hiera_override_dir
end

#hiera_var ⇒ Object 



441
442
443
 
# File 'lib/core/plugin/node.rb', line 441

def hiera_var
  @hiera
end

#hiera_var=(hiera) ⇒ Object 



445
446
447
 
# File 'lib/core/plugin/node.rb', line 445

def hiera_var=hiera
  @hiera = hiera
end

#home(env_var = 'HOME', reset = false) ⇒ Object 



182
183
184
185
186
187
 
# File 'lib/core/plugin/node.rb', line 182

def home(env_var = 'HOME', reset = false)
  if reset || myself[:user_home].nil?
    myself[:user_home] = cli_capture(:echo, '$' + env_var.to_s.gsub('$', '')) if machine
  end
  myself[:user_home]
end

#hostname ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/core/plugin/node.rb', line 137

def hostname
  hostname = setting(:hostname)
  
  unless hostname
    hostname = plugin_name
  end
  
  if hostname.to_s != ui.resource.to_s 
    ui.resource = Util::Console.colorize(hostname, @class_color)
    logger      = hostname
  end
  hostname
end

#id(reset = false) ⇒ Object 



118
119
120
121
 
# File 'lib/core/plugin/node.rb', line 118

def id(reset = false)
  myself[:id] = machine.plugin_name if machine && ( reset || setting(:id).nil? )
  setting(:id)
end

#image(reset = false) ⇒ Object 



286
287
288
289
 
# File 'lib/core/plugin/node.rb', line 286

def image(reset = false)
  myself[:image] = machine.image if machine && ( reset || myself[:image].nil? )
  myself[:image]
end

#image=(image) ⇒ Object 



282
283
284
 
# File 'lib/core/plugin/node.rb', line 282

def image=image
  myself[:image] = image
end

#image_id(image) ⇒ Object

Image utilities



1363
1364
1365
 
# File 'lib/core/plugin/node.rb', line 1363

def image_id(image)
  image.id
end

#image_search_text(image) ⇒ Object 



1375
1376
1377
 
# File 'lib/core/plugin/node.rb', line 1375

def image_search_text(image)
  image.to_s
end

#images(search_terms = [], options = {}) ⇒ Object 



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
 
# File 'lib/core/plugin/node.rb', line 243

def images(search_terms = [], options = {})
  config = Config.ensure(options)
  images = []
  
  if machine
    loaded_images = machine.images
  
    if loaded_images
      require_all = config.get(:require_all, false)
      
      loaded_images.each do |image|
        if usable_image?(image)
          include_image = ( search_terms.empty? ? true : require_all )
          image_text    = image_search_text(image)
          
          search_terms.each do |term|
            if config.get(:match_case, false)
              success = image_text.match(/#{term}/)
            else
              success = image_text.match(/#{term}/i)  
            end
            
            if require_all            
              include_image = false unless success
            else
              include_image = true if success  
            end
          end
      
          images << image if include_image
        end
      end
    end
  end
  images
end

#keypair ⇒ Object 



88
89
90
 
# File 'lib/core/plugin/node.rb', line 88

def keypair
  @keypair
end

#keypair=(keypair) ⇒ Object 



92
93
94
 
# File 'lib/core/plugin/node.rb', line 92

def keypair=keypair
  @keypair = keypair
end

#local? ⇒ Boolean

Checks

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/core/plugin/node.rb', line 71

def local?
  @local_context ? true : false
end

#local_machine ⇒ Object 



108
109
110
 
# File 'lib/core/plugin/node.rb', line 108

def local_machine
  @local_machine
end

#local_machine=(local_machine) ⇒ Object 



112
113
114
 
# File 'lib/core/plugin/node.rb', line 112

def local_machine=local_machine
  @local_machine = local_machine  
end

#localize ⇒ Object 



56
57
58
59
 
# File 'lib/core/plugin/node.rb', line 56

def localize
  @local_context       = true
  myself.local_machine = create_machine(:local_machine, :physical)
end

#lookup(property, default = nil, options = {}) ⇒ Object 



457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/core/plugin/node.rb', line 457

def lookup(property, default = nil, options = {})
  unless local?
    config = Config.ensure(options).import({ :property => property, :quiet => true })
    result = run.node_lookup(config)
    
    if result.status == code.success
      return Util::Data.value(Util::Data.parse_json(result.errors), default)
    end
    return default
  end
  options[:hiera_scope] = Util::Data.prefix('::', facts, '')
  lookup_base(property, default, options)  
end

#machine ⇒ Object 



98
99
100
 
# File 'lib/core/plugin/node.rb', line 98

def machine
  @machine
end

#machine=(machine) ⇒ Object 



102
103
104
 
# File 'lib/core/plugin/node.rb', line 102

def machine=machine
  @machine = machine  
end

#machine_config {|config| ... } ⇒ Object

Settings groups

Yields:

  • (config) 


373
374
375
376
377
378
379
380
 
# File 'lib/core/plugin/node.rb', line 373

def machine_config
  name   = setting(:id)
  name   = setting(:hostname) if name.nil? || name.empty?
  config = Config.new({ :name => name })
  
  yield(config) if block_given?
  config
end

#machine_type(reset = false) ⇒ Object 



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/core/plugin/node.rb', line 225

def machine_type(reset = false)
  myself[:machine_type] = machine.machine_type if machine && ( reset || myself[:machine_type].nil? )
  machine_type          = myself[:machine_type]
  
  if machine_type.nil? && machine
    if types = machine_types
      unless types.empty?
        machine_type          = machine_type_id(types.first)
        myself[:machine_type] = machine_type
      end
    end
  end
  
  machine_type
end

#machine_type_id(machine_type) ⇒ Object

Machine type utilities



1350
1351
1352
 
# File 'lib/core/plugin/node.rb', line 1350

def machine_type_id(machine_type)
  machine_type.id
end

#machine_types ⇒ Object 



221
222
223
 
# File 'lib/core/plugin/node.rb', line 221

def machine_types # Must be set at machine level (queried)
  machine.machine_types if machine
end

#normalize(reload) ⇒ Object

Node plugin interface



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/core/plugin/node.rb', line 12

def normalize(reload)
  super
  
  @class_color = :purple
  
  export.each do |name, value|
    myself[name] = value
  end
  
  ui.resource = Util::Console.colorize(hostname, @class_color)
  logger      = hostname
  
  add_groups([ "all", plugin_provider.to_s, plugin_name.to_s ])
  
  unless reload
    @cli_interface = Util::Liquid.new do |method, args, &code|
      result = exec({ :commands => [ [ method, args ].flatten.join(' ') ] }) do |op, data|
        code.call(op, data) if code
      end
      if result
        result = result.first
        warn(result.errors, { :i18n => false }) unless result.errors.empty?
      end
      result
    end
  
    @action_interface = Util::Liquid.new do |method, args, &code|
      action(method, *args) do |op, data|
        code.call(op, data) if code
      end
    end
  end
end

#private_ip(reset = false) ⇒ Object 



130
131
132
133
 
# File 'lib/core/plugin/node.rb', line 130

def private_ip(reset = false)
  myself[:private_ip] = machine.private_ip if machine && ( reset || setting(:private_ip).nil? )
  setting(:private_ip)
end

#private_key ⇒ Object 



202
203
204
205
206
 
# File 'lib/core/plugin/node.rb', line 202

def private_key
  config_key = myself[:private_key]
  return File.expand_path(config_key, network.directory) if config_key
  nil
end

#private_key=(private_key) ⇒ Object 



198
199
200
 
# File 'lib/core/plugin/node.rb', line 198

def private_key=private_key
  myself[:private_key] = private_key
end

#profiles ⇒ Object 



319
320
321
 
# File 'lib/core/plugin/node.rb', line 319

def profiles
  [ array(myself[:profiles]), lookup_array(:profiles).reverse ].flatten
end

#profiles=(profiles) ⇒ Object 



315
316
317
 
# File 'lib/core/plugin/node.rb', line 315

def profiles=profiles
  myself[:profiles] = array(profiles)
end

#provisioner_info ⇒ Object 



325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/core/plugin/node.rb', line 325

def provisioner_info
  provisioner_info = {}
      
  # Compose needed provisioners and profiles
  profiles.each do |profile|
    if info = Plugin::Provisioner.translate_reference(profile)
      provider = info[:provider]
          
      provisioner_info[provider] = { :profiles => [] } unless provisioner_info.has_key?(provider)
      provisioner_info[provider][:profiles] += info[:profiles]
    end
  end
  provisioner_info
end

#provisioners ⇒ Object 



342
343
344
345
346
347
348
 
# File 'lib/core/plugin/node.rb', line 342

def provisioners
  provisioners = {}        
  provisioner_info.each do |provider, node_profiles|
    provisioners[provider] = network.provisioners(provider)
  end    
  provisioners
end

#public_ip(reset = false) ⇒ Object 



125
126
127
128
 
# File 'lib/core/plugin/node.rb', line 125

def public_ip(reset = false)
  myself[:public_ip] = machine.public_ip if machine && ( reset || setting(:public_ip).nil? )
  setting(:public_ip)
end

#public_key ⇒ Object 



214
215
216
217
 
# File 'lib/core/plugin/node.rb', line 214

def public_key
  config_key = myself[:public_key]
  return File.expand_path(config_key, network.directory) if config_key
end

#public_key=(public_key) ⇒ Object 



210
211
212
 
# File 'lib/core/plugin/node.rb', line 210

def public_key=public_key
  myself[:public_key] = public_key
end

#reload(options = {}) ⇒ Object 



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
 
# File 'lib/core/plugin/node.rb', line 1109

def reload(options = {})
  success = true
  
  if machine && machine.created?
    config = Config.ensure(options)
    
    if extension_check(:reload, { :config => config })
      logger.info("Reloading node: #{plugin_name}")
    
      yield(:config, config) if block_given?      
      success = machine.reload(config.export)
      
      if success && block_given?
        process_success = yield(:process, config)
        success         = process_success if process_success == false        
      end
      
      if success
        extension(:reload_success, { :config => config })
      end
    end
  else
    logger.warn("Node #{plugin_name} does not have an attached machine or is not created so cannot be reloaded")
  end
  success
end

#remote_cache_setting(keys, default = nil, format = false) ⇒ Object 



473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/core/plugin/node.rb', line 473

def remote_cache_setting(keys, default = nil, format = false)
  cache_id = keys.flatten.join('.')   
  result   = run.node_cache({ :name => cache_id })
    
  if result.status == code.success
    value = Util::Data.value(Util::Data.parse_json(result.errors), default)
  else
    value = default
  end 
  filter(value, format)
end

#remove_custom_facts(*facts) ⇒ Object 



307
308
309
310
311
 
# File 'lib/core/plugin/node.rb', line 307

def remove_custom_facts(*facts)
  facts.each do |name|
    delete_setting([ :facts, name ])
  end  
end

#remove_plugin ⇒ Object 



63
64
65
66
 
# File 'lib/core/plugin/node.rb', line 63

def remove_plugin
  CORL.remove_plugin(local_machine) if local_machine
  CORL.remove_plugin(machine) if machine
end

#render_image(image) ⇒ Object 



1369
1370
1371
 
# File 'lib/core/plugin/node.rb', line 1369

def render_image(image)
  ''  
end

#render_machine_type(machine_type) ⇒ Object 



1356
1357
1358
 
# File 'lib/core/plugin/node.rb', line 1356

def render_machine_type(machine_type)
  ''  
end

#run ⇒ Object 



911
912
913
 
# File 'lib/core/plugin/node.rb', line 911

def run
  @action_interface
end

#save(options = {}) ⇒ Object 



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
 
# File 'lib/core/plugin/node.rb', line 1041

def save(options = {})
  config = Config.ensure(options)
  
  # Record machine parameters
  if block_given?
    # Provider or external configuration preparation
    yield(config)  
  else
    # Default configuration preparation
    id(true)
    public_ip(true)
    private_ip(true)
    state(true)
  
    machine_type(false)
    image(false)
  end
  
  network.save(config.import({ 
    :commit      => true,
    :allow_empty => true,
    :message     => config.get(:message, "Saving #{plugin_provider} node #{plugin_name}"),
    :remote      => config.get(:remote, :edit)
  }))    
end

#send_files(local_path, remote_path, files = nil, permission = '0644', &code) ⇒ Object 



745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/core/plugin/node.rb', line 745

def send_files(local_path, remote_path, files = nil, permission = '0644', &code)
  local_path = File.expand_path(local_path)
  return false unless File.directory?(local_path)
  
  success = true
  
  send_file = lambda do |local_file, remote_file|
    send_success = upload(local_file, remote_file) do |op, options|
      code.call(op, options) if code
    end
    send_success = cli_check(:chmod, permission, remote_file) if send_success
    send_success  
  end
  
  if files && files.is_a?(Array)
    files.flatten.each do |rel_file_name|
      local_file  = "#{local_path}/#{rel_file_name}"
      remote_file = "#{remote_path}/#{rel_file_name}"
  
      if File.exists?(local_file)
        send_success = send_file.call(local_file, remote_file) 
        success      = false unless send_success
      end
    end
  else
    send_success = send_file.call(local_path, remote_path)
    success      = false unless send_success
  end
  success
end

#set_remote_cache_setting(keys, value) ⇒ Object 



487
488
489
490
491
492
493
 
# File 'lib/core/plugin/node.rb', line 487

def set_remote_cache_setting(keys, value)
  run.node_cache({ 
    :name  => keys.flatten.join('.'), 
    :value => Util::Data.to_json(value, false), 
    :json  => true 
  }).status == code.success
end

#ssh_path(home_env_var = 'HOME', reset = false) ⇒ Object 



191
192
193
194
 
# File 'lib/core/plugin/node.rb', line 191

def ssh_path(home_env_var = 'HOME', reset = false)
  home = home(home_env_var, reset)
  home ? File.join(home, '.ssh') : nil
end

#ssh_port ⇒ Object 



175
176
177
178
 
# File 'lib/core/plugin/node.rb', line 175

def ssh_port
  myself[:ssh_port] = 22 if myself[:ssh_port].nil?
  myself[:ssh_port]
end

#ssh_port=(ssh_port) ⇒ Object 



170
171
172
173
 
# File 'lib/core/plugin/node.rb', line 170

def ssh_port=ssh_port
  myself[:ssh_port] = ssh_port
  machine.init_ssh(ssh_port) if machine
end

#start(options = {}) ⇒ Object 



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
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
 
# File 'lib/core/plugin/node.rb', line 1069

def start(options = {})
  success = true
  
  if machine
    config = Config.ensure(options)
    
    if extension_check(:start, { :config => config })
      logger.info("Starting node: #{plugin_name}")
    
      yield(:config, config) if block_given?      
      success = machine.start(config.export)
      success = save(config) if success
      
      if success
        if config.get(:bootstrap, true) && bootstrap_script
          result = command("HOSTNAME='#{hostname}' #{bootstrap_script}", { :as_admin => true }) do |op, data|
            yield("bootstrap_#{op}".to_sym, data) if block_given?
            data
          end
          success = false unless result.status == code.success && reload
        end
      end
      
      if success && block_given?
        process_success = yield(:process, config)
        success         = process_success if process_success == false        
      end
      
      if success
        extension(:start_success, { :config => config })
      end
    end
  else
    logger.warn("Node #{plugin_name} does not have an attached machine so cannot be started")
  end
  success
end

#state(reset = false) ⇒ Object 



153
154
155
156
 
# File 'lib/core/plugin/node.rb', line 153

def state(reset = false)
  myself[:state] = machine.state if machine && ( reset || setting(:state).nil? )
  setting(:state)
end

#stop(options = {}) ⇒ Object 



1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
 
# File 'lib/core/plugin/node.rb', line 1168

def stop(options = {})
  success = true
  
  if machine && machine.running?
    config = Config.ensure(options)
    
    if extension_check(:stop, { :config => config })
      logger.info("Stopping node: #{plugin_name}")
    
      yield(:config, config) if block_given?      
      success = machine.stop(config.export)
      
      myself.machine = nil
      
      override_settings = false
      override_settings = yield(:finalize, config) if success && block_given?
      
      if success && ! override_settings
        delete_setting(:id)
        delete_setting(:public_ip)
        delete_setting(:private_ip)
        delete_setting(:ssh_port)
        delete_setting(:build)
      
        myself[:state] = :stopped
      end
      success = save(config)
      
      if success && block_given?
        process_success = yield(:process, config)
        success         = process_success if process_success == false        
      end
      
      if success
        extension(:stop_success, { :config => config })
      end
    end
  else
    logger.warn("Node #{plugin_name} does not have an attached machine or is not running so cannot be stopped")
  end
  success
end

#terminal(options = {}) ⇒ Object 



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
 
# File 'lib/core/plugin/node.rb', line 917

def terminal(options = {})
  myself.status = code.unknown_status
  
  if machine && machine.running?
    config = Config.ensure(options)
    
    if extension_check(:terminal, { :config => config })
      logger.info("Launching terminal for node: #{plugin_name}")
      
      if local? && local_machine
        active_machine = local_machine
      else
        active_machine = machine
      end
      
      config[:private_keys] = private_key
      config[:port]         = ssh_port
      
      myself.status = active_machine.terminal(user, config.export)
      
      if status == code.success
        extension(:exec_success, { :config => config }) 
      end
    end
  else
    logger.warn("Node #{plugin_name} does not have an attached machine or is not running so cannot launch terminal")
  end
  status == code.success
end

#translate_reference(reference) ⇒ Object 



1311
1312
1313
 
# File 'lib/core/plugin/node.rb', line 1311

def translate_reference(reference)
  myself.class.translate_reference(reference)
end

#upload(local_path, remote_path, options = {}) ⇒ Object 



707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/core/plugin/node.rb', line 707

def upload(local_path, remote_path, options = {})
  success = false
  
  if machine && machine.running?
    config      = Config.ensure(options)
    hook_config = Config.new({ :local_path => local_path, :remote_path => remote_path, :config => config })
    
    if extension_check(:upload, hook_config)
      logger.info("Uploading to #{plugin_name}")
    
      info("Starting upload of #{local_path} to #{remote_path}", { :i18n => false }) 
      yield(:config, hook_config) if block_given?
      
      active_machine = local? ? local_machine : machine
      
      success = active_machine.upload(local_path, remote_path, config.export) do |name, sent, total|
        info("#{name}: Sent #{sent} of #{total}", { :i18n => false })
        yield(:progress, { :name => name, :sent => sent, :total => total })  
      end
      
      if success && block_given?
        info("Successfully finished upload of #{local_path} to #{remote_path}", { :i18n => false })
        process_success = yield(:process, hook_config)
        success         = process_success if process_success == false        
      end
      
      if success
        extension(:upload_success, hook_config)
      end
    end
  else
    logger.warn("Node #{plugin_name} does not have an attached machine or is not running so cannot upload")
  end
  success
end

#usable_image?(image) ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/core/plugin/node.rb', line 77

def usable_image?(image)
  true
end

#user ⇒ Object 



164
165
166
 
# File 'lib/core/plugin/node.rb', line 164

def user
  myself[:user]
end

#user=(user) ⇒ Object 



160
161
162
 
# File 'lib/core/plugin/node.rb', line 160

def user=user
  myself[:user] = user
end