Initial split from python-novaclient.0.0

7 files changed, 294 insertions, 0 deletions

diff --git a/docs/ref/backup_schedules.rst b/docs/ref/backup_schedules.rst
new file mode 100644
index 0000000..cbd69e3
--- /dev/null
+++ b/docs/ref/backup_schedules.rst
@@ -0,0 +1,60 @@
+Backup schedules
+================
+
+.. currentmodule:: cinderclient
+
+Rackspace allows scheduling of weekly and/or daily backups for virtual
+servers. You can access these backup schedules either off the API object as
+:attr:`OpenStack.backup_schedules`, or directly off a particular
+:class:`Server` instance as :attr:`Server.backup_schedule`.
+
+Classes
+-------
+
+.. autoclass:: BackupScheduleManager
+   :members: create, delete, update, get
+   
+.. autoclass:: BackupSchedule
+   :members: update, delete
+   
+   .. attribute:: enabled
+   
+        Is this backup enabled? (boolean)
+        
+   .. attribute:: weekly
+   
+        The day of week upon which to perform a weekly backup.
+   
+   .. attribute:: daily
+   
+        The daily time period during which to perform a daily backup.
+        
+Constants
+---------
+
+Constants for selecting weekly backup days:
+
+    .. data:: BACKUP_WEEKLY_DISABLED
+    .. data:: BACKUP_WEEKLY_SUNDAY
+    .. data:: BACKUP_WEEKLY_MONDAY  
+    .. data:: BACKUP_WEEKLY_TUESDAY 
+    .. data:: BACKUP_WEEKLY_WEDNESDA
+    .. data:: BACKUP_WEEKLY_THURSDAY
+    .. data:: BACKUP_WEEKLY_FRIDAY  
+    .. data:: BACKUP_WEEKLY_SATURDAY
+    
+Constants for selecting hourly backup windows:
+
+    .. data:: BACKUP_DAILY_DISABLED   
+    .. data:: BACKUP_DAILY_H_0000_0200
+    .. data:: BACKUP_DAILY_H_0200_0400
+    .. data:: BACKUP_DAILY_H_0400_0600
+    .. data:: BACKUP_DAILY_H_0600_0800
+    .. data:: BACKUP_DAILY_H_0800_1000
+    .. data:: BACKUP_DAILY_H_1000_1200
+    .. data:: BACKUP_DAILY_H_1200_1400
+    .. data:: BACKUP_DAILY_H_1400_1600
+    .. data:: BACKUP_DAILY_H_1600_1800
+    .. data:: BACKUP_DAILY_H_1800_2000
+    .. data:: BACKUP_DAILY_H_2000_2200
+    .. data:: BACKUP_DAILY_H_2200_0000
diff --git a/docs/ref/exceptions.rst b/docs/ref/exceptions.rst
new file mode 100644
index 0000000..23618e3
--- /dev/null
+++ b/docs/ref/exceptions.rst
@@ -0,0 +1,14 @@
+Exceptions
+==========
+
+.. currentmodule:: cinderclient
+
+Exceptions
+----------
+
+Exceptions that the API might throw:
+
+.. automodule:: cinderclient
+   :members: OpenStackException, BadRequest, Unauthorized, Forbidden, 
+             NotFound, OverLimit
+
diff --git a/docs/ref/flavors.rst b/docs/ref/flavors.rst
new file mode 100644
index 0000000..12b396a
--- /dev/null
+++ b/docs/ref/flavors.rst
@@ -0,0 +1,35 @@
+Flavors
+=======
+
+From Rackspace's API documentation:
+
+    A flavor is an available hardware configuration for a server. Each flavor
+    has a unique combination of disk space, memory capacity and priority for
+    CPU time.
+    
+Classes
+-------
+
+.. currentmodule:: cinderclient
+
+.. autoclass:: FlavorManager
+   :members: get, list, find, findall
+
+.. autoclass:: Flavor
+   :members:
+   
+   .. attribute:: id
+   
+       This flavor's ID.
+       
+   .. attribute:: name
+   
+       A human-readable name for this flavor.
+   
+   .. attribute:: ram
+   
+       The amount of RAM this flavor has, in MB.
+       
+   .. attribute:: disk
+   
+       The amount of disk space this flavor has, in MB
diff --git a/docs/ref/images.rst b/docs/ref/images.rst
new file mode 100644
index 0000000..6ba6c24
--- /dev/null
+++ b/docs/ref/images.rst
@@ -0,0 +1,54 @@
+Images
+======
+
+.. currentmodule:: cinderclient
+
+An "image" is a snapshot from which you can create new server instances.
+
+From Rackspace's own API documentation:
+
+    An image is a collection of files used to create or rebuild a server.
+    Rackspace provides a number of pre-built OS images by default. You may
+    also create custom images from cloud servers you have launched. These
+    custom images are useful for backup purposes or for producing "gold"
+    server images if you plan to deploy a particular server configuration
+    frequently.
+
+Classes
+-------
+
+.. autoclass:: ImageManager
+   :members: get, list, find, findall, create, delete
+
+.. autoclass:: Image
+   :members: delete
+      
+   .. attribute:: id
+   
+       This image's ID.
+       
+   .. attribute:: name
+   
+       This image's name.
+       
+   .. attribute:: created
+   
+       The date/time this image was created.
+       
+   .. attribute:: updated
+   
+       The date/time this instance was updated.
+       
+   .. attribute:: status
+   
+       The status of this image (usually ``"SAVING"`` or ``ACTIVE``).
+       
+   .. attribute:: progress
+   
+       During saving of an image this'll be set to something between
+       0 and 100, representing a rough percentage done.
+       
+   .. attribute:: serverId
+   
+       If this image was created from a :class:`Server` then this attribute
+       will be set to the ID of the server whence this image came.
diff --git a/docs/ref/index.rst b/docs/ref/index.rst
new file mode 100644
index 0000000..c1fe136
--- /dev/null
+++ b/docs/ref/index.rst
@@ -0,0 +1,12 @@
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 1
+   
+   backup_schedules
+   exceptions
+   flavors
+   images
+   ipgroups
+   servers
\ No newline at end of file
diff --git a/docs/ref/ipgroups.rst b/docs/ref/ipgroups.rst
new file mode 100644
index 0000000..4c29f2e
--- /dev/null
+++ b/docs/ref/ipgroups.rst
@@ -0,0 +1,46 @@
+Shared IP addresses
+===================
+
+From the Rackspace API guide:
+
+    Public IP addresses can be shared across multiple servers for use in
+    various high availability scenarios. When an IP address is shared to
+    another server, the cloud network restrictions are modified to allow each
+    server to listen to and respond on that IP address (you may optionally
+    specify that the target server network configuration be modified). Shared
+    IP addresses can be used with many standard heartbeat facilities (e.g.
+    ``keepalived``) that monitor for failure and manage IP failover.
+
+    A shared IP group is a collection of servers that can share IPs with other
+    members of the group. Any server in a group can share one or more public
+    IPs with any other server in the group. With the exception of the first
+    server in a shared IP group, servers must be launched into shared IP
+    groups. A server may only be a member of one shared IP group.
+
+.. seealso::
+
+    Use :meth:`Server.share_ip` and `Server.unshare_ip` to share and unshare
+    IPs in a group.
+
+Classes
+-------
+
+.. currentmodule:: cinderclient
+
+.. autoclass:: IPGroupManager
+   :members: get, list, find, findall, create, delete
+   
+.. autoclass:: IPGroup
+   :members: delete
+   
+   .. attribute:: id
+   
+        Shared group ID.
+   
+   .. attribute:: name
+   
+        Name of the group.
+   
+   .. attribute:: servers
+   
+        A list of server IDs in this group.
diff --git a/docs/ref/servers.rst b/docs/ref/servers.rst
new file mode 100644
index 0000000..b02fca5
--- /dev/null
+++ b/docs/ref/servers.rst
@@ -0,0 +1,73 @@
+Servers
+=======
+
+A virtual machine instance.
+
+Classes
+-------
+
+.. currentmodule:: cinderclient
+
+.. autoclass:: ServerManager
+   :members: get, list, find, findall, create, update, delete, share_ip,
+             unshare_ip, reboot, rebuild, resize, confirm_resize,
+             revert_resize
+
+.. autoclass:: Server
+   :members: update, delete, share_ip, unshare_ip, reboot, rebuild, resize,
+             confirm_resize, revert_resize
+
+   .. attribute:: id
+
+        This server's ID.
+
+   .. attribute:: name
+
+        The name you gave the server when you booted it.
+
+   .. attribute:: imageId
+
+        The :class:`Image` this server was booted with.
+
+   .. attribute:: flavorId
+
+        This server's current :class:`Flavor`.
+
+   .. attribute:: hostId
+
+        Rackspace doesn't document this value. It appears to be SHA1 hash.
+
+   .. attribute:: status
+
+        The server's status (``BOOTING``, ``ACTIVE``, etc).
+
+   .. attribute:: progress
+
+        When booting, resizing, updating, etc., this will be set to a
+        value between 0 and 100 giving a rough estimate of the progress
+        of the current operation.
+
+   .. attribute:: addresses
+
+        The public and private IP addresses of this server. This'll be a dict
+        of the form::
+
+            {
+              "public" : ["67.23.10.138"],
+              "private" : ["10.176.42.19"]
+            }
+
+        You *can* get more than one public/private IP provisioned, but not
+        directly from the API; you'll need to open a support ticket.
+
+   .. attribute:: metadata
+
+        The metadata dict you gave when creating the server.
+
+Constants
+---------
+
+Reboot types:
+
+.. data:: REBOOT_SOFT
+.. data:: REBOOT_HARD