You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltacloud.apache.org by cc...@apache.org on 2010/08/13 16:30:26 UTC
svn commit: r985209 [9/11] - in /incubator/deltacloud/trunk/site: ./
Scripts/ css/ css/blueprint/ css/blueprint/plugins/
css/blueprint/plugins/buttons/ css/blueprint/plugins/buttons/icons/
css/blueprint/plugins/fancy-type/ css/blueprint/plugins/link-ic...
Added: incubator/deltacloud/trunk/site/doc/method_list.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/site/doc/method_list.html?rev=985209&view=auto
==============================================================================
--- incubator/deltacloud/trunk/site/doc/method_list.html (added)
+++ incubator/deltacloud/trunk/site/doc/method_list.html Fri Aug 13 14:30:21 2010
@@ -0,0 +1,1243 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+ <head>
+ <meta name="Content-Type" content="text/html; charset=utf-8" />
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+ <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+ <base id="base_target" target="_parent" />
+ </head>
+ <body>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) {
+ document.getElementById('base_target').target = 'main';
+ document.body.className = 'frames';
+ }
+ </script>
+ <div id="content">
+ <h1 id="full_list_header">Method List</h1>
+ <div id="nav">
+ <a target="_self" href="class_list.html">Classes</a> |
+ <a target="_self" href="method_list.html">Methods</a> |
+ <a target="_self" href="file_list.html">Files</a>
+ </div>
+ <div id="search">Search: <input type="text" /></div>
+
+ <ul id="full_list" class="methods">
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/InstanceState/Transition.html#action-instance_method" title="DeltaCloud::InstanceState::Transition#action (method)">#action</a>
+
+ <small>DeltaCloud::InstanceState::Transition</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#actions-instance_method" title="DeltaCloud::API::Instance#actions (method)">#actions</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Instance.html#actions_urls-instance_method" title="DeltaCloud::API::Instance#actions_urls (method)">#actions_urls</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#api_host-instance_method" title="DeltaCloud::API#api_host (method)">#api_host</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#api_path-instance_method" title="DeltaCloud::API#api_path (method)">#api_path</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#api_port-instance_method" title="DeltaCloud::API#api_port (method)">#api_port</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#api_uri-instance_method" title="DeltaCloud::API#api_uri (method)">#api_uri</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#api_version-instance_method" title="DeltaCloud::API#api_version (method)">#api_version</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Image.html#architecture-instance_method" title="DeltaCloud::API::Image#architecture (method)">#architecture</a>
+
+ <small>DeltaCloud::API::Image</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/HardwareProfile.html#architecture-instance_method" title="DeltaCloud::API::HardwareProfile#architecture (method)">#architecture</a>
+
+ <small>DeltaCloud::API::HardwareProfile</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/HardwareProfile.html#architecture%3D-instance_method" title="DeltaCloud::API::HardwareProfile#architecture= (method)">#architecture=</a>
+
+ <small>DeltaCloud::API::HardwareProfile</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Image.html#architecture%3D-instance_method" title="DeltaCloud::API::Image#architecture= (method)">#architecture=</a>
+
+ <small>DeltaCloud::API::Image</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/InstanceState/Transition.html#auto%3F-instance_method" title="DeltaCloud::InstanceState::Transition#auto? (method)">#auto?</a>
+
+ <small>DeltaCloud::InstanceState::Transition</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#base_object-instance_method" title="DeltaCloud::API#base_object (method)">#base_object</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#base_object_collection-instance_method" title="DeltaCloud::API#base_object_collection (method)">#base_object_collection</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="String.html#camelize-instance_method" title="String#camelize (method)">#camelize</a>
+
+ <small>String</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/StorageVolume.html#capacity-instance_method" title="DeltaCloud::API::StorageVolume#capacity (method)">#capacity</a>
+
+ <small>DeltaCloud::API::StorageVolume</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/StorageVolume.html#capacity%3D-instance_method" title="DeltaCloud::API::StorageVolume#capacity= (method)">#capacity=</a>
+
+ <small>DeltaCloud::API::StorageVolume</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud.html#classes-class_method" title="DeltaCloud.classes (method)">classes</a>
+
+ <small>DeltaCloud</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="String.html#classify-instance_method" title="String#classify (method)">#classify</a>
+
+ <small>String</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Realm.html#client-instance_method" title="DeltaCloud::API::Realm#client (method)">#client</a>
+
+ <small>DeltaCloud::API::Realm</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/HardwareProfile.html#client-instance_method" title="DeltaCloud::API::HardwareProfile#client (method)">#client</a>
+
+ <small>DeltaCloud::API::HardwareProfile</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/StorageVolume.html#client-instance_method" title="DeltaCloud::API::StorageVolume#client (method)">#client</a>
+
+ <small>DeltaCloud::API::StorageVolume</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#client-instance_method" title="DeltaCloud::API::Instance#client (method)">#client</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Image.html#client-instance_method" title="DeltaCloud::API::Image#client (method)">#client</a>
+
+ <small>DeltaCloud::API::Image</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/StorageSnapshot.html#client-instance_method" title="DeltaCloud::API::StorageSnapshot#client (method)">#client</a>
+
+ <small>DeltaCloud::API::StorageSnapshot</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#connect-instance_method" title="DeltaCloud::API#connect (method)">#connect</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="String.html#convert-instance_method" title="String#convert (method)">#convert</a>
+
+ <small>String</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/HardwareProfile.html#cpu-instance_method" title="DeltaCloud::API::HardwareProfile#cpu (method)">#cpu</a>
+
+ <small>DeltaCloud::API::HardwareProfile</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/HardwareProfile.html#cpu%3D-instance_method" title="DeltaCloud::API::HardwareProfile#cpu= (method)">#cpu=</a>
+
+ <small>DeltaCloud::API::HardwareProfile</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#create_instance-instance_method" title="DeltaCloud::API#create_instance (method)">#create_instance</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/StorageVolume.html#created-instance_method" title="DeltaCloud::API::StorageVolume#created (method)">#created</a>
+
+ <small>DeltaCloud::API::StorageVolume</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/StorageSnapshot.html#created-instance_method" title="DeltaCloud::API::StorageSnapshot#created (method)">#created</a>
+
+ <small>DeltaCloud::API::StorageSnapshot</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/StorageSnapshot.html#created%3D-instance_method" title="DeltaCloud::API::StorageSnapshot#created= (method)">#created=</a>
+
+ <small>DeltaCloud::API::StorageSnapshot</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/StorageVolume.html#created%3D-instance_method" title="DeltaCloud::API::StorageVolume#created= (method)">#created=</a>
+
+ <small>DeltaCloud::API::StorageVolume</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#declare_entry_points_methods-instance_method" title="DeltaCloud::API#declare_entry_points_methods (method)">#declare_entry_points_methods</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud.html#define_class-class_method" title="DeltaCloud.define_class (method)">define_class</a>
+
+ <small>DeltaCloud</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Image.html#description-instance_method" title="DeltaCloud::API::Image#description (method)">#description</a>
+
+ <small>DeltaCloud::API::Image</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/Documentation.html#description-instance_method" title="DeltaCloud::Documentation#description (method)">#description</a>
+
+ <small>DeltaCloud::Documentation</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/Documentation/OperationParameter.html#description-instance_method" title="DeltaCloud::Documentation::OperationParameter#description (method)">#description</a>
+
+ <small>DeltaCloud::Documentation::OperationParameter</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Image.html#description%3D-instance_method" title="DeltaCloud::API::Image#description= (method)">#description=</a>
+
+ <small>DeltaCloud::API::Image</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#destroy%21-instance_method" title="DeltaCloud::API::Instance#destroy! (method)">#destroy!</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/StorageVolume.html#device-instance_method" title="DeltaCloud::API::StorageVolume#device (method)">#device</a>
+
+ <small>DeltaCloud::API::StorageVolume</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/StorageVolume.html#device%3D-instance_method" title="DeltaCloud::API::StorageVolume#device= (method)">#device=</a>
+
+ <small>DeltaCloud::API::StorageVolume</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#discover_entry_points-instance_method" title="DeltaCloud::API#discover_entry_points (method)">#discover_entry_points</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#discovered%3F-instance_method" title="DeltaCloud::API#discovered? (method)">#discovered?</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#documentation-instance_method" title="DeltaCloud::API#documentation (method)">#documentation</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud.html#driver_name-class_method" title="DeltaCloud.driver_name (method)">driver_name</a>
+
+ <small>DeltaCloud</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#driver_name-instance_method" title="DeltaCloud::API#driver_name (method)">#driver_name</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#entry_points-instance_method" title="DeltaCloud::API#entry_points (method)">#entry_points</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#feature%3F-instance_method" title="DeltaCloud::API#feature? (method)">#feature?</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#features-instance_method" title="DeltaCloud::API#features (method)">#features</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/PlainFormatter.html#format-instance_method" title="DeltaCloud::PlainFormatter#format (method)">#format</a>
+
+ <small>DeltaCloud::PlainFormatter</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/PlainFormatter/FormatObject/Instance.html#format-instance_method" title="DeltaCloud::PlainFormatter::FormatObject::Instance#format (method)">#format</a>
+
+ <small>DeltaCloud::PlainFormatter::FormatObject::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/PlainFormatter/FormatObject/HardwareProfile.html#format-instance_method" title="DeltaCloud::PlainFormatter::FormatObject::HardwareProfile#format (method)">#format</a>
+
+ <small>DeltaCloud::PlainFormatter::FormatObject::HardwareProfile</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/PlainFormatter/FormatObject/StorageVolume.html#format-instance_method" title="DeltaCloud::PlainFormatter::FormatObject::StorageVolume#format (method)">#format</a>
+
+ <small>DeltaCloud::PlainFormatter::FormatObject::StorageVolume</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/PlainFormatter/FormatObject/Realm.html#format-instance_method" title="DeltaCloud::PlainFormatter::FormatObject::Realm#format (method)">#format</a>
+
+ <small>DeltaCloud::PlainFormatter::FormatObject::Realm</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/PlainFormatter/FormatObject/Image.html#format-instance_method" title="DeltaCloud::PlainFormatter::FormatObject::Image#format (method)">#format</a>
+
+ <small>DeltaCloud::PlainFormatter::FormatObject::Image</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/PlainFormatter/FormatObject/StorageSnapshot.html#format-instance_method" title="DeltaCloud::PlainFormatter::FormatObject::StorageSnapshot#format (method)">#format</a>
+
+ <small>DeltaCloud::PlainFormatter::FormatObject::StorageSnapshot</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#hardware_profile-instance_method" title="DeltaCloud::API::Instance#hardware_profile (method)">#hardware_profile</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#hardware_profile-instance_method" title="DeltaCloud::API#hardware_profile (method)">#hardware_profile</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#hardware_profiles-instance_method" title="DeltaCloud::API#hardware_profiles (method)">#hardware_profiles</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/HardwareProfile.html#id-instance_method" title="DeltaCloud::API::HardwareProfile#id (method)">#id</a>
+
+ <small>DeltaCloud::API::HardwareProfile</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/StorageVolume.html#id-instance_method" title="DeltaCloud::API::StorageVolume#id (method)">#id</a>
+
+ <small>DeltaCloud::API::StorageVolume</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Image.html#id-instance_method" title="DeltaCloud::API::Image#id (method)">#id</a>
+
+ <small>DeltaCloud::API::Image</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#id-instance_method" title="DeltaCloud::API::Instance#id (method)">#id</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Realm.html#id-instance_method" title="DeltaCloud::API::Realm#id (method)">#id</a>
+
+ <small>DeltaCloud::API::Realm</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/StorageSnapshot.html#id-instance_method" title="DeltaCloud::API::StorageSnapshot#id (method)">#id</a>
+
+ <small>DeltaCloud::API::StorageSnapshot</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#image-instance_method" title="DeltaCloud::API#image (method)">#image</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#image-instance_method" title="DeltaCloud::API::Instance#image (method)">#image</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#images-instance_method" title="DeltaCloud::API#images (method)">#images</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/HWP/FloatProperty.html#initialize-instance_method" title="DeltaCloud::HWP::FloatProperty#initialize (method)">#initialize</a>
+
+ <small>DeltaCloud::HWP::FloatProperty</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/InstanceState/Transition.html#initialize-instance_method" title="DeltaCloud::InstanceState::Transition#initialize (method)">#initialize</a>
+
+ <small>DeltaCloud::InstanceState::Transition</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/Documentation/OperationParameter.html#initialize-instance_method" title="DeltaCloud::Documentation::OperationParameter#initialize (method)">#initialize</a>
+
+ <small>DeltaCloud::Documentation::OperationParameter</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/PlainFormatter/FormatObject/Base.html#initialize-instance_method" title="DeltaCloud::PlainFormatter::FormatObject::Base#initialize (method)">#initialize</a>
+
+ <small>DeltaCloud::PlainFormatter::FormatObject::Base</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/HWP/Property.html#initialize-instance_method" title="DeltaCloud::HWP::Property#initialize (method)">#initialize</a>
+
+ <small>DeltaCloud::HWP::Property</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/InstanceState/State.html#initialize-instance_method" title="DeltaCloud::InstanceState::State#initialize (method)">#initialize</a>
+
+ <small>DeltaCloud::InstanceState::State</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/Documentation.html#initialize-instance_method" title="DeltaCloud::Documentation#initialize (method)">#initialize</a>
+
+ <small>DeltaCloud::Documentation</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#initialize-instance_method" title="DeltaCloud::API#initialize (method)">#initialize</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/StorageVolume.html#instance-instance_method" title="DeltaCloud::API::StorageVolume#instance (method)">#instance</a>
+
+ <small>DeltaCloud::API::StorageVolume</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#instance-instance_method" title="DeltaCloud::API#instance (method)">#instance</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#instance_state-instance_method" title="DeltaCloud::API#instance_state (method)">#instance_state</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#instance_states-instance_method" title="DeltaCloud::API#instance_states (method)">#instance_states</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#instances-instance_method" title="DeltaCloud::API#instances (method)">#instances</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/HWP/Property.html#kind-instance_method" title="DeltaCloud::HWP::Property#kind (method)">#kind</a>
+
+ <small>DeltaCloud::HWP::Property</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Realm.html#limit-instance_method" title="DeltaCloud::API::Realm#limit (method)">#limit</a>
+
+ <small>DeltaCloud::API::Realm</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Realm.html#limit%3D-instance_method" title="DeltaCloud::API::Realm#limit= (method)">#limit=</a>
+
+ <small>DeltaCloud::API::Realm</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#logger-instance_method" title="DeltaCloud::API#logger (method)">#logger</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/HardwareProfile.html#memory-instance_method" title="DeltaCloud::API::HardwareProfile#memory (method)">#memory</a>
+
+ <small>DeltaCloud::API::HardwareProfile</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/HardwareProfile.html#memory%3D-instance_method" title="DeltaCloud::API::HardwareProfile#memory= (method)">#memory=</a>
+
+ <small>DeltaCloud::API::HardwareProfile</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Image.html#name-instance_method" title="DeltaCloud::API::Image#name (method)">#name</a>
+
+ <small>DeltaCloud::API::Image</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/Documentation/OperationParameter.html#name-instance_method" title="DeltaCloud::Documentation::OperationParameter#name (method)">#name</a>
+
+ <small>DeltaCloud::Documentation::OperationParameter</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Realm.html#name-instance_method" title="DeltaCloud::API::Realm#name (method)">#name</a>
+
+ <small>DeltaCloud::API::Realm</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/HWP/Property.html#name-instance_method" title="DeltaCloud::HWP::Property#name (method)">#name</a>
+
+ <small>DeltaCloud::HWP::Property</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/InstanceState/State.html#name-instance_method" title="DeltaCloud::InstanceState::State#name (method)">#name</a>
+
+ <small>DeltaCloud::InstanceState::State</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#name-instance_method" title="DeltaCloud::API::Instance#name (method)">#name</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/HardwareProfile.html#name-instance_method" title="DeltaCloud::API::HardwareProfile#name (method)">#name</a>
+
+ <small>DeltaCloud::API::HardwareProfile</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Realm.html#name%3D-instance_method" title="DeltaCloud::API::Realm#name= (method)">#name=</a>
+
+ <small>DeltaCloud::API::Realm</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Instance.html#name%3D-instance_method" title="DeltaCloud::API::Instance#name= (method)">#name=</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/HardwareProfile.html#name%3D-instance_method" title="DeltaCloud::API::HardwareProfile#name= (method)">#name=</a>
+
+ <small>DeltaCloud::API::HardwareProfile</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Image.html#name%3D-instance_method" title="DeltaCloud::API::Image#name= (method)">#name=</a>
+
+ <small>DeltaCloud::API::Image</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud.html#new-class_method" title="DeltaCloud.new (method)">new</a>
+
+ <small>DeltaCloud</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Image.html#owner_id-instance_method" title="DeltaCloud::API::Image#owner_id (method)">#owner_id</a>
+
+ <small>DeltaCloud::API::Image</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#owner_id-instance_method" title="DeltaCloud::API::Instance#owner_id (method)">#owner_id</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Image.html#owner_id%3D-instance_method" title="DeltaCloud::API::Image#owner_id= (method)">#owner_id=</a>
+
+ <small>DeltaCloud::API::Image</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#owner_id%3D-instance_method" title="DeltaCloud::API::Instance#owner_id= (method)">#owner_id=</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/Documentation.html#params-instance_method" title="DeltaCloud::Documentation#params (method)">#params</a>
+
+ <small>DeltaCloud::Documentation</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/HWP/Property.html#present%3F-instance_method" title="DeltaCloud::HWP::Property#present? (method)">#present?</a>
+
+ <small>DeltaCloud::HWP::Property</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Instance.html#private_addresses-instance_method" title="DeltaCloud::API::Instance#private_addresses (method)">#private_addresses</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#private_addresses%3D-instance_method" title="DeltaCloud::API::Instance#private_addresses= (method)">#private_addresses=</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Instance.html#public_addresses-instance_method" title="DeltaCloud::API::Instance#public_addresses (method)">#public_addresses</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#public_addresses%3D-instance_method" title="DeltaCloud::API::Instance#public_addresses= (method)">#public_addresses=</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="#read_method_description-instance_method" title="#read_method_description (method)">#read_method_description</a>
+
+ <small>Top Level Namespace</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="#read_parameters-instance_method" title="#read_parameters (method)">#read_parameters</a>
+
+ <small>Top Level Namespace</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="#read_return_value-instance_method" title="#read_return_value (method)">#read_return_value</a>
+
+ <small>Top Level Namespace</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#realm-instance_method" title="DeltaCloud::API::Instance#realm (method)">#realm</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#realm-instance_method" title="DeltaCloud::API#realm (method)">#realm</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#realms-instance_method" title="DeltaCloud::API#realms (method)">#realms</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Instance.html#reboot%21-instance_method" title="DeltaCloud::API::Instance#reboot! (method)">#reboot!</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#request-instance_method" title="DeltaCloud::API#request (method)">#request</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/Documentation/OperationParameter.html#required-instance_method" title="DeltaCloud::Documentation::OperationParameter#required (method)">#required</a>
+
+ <small>DeltaCloud::Documentation::OperationParameter</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="String.html#sanitize-instance_method" title="String#sanitize (method)">#sanitize</a>
+
+ <small>String</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="String.html#singularize-instance_method" title="String#singularize (method)">#singularize</a>
+
+ <small>String</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#start%21-instance_method" title="DeltaCloud::API::Instance#start! (method)">#start!</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/StorageSnapshot.html#state-instance_method" title="DeltaCloud::API::StorageSnapshot#state (method)">#state</a>
+
+ <small>DeltaCloud::API::StorageSnapshot</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#state-instance_method" title="DeltaCloud::API::Instance#state (method)">#state</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Realm.html#state-instance_method" title="DeltaCloud::API::Realm#state (method)">#state</a>
+
+ <small>DeltaCloud::API::Realm</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Instance.html#state%3D-instance_method" title="DeltaCloud::API::Instance#state= (method)">#state=</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/StorageSnapshot.html#state%3D-instance_method" title="DeltaCloud::API::StorageSnapshot#state= (method)">#state=</a>
+
+ <small>DeltaCloud::API::StorageSnapshot</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Realm.html#state%3D-instance_method" title="DeltaCloud::API::Realm#state= (method)">#state=</a>
+
+ <small>DeltaCloud::API::Realm</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Instance.html#stop%21-instance_method" title="DeltaCloud::API::Instance#stop! (method)">#stop!</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/HardwareProfile.html#storage-instance_method" title="DeltaCloud::API::HardwareProfile#storage (method)">#storage</a>
+
+ <small>DeltaCloud::API::HardwareProfile</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/HardwareProfile.html#storage%3D-instance_method" title="DeltaCloud::API::HardwareProfile#storage= (method)">#storage=</a>
+
+ <small>DeltaCloud::API::HardwareProfile</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#storage_snapshot-instance_method" title="DeltaCloud::API#storage_snapshot (method)">#storage_snapshot</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#storage_snapshots-instance_method" title="DeltaCloud::API#storage_snapshots (method)">#storage_snapshots</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#storage_volume-instance_method" title="DeltaCloud::API#storage_volume (method)">#storage_volume</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/StorageSnapshot.html#storage_volume-instance_method" title="DeltaCloud::API::StorageSnapshot#storage_volume (method)">#storage_volume</a>
+
+ <small>DeltaCloud::API::StorageSnapshot</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API.html#storage_volumes-instance_method" title="DeltaCloud::API#storage_volumes (method)">#storage_volumes</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/InstanceState/Transition.html#to-instance_method" title="DeltaCloud::InstanceState::Transition#to (method)">#to</a>
+
+ <small>DeltaCloud::InstanceState::Transition</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/Documentation/OperationParameter.html#to_comment-instance_method" title="DeltaCloud::Documentation::OperationParameter#to_comment (method)">#to_comment</a>
+
+ <small>DeltaCloud::Documentation::OperationParameter</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/InstanceState/State.html#transitions-instance_method" title="DeltaCloud::InstanceState::State#transitions (method)">#transitions</a>
+
+ <small>DeltaCloud::InstanceState::State</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/Documentation/OperationParameter.html#type-instance_method" title="DeltaCloud::Documentation::OperationParameter#type (method)">#type</a>
+
+ <small>DeltaCloud::Documentation::OperationParameter</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/HWP/Property.html#unit-instance_method" title="DeltaCloud::HWP::Property#unit (method)">#unit</a>
+
+ <small>DeltaCloud::HWP::Property</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/Realm.html#uri-instance_method" title="DeltaCloud::API::Realm#uri (method)">#uri</a>
+
+ <small>DeltaCloud::API::Realm</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Instance.html#uri-instance_method" title="DeltaCloud::API::Instance#uri (method)">#uri</a>
+
+ <small>DeltaCloud::API::Instance</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/StorageSnapshot.html#uri-instance_method" title="DeltaCloud::API::StorageSnapshot#uri (method)">#uri</a>
+
+ <small>DeltaCloud::API::StorageSnapshot</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/Image.html#uri-instance_method" title="DeltaCloud::API::Image#uri (method)">#uri</a>
+
+ <small>DeltaCloud::API::Image</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/API/StorageVolume.html#uri-instance_method" title="DeltaCloud::API::StorageVolume#uri (method)">#uri</a>
+
+ <small>DeltaCloud::API::StorageVolume</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API/HardwareProfile.html#uri-instance_method" title="DeltaCloud::API::HardwareProfile#uri (method)">#uri</a>
+
+ <small>DeltaCloud::API::HardwareProfile</small>
+
+ </li>
+
+
+ <li class="r2 ">
+ <a href="DeltaCloud/HWP/Property.html#value-instance_method" title="DeltaCloud::HWP::Property#value (method)">#value</a>
+
+ <small>DeltaCloud::HWP::Property</small>
+
+ </li>
+
+
+ <li class="r1 ">
+ <a href="DeltaCloud/API.html#xml_to_class-instance_method" title="DeltaCloud::API#xml_to_class (method)">#xml_to_class</a>
+
+ <small>DeltaCloud::API</small>
+
+ </li>
+
+
+ </ul>
+ </div>
+ </body>
+</html>
+
Added: incubator/deltacloud/trunk/site/doc/top-level-namespace.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/site/doc/top-level-namespace.html?rev=985209&view=auto
==============================================================================
--- incubator/deltacloud/trunk/site/doc/top-level-namespace.html (added)
+++ incubator/deltacloud/trunk/site/doc/top-level-namespace.html Fri Aug 13 14:30:21 2010
@@ -0,0 +1,301 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta name="Content-Type" content="text/html; charset=utf-8" />
+<title>Top Level Namespace</title>
+<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+ relpath = '';
+ if (relpath != '') relpath += '/';
+</script>
+<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+ </head>
+ <body>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) document.body.className = 'frames';
+ </script>
+
+ <div id="header">
+ <div id="menu">
+
+ <a href="_index.html">Index</a> »
+
+
+ <span class="title">Top Level Namespace</span>
+
+
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+ <div id="search">
+ <a id="class_list_link" href="#">Class List</a>
+ <a id="method_list_link" href="#">Method List</a>
+ <a id ="file_list_link" href="#">File List</a>
+</div>
+
+ <div class="clear"></div>
+ </div>
+
+ <iframe id="search_frame"></iframe>
+
+ <div id="content"><h1>Top Level Namespace
+
+
+
+</h1>
+
+<dl class="box">
+
+
+
+
+
+
+
+
+</dl>
+<div class="clear"></div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+
+
+ <strong class="modules">Modules:</strong> <a href="DeltaCloud.html" title="DeltaCloud (module)">DeltaCloud</a>
+
+
+
+ <strong class="classes">Classes:</strong> <a href="String.html" title="String (class)">String</a>
+
+
+</p>
+
+
+
+
+ <h2>
+ Instance Method Summary
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+ </h2>
+
+ <ul class="summary">
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#read_method_description-instance_method" title="#read_method_description (instance method)">- (Object) <strong>read_method_description</strong>(c, method) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#read_parameters-instance_method" title="#read_parameters (instance method)">- (Object) <strong>read_parameters</strong>(c, method) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#read_return_value-instance_method" title="#read_return_value (instance method)">- (Object) <strong>read_return_value</strong>(c, method) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ </ul>
+
+
+
+
+ <div id="instance_method_details" class="method_details_list">
+ <h2>Instance Method Details</h2>
+
+
+ <div class="method_details first">
+ <p class="signature first" id="read_method_description-instance_method">
+
+ - (<tt>Object</tt>) <strong>read_method_description</strong>(c, method)
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/documentation.rb', line 18</span>
+
+<span class='def def kw'>def</span> <span class='read_method_description identifier id'>read_method_description</span><span class='lparen token'>(</span><span class='c identifier id'>c</span><span class='comma token'>,</span> <span class='method identifier id'>method</span><span class='rparen token'>)</span>
+ <span class='if if kw'>if</span> <span class='method identifier id'>method</span> <span class='match op'>=~</span> <span class='regexp val'>/es$/</span>
+ <span class='dstring node'>" # Read #{c.downcase} collection from Deltacloud API"</span>
+ <span class='else else kw'>else</span>
+ <span class='case case kw'>case</span> <span class='method identifier id'>method</span>
+ <span class='when when kw'>when</span> <span class='string val'>"uri"</span>
+ <span class='string val'>" # Return URI to API for this object"</span>
+ <span class='when when kw'>when</span> <span class='string val'>"action_urls"</span>
+ <span class='string val'>" # Return available actions API URL"</span>
+ <span class='when when kw'>when</span> <span class='string val'>"client"</span>
+ <span class='string val'>" # Return instance of API client"</span>
+ <span class='else else kw'>else</span>
+ <span class='dstring node'>" # Get #{method} attribute value from #{c.downcase}"</span>
+ <span class='end end kw'>end</span>
+ <span class='end end kw'>end</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="read_parameters-instance_method">
+
+ - (<tt>Object</tt>) <strong>read_parameters</strong>(c, method)
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+35
+36
+37
+38
+39
+40
+41</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/documentation.rb', line 35</span>
+
+<span class='def def kw'>def</span> <span class='read_parameters identifier id'>read_parameters</span><span class='lparen token'>(</span><span class='c identifier id'>c</span><span class='comma token'>,</span> <span class='method identifier id'>method</span><span class='rparen token'>)</span>
+ <span class='out identifier id'>out</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
+ <span class='if if kw'>if</span> <span class='method identifier id'>method</span> <span class='match op'>=~</span> <span class='regexp val'>/es$/</span>
+ <span class='out identifier id'>out</span> <span class='lshft op'><<</span> <span class='string val'>" # @param [String, #id] Filter by ID"</span>
+ <span class='end end kw'>end</span>
+ <span class='out identifier id'>out</span><span class='dot token'>.</span><span class='join identifier id'>join</span><span class='lparen token'>(</span><span class='string val'>"\n"</span><span class='rparen token'>)</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="read_return_value-instance_method">
+
+ - (<tt>Object</tt>) <strong>read_return_value</strong>(c, method)
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+43
+44
+45
+46
+47
+48
+49
+50</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/documentation.rb', line 43</span>
+
+<span class='def def kw'>def</span> <span class='read_return_value identifier id'>read_return_value</span><span class='lparen token'>(</span><span class='c identifier id'>c</span><span class='comma token'>,</span> <span class='method identifier id'>method</span><span class='rparen token'>)</span>
+ <span class='if if kw'>if</span> <span class='method identifier id'>method</span> <span class='match op'>=~</span> <span class='regexp val'>/es$/</span>
+ <span class='rt identifier id'>rt</span> <span class='assign token'>=</span> <span class='string val'>"Array"</span>
+ <span class='else else kw'>else</span>
+ <span class='rt identifier id'>rt</span> <span class='assign token'>=</span> <span class='string val'>"String"</span>
+ <span class='end end kw'>end</span>
+ <span class='dstring node'>" # @return [String] Value of #{method}"</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+</div>
+
+ <div id="footer">
+ Generated on Fri Jul 30 12:16:34 2010 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
+ 0.5.6 (ruby-1.8.7).
+</div>
+
+ </body>
+</html>
\ No newline at end of file
Added: incubator/deltacloud/trunk/site/documentation.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/site/documentation.html?rev=985209&view=auto
==============================================================================
--- incubator/deltacloud/trunk/site/documentation.html (added)
+++ incubator/deltacloud/trunk/site/documentation.html Fri Aug 13 14:30:21 2010
@@ -0,0 +1,113 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>
+ Deltacloud - Documentation
+ </title>
+ <meta content='' name='keywords' />
+ <meta content='' name='description' />
+ <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
+ <link href='./styles/favicon.ico' rel='shortcut icon' type='image/x-icon' />
+ <link href='./styles/default.css' rel='StyleSheet' title='Main style' type='text/css' />
+ <link href='./styles/default-debug.css' rel='Alternate StyleSheet' title='Debug main style' type='text/css' />
+ </head>
+ <body>
+ <div id='header'>
+ <div class='container'>
+ <div id='headerLogo' onclick="location.href='index.html';" style='cursor: pointer;'>
+ <h1>
+ Deltacloud - Many clouds. One API. No problem.
+ </h1>
+ </div>
+ </div>
+ </div>
+ <div id='navigation'>
+ <div class='container' id='menu'>
+ <ul class='l0'>
+ <li>
+ <a class='inactive' href='./index.html' title='Deltacloud Home'>Home</a>
+ </li>
+ <li>
+ <a class='inactive' href='./download.html' title='Get the latest releases'>Download</a>
+ </li>
+ <li>
+ <a class='inactive' href='./contribute.html' title='Information about design/development process'>Contribute</a>
+ </li>
+ <li>
+ <a class='active' href='./documentation.html' title='Project documentation'>Documentation</a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <div id='subnavigation'>
+ <div class='container' id='submenu'>
+ <ul class='l1'>
+ <li>
+ <a class='active' href='documentation.html'>
+ Overview
+ </a>
+ </li>
+ <li>
+ <a class='inactive' href='api.html'>
+ REST API
+ </a>
+ </li>
+ <li>
+ <a class='inactive' href='drivers.html'>
+ Drivers
+ </a>
+ </li>
+ <li>
+ <a class='inactive' href='framework.html'>
+ Framework
+ </a>
+ </li>
+ <li>
+ <a class='inactive' href='doc/index.html'>
+ Ruby Client API
+ </a>
+ </li>
+ <li>
+ <a class='inactive' href='client-ruby.html'>
+ Ruby Client
+ </a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <div id='frontpageHeader'></div>
+ <div id='main'>
+ <div class='container' id='content-deltacloud'>
+ <h1>Documentation</h1>
+ <p>The Deltacloud documentation is divided into the following parts:</p>
+ <ul>
+ <li>
+ <a href='api.html'>
+ REST API definition
+ </a>
+ </li>
+ <li>
+ <a href='drivers.html'>
+ Currently-supported drivers
+ </a>
+ </li>
+ <li>
+ <a href='framework.html'>
+ Framework for writing additional drivers
+ </a>
+ </li>
+ <li>
+ <a href='doc/index.html'>
+ Ruby Client API
+ </a>
+ </li>
+ <li>
+ <a href='client-ruby.html'>
+ Ruby client
+ </a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </body>
+</html>
Added: incubator/deltacloud/trunk/site/download.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/site/download.html?rev=985209&view=auto
==============================================================================
--- incubator/deltacloud/trunk/site/download.html (added)
+++ incubator/deltacloud/trunk/site/download.html Fri Aug 13 14:30:21 2010
@@ -0,0 +1,97 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>
+ Deltacloud - Download
+ </title>
+ <meta content='' name='keywords' />
+ <meta content='' name='description' />
+ <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
+ <link href='./styles/favicon.ico' rel='shortcut icon' type='image/x-icon' />
+ <link href='./styles/default.css' rel='StyleSheet' title='Main style' type='text/css' />
+ <link href='./styles/default-debug.css' rel='Alternate StyleSheet' title='Debug main style' type='text/css' />
+ </head>
+ <body>
+ <div id='header'>
+ <div class='container'>
+ <div id='headerLogo' onclick="location.href='index.html';" style='cursor: pointer;'>
+ <h1>
+ Deltacloud - Many clouds. One API. No problem.
+ </h1>
+ </div>
+ </div>
+ </div>
+ <div id='navigation'>
+ <div class='container' id='menu'>
+ <ul class='l0'>
+ <li>
+ <a class='inactive' href='./index.html' title='Deltacloud Home'>Home</a>
+ </li>
+ <li>
+ <a class='active' href='./download.html' title='Get the latest releases'>Download</a>
+ </li>
+ <li>
+ <a class='inactive' href='./contribute.html' title='Information about design/development process'>Contribute</a>
+ </li>
+ <li>
+ <a class='inactive' href='./documentation.html' title='Project documentation'>Documentation</a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <div id='frontpageHeader'></div>
+ <div id='main'>
+ <div class='container' id='content-deltacloud'>
+ <h1>Download</h1>
+
+ <h3>Deltacloud Core</h3>
+
+ <p>Deltacloud Core provides the API server and drivers necessary for connecting
+ to the cloud providers.</p>
+
+ <p>Presently, it is packaged as a Ruby gem. You can install it by typing the
+ following command:</p>
+
+ <pre><code>$ sudo gem install deltacloud-core
</code></pre>
+
+ <h2>Additional Tools</h2>
+
+ <p>These are complementary to the essential Core components.</p>
+
+ <h3>libdeltacloud</h3>
+
+ <p>A library for accessing the Deltacloud API from C/C++ programs.</p>
+
+ <p>You can get the source code:</p>
+
+ <pre><code>$ git clone git://git.fedorahosted.org/deltacloud/libdeltacloud.git
</code></pre>
+
+ <p>Or you can download the RPMs for Fedora 12 and 13:</p>
+
+ <p><a href="http://people.redhat.com/clalance/libdeltacloud">http://people.redhat.com/clalance/libdeltacloud</a></p>
+
+ <p>Contributed by Chris Lalancette.</p>
+
+ <h3>Deltacloud Client</h3>
+
+ <p>Deltacloud Client is a command line tool that communicates with the
+ Deltacloud API.</p>
+
+ <p>Type the following command to install it:</p>
+
+ <pre><code>$ gem install deltacloud-core
</code></pre>
+
+ <h3>Deltacloud driver for VirtualBox</h3>
+
+ <p><a href="http://gitorious.org/deltacloud-devel/deltacloud-virtualbox-driver">http://gitorious.org/deltacloud-devel/deltacloud-virtualbox-driver</a></p>
+
+ <p>Contributed by Michal Fojtik.</p>
+
+ <h3>Your name here</h3>
+
+ <p>Do you have a tool to make Deltacloud more useful? Let us know on our
+ [deltacloud-devel mailing list][deltacloud-devel] and we'll post it here!</p>
+ </div>
+ </div>
+ </body>
+</html>
Added: incubator/deltacloud/trunk/site/drivers.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/site/drivers.html?rev=985209&view=auto
==============================================================================
--- incubator/deltacloud/trunk/site/drivers.html (added)
+++ incubator/deltacloud/trunk/site/drivers.html Fri Aug 13 14:30:21 2010
@@ -0,0 +1,340 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>
+ Deltacloud - Documentation
+ </title>
+ <meta content='' name='keywords' />
+ <meta content='' name='description' />
+ <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
+ <link href='./styles/favicon.ico' rel='shortcut icon' type='image/x-icon' />
+ <link href='./styles/default.css' rel='StyleSheet' title='Main style' type='text/css' />
+ <link href='./styles/default-debug.css' rel='Alternate StyleSheet' title='Debug main style' type='text/css' />
+ </head>
+ <body>
+ <div id='header'>
+ <div class='container'>
+ <div id='headerLogo' onclick="location.href='index.html';" style='cursor: pointer;'>
+ <h1>
+ Deltacloud - Many clouds. One API. No problem.
+ </h1>
+ </div>
+ </div>
+ </div>
+ <div id='navigation'>
+ <div class='container' id='menu'>
+ <ul class='l0'>
+ <li>
+ <a class='inactive' href='./index.html' title='Deltacloud Home'>Home</a>
+ </li>
+ <li>
+ <a class='inactive' href='./download.html' title='Get the latest releases'>Download</a>
+ </li>
+ <li>
+ <a class='inactive' href='./contribute.html' title='Information about design/development process'>Contribute</a>
+ </li>
+ <li>
+ <a class='active' href='./documentation.html' title='Project documentation'>Documentation</a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <div id='subnavigation'>
+ <div class='container' id='submenu'>
+ <ul class='l1'>
+ <li>
+ <a class='inactive' href='documentation.html'>
+ Overview
+ </a>
+ </li>
+ <li>
+ <a class='inactive' href='api.html'>
+ REST API
+ </a>
+ </li>
+ <li>
+ <a class='active' href='drivers.html'>
+ Drivers
+ </a>
+ </li>
+ <li>
+ <a class='inactive' href='framework.html'>
+ Framework
+ </a>
+ </li>
+ <li>
+ <a class='inactive' href='doc/index.html'>
+ Ruby Client API
+ </a>
+ </li>
+ <li>
+ <a class='inactive' href='client-ruby.html'>
+ Ruby Client
+ </a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <div id='frontpageHeader'></div>
+ <div id='main'>
+ <div class='container' id='content-deltacloud'>
+ <h1>Deltacloud Drivers</h1>
+ <!-- - title, rest = page.split("</h1>") -->
+ <!-- = title + '</h1>' -->
+ <ul class="toc">
+ <li>
+ <a href="#h1">Setting up the code</a>
+ </li>
+ <li>
+ <a href="#h2">Launch the server</a>
+ <ul>
+ <li>
+ <a href="#h2_1">EC2 Driver</a>
+ </li>
+ <li>
+ <a href="#h2_2">RHEV-M Driver</a>
+ </li>
+ <li>
+ <a href="#h2_3">Rackspace Driver</a>
+ </li>
+ <li>
+ <a href="#h2_4">RimuHosting</a>
+ </li>
+ <li>
+ <a href="#h2_5">OpenNebula</a>
+ </li>
+ </ul></li></ul>
+ <!-- = rest -->
+
+
+ <p>Deltacloud provides drivers for a growing number of popular clouds. All drivers
+ can handle a set of standard operations, some of them also support a number of
+ optional operations to expose the features of specific clouds more closely. The
+ drivers and their capabilities are:</p>
+ <table id='providers'>
+ <tr>
+ <th class='emptycell'> </th>
+ <th>
+ <strong>Create</strong>
+ new instances
+ </th>
+ <th>
+ <strong>Start</strong>
+ stopped instances
+ </th>
+ <th>
+ <strong>Stop</strong>
+ running instances
+ </th>
+ <th>
+ <strong>Reboot</strong>
+ running instances
+ </th>
+ <th>
+ <strong>Destroy</strong>
+ instances
+ </th>
+ <th>
+ List all/get details about
+ <strong>hardware profiles</strong>
+ </th>
+ <th>
+ List all/get details about
+ <strong>realms</strong>
+ </th>
+ <th>
+ List all/get details about
+ <strong>images</strong>
+ </th>
+ <th>
+ List all/get details about
+ <strong>instances</strong>
+ </th>
+ </tr>
+ <tr>
+ <td class='provider'>
+ Amazon EC2
+ </td>
+ <td class="supported">yes</td>
+ <td class="not-supported">no</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ </tr>
+ <tr>
+ <td class='provider'>
+ GoGrid
+ </td>
+ <td class="supported">yes</td>
+ <td class="not-supported">no</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ </tr>
+ <tr>
+ <td class='provider'>
+ OpenNebula
+ </td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="not-supported">no</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ </tr>
+ <tr>
+ <td class='provider'>
+ Rackspace
+ </td>
+ <td class="supported">yes</td>
+ <td class="not-supported">no</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ </tr>
+ <tr>
+ <td class='provider'>
+ RHEV-M
+ </td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ </tr>
+ <tr>
+ <td class='provider'>
+ RimuHosting
+ </td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ </tr>
+ <tr>
+ <td class='provider'>
+ Terremark
+ <span>coming soon</span>
+ </td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ </tr>
+ <tr>
+ <td class='provider'>
+ vCloud
+ <span>coming soon</span>
+ </td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ <td class="supported">yes</td>
+ </tr>
+ </table>
+
+
+
+ <h2 id="h1">Setting up the code</h2>
+
+ <p>To set up a Deltacloud core and the drivers, install the
+ <a href="http://rubygems.org/gems/deltacloud-core">deltacloud-core</a> Ruby gem:</p>
+
+ <pre><code># gem install deltacloud-core
</code></pre>
+
+ <p>RPM package will be available soon.</p>
+
+ <h2 id="h2">Launch the server</h2>
+
+ <p>The server is launched with the <code>deltacloudd</code> command and pass it the name
+ of the driver you want to use:</p>
+
+ <pre><code>$ deltacloudd -i mock
</code></pre>
+
+ <p>This will start a webserver running the mock driver on
+ <code>http://localhost:3001/api</code>; you can simply browse to that URL to get a
+ pretty view of the objects the driver deals with.</p>
+
+ <h3 id="h2_1">EC2 Driver</h3>
+
+ <p>For the Amazon EC2 you need to install the <code>amazon-ec2</code> Ruby gem:</p>
+
+ <pre><code># gem install amazon-ec2
</code></pre>
+
+ <p>When using the driver for Amazon EC2, the credentials passed in
+ response to the HTTP 401 authentication challenge should be your
+ <em>access_key</em> and <em>secret_access_key</em></p>
+
+ <p>These credentials may be found on the <a href="http://aws-portal.amazon.com/gp/aws/developer/account/index.html?action=access-key">Access Identifiers</a>
+ page at Amazon AWS.</p>
+
+ <h3 id="h2_2">RHEV-M Driver</h3>
+
+ <p>The RHEV-M driver needs to be installed on a Windows machine which has the
+ RHEV-M Powershell API installed and configured. Assuming the directory
+ structure above is followed, you should copy the file
+ deltacloud/deltacloud-driver-rhevm/config/rhevm_config.yaml.EXAMPLE to be
+ rhevm_config.yaml and edit the file woith the domain you are logging into.
+ The username and pasword is provided via the API.</p>
+
+ <p>The actual RHEVM instance you are connecting to is controlled by
+ the RHEVM.dll.config file which is referenced from the profile.ps1
+ file located in My Documents/WindowsPowershell directory</p>
+
+ <h3 id="h2_3">Rackspace Driver</h3>
+
+ <p>When using the Rackspace-cloud driver (Rackspace cloud used to be called
+ "Mosso") - the password in a HTTP 401 challenge should be your API key, NOT
+ your rackspace account password. (you can get the API-key, or generate a
+ new one, from the rackspace console).</p>
+
+ <h3 id="h2_4">RimuHosting</h3>
+
+ <p>Further details coming soon.</p>
+
+ <h3 id="h2_5">OpenNebula</h3>
+
+ <p>When using the <a href="http://www.opennebula.org/">OpenNebula</a> driver, the
+ credentials passed in response to the HTTP 401 authentication challenge
+ should be your OpenNebula user and password.</p>
+
+ <p>The address, on which the OCCI server is listening, needs to be defined in
+ an environment variable called OCCI_URL.</p>
+ </div>
+ </div>
+ </body>
+</html>
Added: incubator/deltacloud/trunk/site/framework.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/site/framework.html?rev=985209&view=auto
==============================================================================
--- incubator/deltacloud/trunk/site/framework.html (added)
+++ incubator/deltacloud/trunk/site/framework.html Fri Aug 13 14:30:21 2010
@@ -0,0 +1,340 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>
+ Deltacloud - Documentation
+ </title>
+ <meta content='' name='keywords' />
+ <meta content='' name='description' />
+ <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
+ <link href='./styles/favicon.ico' rel='shortcut icon' type='image/x-icon' />
+ <link href='./styles/default.css' rel='StyleSheet' title='Main style' type='text/css' />
+ <link href='./styles/default-debug.css' rel='Alternate StyleSheet' title='Debug main style' type='text/css' />
+ </head>
+ <body>
+ <div id='header'>
+ <div class='container'>
+ <div id='headerLogo' onclick="location.href='index.html';" style='cursor: pointer;'>
+ <h1>
+ Deltacloud - Many clouds. One API. No problem.
+ </h1>
+ </div>
+ </div>
+ </div>
+ <div id='navigation'>
+ <div class='container' id='menu'>
+ <ul class='l0'>
+ <li>
+ <a class='inactive' href='./index.html' title='Deltacloud Home'>Home</a>
+ </li>
+ <li>
+ <a class='inactive' href='./download.html' title='Get the latest releases'>Download</a>
+ </li>
+ <li>
+ <a class='inactive' href='./contribute.html' title='Information about design/development process'>Contribute</a>
+ </li>
+ <li>
+ <a class='active' href='./documentation.html' title='Project documentation'>Documentation</a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <div id='subnavigation'>
+ <div class='container' id='submenu'>
+ <ul class='l1'>
+ <li>
+ <a class='inactive' href='documentation.html'>
+ Overview
+ </a>
+ </li>
+ <li>
+ <a class='inactive' href='api.html'>
+ REST API
+ </a>
+ </li>
+ <li>
+ <a class='inactive' href='drivers.html'>
+ Drivers
+ </a>
+ </li>
+ <li>
+ <a class='active' href='framework.html'>
+ Framework
+ </a>
+ </li>
+ <li>
+ <a class='inactive' href='doc/index.html'>
+ Ruby Client API
+ </a>
+ </li>
+ <li>
+ <a class='inactive' href='client-ruby.html'>
+ Ruby Client
+ </a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <div id='frontpageHeader'></div>
+ <div id='main'>
+ <div class='container' id='content-deltacloud'>
+ <h1>Writing Deltacloud Drivers</h1>
+ <!-- - title, rest = page.split("</h1>") -->
+ <!-- = title + '</h1>' -->
+ <ul class="toc">
+ <li>
+ <a href="#h1">Driver SPI</a>
+ <ul>
+ <li>
+ <a href="#h1_1">Credentials</a>
+ </li>
+ <li>
+ <a href="#h1_2">Object models used by drivers</a>
+ </li>
+ <li>
+ <a href="#h1_3">Driver methods</a>
+ </li>
+ </ul></li></ul>
+ <!-- = rest -->
+
+
+ <p>The <em>Deltacloud Core framework</em> is provided to assist in creating
+ intermediary <a href="drivers.html">drivers</a> that speak the <a href="api.html">Deltacloud REST
+ API</a> on the front while communicating with cloud providers
+ using their own native APIs on the back.</p>
+
+ <p><img src="styles/framework.png" alt="Deltacloud framework" /></p>
+
+ <p>The framework handles all aspects of the REST API, while allowing
+ driver implementors to focus on the specific cloud provider native
+ API.</p>
+
+ <p>Drivers may be implemented in as little as one Ruby class and plugged
+ into the Deltacloud Core for deployment.</p>
+
+ <h2 id="h1">Driver SPI</h2>
+
+ <h3 id="h1_1">Credentials</h3>
+
+ <p>The framework will collect credentials when the driver indicates they
+ are required by throwing a <code>DeltaCloud::AuthException</code>. Each driver
+ method takes a credentials hash as the first parameter, but unless the
+ client has provided credentials, this hash will be empty.</p>
+
+ <pre><code>def images(credentials, opts)
 if ( credentials[:name].nil? )
 throw DeltaCloud::AuthException.new
 end
 unless ( credentials_valid?( credentials ) )
 throw DeltaCloud::AuthException.new
 end

 # do work

