fog 1.9.0 → 1.10.0

data/lib/fog/rackspace/models/compute_v2/attachment.rb

@@ -4,8 +4,17 @@ module Fog
   module Compute
     class RackspaceV2
       class Attachment < Fog::Model
+        
+        # @!attribute [r] server_id
+        # @return [String] The server id        
         attribute :server_id, :aliases => 'serverId'
+        
+        # @!attribute [r] volume_id
+        # @return [String] The volume id        
         attribute :volume_id, :aliases => 'volumeId'
+        
+        # @!attribute [r] device
+        # @return [String]device name of the device /dev/xvd[a-p]         
         attribute :device
 
         def initialize(new_attributes = {})
@@ -14,6 +23,10 @@ module Fog
           self
         end
         
+        # Attaches volume to volume to server. 
+        # Requires :server_id, :volume_id, and device to be populated
+        # @return [Boolean] true if volume is attaching
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Attach_Volume_to_Server.html
         def save
           requires :server_id, :volume_id, :device
           data = service.attach_volume(server_id, volume_id, device)
@@ -21,6 +34,9 @@ module Fog
           true
         end
 
+        # Detaches volume from server
+        # @return [Boolean] true if volume is detaching
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Delete_Volume_Attachment.html
         def destroy
           requires :server_id, :volume_id
           service.delete_attachment(server_id, volume_id)

data/lib/fog/rackspace/models/compute_v2/attachments.rb

@@ -10,11 +10,17 @@ module Fog
 
         attr_accessor :server
 
+        # Retrieves attachments belonging to server
+        # @return [Array<Fog::Compute::RackspaceV2::Attachment>] list of attachments        
+        # @see Server#attachments
         def all
           data = service.list_attachments(server.id).body['volumeAttachments']
           load(data)
         end
 
+        # Retrieves attachment belonging to server
+        # @param [String] volume_id
+        # @return [Fog::Compute::RackspaceV2::Attachment] attachment for volume id
         def get(volume_id)
           data = service.get_attachment(server.id, volume_id).body['volumeAttachment']
           data && new(data)

data/lib/fog/rackspace/models/compute_v2/flavor.rb

@@ -4,12 +4,30 @@ module Fog
   module Compute
     class RackspaceV2
       class Flavor < Fog::Model
+        
+        # @!attribute [r] id
+        # @return [String] The flavor id
         identity :id
 
+        
+        # @!attribute [r] name
+        # @return [String] flavor name
         attribute :name
+        
+        # @!attribute [r] rame
+        # @return [Fixnum] ram in MB        
         attribute :ram
+        
+        # @!attribute [r] disk
+        # @return [String] disk space in GB        
         attribute :disk
+        
+        # @!attribute [r] vcpus
+        # @return [Fixnum] number of virtual CPUs        
         attribute :vcpus
+        
+        # @!attribute [r] links
+        # @return [Array] flavor links.
         attribute :links
       end
     end

data/lib/fog/rackspace/models/compute_v2/flavors.rb

@@ -8,12 +8,20 @@ module Fog
 
         model Fog::Compute::RackspaceV2::Flavor
 
+        # Retrieves information for all available flavors
+        # @return [Array<Fog::Compute::RackspaceV2::Flavor>] list of flavors
+        # @note Fog's currentl implementation only returns 1000 flavors.
+        # @note Fog does not retrieve all flavor details. Please use #get to retrieve all details for a specific flavor.
         def all
           data = service.list_flavors.body['flavors']
           load(data)
         end
 
-        def get(flavor_id)
+        # Retrieve image
+        # @param [String] flavor_id id of flavor
+        # @return [Fog::Compute::RackspaceV2::Flavor] flavor
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Get_Flavor_Details-d1e4317.html
+        def get(flavor_id)          
           data = service.get_flavor(flavor_id).body['flavor']
           new(data)
         rescue Fog::Compute::RackspaceV2::NotFound

data/lib/fog/rackspace/models/compute_v2/image.rb

