Class: Fog::Rackspace::Servers::Real

Inherits:
Object
  • Object
show all
Defined in:
lib/fog/rackspace/servers.rb,
lib/fog/rackspace/models/servers/images.rb,
lib/fog/rackspace/models/servers/flavors.rb,
lib/fog/rackspace/models/servers/servers.rb,
lib/fog/rackspace/requests/servers/list_images.rb,
lib/fog/rackspace/requests/servers/create_image.rb,
lib/fog/rackspace/requests/servers/delete_image.rb,
lib/fog/rackspace/requests/servers/list_flavors.rb,
lib/fog/rackspace/requests/servers/list_servers.rb,
lib/fog/rackspace/requests/servers/create_server.rb,
lib/fog/rackspace/requests/servers/delete_server.rb,
lib/fog/rackspace/requests/servers/reboot_server.rb,
lib/fog/rackspace/requests/servers/update_server.rb,
lib/fog/rackspace/requests/servers/list_addresses.rb,
lib/fog/rackspace/requests/servers/get_image_details.rb,
lib/fog/rackspace/requests/servers/get_flavor_details.rb,
lib/fog/rackspace/requests/servers/get_server_details.rb,
lib/fog/rackspace/requests/servers/list_images_detail.rb,
lib/fog/rackspace/requests/servers/list_flavors_detail.rb,
lib/fog/rackspace/requests/servers/list_servers_detail.rb,
lib/fog/rackspace/requests/servers/list_public_addresses.rb,
lib/fog/rackspace/requests/servers/list_private_addresses.rb

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Real

Returns a new instance of Real.


73
74
75
76
77
78
79
80
81
# File 'lib/fog/rackspace/servers.rb', line 73

def initialize(options={})
  credentials = Fog::Rackspace.authenticate(options)
  @auth_token = credentials['X-Auth-Token']
  uri = URI.parse(credentials['X-Server-Management-Url'])
  @host   = uri.host
  @path   = uri.path
  @port   = uri.port
  @scheme = uri.scheme
end

Instance Method Details

#create_image(server_id, options = {}) ⇒ Object

Create an image from a running server

Parameters

  • server_id<~Integer> - Id of server to create image from

  • options<~Hash> - Name

Returns

  • response<~Excon::Response>:

    • 'image'<~Hash>:

      • 'id'<~Integer> - Id of image

      • 'name'<~String> - Name of image

      • 'serverId'<~Integer> - Id of server


18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# File 'lib/fog/rackspace/requests/servers/create_image.rb', line 18

def create_image(server_id, options = {})
  data = {
    'image' => {
      'serverId' => server_id
    }
  }
  if options['name']
    data['image']['name'] = options['name']
  end
  request(
    :body     => data.to_json,
    :expects  => 202,
    :method   => 'POST',
    :path     => "images"
  )
end

#create_server(flavor_id, image_id, name, options = {}) ⇒ Object

Create a new server

Parameters

  • flavor_id<~Integer> - Id of flavor for server

  • image_id<~Integer> - Id of image for server

  • name<~String> - Name of server

  • options<~Hash>:

    • 'metadata'<~Hash> - Up to 5 key value pairs containing 255 bytes of info

    • 'name'<~String> - Name of server, defaults to “slice#id”

    • 'personality'<~Array>: Up to 5 files to customize server

      • file<~Hash>:

        • 'contents'<~String> - Contents of file (10kb total of contents)

        • 'path'<~String> - Path to file (255 bytes total of path strings)

Returns

  • response<~Excon::Response>:

    • body<~Hash>:

    • 'server'<~Hash>:

      • 'addresses'<~Hash>:

        • 'public'<~Array> - public address strings

        • 'private'<~Array> - private address strings

      • 'adminPass'<~String> - Admin password for server

      • 'flavorId'<~Integer> - Id of servers current flavor

      • 'hostId'<~String>

      • 'id'<~Integer> - Id of server

      • 'imageId'<~Integer> - Id of image used to boot server

      • 'metadata'<~Hash> - metadata

      • 'name<~String> - Name of server

      • 'progress'<~Integer> - Progress through current status

      • 'status'<~String> - Current server status