end
</code></pre>
+
+ <h3 id="h1_2">Object models used by drivers</h3>
+
+ <p>To assist driver authors, the framework provides a handful of model
+ classes, representing each resource available through the Deltacloud
+ API. Please see the <a href="api.html">API reference</a> for details about each
+ model. All of these model objects may be initialized with a hash.
+ Every instance <em>must</em> be assigned an <code>id</code> in addition to other
+ attributes it may have. Unless otherwise noted, attributes are text.</p>
+
+ <p>For example</p>
+
+ <pre><code>HardwareProfile.new(
 :architecture=>'x86_64',
 :memory=>4,
 :storage=>650,
)
</code></pre>
+
+ <p>The <code>base_driver</code> interface and the already implemented drivers are
+ located at <code>server/lib/deltacloud/</code> in the Deltacloud Core repository.</p>
+
+ <h4><code>HardwareProfile</code></h4>
+
+ <p>Attributes are</p>
+
+ <ul>
+ <li><strong><code>id</code></strong></li>
+ <li><strong><code>architecture</code></strong></li>
+ <li><strong><code>memory</code></strong> - Decimal, gigabytes</li>
+ <li><strong><code>storage</code></strong> - Decimal, gigabytes</li>
+ <li><strong><code>cpu</code></strong> - Interger, count</li>
+ </ul>
+
+
+ <h4><code>Realm</code></h4>
+
+ <p>Attributes are</p>
+
+ <ul>
+ <li><strong><code>id</code></strong></li>
+ <li><strong><code>name</code></strong></li>
+ <li><strong><code>state</code></strong></li>
+ <li><strong><code>limit</code></strong></li>
+ </ul>
+
+
+ <h4><code>Image</code></h4>
+
+ <p>Attributes are</p>
+
+ <ul>
+ <li><strong><code>id</code></strong></li>
+ <li><strong><code>name</code></strong></li>
+ <li><strong><code>architecture</code></strong></li>
+ <li><strong><code>owner_id</code></strong></li>
+ <li><strong><code>description</code></strong></li>
+ </ul>
+
+
+ <h4><code>Instance</code></h4>
+
+ <p>Attributes are</p>
+
+ <ul>
+ <li><strong><code>id</code></strong></li>
+ <li><strong><code>name</code></strong></li>
+ <li><strong><code>owner_id</code></strong> - Opaque, external reference</li>
+ <li><strong><code>image</code></strong> - References an image</li>
+ <li><strong><code>realm</code></strong> - References a realm</li>
+ <li><strong><code>state</code></strong> - One of <code>PENDING</code>, <code>RUNNING</code>, <code>SHUTTING_DOWN</code>, <code>STOPPED</code></li>
+ <li><strong><code>actions</code></strong> - Array of applicable actions</li>
+ <li><strong><code>public_addresses</code></strong> - Array of IP addresses or hostnames as text</li>
+ <li><strong><code>private_addresses</code></strong> - Array of IP addresses or hostnames as text</li>
+ </ul>
+
+
+ <h3 id="h1_3">Driver methods</h3>
+
+ <p>The primary methods a driver class must implement are</p>
+
+ <ul>
+ <li><code>hardware_profiles(credentials, opts=nil)</code></li>
+ <li><code>images(credentials, opts=nil )</code></li>
+ <li><code>realms(credentials, opts=nil)</code></li>
+ <li><code>instances(credentials, opts=nil)</code></li>
+ <li><code>create_instance(credentials, image_id, opts)</code></li>
+ <li><code>reboot_instance(credentials, id)</code></li>
+ <li><code>stop_instance(credentials, id)</code></li>
+ <li><code>destroy_instance(credentials, id)</code></li>
+ </ul>
+
+
+ <p>Generally, the <code>BaseDriver</code> handles singular cases while the specific
+ provider driver must implement only the plural cases, along with
+ specific action methods against resources.</p>
+
+ <p>Additionally, to assist clients in determining what actions may be
+ available without making additional requests, the following must be
+ implemented.</p>
+
+ <p>While the <code>credentials</code> hash is passed as the first parameter to each
+ method, it <em>may</em> be empty until the driver throws at least one
+ <code>DeltaCloud::AuthException</code>. This exception will indicate to the
+ framework that a normal HTTP authentication challenge should be issued
+ to the client. Depending on the underlying provider the driver is
+ connecting to, the credentials may not be required for some methods.</p>
+
+ <p>Some methods also allow an optional <code>opts</code> hash, which may be <code>nil</code> or
+ empty if not used for a particular invocation. The <code>BaseDriver</code>
+ provides a method <code>filter_on(...)</code> which may be used to safely filter
+ collections. The <code>filter_on(..)</code> method will be demonstrated below.</p>
+
+ <p>Each method will be described in more detail below.</p>
+
+ <h4><code>hardware_profiles(credentials, opts=nil)</code></h4>
+
+ <p>The <code>hardware_profiles(...)</code> method should return an array of
+ <code>HardwareProfile</code> objects. The <code>opts</code> hash, if present, must be
+ inspected for <code>:id</code> and <code>:architecture</code> keys. If these keys are
+ present, the results should be filtered by the value associated with
+ each key. The <code>filter_on(...)</code> method is useful in this case.</p>
+
+ <p>For example</p>
+
+ <pre><code>def hardware_profiles(credentials, opts=nil)
 hardware_profiles = fetch_all_hardware_profiles()
 hardware_profiles = filter_on( hardware_profiles, :id, opts )
 hardware_profiles = filter_on( hardware_profiles, :architecture, opts )
 return hardware_profiles