@@ -10,42 +10,86 @@ module Fog
         ERROR = 'ERROR'
         DELETED = 'DELETED'
 
+        # @!attribute [r] id
+        # @return [String] The server id
         identity :id
 
+        # @!attribute [r] name
+        # @return [String] The image name.
         attribute :name
+        
+        # @!attribute [r] created        
+        # @return [String] The time stamp for the creation date.        
         attribute :created
+        
+        # @!attribute [r] updated
+        # @return [String] The time stamp for the last update.        
         attribute :updated
+        
+        # @!attribute [r] state
+        # @return [String] image status. 
         attribute :state, :aliases => 'status'
+
+        # @!attribute [r] user_id
+        # @return [String] The user Id.        
         attribute :user_id
+        
+        # @!attribute [r] tenant_id
+        # @return [String] The tenant Id.        
         attribute :tenant_id
+        
+        # @!attribute [r] progress
+        # @return [Fixnum] The build completion progress, as a percentage. Value is from 0 to 100.        
         attribute :progress
+        
         attribute :minDisk
         attribute :minRam
+        
+        # @!attribute [rw] disk_config
+        # @return [String<AUTO, MANUAL>] The disk configuration value.
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/ch_extensions.html#diskconfig_attribute
+        #        
+        # 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.        
         attribute :disk_config, :aliases => 'OS-DCF:diskConfig'
+
+        # @!attribute [r] links
+        # @return [Array] image links.
         attribute :links
-        
-        ignore_attributes :metadata        
-                
+                        
         def initialize(attributes={})
-          @connection = attributes[:connection]
+          @service = attributes[:service]
           super
         end
         
+        # Image metadata
+        # @return [Fog::Compute::RackspaceV2::Metadata] Collection of Fog::Compute::RackspaceV2::Metadatum objects containing metadata key value pairs.        
         def metadata
-          raise "Please save image before accessing metadata" unless identity          
           @metadata ||= begin
             Fog::Compute::RackspaceV2::Metadata.new({
-              :connection => connection,
+              :service => service,
               :parent => self
             })
           end
         end
         
+        # Set server metadata
+        # @param [Hash] hash contains key value pairs
         def metadata=(hash={})
-          raise "Please save image before accessing metadata" unless identity
           metadata.from_hash(hash)
         end
 
+        # Is image is in ready state
+        # @param [String] ready_state By default state is ACTIVE
+        # @param [Array,String] error_states By default state is ERROR
+        # @return [Boolean] returns true if server is in a ready state
+        # @raise [RuntimeException] if server state is an error state
         def ready?(ready_state = ACTIVE, error_states=[ERROR])
           if error_states
             error_states = Array(error_states)
@@ -55,6 +99,7 @@ module Fog
         end
         
 
+        # Destroy image
         def destroy
           requires :identity
           service.delete_image(identity)

data/lib/fog/rackspace/models/compute_v2/images.rb

@@ -8,11 +8,20 @@ module Fog
 
         model Fog::Compute::RackspaceV2::Image
 
+        # Returns list of images 
+        # @return [Array<Fog::Compute::RackspaceV2::Image>] Retrieves a list images.
+        # @note Fog's current implementation only returns 1000 images.
+        # @note Fog does not retrieve all image details. Please use get to retrieve all details for a specific image.
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Images-d1e4435.html
         def all
           data = service.list_images.body['images']
           load(data)
         end
 
+        # Retrieve image
+        # @param [String] image_id id of image
+        # @return [Fog::Compute::RackspaceV2:Image] image
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Get_Image_Details-d1e4848.html 
         def get(image_id)
           data = service.get_image(image_id).body['image']
           new(data)

data/lib/fog/rackspace/models/compute_v2/meta_parent.rb

@@ -3,14 +3,21 @@ module Fog
     class RackspaceV2
       module MetaParent
 
+        # Parent of metadata 
+        # @return [#parent] parent of metadata
         def parent
           @parent
         end
 