36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/fog/rackspace/requests/servers/create_server.rb', line 36

def create_server(flavor_id, image_id, name, options = {})
  data = {
    'server' => {
      'flavorId'  => flavor_id,
      'imageId'   => image_id
    }
  }
  if options['metadata']
    data['server']['metadata'] = options['metadata']
  end
  if options['name']
    data['server']['name'] = options['name']
  end
  if options['personality']
    data['server']['personality'] = []
    for file in options['personality']
      data['server']['personality'] << {
        'contents'  => Base64.encode64(file['contents']),
        'path'      => file['path']
      }
    end
  end
  request(
    :body     => data.to_json,
    :expects  => 202,
    :method   => 'POST',
    :path     => 'servers.json'
  )
end

#delete_image(image_id) ⇒ Object

Delete an image

Parameters

  • image_id<~Integer> - Id of image to delete


11
12
13
14
15
16
17
# File 'lib/fog/rackspace/requests/servers/delete_image.rb', line 11

def delete_image(image_id)
  request(
    :expects  => 204,
    :method   => 'DELETE',
    :path     => "images/#{image_id}"
  )
end

#delete_server(server_id) ⇒ Object

Delete an existing server

Parameters

  • id<~Integer> - Id of server to delete


11
12
13
14
15
16
17
# File 'lib/fog/rackspace/requests/servers/delete_server.rb', line 11

def delete_server(server_id)
  request(
    :expects => 202,
    :method => 'DELETE',
    :path   => "servers/#{server_id}"
  )
end

#flavorsObject


9
10
11
# File 'lib/fog/rackspace/models/servers/flavors.rb', line 9

def flavors
  Fog::Rackspace::Servers::Flavors.new(:connection => self)
end

#get_flavor_details(flavor_id) ⇒ Object

Get details for flavor by id

Returns

  • response<~Excon::Response>:

    • body<~Hash>:

      • 'id'<~Integer> - Id of the flavor

      • 'name'<~String> - Name of the flavor

      • 'ram'<~Integer> - Amount of ram for the flavor

      • 'disk'<~Integer> - Amount of diskspace for the flavor


15
16
17
18
19
20
21
# File 'lib/fog/rackspace/requests/servers/get_flavor_details.rb', line 15

def get_flavor_details(flavor_id)
  request(
    :expects  => [200, 203],
    :method   => 'GET',
    :path     => "flavors/#{flavor_id}.json"
  )
end

#get_image_details(image_id) ⇒ Object

Get details for image by id

Returns

  • response<~Excon::Response>:

    • body<~Hash>:

      • 'id'<~Integer> - Id of the image

      • 'name'<~String> - Name of the image

      • 'serverId'<~Integer> - Id of server image was created from

      • 'status'<~Integer> - Status of image

      • 'updated'<~String> - Timestamp of last update


16
17
18
19
20
21
22
# File 'lib/fog/rackspace/requests/servers/get_image_details.rb', line 16

def get_image_details(image_id)
  request(
    :expects  => [200, 203],
    :method   => 'GET',
    :path     => "images/#{image_id}.json"
  )
end

#get_server_details(server_id) ⇒ Object

Get details about a server

Parameters

  • server_id<~Integer> - Id of server to get details for

Returns

  • response<~Excon::Response>:

    • body<~Hash>:

    • 'server'<~Hash>:

      • 'addresses'<~Hash>:

        • 'public'<~Array> - public address strings

        • 'private'<~Array> - private address strings

      • 'flavorId'<~Integer> - Id of servers current flavor

      • 'hostId'<~String>

      • 'id'<~Integer> - Id of server

      • 'imageId'<~Integer> - Id of image used to boot server

      • 'metadata'<~Hash> - metadata

      • 'name<~String> - Name of server

      • 'progress'<~Integer> - Progress through current status

      • 'status'<~String> - Current server status


