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

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

Instance Attribute Summary collapse

Attributes inherited from Model

#collection, #connection

Instance Method Summary collapse

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, #identity, #identity=, #merge_attributes, #new_record?, #requires

Constructor Details

#initialize(attributes = {}) ⇒ Server

Returns a new instance of Server.



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

def initialize(attributes={})
  @groups ||= ["default"] unless attributes[:subnet_id]
  @flavor_id ||= 'm1.small'
  super
end

Instance Attribute Details

#architecture ⇒ Object

Returns the value of attribute architecture.



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

def architecture
  @architecture
end

#instance_initiated_shutdown_behavior ⇒ Object

Returns the value of attribute instance_initiated_shutdown_behavior.



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

def instance_initiated_shutdown_behavior
  @instance_initiated_shutdown_behavior
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#private_key ⇒ Object 



113
114
115
 
# File 'lib/fog/aws/models/compute/server.rb', line 113

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

#private_key_path ⇒ Object 



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

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 



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

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

#public_key_path ⇒ Object 



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

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

#username ⇒ Object 



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

def username
  @username ||= 'root'
end

Instance Method Details

#addresses ⇒ Object 



48
49
50
51
52
 
# File 'lib/fog/aws/models/compute/server.rb', line 48

def addresses
  requires :id

  connection.addresses(:server => self)
end

#availability_zone=(new_availability_zone) ⇒ Object 



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

def availability_zone=(new_availability_zone)
  if new_availability_zone.is_a?(Hash)
    @availability_zone = new_availability_zone['availabilityZone']
  else
    @availability_zone = new_availability_zone
  end
end

#console_output ⇒ Object 



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

def console_output
  requires :id

  connection.get_console_output(@id)
end

#destroy ⇒ Object 



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

def destroy
  requires :id

  connection.terminate_instances(@id)
  true
end

#flavor ⇒ Object 



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

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

#flavor=(new_flavor) ⇒ Object 



81
82
83
 
# File 'lib/fog/aws/models/compute/server.rb', line 81

def flavor=(new_flavor)
  @flavor = new_flavor
end

#flavor_id ⇒ Object 



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

def flavor_id
  @flavor && @flavor.id || @flavor_id
end

#key_pair ⇒ Object 



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

def key_pair
  requires :key_name

  connection.keypairs.all(@key_name).first
end

#key_pair=(new_keypair) ⇒ Object 



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

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

#monitoring=(new_monitoring) ⇒ Object 



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

def monitoring=(new_monitoring)
  if new_monitoring.is_a?(Hash)
    @monitoring = new_monitoring['state']
  else
    @monitoring = new_monitoring
  end
end

#ready? ⇒ Boolean

Returns:

  • (Boolean) 


126
127
128
 
# File 'lib/fog/aws/models/compute/server.rb', line 126

def ready?
  @state == 'running'
end

#reboot ⇒ Object 



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

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

#save ⇒ Object

Raises:



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

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

#setup(credentials = {}) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/fog/aws/models/compute/server.rb', line 170

def setup(credentials = {})
  requires :identity, :ip_address, :username
  sleep(10) # takes a bit before EC2 instances will play nice
  commands = [
    %{mkdir .ssh},
    %{passwd -l root},
    %{echo "#{attributes.to_json}" >> ~/attributes.json}
  ]
  if public_key
    commands << %{echo "#{public_key}" >> ~/.ssh/authorized_keys}
  end
  Fog::SSH.new(ip_address, username, credentials).run(commands)
rescue Errno::ECONNREFUSED => e
  sleep(1)
  retry
end

#ssh(commands) ⇒ Object 



187
188
189
190
 
# File 'lib/fog/aws/models/compute/server.rb', line 187

def ssh(commands)
  requires :identity, :ip_address, :private_key, :username
  Fog::SSH.new(ip_address, username, :key_data => [private_key]).run(commands)
end

#start ⇒ Object 



192
193
194
195
196
 
# File 'lib/fog/aws/models/compute/server.rb', line 192

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

#stop ⇒ Object 



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

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

#volumes ⇒ Object 



208
209
210
211
 
# File 'lib/fog/aws/models/compute/server.rb', line 208

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