Class: Fog::Compute::RackspaceV2::Server
- Inherits:
-
Server
- Object
- Server
- Fog::Compute::RackspaceV2::Server
- Defined in:
- lib/fog/rackspace/models/compute_v2/server.rb
Constant Summary collapse
- ACTIVE =
States
'ACTIVE'
- BUILD =
'BUILD'
- DELETED =
'DELETED'
- ERROR =
'ERROR'
- HARD_REBOOT =
'HARD_REBOOT'
- MIGRATING =
'MIGRATING'
- PASSWORD =
'PASSWORD'
- REBOOT =
'REBOOT'
- REBUILD =
'REBUILD'
- RESCUE =
'RESCUE'
- RESIZE =
'RESIZE'
- REVERT_RESIZE =
'REVERT_RESIZE'
- SUSPENDED =
'SUSPENDED'
- UNKNOWN =
'UNKNOWN'
- VERIFY_RESIZE =
'VERIFY_RESIZE'
Instance Attribute Summary collapse
-
#address ⇒ Hash<String, Array[Hash]>
readonly
IP addresses allocated for server by network.
-
#bandwidth ⇒ Array
readonly
The amount of bandwidth used for the specified audit period.
-
#config_drive_ext ⇒ Boolean
Whether a read-only configuration drive is attached.
-
#created ⇒ String
readonly
The time stamp for the creation date.
-
#disk_config ⇒ String<AUTO, MANUAL>
The disk configuration value.
-
#flavor_id ⇒ String
readonly
The flavor Id.
-
#host Id(Id) ⇒ Object
readonly
The host Id.
-
#id ⇒ String
readonly
The server id.
-
#image_id ⇒ String
readonly
The image Id.
-
#ipv4_address ⇒ String
(also: #access_ipv4_address)
The public IP version 4 access address.
-
#ipv6_address ⇒ String
(also: #access_ipv6_address)
The public IP version 6 access address.
-
#key_name ⇒ String
The name of the key_pair used for server.
-
#links ⇒ Array
readonly
Server links.
-
#name ⇒ String
The server name.
-
#password ⇒ String
Password for system adminstrator account.
-
#personality ⇒ Hash
Hash containing data to inject into the file system of the cloud server instance during server creation.
-
#progress ⇒ Fixnum
readonly
The build completion progress, as a percentage.
-
#state ⇒ String
readonly
Server status.
-
#state_ext ⇒ String
readonly
Server (extended) status.
-
#tenant_id ⇒ String
readonly
The tenant Id.
-
#updated ⇒ String
readonly
The time stamp for the last update.
-
#user_data ⇒ Boolean
User-data.
-
#user_id ⇒ String
readonly
The user Id.
Instance Method Summary collapse
-
#attach_volume(volume, device = nil) ⇒ Fog::Compute::RackspaceV2::Attachment
Attaches Cloud Block Volume.
-
#attachments ⇒ Fog::Compute::RackspaceV2::Attachments
Attached Cloud Block Volumes.
-
#change_admin_password(password) ⇒ Boolean
Change admin password * Status Transition: * ACTIVE -> PASSWORD -> ACTIVE * ACTIVE -> PASSWORD -> ERROR (on error).
-
#confirm_resize ⇒ Object
-
VERIFY_RESIZE -> ERROR (on error)å.
-
-
#create(options) ⇒ Boolean
Creates server * requires attributes: service:, :name, :image_id, and :flavor_id * optional attributes :disk_config, :metadata, :personality, :config_drive * State Transitions * BUILD -> ACTIVE * BUILD -> ERROR (on error).
-
#create_image(name, options = {}) ⇒ Fog::ComputeRackspaceV2::Image
Creates Image from server.
-
#destroy ⇒ Boolean
Destroy the server * Status Transition: * ACTIVE -> DELETED * ERROR -> DELETED.
-
#flavor ⇒ Fog::Compute::RackspaceV2::Flavor
Server flavor.
-
#image ⇒ Fog::Compute::RackspaceV2::Image
Server image.
-
#initialize(attributes = {}) ⇒ Server
constructor
A new instance of Server.
-
#key_pair ⇒ KeyPair
Returns the key pair based on the key_name of the server.
-
#key_pair=(new_keypair) ⇒ Object
Sets the key_pair used by the server.
-
#metadata ⇒ Fog::Compute::RackspaceV2::Metadata
Server metadata.
-
#metadata=(hash = {}) ⇒ Object
Set server metadata.
-
#private_ip_address ⇒ String
Server’s private IPv4 address.
-
#public_ip_address ⇒ String
Server’s public IPv4 address.
-
#ready?(ready_state = ACTIVE, error_states = [ERROR]) ⇒ Boolean
Is server is in ready state.
-
#reboot(type = 'SOFT') ⇒ Boolean
Reboot server * State transition: * ACTIVE -> REBOOT -> ACTIVE (soft reboot) * ACTIVE -> HARD_REBOOT -> ACTIVE (hard reboot).
-
#rebuild(image_id, options = {}) ⇒ Boolean
Rebuild removes all data on the server and replaces it with the specified image.
-
#rescue ⇒ Boolean
Place existing server into rescue mode, allowing for offline editing of configuration.
-
#resize(flavor_id) ⇒ Boolean
Resize existing server to a different flavor, in essence, scaling the server up or down.
-
#revert_resize ⇒ Boolean
Reverts server resize operation * Status Transition: * VERIFY_RESIZE -> ACTIVE * VERIFY_RESIZE -> ERROR (on error).
-
#save(options = {}) ⇒ Boolean
Saves the server.
-
#setup(credentials = {}) ⇒ Object
Setup server for SSH access.
-
#unrescue ⇒ Boolean
Remove existing server from rescue mode.
-
#update ⇒ Object
Updates server This will update :name, :accessIPv4, and :accessIPv6 attributes.
- #virtual_interfaces ⇒ Object
Constructor Details
#initialize(attributes = {}) ⇒ Server
Returns a new instance of Server.
162 163 164 165 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 162 def initialize(attributes={}) @service = attributes[:service] super end |
Instance Attribute Details
#address ⇒ Hash<String, Array[Hash]> (readonly)
Returns IP addresses allocated for server by network.
139 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 139 attribute :addresses |
#bandwidth ⇒ Array (readonly)
Returns The amount of bandwidth used for the specified audit period.
127 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 127 attribute :bandwidth, :aliases => 'rax-bandwidth:bandwidth' |
#config_drive_ext ⇒ Boolean
Returns whether a read-only configuration drive is attached.
117 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 117 attribute :config_drive |
#created ⇒ String (readonly)
Returns The time stamp for the creation date.
36 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 36 attribute :created |
#disk_config ⇒ String<AUTO, MANUAL>
The disk configuration value.
* AUTO - The server is built with a single partition the size of the target flavor disk. The file system is automatically adjusted to fit the entire partition.
This keeps things simple and automated. AUTO is valid only for images and servers with a single partition that use the EXT3 file system.
This is the default setting for applicable Rackspace base images.
* MANUAL - The server is built using whatever partition scheme and file system is in the source image. If the target flavor disk is larger,
the remaining disk space is left unpartitioned. This enables images to have non-EXT3 file systems, multiple partitions,
and so on, and enables you to manage the disk configuration.
112 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 112 attribute :disk_config, :aliases => 'OS-DCF:diskConfig' |
#flavor_id ⇒ String (readonly)
Returns The flavor Id.
144 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 144 attribute :flavor_id, :aliases => 'flavor', :squash => 'id' |
#host Id(Id) ⇒ Object (readonly)
The host Id. The compute provisioning algorithm has an anti-affinity property that attempts to spread customer VMs across hosts. Under certain situations, VMs from the same customer might be placed on the same host. hostId represents the host your server runs on and can be used to determine this scenario if it is relevant to your application. HostId is unique per account and is not globally unique.
49 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 49 attribute :host_id, :aliases => 'hostId' |
#id ⇒ String (readonly)
Returns The server id.
28 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 28 identity :id |
#image_id ⇒ String (readonly)
Returns The image Id.
149 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 149 attribute :image_id, :aliases => 'image', :squash => 'id' |
#ipv4_address ⇒ String Also known as: access_ipv4_address
This field will populate once the server is ready to use.
Returns The public IP version 4 access address.
92 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 92 attribute :ipv4_address, :aliases => 'accessIPv4' |
#ipv6_address ⇒ String Also known as: access_ipv6_address
This field will populate once the server is ready to use.
Returns The public IP version 6 access address.
98 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 98 attribute :ipv6_address, :aliases => 'accessIPv6' |
#key_name ⇒ String
The key_pair/key_name is used to specify the keypair used for server creation. It is not populated by cloud servers.
Returns The name of the key_pair used for server.
160 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 160 attribute :key_name |
#links ⇒ Array (readonly)
Returns Server links.
75 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 75 attribute :links |
#name ⇒ String
Returns The server name.
32 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 32 attribute :name |
#password ⇒ String
Can be set while creating a server, but use change_admin_password instead of save/update for changes.
Returns Password for system adminstrator account.
155 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 155 attribute :password |
#personality ⇒ Hash
This attribute is only used for server creation. This field will be nil on subsequent retrievals.
Returns Hash containing data to inject into the file system of the cloud server instance during server creation.
86 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 86 attribute :personality |
#progress ⇒ Fixnum (readonly)
Returns The build completion progress, as a percentage. Value is from 0 to 100.
63 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 63 attribute :progress |
#state ⇒ String (readonly)
Returns server status.
54 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 54 attribute :state, :aliases => 'status' |
#state_ext ⇒ String (readonly)
Returns server (extended) status.
59 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 59 attribute :state_ext, :aliases => 'OS-EXT-STS:task_state' |
#tenant_id ⇒ String (readonly)
Returns The tenant Id.
71 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 71 attribute :tenant_id |
#updated ⇒ String (readonly)
Returns The time stamp for the last update.
40 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 40 attribute :updated |
#user_data ⇒ Boolean
Returns User-data.
122 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 122 attribute :user_data |
#user_id ⇒ String (readonly)
Returns The user Id.
67 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 67 attribute :user_id |
Instance Method Details
#attach_volume(volume, device = nil) ⇒ Fog::Compute::RackspaceV2::Attachment
Attaches Cloud Block Volume
377 378 379 380 381 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 377 def attach_volume(volume, device=nil) requires :identity volume_id = volume.is_a?(String) ? volume : volume.id .create(:server_id => identity, :volume_id => volume_id, :device => device) end |
#attachments ⇒ Fog::Compute::RackspaceV2::Attachments
Attached Cloud Block Volumes
359 360 361 362 363 364 365 366 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 359 def @attachments ||= begin Fog::Compute::RackspaceV2::Attachments.new({ :service => service, :server => self }) end end |
#change_admin_password(password) ⇒ Boolean
Though Rackspace does not enforce complexity requirements for the password, the operating system might. If the password is not complex enough, the server might enter an ERROR state.
Change admin password
-
Status Transition:
-
ACTIVE -> PASSWORD -> ACTIVE
-
ACTIVE -> PASSWORD -> ERROR (on error)
-
557 558 559 560 561 562 563 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 557 def change_admin_password(password) requires :identity service.change_server_password(identity, password) self.state = PASSWORD self.password = password true end |
#confirm_resize ⇒ Object
-
VERIFY_RESIZE -> ERROR (on error)å
481 482 483 484 485 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 481 def confirm_resize requires :identity service.confirm_resize_server(identity) true end |
#create(options) ⇒ Boolean
You should use servers.create to create servers instead calling this method directly
Creates server
-
requires attributes: service:, :name, :image_id, and :flavor_id
-
optional attributes :disk_config, :metadata, :personality, :config_drive
-
State Transitions
-
BUILD -> ACTIVE
-
BUILD -> ERROR (on error)
-
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 237 def create() requires :name, :image_id, :flavor_id = Marshal.load(Marshal.dump()) if attributes[:keypair] Fog::Logger.deprecation(":keypair has been depreciated. Please use :key_name instead.") [:key_name] = attributes[:keypair] end [:password] ||= attributes[:password] unless password.nil? [:networks] ||= attributes[:networks] [:disk_config] = disk_config unless disk_config.nil? [:metadata] = .to_hash unless @metadata.nil? [:personality] = personality unless personality.nil? [:config_drive] = config_drive unless config_drive.nil? [:user_data] = user_data_encoded unless user_data_encoded.nil? [:key_name] ||= attributes[:key_name] if [:networks] [:networks].map! { |id| { :uuid => id } } end data = service.create_server(name, image_id, flavor_id, 1, 1, ) merge_attributes(data.body['server']) true end |
#create_image(name, options = {}) ⇒ Fog::ComputeRackspaceV2::Image
Creates Image from server. Once complete, a new image is available that you can use to rebuild or create servers.
-
State Transition:
-
SAVING -> ACTIVE
-
SAVING -> ERROR (on error)
-
341 342 343 344 345 346 347 348 349 350 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 341 def create_image(name, = {}) requires :identity response = service.create_image(identity, name, ) begin image_id = response.headers["Location"].match(/\/([^\/]+$)/)[1] Fog::Compute::RackspaceV2::Image.new(:collection => service.images, :service => service, :id => image_id) rescue nil end end |
#destroy ⇒ Boolean
Destroy the server
-
Status Transition:
-
ACTIVE -> DELETED
-
ERROR -> DELETED
-
299 300 301 302 303 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 299 def destroy requires :identity service.delete_server(identity) true end |
#flavor ⇒ Fog::Compute::RackspaceV2::Flavor
Server flavor
311 312 313 314 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 311 def flavor requires :flavor_id @flavor ||= service.flavors.get(flavor_id) end |
#image ⇒ Fog::Compute::RackspaceV2::Image
Server image
322 323 324 325 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 322 def image requires :image_id @image ||= service.images.get(image_id) end |
#key_pair ⇒ KeyPair
The key_pair/key_name is used to specify the keypair used for server creation. It is not populated by cloud servers.
Returns the key pair based on the key_name of the server
192 193 194 195 196 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 192 def key_pair requires :key_name service.key_pairs.get(key_name) end |
#key_pair=(new_keypair) ⇒ Object
The key_pair/key_name is used to specify the keypair used for server creation. It is not populated by cloud servers.
Sets the key_pair used by the server.
201 202 203 204 205 206 207 208 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 201 def key_pair=(new_keypair) if new_keypair.is_a?(String) Fog::Logger.deprecation("#key_pair= should be used to set KeyPair objects. Please use #key_name method instead") self.key_name = new_keypair else self.key_name = new_keypair && new_keypair.name end end |
#metadata ⇒ Fog::Compute::RackspaceV2::Metadata
Server metadata
174 175 176 177 178 179 180 181 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 174 def @metadata ||= begin Fog::Compute::RackspaceV2::Metadata.new({ :service => service, :parent => self }) end end |
#metadata=(hash = {}) ⇒ Object
Set server metadata
185 186 187 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 185 def (hash={}) .from_hash(hash) end |
#private_ip_address ⇒ String
Server’s private IPv4 address
385 386 387 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 385 def private_ip_address addresses['private'].select{|a| a["version"] == 4}[0]["addr"] rescue '' end |
#public_ip_address ⇒ String
Server’s public IPv4 address
391 392 393 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 391 def public_ip_address ipv4_address end |
#ready?(ready_state = ACTIVE, error_states = [ERROR]) ⇒ Boolean
Is server is in ready state
400 401 402 403 404 405 406 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 400 def ready?(ready_state = ACTIVE, error_states=[ERROR]) if error_states error_states = Array(error_states) raise InvalidServerStateException.new(ready_state, state) if error_states.include?(state) end state == ready_state end |
#reboot(type = 'SOFT') ⇒ Boolean
Reboot server
-
State transition:
-
ACTIVE -> REBOOT -> ACTIVE (soft reboot)
-
ACTIVE -> HARD_REBOOT -> ACTIVE (hard reboot)
-
420 421 422 423 424 425 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 420 def reboot(type = 'SOFT') requires :identity service.reboot_server(identity, type) self.state = type == 'SOFT' ? REBOOT : HARD_REBOOT true end |
#rebuild(image_id, options = {}) ⇒ Boolean
Rebuild removes all data on the server and replaces it with the specified image. The id and all IP addresses remain the same.
-
Status Transition:
-
ACTIVE -> REBUILD -> ACTIVE
-
ACTIVE -> REBUILD -> ERROR (on error)
-
439 440 441 442 443 444 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 439 def rebuild(image_id, ={}) requires :identity service.rebuild_server(identity, image_id, ) self.state = REBUILD true end |
#rescue ⇒ Boolean
Rescue mode is only guaranteed to be active for 90 minutes.
Place existing server into rescue mode, allowing for offline editing of configuration. The original server’s disk is attached to a new instance of the same base image for a period of time to facilitate working within rescue mode. The original server will be automatically restored after 90 minutes.
-
Status Transition:
-
ACTIVE -> PREP_RESCUE -> RESCUE
-
518 519 520 521 522 523 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 518 def rescue requires :identity data = service.rescue_server(identity) merge_attributes(data.body) true end |
#resize(flavor_id) ⇒ Boolean
All resizes are automatically confirmed after 24 hours if you do not explicitly confirm or revert the resize.
Resize existing server to a different flavor, in essence, scaling the server up or down. The original server is saved for a period of time to allow rollback if there is a problem. All resizes should be tested and explicitly confirmed, at which time the original server is removed. All resizes are automatically confirmed after 24 hours if they are not confirmed or reverted.
-
Status Transition:
-
ACTIVE -> QUEUE_RESIZE -> PREP_RESIZE -> VERIFY_RESIZE
-
ACTIVE -> QUEUE_RESIZE -> ACTIVE (on error)
-
461 462 463 464 465 466 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 461 def resize(flavor_id) requires :identity service.resize_server(identity, flavor_id) self.state = RESIZE true end |
#revert_resize ⇒ Boolean
All resizes are automatically confirmed after 24 hours if you do not explicitly confirm or revert the resize.
Reverts server resize operation
-
Status Transition:
-
VERIFY_RESIZE -> ACTIVE
-
VERIFY_RESIZE -> ERROR (on error)
-
500 501 502 503 504 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 500 def revert_resize requires :identity service.revert_resize_server(identity) true end |
#save(options = {}) ⇒ Boolean
Saves the server. Creates server if it is new, otherwise it will update server attributes name, accessIPv4, and accessIPv6.
213 214 215 216 217 218 219 220 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 213 def save( = {}) if persisted? update else create() end true end |
#setup(credentials = {}) ⇒ Object
Setup server for SSH access
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 567 def setup(credentials = {}) requires :ssh_ip_address, :identity, :public_key, :username retried_disconnect = false commands = [ %{mkdir .ssh}, %{echo "#{public_key}" >> ~/.ssh/authorized_keys}, password_lock, %{echo "#{Fog::JSON.encode(attributes)}" >> ~/attributes.json}, %{echo "#{Fog::JSON.encode()}" >> ~/metadata.json} ] commands.compact self.password = nil if password_lock Fog::SSH.new(ssh_ip_address, username, credentials).run(commands) rescue Errno::ECONNREFUSED sleep(1) retry # Ubuntu 12.04 images seem to be disconnecting during the ssh setup process. # This rescue block is an effort to address that issue. rescue Net::SSH::Disconnect unless retried_disconnect retried_disconnect = true sleep(1) retry end end |
#unrescue ⇒ Boolean
Rescue mode is only guaranteed to be active for 90 minutes.
Remove existing server from rescue mode.
-
Status Transition:
-
PREP_UNRESCUE -> ACTIVE
-
537 538 539 540 541 542 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 537 def unrescue requires :identity service.unrescue_server(identity) self.state = ACTIVE true end |
#update ⇒ Object
If you edit the server name, the server host name does not change. Also, server names are not guaranteed to be unique.
Updates server This will update :name, :accessIPv4, and :accessIPv6 attributes.
-
State Transition
-
ACTIVE -> ACTIVE
-
275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 275 def update requires :identity = { 'name' => name, 'accessIPv4' => ipv4_address, 'accessIPv6' => ipv6_address } data = service.update_server(identity, ) merge_attributes(data.body['server']) true end |
#virtual_interfaces ⇒ Object
597 598 599 |
# File 'lib/fog/rackspace/models/compute_v2/server.rb', line 597 def virtual_interfaces @virtual_interfaces ||= Fog::Compute::RackspaceV2::VirtualInterfaces.new :server => self, :service => service end |