+        # Sets parent of metadata
+        # @param [#parent] new_parent of metadata
         def parent=(new_parent)
           @parent = new_parent
         end
 
+        # Collection type for parent
+        # @return [String] collection type
+        # @raise [RuntimeException] raises excpetion if collection type for parent is unknown
         def collection_name
           if parent.class == Fog::Compute::RackspaceV2::Image
             return "images"
@@ -21,6 +28,8 @@ module Fog
           end
         end
 
+        # Converts metadata to hash
+        # @return [Hash] hash containing key value pairs for metadata
         def metas_to_hash(metas)
           hash = {}
           metas.each { |meta| hash[meta.key] = meta.value }

data/lib/fog/rackspace/models/compute_v2/metadata.rb

@@ -14,50 +14,71 @@ module Fog
 
         include Fog::Compute::RackspaceV2::MetaParent
 
+        # Retrieves all of the metadata from server
+        # @return [Array<Fog::Compute::RackspaceV2::Metadatum>] list of metadatum
         def all
           requires :parent
-          data = connection.list_metadata(collection_name, parent.id).body['metadata']
+          return unless parent.identity
+          data = service.list_metadata(collection_name, parent.id).body['metadata']
           from_hash(data)
         end
 
+        # Retrieves specific metadata from server
+        # @param [String] key for metadatum
+        # @return [Fog::Compute::RackspaceV2::Metadatum] metadatum
         def get(key)
           requires :parent
-          data = connection.get_metadata_item(collection_name, parent.id, key).body["meta"]          
+          data = service.get_metadata_item(collection_name, parent.id, key).body["meta"]          
           datum = data.first
           new(:key => datum[0], :value => datum[1])
         rescue Fog::Compute::RackspaceV2::NotFound
-          nil
+          nil 
         end
         
+        # Retrieve specific value for key from Metadata.
+        #   * If key is of type String, this method will return the value of the metadatum
+        #   * If key is of type Fixnum, this method will return a Fog::Compute::RackspaceV2::Metadatum object (legacy)
+        # @param [#key] key 
+        # @return [#value] 
         def [](key)
           return super(key) if key.is_a?(Integer)
           return nil unless key
           datum = self.find {|datum| datum.key == key || datum.key == key.to_sym }
           datum ? datum.value : nil
         end
-        
+
+        # Set value for key.
+        #   * If key is of type String, this method will set/add the value to Metadata
+        #   * If key is of type Fixnum, this method will set a Fog::Compute::RackspaceV2::Metadatum object (legacy)
+        # @param [#key] key 
+        # @return [String] 
         def []=(key, value)
           return super(key,value) if key.is_a?(Integer)          
           return nil unless key
           datum = self.find {|datum| datum.key == key || datum.key == key.to_sym }
           if datum
-            data.value = value
+            datum.value = value
           else
-            self << Fog::Compute::RackspaceV2::Metadatum.new(:key => key, :value => value, :connection => connection, :parent => parent)
+            self << Fog::Compute::RackspaceV2::Metadatum.new(:key => key, :value => value, :service => service, :parent => parent)
           end
           value
         end
         
+        # Saves the current metadata on server
         def save
           requires :parent
-          connection.set_metadata(collection_name, parent.id, to_hash)          
+          service.set_metadata(collection_name, parent.id, to_hash)          
         end
 
+        # Creates new metadata
         def new(attributes = {})
           requires :parent
           super({ :parent => parent }.merge!(attributes))
         end
 
+        # Resets metadata using data from hash
+        # @param hash hash containing key value pairs used to populate metadata.
+        # @note This will remove existing data
         def from_hash(hash)
           return unless hash
           metas = []
@@ -65,6 +86,8 @@ module Fog
           load(metas)
         end
         
+        # Converts metadata object to hash
+        # @return [Hash] hash of metadata key value pairs
         def to_hash
           h = {}
           self.each { |datum| h[datum.key] = datum.value }

data/lib/fog/rackspace/models/compute_v2/metadatum.rb

@@ -11,12 +11,16 @@ module Fog
         identity :key
         attribute :value
 
