Class: Fog::AWS::Compute::Server

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

Instance Attribute Summary collapse

Attributes inherited from Model

#collection, #connection

Instance Method Summary collapse

Methods included from Deprecation

deprecate, self_deprecate

Methods inherited from Model

#inspect, #reload, #to_json, #wait_for

Methods included from Fog::Attributes::ClassMethods

#_load, #aliases, #attribute, #attributes, #identity, #ignore_attributes, #ignored_attributes

Methods included from Fog::Attributes::InstanceMethods

#_dump, #attributes, #dup, #identity, #identity=, #merge_attributes, #new_record?, #requires

Constructor Details

#initialize(attributes = {}) ⇒ Server

Returns a new instance of Server.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/fog/compute/models/aws/server.rb', line 44

def initialize(attributes={})
  self.groups     ||= ["default"] unless attributes[:subnet_id]
  self.flavor_id  ||= 't1.micro'
  self.image_id ||= begin
    case attributes[:connection].instance_variable_get(:@region) # Ubuntu 10.04 LTS 64bit (EBS)
    when 'ap-northeast-1'
      'ami-5e0fa45f'
    when 'ap-southeast-1'
      'ami-f092eca2'
    when 'eu-west-1'
      'ami-3d1f2b49'
    when 'us-east-1'
      'ami-3202f25b'
    when 'us-west-1'
      'ami-f5bfefb0'
    end
  end
  super
end

Instance Attribute Details

#architecture ⇒ Object

Returns the value of attribute architecture.



13
14
15
 
# File 'lib/fog/compute/models/aws/server.rb', line 13

def architecture
  @architecture
end

#instance_initiated_shutdown_behavior ⇒ Object

Returns the value of attribute instance_initiated_shutdown_behavior.



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

def instance_initiated_shutdown_behavior
  @instance_initiated_shutdown_behavior
end

#password ⇒ Object

Returns the value of attribute password.



41
42
43
 
# File 'lib/fog/compute/models/aws/server.rb', line 41

def password
  @password
end

#private_key ⇒ Object 



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

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

#private_key_path ⇒ Object 



106
107
108
109
 
# File 'lib/fog/compute/models/aws/server.rb', line 106

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 



120
121
122
 
# File 'lib/fog/compute/models/aws/server.rb', line 120

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

#public_key_path ⇒ Object 



115
116
117
118
 
# File 'lib/fog/compute/models/aws/server.rb', line 115

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

#username ⇒ Object 



223
224
225
 
# File 'lib/fog/compute/models/aws/server.rb', line 223

def username
  @username ||= 'root'
end

Instance Method Details

#addresses ⇒ Object 



64
65
66
67
68
 
# File 'lib/fog/compute/models/aws/server.rb', line 64

def addresses
  requires :id

  connection.addresses(:server => self)
end

#console_output ⇒ Object 



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

def console_output
  requires :id

  connection.get_console_output(id)
end

#destroy ⇒ Object 



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

def destroy
  requires :id

  connection.terminate_instances(id)
  true
end

#flavor ⇒ Object 



92
93
94
 
# File 'lib/fog/compute/models/aws/server.rb', line 92

def flavor
  @flavor ||= connection.flavors.all.detect {|flavor| flavor.id == flavor_id}
end

#flavor=(new_flavor) ⇒ Object 



88
89
90
 
# File 'lib/fog/compute/models/aws/server.rb', line 88

def flavor=(new_flavor)
  @flavor = new_flavor
end

#flavor_id ⇒ Object 



84
85
86
 
# File 'lib/fog/compute/models/aws/server.rb', line 84

def flavor_id
  @flavor && @flavor.id || attributes[:flavor_id]
end

#key_pair ⇒ Object 



96
97
98
99
100
 
# File 'lib/fog/compute/models/aws/server.rb', line 96

def key_pair
  requires :key_name

  connection.key_pairs.all(key_name).first
end

#key_pair=(new_keypair) ⇒ Object 



102
103
104
 
# File 'lib/fog/compute/models/aws/server.rb', line 102

def key_pair=(new_keypair)
  self.key_name = new_keypair && new_keypair.name
end

#monitor=(new_monitor) ⇒ Object

I tried to call it monitoring= and be smart with attributes[] but in #save a merge_attribute is called after run_instance thus making an un-necessary request. Use this until finding a clever solution



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/fog/compute/models/aws/server.rb', line 235