26
27
28
29
30
31
32
# File 'lib/fog/rackspace/requests/servers/get_server_details.rb', line 26

def get_server_details(server_id)
  request(
    :expects  => [200, 203],
    :method   => 'GET',
    :path     => "servers/#{server_id}.json"
  )
end

#images(attributes = {}) ⇒ Object


9
10
11
12
13
# File 'lib/fog/rackspace/models/servers/images.rb', line 9

def images(attributes = {})
  Fog::Rackspace::Servers::Images.new({
    :connection => self
  }.merge!(attributes))
end

#list_addresses(server_id) ⇒ Object

List all server addresses

Parameters

  • server_id<~Integer> - Id of server to list addresses for

Returns

  • response<~Excon::Response>:

    • body<~Hash>:

    • 'addresses'<~Array>:

      • 'public'<~Array> - Public ip addresses

      • 'private'<~Array> - Private ip addresses


17
18
19
20
21
22
23
# File 'lib/fog/rackspace/requests/servers/list_addresses.rb', line 17

def list_addresses(server_id)
  request(
    :expects  => [200, 203],
    :method   => 'GET',
    :path     => "servers/#{server_id}/ips.json"
  )
end

#list_flavorsObject

List all flavors (IDs and names only)

Returns

  • response<~Excon::Response>:

    • body<~Hash>:

      • 'id'<~Integer> - Id of the flavor

      • 'name'<~String> - Name of the flavor


13
14
15
16
17
18
19
# File 'lib/fog/rackspace/requests/servers/list_flavors.rb', line 13

def list_flavors
  request(
    :expects  => [200, 203],
    :method   => 'GET',
    :path     => 'flavors.json'
  )
end

#list_flavors_detailObject

List all flavors

Returns

  • response<~Excon::Response>:

    • body<~Hash>:

      • 'id'<~Integer> - Id of the flavor

      • 'name'<~String> - Name of the flavor

      • 'ram'<~Integer> - Amount of ram for the flavor

      • 'disk'<~Integer> - Amount of diskspace for the flavor


15
16
17
18
19
20
21
# File 'lib/fog/rackspace/requests/servers/list_flavors_detail.rb', line 15

def list_flavors_detail
  request(
    :expects  => [200, 203],
    :method   => 'GET',
    :path     => 'flavors/detail.json'
  )
end

#list_imagesObject

List all images (IDs and names only)

Returns

  • response<~Excon::Response>:

    • body<~Hash>:

      • 'id'<~Integer> - Id of the image

      • 'name'<~String> - Name of the image


13
14
15
16
17
18
19
# File 'lib/fog/rackspace/requests/servers/list_images.rb', line 13

def list_images
  request(
    :expects  => [200, 203],
    :method   => 'GET',
    :path     => 'images.json'
  )
end

#list_images_detailObject

List all images

Returns

  • response<~Excon::Response>:

    • body<~Hash>:

      • 'id'<~Integer> - Id of the image

      • 'name'<~String> - Name of the image

      • 'updated'<~String> - Last update timestamp for image

      • 'created'<~String> - Creation timestamp for image

      • 'status'<~String> - Status of image


16
17
18
19
20
21
22
# File 'lib/fog/rackspace/requests/servers/list_images_detail.rb', line 16

def list_images_detail
  request(
    :expects  => [200, 203],
    :method   => 'GET',
    :path     => 'images/detail.json'
  )
end

#list_private_addresses(server_id) ⇒ Object

List private server addresses

Parameters

  • server_id<~Integer> - Id of server to list addresses for

Returns

  • response<~Excon::Response>:

    • body<~Hash>:

      • 'private'<~Array> - Public ip addresses


15
16
17
18
19
20
21
# File 'lib/fog/rackspace/requests/servers/list_private_addresses.rb', line 15

def list_private_addresses(server_id)
  request(
    :expects  => [200, 203],
    :method   => 'GET',
    :path     => "servers/#{server_id}/ips/private.json"
  )
end