+        # Remove metadatum from server
+        # @return [Boolean] return true if metadatum is deleting
         def destroy
           requires :identity
           connection.delete_metadata_item(collection_name, parent.id, key)
           true
         end
 
+        # Save metadatum on server
+        # @return [Boolean] return true if metadatum is saving
         def save
           requires :identity, :value
           connection.set_metadata_item(collection_name, parent.id, key, value)

data/lib/fog/rackspace/models/compute_v2/network.rb

@@ -0,0 +1,27 @@
+module Fog
+  module Compute
+    class RackspaceV2
+      class Network < Fog::Model
+        identity :id
+
+        attribute :label
+        attribute :cidr
+
+        def save
+          requires :label, :cidr
+
+          data = service.create_network(label, cidr)
+          merge_attributes(data.body['network'])
+          true
+        end
+
+        def destroy
+          requires :identity
+
+          service.delete_network(identity)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/models/compute_v2/networks.rb

@@ -0,0 +1,23 @@
+require 'fog/rackspace/models/compute_v2/network'
+
+module Fog
+  module Compute
+    class RackspaceV2
+      class Networks < Fog::Collection
+        model Fog::Compute::RackspaceV2::Network
+
+        def all
+          data = service.list_networks.body['networks']
+          load(data)
+        end
+
+        def get(id)
+          data = service.get_network(id).body['network']
+          new(data)
+        rescue Fog::Compute::RackspaceV2::NotFound
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/models/compute_v2/server.rb

@@ -22,42 +22,134 @@ module Fog
         UNKNOWN = 'UNKNOWN'
         VERIFY_RESIZE = 'VERIFY_RESIZE'
 
+        # @!attribute [r] id
+        # @return [String] The server id
         identity :id
 
+        # @!attribute [rw] name
+        # @return [String] The server name.
         attribute :name
+        
+        # @!attribute [r] created        
+        # @return [String] The time stamp for the creation date.
         attribute :created
+        
+        # @!attribute [r] updated
+        # @return [String] The time stamp for the last update.
         attribute :updated
+        
+        # @!attribute [r] host Id
+        #   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.        
+        # @return [String] host id. 
         attribute :host_id, :aliases => 'hostId'
+
+        # @!attribute [r] state
+        # @return [String] server status. 
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Servers-d1e2078.html#server_status
         attribute :state, :aliases => 'status'
+                
+        # @!attribute [r] progress
+        # @return [Fixnum] The build completion progress, as a percentage. Value is from 0 to 100.
         attribute :progress
+
+        # @!attribute [r] user_id
+        # @return [String] The user Id.
         attribute :user_id
+        
+        # @!attribute [r] tenant_id
+        # @return [String] The tenant Id.
         attribute :tenant_id
+        
+        # @!attribute [r] links
+        # @return [Array] Server links.
         attribute :links
+        
+        # @!attribute [rw] personality
+        # @note This attribute is only used for server creation. This field will be nil on subsequent retrievals.
+        # @return [Hash] Hash containing data to inject into the file system of the cloud server instance during server creation.
+        # @example To inject fog.txt into file system
+        #   :personality => [{ :path => '/root/fog.txt',
+        #                      :contents => Base64.encode64('Fog was here!')
+        #                   }]
+        # @see #create
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Server_Personality-d1e2543.html
         attribute :personality
+        
+        # @!attribute [rw] ipv4_address
+        # @return [String] The public IP version 4 access address.
+        # @note This field will populate once the server is ready to use. 
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Server_Primary_Addresses-d1e2558.html
         attribute :ipv4_address, :aliases => 'accessIPv4'
+        
+        # @!attribute [rw] ipv6_address
+        # @return [String] The public IP version 6 access address.
+        # @note This field will populate once the server is ready to use.
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Server_Primary_Addresses-d1e2558.html       
         attribute :ipv6_address, :aliases => 'accessIPv6'