end
</code></pre>
+
+ <h4><code>realms(credentials, opts=nil)</code></h4>
+
+ <p>The <code>realms(...)</code> method should return an array of <code>Realm</code> objects.</p>
+
+ <h4><code>images(credentials, opts=nil)</code></h4>
+
+ <p>The <code>images(...)</code> method should return an array of <code>Image</code> objects
+ visible and accessible to the current user, as defined by the
+ <code>credentials</code> hash.</p>
+
+ <p>The <code>opts</code> hash, if present, must be inspected for <code>:id</code>, <code>:owner_id</code>
+ and <code>:architecture</code> keys. If these keys are present, the results
+ should be filtered by the value assocaited with each key.</p>
+
+ <h4><code>instances(credentials, opts=nil)</code></h4>
+
+ <p>The <code>instances(...)</code> method should return an array of <code>Instance</code>
+ objects visible and accessible to the current user, as defined bv the
+ <code>credentials</code> hash. If the <code>opts</code> hash is present and contains an
+ <code>:id</code> key, the results should be filtered by the value associated with
+ the key.</p>
+
+ <h4><code>create_instance(credentials, image_id, opts)</code></h4>
+
+ <p>The <code>create_instance(...)</code> method should create within the cloud, a
+ new running instance based from an image identifier. The method should
+ return an <code>Instance</code> object representing the newly-created instance.</p>
+
+ <p>The <code>image_id</code> parameter must be non-nil. The <code>opts</code> hash may contain
+ keys for <code>hwp_id</code> and <code>realm_id</code>. If they are present, they should be
+ used for the creation of the instance. If they are not present,
+ reasonable defaults should be used. In the case of hardware profile,
+ one compatible with the image should be used as the default.</p>
+
+ <h4><code>reboot_instance(credentials, id)</code></h4>
+
+ <p>The <code>reboot_instance(...)</code> method should trigger a running instance to
+ be rebooted. This method has no return value.</p>
+
+ <h4><code>stop_instance(credentials, id)</code></h4>
+
+ <p>The <code>stop_instance(...)</code> method should trigger a running instance to
+ be stopped. This method has no return value. A cloud provider may
+ allow restarting an instance, or may not.</p>
+
+ <h4><code>destroy_instance(credentials, id)</code></h4>
+
+ <p>The <code>destroy_instance(...)</code> method should remove the instance from the
+ cloud provider, stopping it first, if necessary.</p>
+
+ <h4><code>instance_states()</code></h4>
+
+ <p>The <code>instance_states()</code> method should return an array/hash structure
+ representing the finite-state-machine for instances. Each state an
+ instance may be in should be an element in the returned array. Each
+ state itself is also an array with 2 members. The first member is the
+ name of the state, and the second member is a hash indicating valid
+ transitions.</p>
+
+ <p>The general format for the entire FSM structure is</p>
+
+ <pre><code>[
 [ :origin_state1, {
 :destination_state1=>:action1, 
 :destination_state2=>:action2, 
 } ],
 [ :origin_state2, {
 :destination_state3=>:action3, 
 :destination_state4=>:action4, 
 } ],
]
</code></pre>
+
+ <p>Valid states are</p>
+
+ <ul>
+ <li><strong><code>:begin</code></strong></li>
+ <li><strong><code>:pending</code></strong></li>
+ <li><strong><code>:running</code></strong></li>
+ <li><strong><code>:shutting_down</code></strong></li>
+ <li><strong><code>:stopped</code></strong></li>
+ <li><strong><code>:end</code></strong></li>
+ </ul>
+
+
+ <p>The <code>:begin</code> state is the state an instance is in immediate before
+ being created. The <code>:end</code> state is the state an instance is in
+ immediately after being destroyed.</p>
+
+ <p>Valid transition actions are</p>
+
+ <ul>
+ <li><strong><code>:stop</code></strong></li>
+ <li><strong><code>:start</code></strong></li>
+ <li><strong><code>:reboot</code></strong></li>
+ </ul>
+
+
+ <p>Additionally, to indicate a transition that may occur <em>without</em> an
+ action being triggered, the action **<code>:_auto_</code> may be used.</p>
+ </div>
+ </div>
+ </body>
+</html>