#list_public_addresses(server_id) ⇒ Object

List public server addresses

Parameters

  • server_id<~Integer> - Id of server to list addresses for

Returns

  • response<~Excon::Response>:

    • body<~Hash>:

      • 'public'<~Array> - Public ip addresses


15
16
17
18
19
20
21
# File 'lib/fog/rackspace/requests/servers/list_public_addresses.rb', line 15

def list_public_addresses(server_id)
  request(
    :expects  => [200, 203],
    :method   => 'GET',
    :path     => "servers/#{server_id}/ips/public.json"
  )
end

#list_serversObject

List all servers (IDs and names only)

Returns

  • response<~Excon::Response>:

    • body<~Hash>:

    • 'servers'<~Array>:

      • 'id'<~Integer> - Id of server

      • 'name<~String> - Name of server


14
15
16
17
18
19
20
# File 'lib/fog/rackspace/requests/servers/list_servers.rb', line 14

def list_servers
  request(
    :expects  => [200, 203],
    :method   => 'GET',
    :path     => 'servers.json'
  )
end

#list_servers_detailObject

List all servers details

Returns

  • response<~Excon::Response>:

    • body<~Hash>:

    • 'servers'<~Array>:

      • 'id'<~Integer> - Id of server

      • 'name<~String> - Name of server

      • 'imageId'<~Integer> - Id of image used to boot server

      • 'flavorId'<~Integer> - Id of servers current flavor

      • 'hostId'<~String>

      • 'status'<~String> - Current server status

      • 'progress'<~Integer> - Progress through current status

      • 'addresses'<~Hash>:

        • 'public'<~Array> - public address strings

        • 'private'<~Array> - private address strings

      • 'metadata'<~Hash> - metadata


23
24
25
26
27
28
29
# File 'lib/fog/rackspace/requests/servers/list_servers_detail.rb', line 23

def list_servers_detail
  request(
    :expects  => [200, 203],
    :method   => 'GET',
    :path     => 'servers/detail.json'
  )
end

#reboot_server(server_id, type = 'SOFT') ⇒ Object

Reboot an existing server

Parameters

  • server_id<~Integer> - Id of server to reboot

  • type<~String> - Type of reboot, must be in ['HARD', 'SOFT']


12
13
14
15
16
17
18
19
# File 'lib/fog/rackspace/requests/servers/reboot_server.rb', line 12

def reboot_server(server_id, type = 'SOFT')
  request(
    :body     => { 'reboot' => { 'type' => type }}.to_json,
    :expects  => 202,
    :method   => 'POST',
    :path     => "servers/#{server_id}/action.json"
  )
end

#request(params) ⇒ Object


83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/fog/rackspace/servers.rb', line 83

def request(params)
  @connection = Fog::Connection.new("#{@scheme}://#{@host}:#{@port}")
  response = @connection.request({
    :body     => params[:body],
    :expects  => params[:expects],
    :headers  => {
      'Content-Type' => 'application/json',
      'X-Auth-Token' => @auth_token
    }.merge!(params[:headers] || {}),
    :host     => @host,
    :method   => params[:method],
    :path     => "#{@path}/#{params[:path]}"
  })
  unless response.body.empty?
    response.body = JSON.parse(response.body)
  end
  response
end

#serversObject


15
16
17
# File 'lib/fog/rackspace/models/servers/servers.rb', line 15

def servers
  Fog::Rackspace::Servers::Servers.new(:connection => self)
end

#update_server(server_id, options = {}) ⇒ Object

Update an existing server

Parameters

# server_id<~Integer> - Id of server to update

  • options<~Hash>:

    • adminPass<~String> - New admin password for server

    • name<~String> - New name for server


13
14
15
16
17
18
19
20
# File 'lib/fog/rackspace/requests/servers/update_server.rb', line 13

def update_server(server_id, options = {})
  request(
    :body     => { 'server' => options }.to_json,
    :expects  => 204,
    :method   => 'PUT',
    :path     => "servers/#{server_id}.json"
  )
end