+        
+        # @!attribute [rw] disk_config
+        # @return [String<AUTO, MANUAL>] The disk configuration value.
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/ch_extensions.html#diskconfig_attribute
+        #        
+        # 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.
         attribute :disk_config, :aliases => 'OS-DCF:diskConfig'
+        
+        # @!attribute [r] bandwidth
+        # @return [Array] The amount of bandwidth used for the specified audit period.
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/ch_extensions.html#bandwidth_extension
         attribute :bandwidth, :aliases => 'rax-bandwidth:bandwidth'
+        
+        # @!attribute [r] address
+        # @return [Hash<String, Array[Hash]>] IP addresses allocated for server by network
+        # @example  
+        #  { 
+        #     "public" => [
+        #          {"version"=>4, "addr"=>"166.78.105.63"}, 
+        #          {"version"=>6, "addr"=>"2001:4801:7817:0072:0fe1:75e8:ff10:61a9"}
+        #                 ], 
+        #    "private"=> [{"version"=>4, "addr"=>"10.177.18.209"}]
+        #  }
         attribute :addresses
-        attribute :flavor_id, :aliases => 'flavor', :squash => 'id'
-        attribute :image_id, :aliases => 'image', :squash => 'id'
         
-        ignore_attributes :metadata
+        # @!attribute [r] flavor_id
+        # @return [String] The flavor Id. 
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Flavors-d1e4188.html
+        attribute :flavor_id, :aliases => 'flavor', :squash => 'id'
         
+        # @!attribute [r] image_id
+        # @return [String] The image Id.
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Images-d1e4435.html
+        attribute :image_id, :aliases => 'image', :squash => 'id'
+        # @!attribute [r] password
+        # @return [String] Password for system adminstrator account. 
+        # @note This value is ONLY populated on server creation.
         attr_reader :password 
-        
+
+
         def initialize(attributes={})
           @service = attributes[:service]
           super
         end
-        
+
         alias :access_ipv4_address :ipv4_address
         alias :access_ipv4_address= :ipv4_address=
         alias :access_ipv6_address :ipv6_address
         alias :access_ipv6_address= :ipv6_address=
-        
+
+        # Server metadata
+        # @return [Fog::Compute::RackspaceV2::Metadata] metadata key value pairs.
         def metadata
-          raise "Please save server before accessing metadata" unless identity
           @metadata ||= begin
             Fog::Compute::RackspaceV2::Metadata.new({
               :service => service,
@@ -65,34 +157,60 @@ module Fog
             })
           end
         end
-        
+
+        # Set server metadata
+        # @param [Hash] hash contains key value pairs
         def metadata=(hash={})
-          raise "Please save server before accessing metadata" unless identity
           metadata.from_hash(hash)
         end
 
-        def save
+        # Saves the server.
+        # Creates server if it is new, otherwise it will update server attributes name, accessIPv4, and accessIPv6.
+        # @return [Boolean] true if server has started saving
+        def save(options = {})
           if persisted?
             update
           else
-            create
+            create(options)
           end
           true
         end
 
-        def create
+        # Creates server
+        # * requires attributes: service:, :name, :image_id, and :flavor_id
+        # * optional attributes :disk_config, :metadata, :personality
+        # @return [Boolean] returns true if server is being created
+        # @note You should use servers.create to create servers instead calling this method directly
+        # @see Servers#create
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/CreateServers.html        
+        #
+        # * State Transitions
+        #   * BUILD -> ACTIVE
+        #   * BUILD -> ERROR (on error)
+        def create(options)
           requires :name, :image_id, :flavor_id
 
-          options = {}
           options[:disk_config] = disk_config unless disk_config.nil?
-          options[:metadata] = metadata unless @metadata.nil?
+          options[:metadata] = metadata.to_hash unless @metadata.nil?
           options[:personality] = personality unless personality.nil?
 
+          if options[:networks]
+            options[:networks].map! { |id| { :uuid => id } }
+          end
+
           data = service.create_server(name, image_id, flavor_id, 1, 1, options)
           merge_attributes(data.body['server'])
           true
         end
 
