Class: Fog::Compute::Server

Inherits:
Model
  • Object
show all
Defined in:
lib/fog/compute/models/server.rb

Constant Summary collapse

INITIAL_SSHABLE_TIMEOUT = 
8

Instance Attribute Summary collapse

Attributes inherited from Model

#collection, #service

Instance Method Summary collapse

Methods inherited from Model

#==, #cache, #initialize, #inspect, #reload, #symbolize_keys, #to_json, #wait_for

Methods included from Attributes::ClassMethods

#_load, #aliases, #associations, #attribute, #attributes, #default_values, #has_many, #has_many_identities, #has_one, #has_one_identity, #identity, #ignore_attributes, #ignored_attributes, #masks

Methods included from Fog::Core::DeprecatedConnectionAccessors

#connection, #connection=, #prepare_service_value

Methods included from Attributes::InstanceMethods

#_dump, #all_associations, #all_associations_and_attributes, #all_attributes, #associations, #attributes, #dup, #identity, #identity=, #identity_name, #masks, #merge_attributes, #new_record?, #persisted?, #requires, #requires_one

Constructor Details

This class inherits a constructor from Fog::Model

Instance Attribute Details

#private_key ⇒ Object 



30
31
32
 
# File 'lib/fog/compute/models/server.rb', line 30

def private_key
  @private_key ||= private_key_path && File.read(private_key_path)
end

#private_key_path ⇒ Object 



25
26
27
28
 
# File 'lib/fog/compute/models/server.rb', line 25

def private_key_path
  @private_key_path ||= Fog.credentials[:private_key_path]
  @private_key_path &&= File.expand_path(@private_key_path)
end

#public_key ⇒ Object 



39
40
41
 
# File 'lib/fog/compute/models/server.rb', line 39

def public_key
  @public_key ||= public_key_path && File.read(public_key_path)
end

#public_key_path ⇒ Object 



34
35
36
37
 
# File 'lib/fog/compute/models/server.rb', line 34

def public_key_path
  @public_key_path ||= Fog.credentials[:public_key_path]
  @public_key_path &&= File.expand_path(@public_key_path)
end

#ssh_ip_address ⇒ String

Note:

By default this returns the public_ip_address

IP Address used for ssh/scp interactions with server.

Returns:

  • (String) —

    IP Address



53
54
55
56
57
 
# File 'lib/fog/compute/models/server.rb', line 53

def ssh_ip_address
  return public_ip_address unless @ssh_ip_address
  return @ssh_ip_address.call(self) if @ssh_ip_address.is_a?(Proc)
  @ssh_ip_address
end

#ssh_options ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'lib/fog/compute/models/server.rb', line 59

def ssh_options
  @ssh_options ||= {}
  ssh_options = @ssh_options.merge(:port => ssh_port)
  if private_key
    ssh_options[:key_data] = [private_key]
    ssh_options[:auth_methods] = %w(publickey)
  end
  ssh_options
end

#ssh_port ⇒ Integer

Note:

By default this returns 22

Port used for ssh/scp interactions with server.

Returns:

  • (Integer) —

    IP port



46
47
48
 
# File 'lib/fog/compute/models/server.rb', line 46

def ssh_port
  @ssh_port ||= 22
end

#username ⇒ Object 



21
22
23
 
# File 'lib/fog/compute/models/server.rb', line 21

def username
  @username ||= "root"
end

Instance Method Details

#ready? ⇒ Boolean

Is the server ready to receive connections?

Returns false by default.

Subclasses should implement #ready? appropriately.

Returns:



110
111
112
 
# File 'lib/fog/compute/models/server.rb', line 110

def ready?
  false
end

#scp(local_path, remote_path, upload_options = {}) ⇒ Object Also known as: scp_upload 



69
70
71
72
73
 
# File 'lib/fog/compute/models/server.rb', line 69

def scp(local_path, remote_path, upload_options = {})
  requires :ssh_ip_address, :username

  Fog::SCP.new(ssh_ip_address, username, ssh_options).upload(local_path, remote_path, upload_options)
end

#scp_download(remote_path, local_path, download_options = {}) ⇒ Object 



77
78
79
80
81
 
# File 'lib/fog/compute/models/server.rb', line 77

def scp_download(remote_path, local_path, download_options = {})
  requires :ssh_ip_address, :username

  Fog::SCP.new(ssh_ip_address, username, ssh_options).download(remote_path, local_path, download_options)
end

#ssh(commands, options = {}, &blk) ⇒ Object 



83
84
85
86
87
88
89
 
# File 'lib/fog/compute/models/server.rb', line 83

def ssh(commands, options = {}, &blk)
  requires :ssh_ip_address, :username

  options = ssh_options.merge(options)

  Fog::SSH.new(ssh_ip_address, username, options).run(commands, &blk)
end

#sshable?(options = {}) ⇒ Boolean

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/fog/compute/models/server.rb', line 91

def sshable?(options = {})
  result = ready? && !ssh_ip_address.nil? && !!Timeout.timeout(sshable_timeout) { ssh("pwd", options) }
  @sshable_timeout = nil
  result
rescue SystemCallError
  false
rescue Net::SSH::AuthenticationFailed, Net::SSH::Disconnect
  @sshable_timeout = nil
  false
rescue Timeout::Error
  increase_sshable_timeout
  false
end