class Fog::Compute::Server
Constants
- INITIAL_SSHABLE_TIMEOUT
Attributes
private_key[W]
private_key_path[W]
public_key[W]
public_key_path[W]
ssh_ip_address[W]
Sets the proc used to determine the IP Address used for ssh/scp interactions. @example
service.servers.bootstrap :name => "bootstrap-server", :flavor_id => service.flavors.first.id, :image_id => service.images.find {|img| img.name =~ /Ubuntu/}.id, :public_key_path => "~/.ssh/fog_rsa.pub", :private_key_path => "~/.ssh/fog_rsa", :ssh_ip_address => Proc.new {|server| server.private_ip_address }
@note By default scp/ssh will use the public_ip_address if this proc is not set.
ssh_options[W]
ssh_port[W]
username[W]
Public Instance Methods
private_key()
click to toggle source
# 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()
click to toggle source
# 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()
click to toggle source
# 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()
click to toggle source
# 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
ready?()
click to toggle source
Is the server ready to receive connections?
Returns false by default.
Subclasses should implement ready?
appropriately.
# File lib/fog/compute/models/server.rb, line 110 def ready? false end
scp(local_path, remote_path, upload_options = {})
click to toggle source
# 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
Also aliased as: scp_upload
scp_download(remote_path, local_path, download_options = {})
click to toggle source
# 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)
click to toggle source
# 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
ssh_ip_address()
click to toggle source
IP Address used for ssh/scp interactions with server. @return [String] IP Address @note By default this returns the public_ip_address
# 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()
click to toggle source
# 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()
click to toggle source
Port used for ssh/scp interactions with server. @return [Integer] IP port @note By default this returns 22
# File lib/fog/compute/models/server.rb, line 46 def ssh_port @ssh_port ||= 22 end
sshable?(options = {})
click to toggle source
# 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
username()
click to toggle source
# File lib/fog/compute/models/server.rb, line 21 def username @username ||= "root" end
Private Instance Methods
increase_sshable_timeout()
click to toggle source
# File lib/fog/compute/models/server.rb, line 120 def increase_sshable_timeout if defined?(@sshable_timeout) && @sshable_timeout if @sshable_timeout >= 40 @sshable_timeout = 60 else @sshable_timeout *= 1.5 end else @sshable_timeout = INITIAL_SSHABLE_TIMEOUT end end
sshable_timeout()
click to toggle source
# File lib/fog/compute/models/server.rb, line 116 def sshable_timeout @sshable_timeout ||= increase_sshable_timeout end