+        # Updates server
+        # This will update :name, :accessIPv4, and :accessIPv6 attributes.
+        # @note If you edit the server name, the server host name does not change. Also, server names are not guaranteed to be unique.
+        # @return true if update has started updating
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/ServerUpdate.html
+        #
+        # * State Transition
+        #   * ACTIVE -> ACTIVE
         def update
           requires :identity
           options = {
@@ -100,32 +218,53 @@ module Fog
             'accessIPv4' => ipv4_address,
             'accessIPv6' => ipv6_address
           }
-          
+
           data = service.update_server(identity, options)
           merge_attributes(data.body['server'])
           true
         end
 
+        # Destroy the server
+        # @return [Boolean] returns true if server has started deleting
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Delete_Server-d1e2883.html
+        #
+        #   * Status Transition:	
+        #     * ACTIVE -> DELETED
+        #     * ERROR -> DELETED
         def destroy
           requires :identity
           service.delete_server(identity)
           true
         end
 
+        # Server flavor
+        # @return [Fog::Compute::RackspaceV2::Flavor] server flavor
         def flavor
           requires :flavor_id
           @flavor ||= service.flavors.get(flavor_id)
         end
 
+        # Server image
+        # @return [Fog::Compute::RackspaceV2::Image] server image
         def image
           requires :image_id
           @image ||= service.images.get(image_id)
         end
 
+        # Creates Image from server. Once complete, a new image is available that you can use to rebuild or create servers. 
+        # @param name [String] name of image to create
+        # @param options [Hash]:
+        # @option options [Hash<String, String>] metadata hash of containing metadata key value pairs.
+        # @return [Fog::ComputeRackspaceV2::Image] image being created
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Create_Image-d1e4655.html
+        #
+        #   * State Transition:
+        #     * SAVING -> ACTIVE
+        #     * SAVING  -> ERROR (on error)
         def create_image(name, options = {})
           requires :identity
           response = service.create_image(identity, name, options)
-          begin 
+          begin
             image_id = response.headers["Location"].match(/\/([^\/]+$)/)[1]
             Fog::Compute::RackspaceV2::Image.new(:collection => service.images, :service => service, :id => image_id)
           rescue
@@ -133,6 +272,9 @@ module Fog
           end
         end
 
+        # Attached Cloud Block Volumes
+        # @return [Fog::Compute::RackspaceV2::Attachments] attached Cloud Block Volumes 
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Volume_Attachments.html
         def attachments
           @attachments ||= begin
             Fog::Compute::RackspaceV2::Attachments.new({
@@ -141,21 +283,35 @@ module Fog
             })
           end
         end
-        
+
+        # Attaches Cloud Block Volume
+        # @param [Fog::Rackspace::BlockStorage::Volume, String] volume object or the volume id of volume to mount
+        # @param [String] device name of the device /dev/xvd[a-p]  (optional)
+        # @return [Fog::Compute::RackspaceV2::Attachment] resulting attachment object
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Attach_Volume_to_Server.html
         def attach_volume(volume, device=nil)
           requires :identity
           volume_id = volume.is_a?(String) ? volume : volume.id
           attachments.create(:server_id => identity, :volume_id => volume_id, :device => device)
-        end        
+        end
 
+        # Server's private IPv4 address
+        # @return [String] private IPv4 address
         def private_ip_address
           addresses['private'].select{|a| a["version"] == 4}[0]["addr"]
         end
 
+        # Server's public IPv4 address
+        # @return [String] public IPv4 address
         def public_ip_address
           ipv4_address
         end
 
+        # Is server is in ready state
+        # @param [String] ready_state By default state is ACTIVE
+        # @param [Array,String] error_states By default state is ERROR
+        # @return [Boolean] returns true if server is in a ready state
+        # @raise [RuntimeException] if server state is an error state
         def ready?(ready_state = ACTIVE, error_states=[ERROR])
           if error_states
             error_states = Array(error_states)
