You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltacloud.apache.org by ma...@apache.org on 2012/06/25 17:05:57 UTC
svn commit: r1353588 [21/23] - in /deltacloud/trunk/site: ./ content/
content/Scripts/ content/assets/ content/assets/css/ content/assets/img/
content/assets/img/documentation_files/ content/assets/js/
content/assets/less/ content/css/ content/css/blue...
Modified: deltacloud/trunk/site/output/libdeltacloud/index.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/output/libdeltacloud/index.html?rev=1353588&r1=1353587&r2=1353588&view=diff
==============================================================================
--- deltacloud/trunk/site/output/libdeltacloud/index.html (original)
+++ deltacloud/trunk/site/output/libdeltacloud/index.html Mon Jun 25 15:05:02 2012
@@ -1,138 +1,96 @@
-<!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">
-<head>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<title>libdeltacloud: libdeltacloud main page</title>
-<link href="tabs.css" rel="stylesheet" type="text/css"/>
-<link href="search/search.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="search/search.js"></script>
-<link href="doxygen.css" rel="stylesheet" type="text/css"/>
-</head>
-<body onload='searchBox.OnSelectItem(0);'>
-<!-- Generated by Doxygen 1.7.4 -->
-<script type="text/javascript"><!--
-var searchBox = new SearchBox("searchBox", "search",false,'Search');
---></script>
-<div id="top">
-<div id="titlearea">
-<table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">libdeltacloud <span id="projectnumber">0.9</span></div>
- </td>
- </tr>
- </tbody>
-</table>
-</div>
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li class="current"><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="annotated.html"><span>Data Structures</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- <li id="searchli">
- <div id="MSearchBox" class="MSearchBoxInactive">
- <span class="left">
- <img id="MSearchSelect" src="search/mag_sel.png"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- alt=""/>
- <input type="text" id="MSearchField" value="Search" accesskey="S"
- onfocus="searchBox.OnSearchFieldFocus(true)"
- onblur="searchBox.OnSearchFieldFocus(false)"
- onkeyup="searchBox.OnSearchFieldChange(event)"/>
- </span><span class="right">
- <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
- </span>
- </div>
- </li>
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Libdeltacloud</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li class="active"><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Run API <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Use API <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/use-the-api">Using API</a></li>
+ <li><a href="/clients">Clients</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/how-to-contribute">How Can I Contribute?</a></li>
+ <li><a href="/getting-sources">Getting the Sources</a></li>
</ul>
- </div>
-</div>
-<div class="header">
- <div class="headertitle">
-<div class="title">libdeltacloud main page </div> </div>
-</div>
-<div class="contents">
-<div class="textblock"><h2><a class="anchor" id="Introduction"></a>
-Introduction</h2>
-<p>libdeltacloud is a library for accessing the deltacloud API through a convenient C library. </p>
-<h2><a class="anchor" id="api_abi_stability"></a>
-API and ABI stability</h2>
-<p>As of version 0.9, libdeltacloud is mostly API, but not ABI, stable. The difference between the two is subtle but important. A library that is ABI (Application Binary Interface) stable means that programs that use the library will not need to be modified nor re-compiled when a new version of the library comes out. A library that is API (Application Programming Interface) stable means that programs that use the library will not need to be modified, but may need to be re-compiled when a new version of the library comes out. That is because the sizes of structures in the library might change, and a mis-match between what the library thinks the size of a structure is and what the program thinks the size of a structure is is a recipe for disaster.</p>
-<p>Due to the magic of libtool versioning, programs built against an older version of libdeltacloud will refuse to run against a newer version of libdeltacloud if the size of the structures has changed. If this happens, then the program must be recompiled against the newer libdeltacloud. </p>
-<h2><a class="anchor" id="examples"></a>
-Examples</h2>
-<h3><a class="anchor" id="example1"></a>
-Connect to deltacloud</h3>
-<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include <stdio.h></span>
-<span class="preprocessor"> #include <stdlib.h></span>
-<span class="preprocessor"> #include <libdeltacloud/libdeltacloud.h></span>
-
- <span class="keywordtype">int</span> main()
- {
- <span class="keyword">struct </span><a class="code" href="structdeltacloud__api.html">deltacloud_api</a> api;
-
- <span class="keywordflow">if</span> (<a class="code" href="libdeltacloud_8c.html#ab4620eafb5a0553271962abb4d98a6c3">deltacloud_initialize</a>(&api, <span class="stringliteral">"http://localhost:3001/api"</span>, <span class="stringliteral">"mockuser"</span>,
- <span class="stringliteral">"mockpassword"</span>) < 0) {
- fprintf(stderr, <span class="stringliteral">"Failed to initialize libdeltacloud: %s\n"</span>,
- <a class="code" href="libdeltacloud_8c.html#ab683313c53fd582e744645f245cb527d">deltacloud_get_last_error_string</a>());
- <span class="keywordflow">return</span> 1;
- }
-
- <a class="code" href="libdeltacloud_8c.html#ac4d391aa694401e1b2a008a0aeda5a05">deltacloud_free</a>(&api);
- <span class="keywordflow">return</span> 0;
- }
-</pre></div> <h3><a class="anchor" id="example2"></a>
-List all running instances</h3>
-<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include <stdio.h></span>
-<span class="preprocessor"> #include <stdlib.h></span>
-<span class="preprocessor"> #include <libdeltacloud/libdeltacloud.h></span>
-
- <span class="keywordtype">int</span> main()
- {
- <span class="keyword">struct </span><a class="code" href="structdeltacloud__api.html">deltacloud_api</a> api;
- <span class="keyword">struct </span>deltacloud_instances *instances = NULL;
- <span class="keywordtype">int</span> ret = 2;
-
- <span class="keywordflow">if</span> (<a class="code" href="libdeltacloud_8c.html#ab4620eafb5a0553271962abb4d98a6c3">deltacloud_initialize</a>(&api, <span class="stringliteral">"http://localhost:3001/api"</span>, <span class="stringliteral">"mockuser"</span>,
- <span class="stringliteral">"mockpassword"</span>) < 0) {
- fprintf(stderr, <span class="stringliteral">"Failed to initialize libdeltacloud: %s\n"</span>,
- <a class="code" href="libdeltacloud_8c.html#ab683313c53fd582e744645f245cb527d">deltacloud_get_last_error_string</a>());
- <span class="keywordflow">return</span> 1;
- }
-
- <span class="keywordflow">if</span> (<a class="code" href="instance_8c.html#a29807d22a10e50d8c9c1d36cf8d417d4">deltacloud_get_instances</a>(&api, &instances) < 0) {
- fprintf(stderr, <span class="stringliteral">"Failed to get deltacloud instances: %s\n"</span>,
- <a class="code" href="libdeltacloud_8c.html#ab683313c53fd582e744645f245cb527d">deltacloud_get_last_error_string</a>());
- <span class="keywordflow">goto</span> cleanup;
- }
-
- <a class="code" href="instance_8c.html#a3e7352437d5da105134e43d08b67fb23">deltacloud_free_instance_list</a>(&instances);
-
- ret = 0;
-
- cleanup:
- <a class="code" href="libdeltacloud_8c.html#ac4d391aa694401e1b2a008a0aeda5a05">deltacloud_free</a>(&api);
- <span class="keywordflow">return</span> ret;
- }
-</pre></div> </div></div>
-<!-- window showing the filter options -->
-<div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
-<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a></div>
-
-<!-- iframe showing the search results (closed by default) -->
-<div id="MSearchResultsWindow">
-<iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
-</iframe>
-</div>
-
-<hr class="footer"/><address class="footer"><small>Generated on Thu Jun 23 2011 for libdeltacloud by 
-<a href="http://www.doxygen.org/index.html">
-<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
-</body>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api">REST API</a></li>
+ <li><a href="/drivers">Drivers API</a></li>
+ <li><a href="/libdeltacloud">C library libdeltacloud</a></li>
+ </ul>
+ </li>
+ <li><a href="#contact">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container">
+
+
+
+ <footer class="footer">
+ <p class="footer-right">
+ <img src="/assets/img/asf_logo_wide.png" alt="Apache Software
+ Foundation"/>
+ </p>
+ <p>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </p>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
</html>
Added: deltacloud/trunk/site/output/link-page.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/output/link-page.html?rev=1353588&view=auto
==============================================================================
--- deltacloud/trunk/site/output/link-page.html (added)
+++ deltacloud/trunk/site/output/link-page.html Mon Jun 25 15:05:02 2012
@@ -0,0 +1,154 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Example Link Page</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li class="active"><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Run API <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Use API <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/use-the-api.html">Using API</a></li>
+ <li><a href="/clients.html">Clients</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ <li><a href="/getting-sources.html">Getting the Sources</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ <li><a href="/libdeltacloud.html">C library libdeltacloud</a></li>
+ </ul>
+ </li>
+ <li><a href="#contact">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container">
+
+ <ul class="nav nav-list article-nav well">
+<li class="nav-header">
+ Content
+ </li>
+ <li><a href="#">Section 1</a></li>
+ <li><a href="#">Section 2</a></li>
+ <li><a href="#">Section 3</a></li>
+ <li><a href="#">Section 4</a></li>
+</ul><h1 id="a-first-level-header">A First Level Header</h1>
+
+<h2 id="a-second-level-header">A Second Level Header</h2>
+
+<p>Now is the time for all good men to come to
+the aid of their country. This is just a
+regular paragraph. Test of <a href="link-page/index.html">link</a>.</p>
+
+<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed iaculis rutrum
+augue, vel cursus erat hendrerit eget. Nam quis massa euismod eros laoreet
+auctor. Integer elementum velit ac enim semper volutpat. Donec ut arcu massa,
+ vel laoreet sapien. Fusce ultrices aliquet velit nec consectetur. Quisque erat
+ lorem, accumsan vel volutpat ac, laoreet ut quam. Ut neque arcu, adipiscing
+ nec iaculis ut, bibendum sit amet orci. Suspendisse potenti. Lorem ipsum dolor
+ sit amet, consectetur adipiscing elit. Vestibulum egestas risus ac nisi
+ blandit id auctor nisi pharetra.</p>
+
+<h2 id="a-second-level-header-1">A Second Level Header</h2>
+
+<p>Curabitur imperdiet ultrices sem quis facilisis. Ut dictum bibendum erat, et
+auctor dui rutrum nec. Cras facilisis libero nec nunc consequat id placerat
+metus suscipit. </p>
+
+<ul>
+<li>Nullam et <strong>pulvinar</strong> justo. <em>Fusce</em> lacinia adipiscing ultrices.</li>
+ <li>Donec lorem tortor, dictum ac rhoncus ac, mollis vel felis. In facilisis, sapien</li>
+ <li>id viverra vestibulum, est nisi lacinia augue, vitae tincidunt arcu urna vel</li>
+</ul><p>elit. Suspendisse eget libero sapien. Maecenas in ipsum magna, eget auctor
+sapien. Nullam lacus felis, molestie at pharetra sit amet, lobortis et est.
+Nullam quis magna turpis, ac suscipit dui.</p>
+
+<p>The quick brown fox jumped over the lazy
+dogâs back.</p>
+
+<figure><figcaption>Listing 1: Example in ruby.</figcaption><pre><code class="language-ruby">puts <span class="string"><span class="delimiter">"</span><span class="content">hello world</span><span class="delimiter">"</span></span>
+<span class="constant">DeltaCloud</span>.new(<span class="symbol">:url</span> => <span class="string"><span class="delimiter">'</span><span class="content">test</span><span class="delimiter">'</span></span>)</code></pre></figure><p>Etiam consequat velit ut erat vestibulum dapibus. Ut tempus, nunc sit amet
+laoreet condimentum, nisi orci laoreet urna, at vestibulum libero lacus ac erat.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed feugiat nulla id
+felis condimentum in tincidunt velit facilisis. Curabitur pulvinar lorem nisi,</p>
+
+<blockquote>
+ <p>imperdiet tincidunt est. Curabitur fermentum justo nec quam tincidunt
+pellentesque. Donec in felis ut nunc facilisis vehicula eu aliquet odio.
+Nunc ultricies ligula sed felis ultrices in viverra dolor imperdiet.
+Suspendisse cursus, felis ut hendrerit aliquam, ipsum massa gravida metus,
+sed pretium felis justo in nisi. Suspendisse ornare nunc vel dui mattis
+congue eu vel neque. Ut tempor urna sapien, id faucibus magna. Donec
+turpis odio, blandit in pretium quis, varius vulputate justo.</p>
+</blockquote>
+
+ <footer class="footer">
+ <p class="footer-right">
+ <img src="/assets/img/asf_logo_wide.png" alt="Apache Software
+ Foundation"/>
+ </p>
+ <p>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </p>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>
Added: deltacloud/trunk/site/output/load-balancers.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/output/load-balancers.html?rev=1353588&view=auto
==============================================================================
--- deltacloud/trunk/site/output/load-balancers.html (added)
+++ deltacloud/trunk/site/output/load-balancers.html Mon Jun 25 15:05:02 2012
@@ -0,0 +1,432 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Load balancers</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-transition.js"></script>
+ <script src="/assets/js/bootstrap-alert.js"></script>
+ <script src="/assets/js/bootstrap-modal.js"></script>
+ <script src="/assets/js/bootstrap-scrollspy.js"></script>
+ <script src="/assets/js/bootstrap-tab.js"></script>
+ <script src="/assets/js/bootstrap-tooltip.js"></script>
+ <script src="/assets/js/bootstrap-popover.js"></script>
+ <script src="/assets/js/bootstrap-button.js"></script>
+ <script src="/assets/js/bootstrap-collapse.js"></script>
+ <script src="/assets/js/bootstrap-carousel.js"></script>
+ <script src="/assets/js/bootstrap-typeahead.js"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client Libraries</a></li>
+ <li><a href="/command-tools.html">Command Line Tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container content">
+
+ <p><br></p>
+
+<div class="row">
+ <div class="span9">
+
+<h3 id="load">Load balancers</h3>
+
+<p>
+Load balancers allow distribution of ingress network traffic received by a specified IP address to a number of running instances. For example, a number of instances that are fulfilling the role of web servers can be attached to a single load balancer. It allows you to handle a large number of requests without influence on website performance.
+</p>
+
+<p>
+This collection is not supported by all back-end cloud providers and at present, it is implemented for the Gogrid and Amazon EC2 cloud drivers. A load balancer is launched into a specific realm. Only instances within this specific realm may be attached to the balancer. Each load balancer has
+</p>
+
+<ul>
+<li>a <strong>list of instances</strong>;</li>
+ <li>a <strong>public address</strong> representing the IP address that the balancer will respond on to client requests;</li>
+ <li>a <strong>created_at</strong> timestamp; and</li>
+ <li>a list of <strong>listeners</strong>.</li>
+</ul>
+<p>
+Each <strong>listener</strong> has a <strong>protocol</strong> (e.g. TCP), a <strong>load balancer port</strong> and an <strong>instance port</strong>. The load balancer represents the port on which the balancer accepts connections. The instance port represents the port on which network traffic is forwarded to instances in the <strong>instance list</strong>.
+</p>
+
+ </div>
+ <div class="span3">
+
+<ul class="nav nav-list well">
+<li class="nav-header">
+ REST API
+ </li>
+ <li><a href="rest-api.html">Introduction</a></li>
+ <li><a href="api-entry-point.html">API entry point</a></li>
+ <li><a href="compute-resources.html">Compute resources</a></li>
+ <ul class="nav nav-list">
+<li><a href="realms.html">Realms</a></li>
+ <li><a href="hardware-profiles.html">Hardware profiles</a></li>
+ <li><a href="images.html">Images</a></li>
+ <li><a href="instance-states.html">Instance states</a></li>
+ <li><a href="instances.html">Instances</a></li>
+ <li><a href="keys.html">Keys</a></li>
+ <li><a href="firewalls.html">Firewalls</a></li>
+ <li><a href="addresses.html">Addresses</a></li>
+ <li class="active"><a href="#load">Load balancers</a></li>
+ </ul>
+<li><a href="storage-resources.html">Storage resources</a></li>
+</ul>
+</div>
+</div>
+
+<p><br></p>
+
+<ul class="nav nav-pills">
+<li class="active"><a href="#tab1" data-toggle="tab">Get the details of all load balancers</a></li>
+ <li><a href="#tab2" data-toggle="tab">Get the details for a load balancer</a></li>
+ <li><a href="#tab3" data-toggle="tab">Create/delete a load balancer</a></li>
+ <li><a href="#tab4" data-toggle="tab">Register/unregister an instance</a></li>
+</ul><hr><div class="tab-content">
+ <div class="tab-pane active" id="tab1">
+
+
+<h4>Get the details of all load balancers</h4>
+
+<p>
+To retrieve details of all load balancers use call <strong>GET /api/load_balancers</strong>.
+</p>
+
+<p>
+Example request:
+</p>
+
+<pre>
+GET /api/load_balancers?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
+Host: localhost:3001
+Accept: */*
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+Date: Thu, 28 Jul 2011 13:37:19 GMT
+Content-Length: 1844
+
+<?xml version='1.0' encoding='utf-8' ?>
+<load_balancers>
+ <load_balancer href='http://localhost:3001/api/load_balancers/webtraffic-balancer' id='webtraffic-balancer'>
+ <actions>
+ <link href='http://localhost:3001/api/load_balancers/webtraffic-balancer' method='delete' rel='destroy' />
+ <link href='http://localhost:3001/api/load_balancers/webtraffic-balancer/register' method='post' rel='register' />
+ </actions>
+ <public_addresses>
+ <address>webtraffic-balancer-1306196965.us-east-1.elb.amazonaws.com</address>
+ </public_addresses>
+ <created_at>Thu Jul 28 13:29:52 UTC 2011</created_at>
+ <realm href='http://localhost:3001/api/realms/us-east-1a' id='us-east-1a'></realm>
+ <listeners>
+ <listener protocol='HTTP'>
+ <load_balancer_port>80</load_balancer_port>
+ <instance_port>3001</instance_port>
+ </listener>
+ </listeners>
+ <instances>
+ </instances>
+ </load_balancer>
+ <load_balancer href='http://localhost:3001/api/load_balancers/secure-site-balancer' id='secure-site-balancer'>
+ <actions>
+ <link href='http://localhost:3001/api/load_balancers/secure-site-balancer' method='delete' rel='destroy' />
+ <link href='http://localhost:3001/api/load_balancers/secure-site-balancer/register' method='post' rel='register' />
+ </actions>
+ <public_addresses>
+ <address>secure-site-balancer-1347100846.us-east-1.elb.amazonaws.com</address>
+ </public_addresses>
+ <created_at>Thu Jul 28 13:36:29 UTC 2011</created_at>
+ <realm href='http://localhost:3001/api/realms/us-east-1a' id='us-east-1a'></realm>
+ <listeners>
+ <listener protocol='HTTP'>
+ <load_balancer_port>443</load_balancer_port>
+ <instance_port>443</instance_port>
+ </listener>
+ </listeners>
+ <instances>
+ </instances>
+ </load_balancer>
+</load_balancers>
+</pre>
+
+ </div>
+ <div class="tab-pane" id="tab2">
+
+<h4>Get the details for a load balancer</h4>
+
+<p>To retrieve details for a specific load balancer use call <strong>GET /api/load_balancers/:id</strong>.</p>
+
+<p>Example request:</p>
+
+<pre>
+GET /api/load_balancers/secure-site-balancer?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
+Host: localhost:3001
+Accept: */*
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+Date: Thu, 28 Jul 2011 18:11:49 GMT
+Content-Length: 1361
+
+<?xml version='1.0' encoding='utf-8' ?>
+<load_balancer href='http://localhost:3001/api/load_balancers/secure-site-balancer' id='secure-site-balancer'>
+ <actions>
+ <link href='http://localhost:3001/api/load_balancers/secure-site-balancer' method='delete' rel='destroy' />
+ <link href='http://localhost:3001/api/load_balancers/secure-site-balancer/register' method='post' rel='register' />
+ </actions>
+ <public_addresses>
+ <address>secure-site-balancer-1347100846.us-east-1.elb.amazonaws.com</address>
+ </public_addresses>
+ <created_at>Thu Jul 28 13:36:29 UTC 2011</created_at>
+ <realm href='http://localhost:3001/api/realms/us-east-1a' id='us-east-1a'></realm>
+ <listeners>
+ <listener protocol='HTTP'>
+ <load_balancer_port>443</load_balancer_port>
+ <instance_port>443</instance_port>
+ </listener>
+ </listeners>
+ <instances>
+ <instance href='http://localhost:3001/api/instances/i-4f06b52e' id='i-4f06b52e'>
+ <link href='http://localhost:3001/api/load_balancers/secure-site-balancer/unregister?instance_id=i-4f06b52e' rel='unregister' />
+ </instance>
+ <instance href='http://localhost:3001/api/instances/i-d706b5b6' id='i-d706b5b6'>
+ <link href='http://localhost:3001/api/load_balancers/secure-site-balancer/unregister?instance_id=i-d706b5b6' rel='unregister' />
+ </instance>
+ </instances>
+</load_balancer>
+</pre>
+
+ </div>
+ <div class="tab-pane" id="tab3">
+
+<h4>Create a load balancer</h4>
+
+<p>
+To create a new load balancer use call <strong>POST /api/load_balancers</strong>. Clients must provide the load balancer <strong>name</strong>, the <strong>realm_id</strong> to which the balancer is applied, a <strong>listener_protocol</strong> which the balancer will respond to (one of <strong>HTTP</strong> or <strong>TCP</strong>), the <strong>listener_balancer_port</strong> which specifies the port that the load balancer will be expecting network traffic on and finally the <strong>listener_instance_port</strong> which specifies the port on which instances will be receiving network traffic forwarded by the load balancer. As with other operations in the Deltacloud API, parameters may be specified by a requesting client using multipart/form-data or as application/x-www-form-urlencoded data.
+</p>
+
+<p>Example request:</p>
+
+<pre>
+OST /api/load_balancers?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
+Host: localhost:3001
+Accept: */*
+Content-Length: 121
+Content-Type: application/x-www-form-urlencoded
+
+name=webtraffic-balancer&realm_id=us-east-1c&listener_protocol=HTTP&
+listener_balancer_port=80&listener_instance_port=3001
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 201 Created
+Content-Type: application/xml
+Date: Thu, 28 Jul 2011 13:30:05 GMT
+Content-Length: 884
+
+<?xml version='1.0' encoding='utf-8' ?>
+<load_balancer href='http://localhost:3001/api/load_balancers/webtraffic-balancer' id='webtraffic-balancer'>
+ <actions>
+ <link href='http://localhost:3001/api/load_balancers/webtraffic-balancer' method='delete' rel='destroy' />
+ <link href='http://localhost:3001/api/load_balancers/webtraffic-balancer/register' method='post' rel='register' />
+ </actions>
+ <public_addresses>
+ <address>webtraffic-balancer-1306196965.us-east-1.elb.amazonaws.com</address>
+ </public_addresses>
+ <created_at>Thu Jul 28 13:29:52 UTC 2011</created_at>
+ <realm href='http://localhost:3001/api/realms/us-east-1a' id='us-east-1a'></realm>
+ <listeners>
+ <listener protocol='HTTP'>
+ <load_balancer_port>80</load_balancer_port>
+ <instance_port>3001</instance_port>
+ </listener>
+ </listeners>
+ <instances>
+ </instances>
+</load_balancer>
+</pre>
+
+<h4>Delete a load balancer</h4>
+
+<p>To delete the specified load balancer from the back-end cloud provider use call <strong>DELETE /api/load_balancers/:id</strong>. The Deltacloud server will respond with <strong>HTTP 204 No Content</strong> for a succesful operation</p>
+
+<p>Example request:</p>
+
+<pre>
+DELETE /api/load_balancers/webtraffic-balancer?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
+Host: localhost:3001
+Accept: */*
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 204 No Content
+Date: Thu, 28 Jul 2011 13:23:33 GMT
+</pre>
+
+ </div>
+ <div class="tab-pane" id="tab4">
+
+<h4>Register an instance with a load balancer</h4>
+
+<p>
+To register a running instance with a specified load balancer use call <strong>POST /api/load_balancers/:id/register</strong>. Clients must provide the <strong>instance_id</strong> as a parameter to the request. The Deltacloud server will respond with a <strong>HTTP 204 No Content</strong> after a succesful operation. The Deltacloud server will accept client request parameters encoded as multipart/form-data or as application/x-www-form-urlencoded data.
+</p>
+
+<p>Example request:</p>
+
+<pre>
+POST /api/load_balancers/secure-site-balancer/register?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
+Host: localhost:3001
+Accept: */*
+Content-Length: 22
+Content-Type: application/x-www-form-urlencoded
+
+instance_id=i-4f06b52e
+</pre>
+
+Server response:
+
+<pre>
+HTTP/1.1 204 No Content
+Date: Thu, 28 Jul 2011 18:20:03 GMT
+</pre>
+
+<h4>Unreagister an instance from a load balancer</h4>
+
+<p>
+To unregister a specified instance from the given load balancer use call <strong>POST /api/load_balancers/:id/unregister</strong>. The client must supply the <strong>instance_id</strong> parameter to identify the instance, either as multipart/form-data or as application/x-www-form-urlencoded data.
+</p>
+
+<p>Example request:</p>
+
+<pre>
+POST /api/load_balancers/secure-site-balancer/unregister?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
+Host: localhost:3001
+Accept: */*
+Content-Length: 22
+Content-Type: application/x-www-form-urlencoded
+
+instance_id=i-4f06b52e
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 204 No Content
+Date: Thu, 28 Jul 2011 19:09:17 GMT
+</pre>
+
+ </div>
+</div>
+
+<p><a class="btn btn-inverse btn-large" style="float: right" href="storage-resources.html">Storage resources <i class="icon-arrow-right icon-white" style="vertical-align:baseline"> </i></a></p>
+
+<p><br></p>
+
+ <footer class="footer">
+ <p class="pull-right"><span class='icon-circle-arrow-up'> </span><a href="#">Back to top</a></p>
+ <div class='row'>
+ <div class='span3'>
+ <img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
+ </div>
+ <div class='span9'>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </div>
+ </div>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>
Added: deltacloud/trunk/site/output/rest-api.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/output/rest-api.html?rev=1353588&view=auto
==============================================================================
--- deltacloud/trunk/site/output/rest-api.html (added)
+++ deltacloud/trunk/site/output/rest-api.html Mon Jun 25 15:05:02 2012
@@ -0,0 +1,287 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>REST API</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-transition.js"></script>
+ <script src="/assets/js/bootstrap-alert.js"></script>
+ <script src="/assets/js/bootstrap-modal.js"></script>
+ <script src="/assets/js/bootstrap-scrollspy.js"></script>
+ <script src="/assets/js/bootstrap-tab.js"></script>
+ <script src="/assets/js/bootstrap-tooltip.js"></script>
+ <script src="/assets/js/bootstrap-popover.js"></script>
+ <script src="/assets/js/bootstrap-button.js"></script>
+ <script src="/assets/js/bootstrap-collapse.js"></script>
+ <script src="/assets/js/bootstrap-carousel.js"></script>
+ <script src="/assets/js/bootstrap-typeahead.js"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client Libraries</a></li>
+ <li><a href="/command-tools.html">Command Line Tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container content">
+
+ <p><br></p>
+
+<div class="row">
+ <div class="span9">
+
+<h3 id="rest">REST API</h3>
+
+<p>
+Apache Deltacloud is a REST-based (HATEOAS) cloud abstraction API. It enables management of resources in different IaaS clouds using a single API. There are back-end drivers communicating with each cloud provider's native API and the Deltacloud Core Framework provides the basis for implementing drivers to new IaaS clouds. Apache Deltacloud currently supports many back-end <a href="drivers.html#drivers">cloud providers</a>.
+</p>
+
+<p>
+With Deltacloud project, you don't have to limit yourself to a single cloud provider. Instead of taking care of a number of clouds, you are dealing with just one API abstraction.
+</p>
+
+<h3 id="collections">Collections</h3>
+
+<p style="margin-bottom:0px">
+The following terms describe abstractions used in the Apache Deltacloud API. Each collection represents an entity in the back-end provider cloud, such as a running virtual server or a server image. Please note that the list of supported collections may differ from cloud to cloud. Only the appropriate collections are exposed for a given back-end driver (e.g. the Microsoft Azure driver currently exposes only the Buckets collection).
+</p>
+
+ </div>
+ <div class="span3">
+
+<ul class="nav nav-list well">
+<li class="nav-header">
+ REST API
+ </li>
+ <li class="active"><a href="#rest">Introduction</a></li>
+ <ul class="nav nav-list">
+<li><a href="#collections">Collections</a></li>
+ <li><a href="#requests">Client requests</a></li>
+ <li><a href="#auth">Authentication</a></li>
+ <li><a href="#response">Server responses</a></li>
+ <li><a href="#conv">API conventions</a></li>
+ <li><a href="#stab">API stability</a></li>
+ <li><a href="#doc">Online documentation</a></li>
+ </ul>
+<li><a href="api-entry-point.html">API entry point</a></li>
+ <li><a href="compute-resources.html">Compute resources</a></li>
+ <li><a href="storage-resources.html">Storage resources</a></li>
+</ul>
+</div>
+</div>
+
+<dl class="dl dl-horizontal">
+<dt><h4>Realms</h4></dt>
+ <dd>
+ A distinct organizational unit within the back-end cloud, for exapmle a datacenter. A realm may but does not necessarily represent the geographical location of the compute resources which you access.
+ </dd>
+ <dt><h4>Instances</h4></dt>
+ <dd>
+ A realized virtual server, running in a given back-end cloud. Instances are instantiated from server images.
+ </dd>
+ <dt><h4>Images</h4></dt>
+ <dd>
+ Templates (virtual machine images) from which instances are created. Each image defines the root partition and initial storage for the instance operating system.
+ </dd>
+<dt><h4>Instance states</h4></dt>
+ <dd>
+ Instance states represent the instance lifecycle. at any time an instance is in one of states: start, pending, running, stopped, shutting_down, finished.
+ </dd>
+ <dt><h4>Keys</h4></dt>
+ <dd>
+ Keys represent credentials used to access a running instance. Keys can take the form of key (for example an RSA key) or of password (with username and password attributes).
+ </dd>
+ <dt><h4>Storage volume</h4></dt>
+ <dd>
+ A virtual storage device that can be attached to an instance and mounted by the OS.
+ </dd>
+ <dt><h4>Storage snapshot</h4></dt>
+ <dd>
+ Storage snapshots are copies, snapshots of a storage volume at a specified time.
+ </dd>
+ <dt><h4>Bucket</h4></dt>
+ <dd>
+ A container for data blobs. The organizational unit of a generic key ==> value based on data store (such as Rackspace CloudFiles or Amazon S3). Individual data items, blobs, are exposed as a subcollection under a bucket.
+ </dd>
+ <dt><h4>Blob</h4></dt>
+ <dd>
+ A generic binary data item that exists within a specified bucket (an object in Amazon S3 and Rackspace CloudFiles).
+ </dd>
+ <dt><h4>Address</h4></dt>
+ <dd>
+ Address represents an IP address. Depending on the back-end cloud provider, address can be public or private. Public address represents a unique, globally routable IP address, private address represents an address routable only within a private network.
+ </dd>
+ <dt><h4>Load Balancer</h4></dt>
+ <dd>
+ A load balancer allows a distribution of ingress network traffic received by a specified IP address to a number of instances.
+ </dd>
+ <dt><h4>Firewalls</h4></dt>
+ <dd>Sets of rules that govern the accessibility of a running instance over the public Internet.
+ </dd>
+ <dt><h4>Metrics</h4></dt>
+ <dd>
+ Metrics collection provides useful information about your cloud resources, e.g. CPU utilization or network throughput. It may be helpful for developers for better scaling and monitoring. The collection is currently supported only for Amazon EC2 cloud. It collects information from Amazon CloudWatch service.
+ </dd>
+
+
+<h3 id="requests">Client Requests</h3>
+
+<p>
+In accordance with REST principles, clients make requests through HTTP with the usual meanings assigned to the standard HTTP verbs GET, POST, PUT, and DELETE.
+</p>
+
+<p>
+Besides the generally accepted REST design principles, Apache Deltacloud follows the guidelines discussed in the Fedora Project <a href="http://fedoraproject.org/wiki/Cloud_APIs_REST_Style_Guide">Cloud APIs Rest Style Guide</a>.
+</p>
+
+<p>
+The URL space of the API is structured into collections of resources. The top level entities used in the Deltacloud API are: realms, images, instance states, instances, keys, storage volumes, storage snapshots, blob storage, hardware profiles and drivers.
+</p>
+
+<h3 id="auth">Authentication</h3>
+
+<p>
+The Deltacloud API server is stateless and does not keep any information about the current client. The Deltalcloud server does not store the credentials for the back-end cloud which the server is talking to. Instead, the server uses HTTP basic authentication and clients have to send the username/password for the back-end cloud on every request.
+</p>
+
+<p>
+The specifics of what needs to be sent varies from cloud to cloud; some cloud providers request a username and password for API access, the others use special-purpose API keys. Check the list of the <a href="drivers.html#credentials">credentials</a> to find out what kind of information a specific cloud provider expects.
+</p>
+
+<h3 id="response">Server responses</h3>
+
+<p>
+The server can respond to client requests in various formats. The appropriate response format is determined by HTTP content negotiation. The primary format is XML. The output is also available as JSON and as HTML (mostly for testing). Clients can also explicitly request a specific response format by including the <strong>format=</strong> request parameter (<strong>http://deltacloudserver.foo/api?format=xml</strong> or <strong>http://deltacloudserver.foo/api?format=json</strong>).
+</p>
+
+<p>
+In general (especially for the HTML interface), list operations such as <strong>GET /api/realms</strong> will provide a list of objects of this resource type with only brief details. Full details can be retrieved by making a request <strong>GET /api/realms/:id</strong> to the URL of the individual realm.
+</p>
+
+<h3 id="conv">API conventions</h3>
+
+<p>
+Any XML element which represents an object (such as an instance) has a <strong>href</strong> and an <strong>id</strong> attribute. The href attribute provides the URL at which object-specific actions can be performed (for example a GET action applied to the URL will return details of the object). The id provides an identifier of the object, which is unique within its collection (there is a unique id for each Instance, Image, Realm etc).
+</p>
+
+<p>
+Objects also have a human-readable name. The name is provided in a <code><name/></code> child element of the objectâs container tag.
+</p>
+
+<h3 id="stab">API stability and evolution</h3>
+
+<p>
+Every change to the API is made in a way that allows old clients to work against newer versions of the API server.
+</p>
+
+<p>
+You may come across the following changes in newer versions of the API:
+</p>
+
+<ul>
+<li>adding new collections, or supporting new operations on existing collections</li>
+ <li>adding optional parameters to existing operations</li>
+ <li>adding additional attributes and elements to the XML/JSON responses</li>
+</ul>
+<p>
+On the other hand, these changes would violate API stability and therefore they are not made:
+</p>
+
+<ul>
+<li>removing an operation on a collection</li>
+ <li>making an optional parameter for an operation mandatory</li>
+ <li>removing attributes or elements from XML responses</li>
+</ul>
+<h3 id="doc">Online documentation</h3>
+
+<p>
+You can access an automatically generated documentation on every server running the Deltacloud Core API service through the URL <a href="http://localhost:3001/api/docs/">http://localhost:3001/api/docs/</a>. The documentation is both available in HTML and XML, though the XML format is not part of this specification and may change in an incompatible way.
+</p>
+
+<a class="btn btn-inverse btn-large" style="float: right" href="api-entry-point.html">API entry point <i class="icon-arrow-right icon-white" style="vertical-align:baseline"> </i></a>
+
+<br>
+</dl>
+
+ <footer class="footer">
+ <p class="pull-right"><span class='icon-circle-arrow-up'> </span><a href="#">Back to top</a></p>
+ <div class='row'>
+ <div class='span3'>
+ <img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
+ </div>
+ <div class='span9'>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </div>
+ </div>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>
Added: deltacloud/trunk/site/output/rest-api/index.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/output/rest-api/index.html?rev=1353588&view=auto
==============================================================================
--- deltacloud/trunk/site/output/rest-api/index.html (added)
+++ deltacloud/trunk/site/output/rest-api/index.html Mon Jun 25 15:05:02 2012
@@ -0,0 +1,96 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>REST API</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li class="active"><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Run API <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Use API <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/use-the-api">Using API</a></li>
+ <li><a href="/clients">Clients</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/how-to-contribute">How Can I Contribute?</a></li>
+ <li><a href="/getting-sources">Getting the Sources</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api">REST API</a></li>
+ <li><a href="/drivers">Drivers API</a></li>
+ <li><a href="/libdeltacloud">C library libdeltacloud</a></li>
+ </ul>
+ </li>
+ <li><a href="#contact">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container">
+
+
+
+ <footer class="footer">
+ <p class="footer-right">
+ <img src="/assets/img/asf_logo_wide.png" alt="Apache Software
+ Foundation"/>
+ </p>
+ <p>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </p>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>
Added: deltacloud/trunk/site/output/ruby-client.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/output/ruby-client.html?rev=1353588&view=auto
==============================================================================
--- deltacloud/trunk/site/output/ruby-client.html (added)
+++ deltacloud/trunk/site/output/ruby-client.html Mon Jun 25 15:05:02 2012
@@ -0,0 +1,233 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>The Deltacloud Ruby Client</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-transition.js"></script>
+ <script src="/assets/js/bootstrap-alert.js"></script>
+ <script src="/assets/js/bootstrap-modal.js"></script>
+ <script src="/assets/js/bootstrap-scrollspy.js"></script>
+ <script src="/assets/js/bootstrap-tab.js"></script>
+ <script src="/assets/js/bootstrap-tooltip.js"></script>
+ <script src="/assets/js/bootstrap-popover.js"></script>
+ <script src="/assets/js/bootstrap-button.js"></script>
+ <script src="/assets/js/bootstrap-collapse.js"></script>
+ <script src="/assets/js/bootstrap-carousel.js"></script>
+ <script src="/assets/js/bootstrap-typeahead.js"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client Libraries</a></li>
+ <li><a href="/command-tools.html">Command Line Tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container content">
+
+ <p><br></p>
+
+<div class="row">
+ <div class="span8">
+
+<h3>Working with Deltacloud Ruby Client</h3>
+<p>Each type of a resource has an associated model. Where resource refers to other resources, natural navigation across the object model is possible. For example:</p>
+
+<pre>
+puts instance.image.name
+puts instance.hardware_profile.architecture
+</pre>
+
+<h4 id="realms">Listing realms</h4>
+<p>Retrieve a complete list of realms available to you:</p>
+
+<pre>realm = client.realms</pre>
+
+</div>
+ <div class="span4">
+
+<ul class="nav nav-list well">
+<li class="nav-header">Deltacloud Ruby Client</li>
+ <li class="active"><a href="#realms">Listing realms</a></li>
+ <li><a href="#profiles">Listing hardware profiles</a></li>
+ <li><a href="#images">Listing images</a></li>
+ <li><a href="#instances1">Listing instances</a></li>
+ <li><a href="#instances2">Lauching instances</a></li>
+ <li><a href="#instances3">Manipulating instances</a></li>
+ <li><a href="http://deltacloud.apache.org/ruby-client/doc/index.html">Client documentation</a></li>
+</ul>
+</div>
+</div>
+
+<p>You can access a specific realm by adding its identifier:</p>
+
+<pre>realm = client.realm( 'us' )</pre>
+
+<h4 id="profiles">Listing hardware profiles</h4>
+
+<p>Display a complete list of hardware profiles available for launching machines:</p>
+
+<pre>hwp = client.hardware_profiles</pre>
+
+<p>You can filter hardware profiles by architecture.</p>
+
+<pre>hardware_profiles = client.hardware_profiles( :architecture=>'x86_64' )</pre>
+
+<p>Retrieve a specific hardware profile by its identifier:</p>
+
+<pre>hardware_profile = client.hardware_profile( 'm1-small' )</pre>
+
+<h4 id="images">Listing images</h4>
+
+<p>Return a complete list of images:</p>
+
+<pre>images = client.images</pre>
+
+<p>Retrieve a list of images owned by the currently authenticated user:</p>
+
+<pre>images = client.images( :owner_id=>:self )</pre>
+
+<p>You can also retrieve a list of images visible to you but owned by a specific user:</p>
+
+<pre>images = client.images( :owner_id=>'daryll' )</pre>
+
+<p>Access a specific image by its identifier:</p>
+
+<pre>image = client.image( 'ami-8675309' )</pre>
+
+<h4 id="instances1">Listing instances</h4>
+
+<p>Get a list of all instances visible to you:</p>
+
+<pre>instances = client.instances</pre>
+
+<p>Retrieve a list of all running instances:</p>
+
+<pre>instances = client.instances( :state =>:running )</pre>
+
+<p>Look up the first instance in the list:</p>
+
+<pre>instance = client.instances.first</pre>
+
+<p>Find a specific instance by its identifier:</p>
+
+<pre>instance = client.instance( 'i-90125' )</pre>
+
+<h4 id="instances2">Launching instances</h4>
+
+<p>Launch an instance using an image identifier:</p>
+
+<pre>instance = client.create_instance(image_id)</pre>
+
+<p>You may specify a hardware profile:</p>
+
+<pre>instance = client.create_instance(image_id, :hwp_id => 'm1-small')</pre>
+
+<p>To create new instance, you can also use the 'user_name' feature:</p>
+
+<pre>instance = client.create_instance(image_id, :name => 'myinst1')</pre>
+
+<h4 id="instances3">Manipulating instances</h4>
+
+<p>Start an instance:</p>
+
+<pre>instance.start!</pre>
+
+<p>Execute the 'reboot' operation:</p>
+
+<pre>instance.reboot!</pre>
+
+<p>Destroy an instance:</p>
+
+<pre>instance.destroy!</pre>
+
+<p><br></p>
+
+<p>For more details on Deltacloud Ruby client see the full <a href="http://deltacloud.apache.org/ruby-client/doc/index.html">documentation</a>.</p>
+
+<p><a class="btn btn-inverse btn-large" style="float: right" href="usage.html#clients"><i class="icon-arrow-left icon-white" style="vertical-align:baseline"> </i> Back</a></p>
+
+<p><br></p>
+
+ <footer class="footer">
+ <p class="pull-right"><span class='icon-circle-arrow-up'> </span><a href="#">Back to top</a></p>
+ <div class='row'>
+ <div class='span3'>
+ <img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
+ </div>
+ <div class='span9'>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </div>
+ </div>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>
Added: deltacloud/trunk/site/output/ruby.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/output/ruby.html?rev=1353588&view=auto
==============================================================================
--- deltacloud/trunk/site/output/ruby.html (added)
+++ deltacloud/trunk/site/output/ruby.html Mon Jun 25 15:05:02 2012
@@ -0,0 +1,116 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>The Deltacloud Ruby Client</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Clients</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ <li><a href="/getting-sources.html">Getting the Sources</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container">
+
+ <p><br></p>
+
+<p>Installing the Deltacloud client also gives you the <strong>deltacloudc</strong> command line tool. This executable makes use of the Deltacloud client library to speak to the Deltacloud server using the <a href="rest-api.html">REST API</a>. This allows you to to control your IAAS cloud infrastructure from the command line. If you are familiar with linux scripting, you can knock up a bash script in no time to automate your cloud infrastructure tasks.The general usage pattern for deltacloudc is:</p><p>
+
+</p><pre>$ deltacloudc collection operation [options]</pre>
+
+<dl class="dl-horizontal">
+<dt><h6>collection</h6></dt>
+ <dd>
+ refers to the Deltacloud object collections, such as Instances, Images, Buckets, Realms etc, as described in greater detail in the REST API
+ </dd>
+ <dt><h6>operation</h6></dt>
+ <dd>nanoc
+ is collection dependant. All collections respond to 'index' and 'show' operations (retrieve details on all objects in a given collection or on a specific object, respectively); some collections respond to 'create' and 'destroy' operations. The instances collection (realised virtual servers) responds to operations for managing the instance lifecycle, such as 'stop', 'reboot' etc.
+ </dd>
+ <dt><h6>options</h6></dt>
+ <dd>
+ are listed by invoking <strong>deltacloudc -h</strong> One important option is <strong>-u</strong>, with which you specify the API_URL, where the Deltacloud server is running. The API_URL takes the form <strong>http://[user]:[password]@[api_url]:[port]/[api]</strong> (examples follow). Alternatively, rather than having to supply the API_URL for every invocation of <strong>deltacloudc</strong> you have the choice of setting the API_URL environment variable (e.g., export API_URL=http://mockuser:mockpassword@localhost:3001/api). A listing of the credentials you need to provide for each back-end cloud provider is available here.
+ </dd>
+</dl>
+
+ <footer class="footer">
+ <p class="footer-right">
+ <img src="/assets/img/asf_logo_wide.png" alt="Apache Software
+ Foundation"/>
+ </p>
+ <p>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </p>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>
Added: deltacloud/trunk/site/output/run-deltacloud-server.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/output/run-deltacloud-server.html?rev=1353588&view=auto
==============================================================================
--- deltacloud/trunk/site/output/run-deltacloud-server.html (added)
+++ deltacloud/trunk/site/output/run-deltacloud-server.html Mon Jun 25 15:05:02 2012
@@ -0,0 +1,194 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Run the Deltacloud server</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-transition.js"></script>
+ <script src="/assets/js/bootstrap-alert.js"></script>
+ <script src="/assets/js/bootstrap-modal.js"></script>
+ <script src="/assets/js/bootstrap-scrollspy.js"></script>
+ <script src="/assets/js/bootstrap-tab.js"></script>
+ <script src="/assets/js/bootstrap-tooltip.js"></script>
+ <script src="/assets/js/bootstrap-popover.js"></script>
+ <script src="/assets/js/bootstrap-button.js"></script>
+ <script src="/assets/js/bootstrap-collapse.js"></script>
+ <script src="/assets/js/bootstrap-carousel.js"></script>
+ <script src="/assets/js/bootstrap-typeahead.js"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client Libraries</a></li>
+ <li><a href="/command-tools.html">Command Line Tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container content">
+
+ <p><br></p>
+<h3> Quick-start guide</h3>
+<p>This guide focuses on a linux environment. Some of the Deltacloud developers are running recent versions of <a href="http://fedoraproject.org/">Fedora</a>. However, you should be able to install Deltacloud on any OS that supports Ruby. If you are having any problems with installation, please <a href="contact.html">let us know</a>, we'd love to hear from you!</p>
+
+<h3>Running the Deltacloud server</h3>
+<p>Start the server by typing <strong>deltacloudd -i driver_id</strong>.</p>
+<p>The <strong>driver_id</strong> is the name of the cloud provider that you have an account with, for example <code>deltacloudd -i ec2</code>.</p>
+<p>If you don't yet have an account with a cloud provider, you can still try the Deltacloud mock driver:</p>
+<pre>deltacloudd -i mock</pre>
+<p>This will start the Deltacloud server on your local machine with the mock driver, accepting connections on port 3001 (default). From version 0.4.0 of Deltacloud, you can use the '-l' flag to see all available <strong>driver_ids</strong> that can be used with the <strong>deltacloudd</strong> executable:</p>
+<pre>
+$ deltacloudd -l
+
+Available drivers:
+* condor
+* vsphere
+* opennebula
+* eucalyptus
+* rhevm
+* sbc
+* azure
+* gogrid
+* mock
+* rackspace
+* rimuhosting
+* terremark
+* ec2
+</pre>
+
+<h3>Deltacloud HTML interface</h3>
+<p>After you start the server, you are ready to use the Deltacloud HTML interface.</p>
+<p>Open the address <strong>http://localhost:3001/api</strong> in your web browser:</p>
+
+<p>To display the XML output from the server in the browser, append <strong>format=xml</strong> to each URL. On Webkit based browsers like Safari, you might need to instruct the server explicitly to <a href="http://www.gethifi.com/blog/webkit-team-admits-accept-header-error">return HTML</a>. Do this by appending <strong>format=html</strong> to each URL.</p>
+
+<p>Your browser will prompt you for <a href="drivers.html#credentials">credentials</a> when you invoke an operation that requires authentication.</p>
+
+<p>The '-h' flag will list all available options for <strong>deltacloudd</strong>. For example, to start the Deltacloud server with the Rackspace driver on <strong>port 10000</strong> you can use:</p>
+
+<pre>$ deltacloudd -i rackspace -p 10000</pre>
+
+<p>If you want to install the server on another machine and make Deltacloud available on your local network, you need to bind the Deltacloud server to an address other than 'localhost' (default). To start the server use the IP address of a machine where you installed and started Deltacloud. For instance:</p>
+
+<pre>$ deltacloudd -i ec2 -p 5000 -r 192.168.10.200</pre>
+
+<p>This will make the Deltacloud server available at the address <strong>http://192.168.10.200:5000/api.</strong> Instead of IP address you can also use the hostname to start the server on another machine.</p>
+
+<h3>Using CIMI</h3>
+
+<p>
+To use <a href="http://dmtf.org/standards/cloud">CIMI</a>, first, go to the direcotry <strong>~/deltacloud/server/bin</strong> and start the Deltacloud server in the background:
+</p>
+
+<pre>
+./deltacloudd -i mock --cimi &
+</pre>
+
+<p>
+Then go to the directory <strong>~/deltacloud/clients/cimi</strong> and start the CIMI client server in the background:
+</p>
+
+<pre>
+bin/start -u http://localhost:3001/cimi -r <your_server_host_name> &
+</pre>
+
+<p>
+Use the -r option to make your client accessible from other machines different from the machine on which you are running both servers.
+</p>
+
+<p>
+If there are some problems when you start up the servers, you may have missing dependencies. Check the <a href="install-deltacloud.html#gem-list">RubyGems list</a> with the list above and make sure you don't have anything missing. If there are no problems with starting the servers, access the application using your browser by following URL:
+</p>
+
+<pre>
+http://<your_server_host_name>:4001/cimi
+</pre>
+
+<p>
+The browser will ask for credentials. To log in use mockuser and mockpassword as user ID and password.
+</p>
+
+<p><a class="btn btn-inverse btn-large" style="float: right" href="usage.html">Use Deltacloud</a></p>
+
+<p><br></p>
+
+ <footer class="footer">
+ <p class="pull-right"><span class='icon-circle-arrow-up'> </span><a href="#">Back to top</a></p>
+ <div class='row'>
+ <div class='span3'>
+ <img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
+ </div>
+ <div class='span9'>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </div>
+ </div>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>
Added: deltacloud/trunk/site/output/run-deltacloud-server/index.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/output/run-deltacloud-server/index.html?rev=1353588&view=auto
==============================================================================
--- deltacloud/trunk/site/output/run-deltacloud-server/index.html (added)
+++ deltacloud/trunk/site/output/run-deltacloud-server/index.html Mon Jun 25 15:05:02 2012
@@ -0,0 +1,96 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Run the Deltacloud server</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li class="active"><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Run API <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Use API <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/use-the-api">Using API</a></li>
+ <li><a href="/clients">Clients</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/how-to-contribute">How Can I Contribute?</a></li>
+ <li><a href="/getting-sources">Getting the Sources</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api">REST API</a></li>
+ <li><a href="/drivers">Drivers API</a></li>
+ <li><a href="/libdeltacloud">C library libdeltacloud</a></li>
+ </ul>
+ </li>
+ <li><a href="#contact">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container">
+
+
+
+ <footer class="footer">
+ <p class="footer-right">
+ <img src="/assets/img/asf_logo_wide.png" alt="Apache Software
+ Foundation"/>
+ </p>
+ <p>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </p>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>
Added: deltacloud/trunk/site/output/run-the-api.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/output/run-the-api.html?rev=1353588&view=auto
==============================================================================
--- deltacloud/trunk/site/output/run-the-api.html (added)
+++ deltacloud/trunk/site/output/run-the-api.html Mon Jun 25 15:05:02 2012
@@ -0,0 +1,98 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Run the API</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client libraries</a></li>
+ <li><a href="/command-tools.html">Command line tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting the Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container">
+
+
+
+ <footer class="footer">
+ <p class="footer-right">
+ <img src="/assets/img/asf_logo_wide.png" alt="Apache Software
+ Foundation"/>
+ </p>
+ <p>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </p>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>