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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Server

Returns a new instance of Server.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/fog/aws/models/compute/server.rb', line 60

def initialize(attributes={})
  self.groups     ||= ["default"] unless (attributes[:subnet_id] || attributes[:security_group_ids] || attributes[:network_interfaces])
  self.flavor_id  ||= 't1.micro'

  # Old 'connection' is renamed as service and should be used instead
  prepare_service_value(attributes)

  self.image_id   ||= begin
    self.username ||= 'ubuntu'
    case @service.instance_variable_get(:@region) # Ubuntu 10.04 LTS 64bit (EBS)
    when 'ap-northeast-1'
      'ami-5e0fa45f'
    when 'ap-southeast-1'
      'ami-f092eca2'
    when 'ap-southeast-2'
      'ami-fb8611c1' # Ubuntu 12.04 LTS 64bit (EBS)
    when 'eu-west-1'
      'ami-3d1f2b49'
    when 'sa-east-1'
      'ami-d0429ccd'
    when 'us-east-1'
      'ami-3202f25b'
    when 'us-west-1'
      'ami-f5bfefb0'
    when 'us-west-2'
      'ami-e0ec60d0'
    end
  end
  super
end

Instance Attribute Details

#architecture ⇒ Object

Returns the value of attribute architecture.



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

def architecture
  @architecture
end

#iam_instance_profile_arn=(value) ⇒ Object (writeonly)

Sets the attribute iam_instance_profile_arn

Parameters:

  • value —

    the value to set the attribute iam_instance_profile_arn to.



58
59
60
 
# File 'lib/fog/aws/models/compute/server.rb', line 58

def iam_instance_profile_arn=(value)
  @iam_instance_profile_arn = value
end

#iam_instance_profile_name=(value) ⇒ Object (writeonly)

Sets the attribute iam_instance_profile_name

Parameters:

  • value —

    the value to set the attribute iam_instance_profile_name to.



58
59
60
 
# File 'lib/fog/aws/models/compute/server.rb', line 58

def iam_instance_profile_name=(value)
  @iam_instance_profile_name = value
end

#instance_initiated_shutdown_behavior ⇒ Object

Returns the value of attribute instance_initiated_shutdown_behavior.



28
29
30
 
# File 'lib/fog/aws/models/compute/server.rb', line 28

def instance_initiated_shutdown_behavior
  @instance_initiated_shutdown_behavior
end

#password ⇒ Object

Returns the value of attribute password.



57
58
59
 
# File 'lib/fog/aws/models/compute/server.rb', line 57

def password
  @password
end

Instance Method Details

#addresses ⇒ Object 



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

def addresses
  requires :id

  service.addresses(:server => self)
end

#console_output ⇒ Object 



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

def console_output
  requires :id

  service.get_console_output(id)
end

#destroy ⇒ Object 



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

def destroy
  requires :id

  service.terminate_instances(id)
  true
end

#flavor ⇒ Object 



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

def flavor
  @flavor ||= service.flavors.all.find {|flavor| flavor.id == flavor_id}
end

#flavor=(new_flavor) ⇒ Object 



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

def flavor=(new_flavor)
  @flavor = new_flavor
end

#flavor_id ⇒ Object 



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

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

#key_pair ⇒ Object 



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

def key_pair
  requires :key_name
  service.key_pairs.all({'key-name' => key_name}).first
end

#key_pair=(new_keypair) ⇒ Object 



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

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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/fog/aws/models/compute/server.rb', line 246

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

#ready? ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
 
# File 'lib/fog/aws/models/compute/server.rb', line 132

def ready?
  state == 'running'
end

#reboot ⇒ Object 



136
137
138
139
140
 
# File 'lib/fog/aws/models/compute/server.rb', line 136

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

#run_instance_options ⇒ Object

Raises:

  • (Fog::Errors::Error) 


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
167
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
194
195
196
197
198
199
200
 
# File 'lib/fog/aws/models/compute/server.rb', line 142

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

  options = {
    'BlockDeviceMapping'          => block_device_mapping,
    'HibernationOptions'          => hibernation_options,
    'NetworkInterfaces'           => network_interfaces,
    'ClientToken'                 => client_token,
    'DisableApiTermination'       => disable_api_termination,
    'EbsOptimized'                => ebs_optimized,
    'IamInstanceProfile.Arn'      => @iam_instance_profile_arn,
    'IamInstanceProfile.Name'     => @iam_instance_profile_name,
    'InstanceInitiatedShutdownBehavior' => instance_initiated_shutdown_behavior,
    'InstanceType'                => flavor_id,
    'KernelId'                    => kernel_id,
    'KeyName'                     => key_name,
    'Monitoring.Enabled'          => monitoring,
    'Placement.AvailabilityZone'  => availability_zone,
    'Placement.GroupName'         => placement_group,
    'Placement.Tenancy'           => tenancy,
    'PrivateIpAddress'            => private_ip_address,
    'RamdiskId'                   => ramdisk_id,
    'SecurityGroup'               => groups,
    'SecurityGroupId'             => security_group_ids,
    'SubnetId'                    => subnet_id,
    'UserData'                    => user_data,
  }
  options.delete_if {|key, value| value.nil?}

  # If subnet is defined then this is a Virtual Private Cloud.
  # subnet & security group cannot co-exist. Attempting to specify
  # both subnet and groups will cause an error.  Instead please make
  # use of Security Group Ids when working in a VPC.
  if subnet_id
    options.delete('SecurityGroup')
    if associate_public_ip
      options['NetworkInterface.0.DeviceIndex'] = 0
      options['NetworkInterface.0.AssociatePublicIpAddress'] = associate_public_ip
      options['NetworkInterface.0.SubnetId'] = options['SubnetId']
      options.delete('SubnetId')
      if options['SecurityGroupId'].kind_of?(Array)
        options['SecurityGroupId'].each {|id|
          options["NetworkInterface.0.SecurityGroupId.#{options['SecurityGroupId'].index(id)}"] = id
        }
      else
        options["NetworkInterface.0.SecurityGroupId.0"] = options['SecurityGroupId']
      end
      options.delete('SecurityGroupId')
      if private_ip_address
        options.delete('PrivateIpAddress')
        options['NetworkInterface.0.PrivateIpAddress'] = private_ip_address
      end
    end
  else
    options.delete('SubnetId')
  end
  options
end

#save ⇒ Object 



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

def save
  servers = service.servers.save_many(self, 1, 1)
  merge_attributes(servers.first.attributes)
  true
end

#setup(credentials = {}) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/fog/aws/models/compute/server.rb', line 208

def setup(credentials = {})
  requires :ssh_ip_address, :username

  commands = [
    %{mkdir .ssh},
    %{passwd -l #{username}},
    %{echo "#{Fog::JSON.encode(Fog::JSON.sanitize(attributes))}" >> ~/attributes.json}
  ]
  if public_key
    commands << %{echo "#{public_key}" >> ~/.ssh/authorized_keys}
  end

  # wait for aws to be ready
  wait_for { sshable?(credentials) }

  Fog::SSH.new(ssh_ip_address, username, credentials).run(commands)
end

#start ⇒ Object 



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

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

#stop(options = {}) ⇒ Object 



232
233
234
235
236
 
# File 'lib/fog/aws/models/compute/server.rb', line 232

def stop(options = {})
  requires :id
  service.stop_instances(id, options)
  true
end

#volumes ⇒ Object 



238
239
240
241
 
# File 'lib/fog/aws/models/compute/server.rb', line 238

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