@@ -164,6 +320,13 @@ module Fog
           state == ready_state
         end
 
+        # Reboot server
+        # @param [String<SOFT, HARD>] type 'SOFT' will do a soft reboot. 'HARD' will do a hard reboot.
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Reboot_Server-d1e3371.html
+        #
+        # * State transition:
+        #   * ACTIVE -> REBOOT  -> ACTIVE (soft reboot)
+        #   * ACTIVE -> HARD_REBOOT -> ACTIVE (hard reboot)
         def reboot(type = 'SOFT')
           requires :identity
           service.reboot_server(identity, type)
@@ -171,13 +334,15 @@ module Fog
           true
         end
 
-        def resize(flavor_id)
-          requires :identity
-          service.resize_server(identity, flavor_id)
-          self.state = RESIZE
-          true
-        end
 
+        # Rebuild removes all data on the server and replaces it with the specified image. The id and all IP addresses remain the same.
+        # @param [String] image_id image to use for rebuild
+        # @return [Boolean] returns true if rebuild is in process
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Rebuild_Server-d1e3538.html
+        #
+        # * Status Transition:
+        #   * ACTIVE -> REBUILD -> ACTIVE
+        #   * ACTIVE -> REBUILD -> ERROR (on error)
         def rebuild(image_id, options={})
           requires :identity
           service.rebuild_server(identity, image_id, options)
@@ -185,18 +350,61 @@ module Fog
           true
         end
 
+        # 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.     
+        # @param [String] flavor to resize 
+        # @return [Boolean] returns true if resize is in process
+        # @note All resizes are automatically confirmed after 24 hours if you do not explicitly confirm or revert the resize.
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Resize_Server-d1e3707.html
+        # @see #confirm_resize
+        # @see #revert_resize        
+        #
+        # * Status Transition:
+        #   * ACTIVE -> QUEUE_RESIZE -> PREP_RESIZE -> VERIFY_RESIZE
+        #   * ACTIVE -> QUEUE_RESIZE -> ACTIVE (on error)
+        def resize(flavor_id)
+          requires :identity
+          service.resize_server(identity, flavor_id)
+          self.state = RESIZE
+          true
+        end
+
+        # Confirms server resize operation
+        # @note All resizes are automatically confirmed after 24 hours if you do not explicitly confirm or revert the resize.        
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Confirm_Resized_Server-d1e3868.html
+        # @see #resize
+        #
+        # * Status Transition:
+        #   * VERIFY_RESIZE -> ACTIVE
+        #   * VERIFY_RESIZE -> ERROR (on error)        
         def confirm_resize
           requires :identity
           service.confirm_resize_server(identity)
           true
         end
 
+        # Reverts server resize operation
+        # @note All resizes are automatically confirmed after 24 hours if you do not explicitly confirm or revert the resize.        
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Revert_Resized_Server-d1e4024.html
+        # @see #resize                
+        #
+        # * Status Transition:
+        #   * VERIFY_RESIZE -> ACTIVE
+        #   * VERIFY_RESIZE -> ERROR (on error)
         def revert_resize
           requires :identity
           service.revert_resize_server(identity)
           true
         end
 
+        # Change admin password
+        # @param [String] password The administrator password.
+        # @return [Boolean] returns true if operation was scheduled
+        # @note 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.
+        # @see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/Change_Password-d1e3234.html
+        #
+        # * Status Transition:	
+        #   * ACTIVE -> PASSWORD -> ACTIVE
+        #   * ACTIVE -> PASSWORD -> ERROR (on error)        
         def change_admin_password(password)
           requires :identity
           service.change_server_password(identity, password)
@@ -205,6 +413,9 @@ module Fog
           true
         end
 
+        # Setup server for SSH access
+        # This requires public_key_path and private_key_path to be passed into Compute service via Fog::Compute constructor or .fog file
+        # @see Servers#bootstrap
         def setup(credentials = {})
           requires :public_ip_address, :identity, :public_key, :username
           Fog::SSH.new(public_ip_address, username, credentials).run([