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

Inherits:
Model
  • Object
show all
Defined in:
lib/fog/compute/models/aws/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/compute/models/aws/server.rb', line 42

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

Instance Attribute Details

#architectureObject

Returns the value of attribute architecture.



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

def architecture
  @architecture
end

#instance_initiated_shutdown_behaviorObject

Returns the value of attribute instance_initiated_shutdown_behavior.



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

def instance_initiated_shutdown_behavior
  @instance_initiated_shutdown_behavior
end

#passwordObject

Returns the value of attribute password.



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

def password
  @password
end

#private_keyObject



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

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

#private_key_pathObject



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

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

#public_keyObject



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

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

#public_key_pathObject



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

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

#usernameObject



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

def username
  @username ||= 'root'
end

Instance Method Details

#addressesObject



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

def addresses
  requires :id

  connection.addresses(:server => self)
end

#console_outputObject



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

def console_output
  requires :id

  connection.get_console_output(id)
end

#destroyObject



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

def destroy
  requires :id

  connection.terminate_instances(id)
  true
end

#flavorObject



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

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

#flavor=(new_flavor) ⇒ Object



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

def flavor=(new_flavor)
  @flavor = new_flavor
end

#flavor_idObject



68
69
70
# File 'lib/fog/compute/models/aws/server.rb', line 68

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

#key_pairObject



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

def key_pair
  requires :key_name

  connection.keypairs.all(key_name).first
end

#key_pair=(new_keypair) ⇒ Object



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

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

#ready?Boolean

Returns:

  • (Boolean)


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

def ready?
  state == 'running'
end

#rebootObject



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

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

#saveObject

Raises:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/fog/compute/models/aws/server.rb', line 118

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



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

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

  commands = [
    %{mkdir .ssh},
    %{passwd -l root},
    %{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



179
180
181
182
183
184
185
# File 'lib/fog/compute/models/aws/server.rb', line 179

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

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

#startObject



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

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

#stopObject



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

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

#volumesObject



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

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