def monitor=(new_monitor)
  if identity
    case new_monitor
    when true
      response = connection.monitor_instances(identity)
    when false
      response = connection.unmonitor_instances(identity)
    else
      raise ArgumentError.new("only Boolean allowed here")
    end
  end
  self.monitoring = new_monitor
end

#ready? ⇒ Boolean

Returns:

  • (Boolean) 


124
125
126
 
# File 'lib/fog/compute/models/aws/server.rb', line 124

def ready?
  state == 'running'
end

#reboot ⇒ Object 



128
129
130
131
132
 
# File 'lib/fog/compute/models/aws/server.rb', line 128

def reboot
  requires :id
  connection.reboot_instances(id)
  true
end

#save ⇒ Object

Raises:



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/fog/compute/models/aws/server.rb', line 134

def save
  raise Fog::Errors::Error.new('Resaving an existing object may create a duplicate') if identity
  requires :image_id

  options = {
    'BlockDeviceMapping'          => block_device_mapping,
    'ClientToken'                 => client_token,
    'InstanceInitiatedShutdownBehavior' => instance_initiated_shutdown_behavior,
    'InstanceType'                => flavor_id,
    'KernelId'                    => kernel_id,
    'KeyName'                     => key_name,
    'Monitoring.Enabled'          => monitoring,
    'Placement.AvailabilityZone'  => availability_zone,
    'RamdiskId'                   => ramdisk_id,
    'SecurityGroup'               => groups,
    'SubnetId'                    => subnet_id,
    'UserData'                    => user_data
  }
  options.delete_if {|key, value| value.nil?}

  # If subnet is defined we are working on a virtual private cloud.
  # subnet & security group cannot co-exist. I wish VPC just ignored
  # the security group parameter instead, it would be much easier!
  if subnet_id
    options.delete('SecurityGroup')
  else
    options.delete('SubnetId')
  end

  data = connection.run_instances(image_id, 1, 1, options)
  merge_attributes(data.body['instancesSet'].first)
  true
end

#scp(local_path, remote_path) ⇒ Object 



203
204
205
206
207
208
209
 
# File 'lib/fog/compute/models/aws/server.rb', line 203

def scp(local_path, remote_path)
  requires :public_ip_address, :username

  options = {}
  options[:key_data] = [private_key] if private_key
  Fog::SCP.new(public_ip_address, username, options).upload(local_path, remote_path)
end

#setup(credentials = {}) ⇒ Object 



168
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
 
# File 'lib/fog/compute/models/aws/server.rb', line 168

def setup(credentials = {})
  requires :identity, :ip_address, :username
  require 'json'

  commands = [
    %{mkdir .ssh},
    %{passwd -l #{username}},
    %{echo "#{attributes.to_json}" >> ~/attributes.json}
  ]
  if public_key
    commands << %{echo "#{public_key}" >> ~/.ssh/authorized_keys}
  end
  # allow some retries over the first 120 seconds because aws is weird
  Timeout::timeout(120) do
    begin
      Timeout::timeout(4) do
        Fog::SSH.new(ip_address, username, credentials).run(commands)
      end
    rescue Net::SSH::AuthenticationFailed, Timeout::Error
      retry
    end
  end
rescue Errno::ECONNREFUSED => e
  sleep(1)
  retry
end

#ssh(commands) ⇒ Object 



195
196
197
198
199
200
201
 
# File 'lib/fog/compute/models/aws/server.rb', line 195

def ssh(commands)
  requires :identity, :public_ip_address, :username

  options = {}
  options[:key_data] = [private_key] if private_key
  Fog::SSH.new(public_ip_address, username, options).run(commands)
end

#start ⇒ Object 



211
212
213
214
215
 
# File 'lib/fog/compute/models/aws/server.rb', line 211

def start
  requires :id
  connection.start_instances(id)
  true
end

#stop ⇒ Object 



217
218
219
220
221
 
# File 'lib/fog/compute/models/aws/server.rb', line 217

def stop
  requires :id
  connection.stop_instances(id)
  true
end

#volumes ⇒ Object 



227
228
229
230
 
# File 'lib/fog/compute/models/aws/server.rb', line 227

def volumes
  requires :id
  connection.volumes(:server => self)
end