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 2013/03/06 23:09:18 UTC
[5/5] git commit: SITE: addresses DTACLOUD-478,
DTACLOUD-479 and removes crud
Updated Branches:
refs/heads/master 422ca9f49 -> c7f4d0226
SITE: addresses DTACLOUD-478, DTACLOUD-479 and removes crud
https://issues.apache.org/jira/browse/DTACLOUD-479
https://issues.apache.org/jira/browse/DTACLOUD-478
Project: http://git-wip-us.apache.org/repos/asf/deltacloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/deltacloud/commit/c7f4d022
Tree: http://git-wip-us.apache.org/repos/asf/deltacloud/tree/c7f4d022
Diff: http://git-wip-us.apache.org/repos/asf/deltacloud/diff/c7f4d022
Branch: refs/heads/master
Commit: c7f4d022681667730371b796b63c94d321d12fa4
Parents: 422ca9f
Author: marios <ma...@redhat.com>
Authored: Fri Mar 1 18:16:00 2013 +0200
Committer: marios <ma...@redhat.com>
Committed: Thu Mar 7 00:03:19 2013 +0200
----------------------------------------------------------------------
site/content/about.md | 2 +-
site/content/command-tools.md | 2 +-
site/content/drivers.md | 35 +-
site/layouts/partials/default/nav.html | 2 +-
site/output/#about.md# | 41 -
site/output/#api-entry-point.md# | 227 ------
site/output/#blob-storage.md# | 456 -----------
site/output/#credentials.md# | 1 -
site/output/#getting-sources.md# | 79 --
site/output/#how-to-contribute.md# | 94 ---
site/output/#images.md# | 286 -------
site/output/#index.md# | 77 --
site/output/#instance-states.md# | 126 ---
site/output/#instances.md# | 630 ---------------
site/output/#keys.md# | 226 ------
site/output/#load-balancers.md# | 317 --------
site/output/#rest-api.md# | 184 -----
site/output/#run-deltacloud-server.md# | 50 --
site/output/#send-patch.md# | 243 ------
site/output/#storage-resources.md# | 333 --------
site/output/#storage-snapshots.md# | 185 -----
site/output/#usage.md# | 135 ---
site/output/#write-new-driver.md# | 140 ----
site/output/#writing-tests.md# | 57 --
site/output/about.html | 29 +-
site/output/addresses.html | 30 +-
site/output/api-docs.html | 3 +-
site/output/api-entry-point.html | 83 +--
site/output/blob-storage.html | 23 +-
site/output/cimi-curl.html | 17 +-
site/output/cimi-curl/cimi-curl-machines.html | 31 +-
.../cimi-curl/cimi-curl-resource_metadata.html | 13 +-
site/output/cimi-curl/cimi-curl-volumes.html | 30 +-
site/output/cimi-rest.html | 19 +-
site/output/cimi-rest/cimi-rest-collections.html | 48 +-
site/output/cimi-rest/cimi-rest-entry-point.html | 12 +-
.../cimi-rest/cimi-rest-machine-configs.html | 25 +-
.../output/cimi-rest/cimi-rest-machine-images.html | 31 +-
.../cimi-rest/cimi-rest-machine-templates.html | 25 +-
.../cimi-rest/cimi-rest-resource-metadata.html | 162 ++--
.../output/cimi-rest/cimi-rest-volume-configs.html | 28 +-
site/output/cimi-rest/cimi-rest-volume-images.html | 28 +-
.../cimi-rest/cimi-rest-volume-templates.html | 28 +-
site/output/cimi-rest/cimi-rest-volumes.html | 28 +-
site/output/clients.html | 3 +-
site/output/command-tools.html | 20 +-
site/output/compute-resources.html | 12 +-
site/output/contact.html | 2 +-
site/output/contribute.html | 3 +-
site/output/credentials.html | 67 +-
site/output/curl-examples.html | 17 +-
site/output/download.html | 26 +-
site/output/drivers.html | 235 +++---
site/output/firewalls.html | 28 +-
site/output/getting-sources.html | 3 +-
site/output/hardware-profiles.html | 15 +-
site/output/how-to-contribute.html | 9 +-
site/output/images.html | 23 +-
site/output/index.html | 19 +-
site/output/install-deltacloud.html | 9 +-
site/output/instance-states.html | 83 +--
site/output/instances.html | 91 +--
site/output/join-deltacloud.html | 3 +-
site/output/keys.html | 23 +-
site/output/libdeltacloud.html | 3 +-
site/output/link-page.html | 154 ----
site/output/load-balancers.html | 23 +-
site/output/rest-api.html | 18 +-
site/output/ruby-client.html | 8 +-
site/output/ruby.html | 116 ---
site/output/run-deltacloud-server.html | 3 +-
site/output/run-the-api.html | 98 ---
site/output/send-patch.html | 21 +-
site/output/storage-resources.html | 27 +-
site/output/storage-snapshots.html | 24 +-
site/output/supported-providers.html | 174 ++---
site/output/supproted-providers.html | 98 ---
site/output/usage.html | 14 +-
site/output/use-the-api.html | 3 +-
site/output/write-new-driver.html | 34 +-
site/output/writing-tests.html | 166 ----
81 files changed, 760 insertions(+), 5536 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/content/about.md
----------------------------------------------------------------------
diff --git a/site/content/about.md b/site/content/about.md
index 2d6c6f6..86fea6e 100644
--- a/site/content/about.md
+++ b/site/content/about.md
@@ -31,7 +31,7 @@ title: About
<br/>
<h3>How does Deltacloud work?</h3>
<br/>
-<p>Deltacloud contains a cloud abstraction API - whether the <a href="/rest-api.html">Deltacloud</a> classic API, the DMTF <a href="/cimi-rest.html">CIMI API</a> or even the EC2 API. The API works as a wrapper around a large number of clouds, abstracting their differences. For every cloud <a href="/supported-providers.html" rel="tooltip" title="currently supported providers">provider</a> there is a driver "speaking" that cloud provider's native API, freeing you from dealing with the particulars of each cloud's API.</p>
+<p>Deltacloud contains a cloud abstraction API - whether the <a href="/rest-api.html">Deltacloud</a> classic API, the DMTF <a href="/cimi-rest.html">CIMI API</a> or even the EC2 API. The API works as a wrapper around a large number of clouds, abstracting their differences. For every cloud <a href="/drivers.html#drivers" rel="tooltip" title="currently supported providers">provider</a> there is a driver "speaking" that cloud provider's native API, freeing you from dealing with the particulars of each cloud's API.</p>
<p>Install Deltacloud and start the <strong>deltacloudd</strong> daemon server. You can use your favourite HTTP client to talk to the server using the <a href="/rest-api.html">Deltacloud REST API</a>, the DMTF <a href="/cimi-rest.html">CIMI API</a> or even the EC2 API. Deltacloud even comes with an HTML interface so you can simply use your web browser to control your cloud infrastructure straight out of the box. The HTML interface is written with the <a href="http://jquerymobile.com/">jQuery mobile</a> framework, so it is compatible with your mobile or tablet devices.</p>
<br/>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/content/command-tools.md
----------------------------------------------------------------------
diff --git a/site/content/command-tools.md b/site/content/command-tools.md
index 90670a6..3c3f8d6 100644
--- a/site/content/command-tools.md
+++ b/site/content/command-tools.md
@@ -36,7 +36,7 @@ The deltacloud core developers use (almost exclusively) <a href="http://curl.hax
</dd>
<dt>Options</dt>
<dd>
- are listed by invoking <strong>deltacloudc -h</strong>. The important option is <strong>-u</strong>, which specifies the API_URL, where the Deltacloud server is running. The API_URL takes the form of <strong>http://[user]:[password]@[api_url]:[port]/[api]</strong>. Alternatively, you can set the API_URL environment variable (e.g., export API_URL=http://mockuser:mockpassword@localhost:3001/api). If your username or your password contains special characters, it's necessary to use options <strong>-U</strong> and <strong>-P</strong> in addition to the option <strong>-u</strong>. Check the <a href="/supported-providers.html#credentials"> list of credentials</a> you need for each back-end cloud provider.
+ are listed by invoking <strong>deltacloudc -h</strong>. The important option is <strong>-u</strong>, which specifies the API_URL, where the Deltacloud server is running. The API_URL takes the form of <strong>http://[user]:[password]@[api_url]:[port]/[api]</strong>. Alternatively, you can set the API_URL environment variable (e.g., export API_URL=http://mockuser:mockpassword@localhost:3001/api). If your username or your password contains special characters, it's necessary to use options <strong>-U</strong> and <strong>-P</strong> in addition to the option <strong>-u</strong>. Check the <a href="/drivers.html#credentials"> list of credentials</a> you need for each back-end cloud provider.
</dd>
</dl>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/content/drivers.md
----------------------------------------------------------------------
diff --git a/site/content/drivers.md b/site/content/drivers.md
index 0fc270f..33f61b3 100644
--- a/site/content/drivers.md
+++ b/site/content/drivers.md
@@ -275,6 +275,20 @@ The driver and provider can be selected through the request headers <strong> X-D
<td style="text-align:center">yes</td>
<td style="text-align:center">yes</td>
</tr>
+ <tr>
+ <td class='provider'>
+ <strong>DigitalOcean</strong>
+ </td>
+ <td style="text-align:center">yes</td>
+ <td style="text-align:center">yes</td>
+ <td style="text-align:center">yes</td>
+ <td style="text-align:center">yes</td>
+ <td style="text-align:center">yes</td>
+ <td style="text-align:center">yes</td>
+ <td style="text-align:center">yes</td>
+ <td style="text-align:center">yes</td>
+ <td style="text-align:center">yes</td>
+ </tr>
</tbody>
</table>
@@ -361,6 +375,17 @@ The driver and provider can be selected through the request headers <strong> X-D
<td style="text-align:center">yes</td>
<td style="text-align:center">yes</td>
</tr>
+ <tr>
+ <td class='provider'>
+ <strong>Openstack object-store (swift)</strong>
+ </td>
+ <td style="text-align:center">yes</td>
+ <td style="text-align:center">yes</td>
+ <td style="text-align:center">yes</td>
+ <td style="text-align:center">yes</td>
+ <td style="text-align:center">yes</td>
+ <td style="text-align:center">yes</td>
+ </tr>
</tbody>
</table>
<br/>
@@ -536,7 +561,15 @@ The following table gives details about the credentials that must be provided fo
<td>Password</td>
<td></td>
</tr>
-
+ <tr>
+ <td>
+ <strong>DigitalOcean</strong>
+ </td>
+ <td>digitalocean</td>
+ <td>Client Key</td>
+ <td>API Key</td>
+ <td>Obtain these credentials from the <a href="https://www.digitalocean.com/api_access">API access</a> page of your digitalocean account.</td>
+ </tr>
</tbody>
</table>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/layouts/partials/default/nav.html
----------------------------------------------------------------------
diff --git a/site/layouts/partials/default/nav.html b/site/layouts/partials/default/nav.html
index ccf0f56..7198a41 100644
--- a/site/layouts/partials/default/nav.html
+++ b/site/layouts/partials/default/nav.html
@@ -4,7 +4,7 @@
<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>
+ <li><a href="/drivers.html#drivers">Supported Providers</a></li>
</ul>
</li>
<li><a href="/download.html">Download</a></li>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/output/#about.md#
----------------------------------------------------------------------
diff --git a/site/output/#about.md# b/site/output/#about.md#
deleted file mode 100644
index 18e4457..0000000
--- a/site/output/#about.md#
+++ /dev/null
@@ -1,41 +0,0 @@
----
-site_name: Deltacloud API
-title: About
----
-<div class="row">
-
-<div class="span4">
-
-<br/>
-
-<h2>About Deltacloud</h2>
-<p>Deltacloud provides backward compatibility across versions and long-term stability for scripts, tools and applications. Using single API Deltacloud enables management of resources in different clouds.</p>
-
-<p>Start an instance on an internal cloud, then with the same code start another on EC2 or RHEV-M.</p>
-</div>
-
-the API server and drivers necessary for connecting to cloud providers
-<br/>
-
-<div class="span8">
- <img src="/assets/img/diagram-soa.png" alt="Deltacloud API SOA diagram" align="center"/>
-</div>
-
-<div class="span12">
-
-<br/>
-<br/>
-<h2>How does Deltacloud work?</h2>
-<p>Deltacloud contains a cloud abstraction API. The API works as a wrapper around a large number of clouds, abstracting their differences. For every <a href="/supported-providers.html" rel="tooltip" title="currently supported providers">provider</a> there is a driver "speaking" cloud provider's native API. It frees you from dealing with the particulars of each cloud's API.</p>
-
-<p>Install Deltacloud and start the <strong>deltacloudd</strong> daemon server. You can use your favourite HTTP client to talk to the server using the Deltacloud REST API. Deltacloud even comes with a HTML interface so you can simply use your web browser to control your cloud infrastructure straight out of the box.</p>
-<br/>
-
-<img src="/assets/img/deltacloud_concept.gif" alt="Deltacloud concept scheme"/>
-
-<br/>
-
-<a class="btn btn-inverse btn-large" style="float: right" href="/install-deltacloud.html">Get Deltacloud</a>
-
-</div>
-</div>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/output/#api-entry-point.md#
----------------------------------------------------------------------
diff --git a/site/output/#api-entry-point.md# b/site/output/#api-entry-point.md#
deleted file mode 100644
index 9e40172..0000000
--- a/site/output/#api-entry-point.md#
+++ /dev/null
@@ -1,227 +0,0 @@
----
-site_name: Deltacloud API
-title: API entry point
----
-<br/>
-
-<div class="row">
- <div class="span9">
-
-<h3 id="api-entry">The API entry point</h3>
-
-<p>
-Any part of the official API can be reached through the main entry point, by default <a href="http://localhost:3001/api">http://localhost:3001/api</a>. The entry point lists the resources for the current cloud provider, which the server knows about. For example, for the Amazon EC2 driver these are:
-</p>
-
-<ul style="margin-bottom:0px">
-<li>instances</li>
-<li>instance states</li>
-<li>images</li>
-<li>realms</li>
-</ul>
-
- </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 class="active"><a href="#api-entry">API entry point</a></li>
- <ul class="nav nav-list">
- <li><a href="#feature">Features</a></li>
- </ul>
- <li><a href="/compute-resources.html">Compute resources</a></li>
- <li><a href="/storage-resources.html">Storage resources</a></li>
-</ul>
-
- </div>
-</div>
-
-<ul style="margin-top:0px">
-<li>hardware profiles</li>
-<li>keys</li>
-<li>buckets</li>
-<li>storage volumes</li>
-<li>storage snapshots</li>
-<li>load balancers</li>
-<li>addresses</li>
-<li>firewalls</li>
-</ul>
-
-<p>Example request:</p>
-
-<pre>
-GET /api?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
-Content-Length: 1439
-
-<api driver='ec2' version='0.3.0'>
- <link href='http://localhost:3001/api/instance_states' rel='instance_states'>
- </link>
- <link href='http://localhost:3001/api/drivers' rel='drivers'>
- </link>
- <link href='http://localhost:3001/api/addresses' rel='addresses'>
- </link>
- <link href='http://localhost:3001/api/hardware_profiles' rel='hardware_profiles'>
- </link>
- <link href='http://localhost:3001/api/firewalls' rel='firewalls'>
- </link>
- <link href='http://localhost:3001/api/storage_volumes' rel='storage_volumes'>
- </link>
- <link href='http://localhost:3001/api/images' rel='images'>
- <feature name='owner_id'>
- </feature>
- </link>
- <link href='http://localhost:3001/api/realms' rel='realms'>
- </link>
- <link href='http://localhost:3001/api/buckets' rel='buckets'>
- <feature name='bucket_location'>
- </feature>
- </link>
- <link href='http://localhost:3001/api/instances' rel='instances'>
- <feature name='user_data'>
- </feature>
- <feature name='authentication_key'>
- </feature>
- <feature name='firewalls'>
- </feature>
- <feature name='instance_count'>
- </feature>
- <feature name='attach_snapshot'>
- </feature>
- </link>
- <link href='http://localhost:3001/api/storage_snapshots' rel='storage_snapshots'>
- </link>
- <link href='http://localhost:3001/api/keys' rel='keys'>
- </link>
- <link href='http://localhost:3001/api/load_balancers' rel='load_balancers'>
- </link>
-</api>
-</pre>
-
-<p>
-Some implementations for the Apache Deltacloud API may not support all resource types defined by API. For example, a Deltacloud instance pointing at a storage-only service will not expose compute resources like instances and hardware profiles.
-</p>
-
-<h3 id="feature">Features</h3>
-
-<p>
-The Apache Deltacloud API defines the standard behavior and semantics for each of the resource types as a baseline for any API implementation. It is often desirable to enhance standard API behavior with specific features. The API also defines all features that can be supported by the API implementation - each of them has a fixed predefined meaning. For example, the feature user_name indicates that a user-specified name can be assigned to an instance when it is created. Features are advertised in the top-level entry point as illustrated below:
-</p>
-
-<pre>
-<api driver='mock' version='0.3.0'>
- ...
- <link href='http://localhost:3001/api/instances' rel='instances'>
- <feature name='hardware_profiles'></feature>
- <feature name='user_name'></feature>
- <feature name='authentication_key'></feature>
- </link>
- ...
-</api>
-</pre>
-
-<p>
-These features are available to each collection in the Deltacloud API:
-</p>
-
-<table class="table table-striped table-condensed">
- <thead>
- <tr>
- <th>Feature</th>
- <th>Collection</th>
- <th>Operation</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>owner_id</td>
- <td>Images</td>
- <td>GET /api/images</td>
- <td>Allows filtering of the image list by owner_id.</td>
- </tr>
- <tr>
- <td>user_name</td>
- <td>Instances</td>
- <td>POST /api/instances</td>
- <td>Accepts a user-defined name on instance creation.</td>
- </tr>
- <tr>
- <td>user_data</td>
- <td>Instances</td>
- <td>POST /api/instances</td>
- <td>Provides user-defined data that is accessible by the running instance.</td>
- </tr>
- <tr>
- <td>user_iso</td>
- <td>Instances</td>
- <td>POST /api/instances</td>
- <td>Provides a base64 encoded gzipped ISO file accessible as CD-ROM drive by the running instnace.</td>
- </tr>
- <tr>
- <td>user_files</td>
- <td>Instances</td>
- <td>POST /api/instances</td>
- <td>Accept files that will be placed into the launched instance.</td>
- </tr>
- <tr>
- <td>firewalls</td>
- <td>Instances</td>
- <td>POST /api/instances</td>
- <td>Put the instance into one or more firewalls on launch.</td>
- </tr>
- <tr>
- <td>authentication_key</td>
- <td>Instances</td>
- <td>POST /api/instances</td>
- <td>Provides the authentication key to access the instance.</td>
- </tr>
- <tr>
- <td>authentication_password</td>
- <td>Instances</td>
- <td>POST /api/instances</td>
- <td>Provides the password to access the running instance.</td>
- </tr>
- <tr>
- <td>instance_count</td>
- <td>Instances</td>
- <td>POST /api/instances</td>
- <td>Specifies the number of instances to launch in one operation.</td>
- </tr>
- <tr>
- <td>attach_snapshot</td>
- <td>Instances</td>
- <td>POST /api/instances</td>
- <td>Attaches a storage snapshot to an instance as a storage volume.</td>
- </tr>
- <tr>
- <td>sandboxing</td>
- <td>Instances</td>
- <td>POST /api/instances</td>
- <td>Launches an instance from a sandbox image (Gogrid specific).</td>
- </tr>
- <tr>
- <td>bucket_location</td>
- <td>Buckets</td>
- <td>POST /api/buckets</td>
- <td>Specifies a location that the bucket should be created in (e.g. specific cloud-provider datacenter).</td>
- </tr>
- </tbody>
-</table>
-
-<a class="btn btn-inverse btn-large" style="float: right" href="/compute-resources.html">Compute resources <i class="icon-arrow-right icon-white" style="vertical-align:baseline"> </i></a>
-
-<br/>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/output/#blob-storage.md#
----------------------------------------------------------------------
diff --git a/site/output/#blob-storage.md# b/site/output/#blob-storage.md#
deleted file mode 100644
index afeebfa..0000000
--- a/site/output/#blob-storage.md#
+++ /dev/null
@@ -1,456 +0,0 @@
----
-site_name: Deltacloud API
-title: Blob storage
----
-
-<br/>
-
-<div class="alert alert-info">
-<a class="close" data-dismiss="alert" href="#">×</a>
-This section is currently being updated.
-</div>
-
-<div class="row">
- <div class="span8">
-
-<h3 id="blob">Blob Storage</h3>
-
-<p>
-Blob storage represents a generic key ==> value data store. It is implemented by Amazon S3 or Rackspace Cloudfiles. In Deltacloud, the organisational unit of blob storage is a bucket. Individual data items - blobs are exposed as a subcollection under each bucket.
-</p>
-
-<p>
-A bucket has a <strong>name</strong>, a <strong>size</strong> (denotes the number of blobs it contains) and a list of <strong>links to each blob</strong>.
-</p>
-
-<p>
-A blob has a <strong>content_length</strong>, a <strong>content_type</strong>, a <strong>last_modified</strong> timestamp, a structure containing <strong>user_metadata</strong>, a link to the blob <strong>content</strong> and the name of the bucket in which this blob exists.
-</p>
-
- </div>
- <div class="span4">
-
-<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>
- <li><a href="/storage-resources.html">Storage resources</a></li>
- <ul class="nav nav-list">
- <li><a href="/storage-resources.html#volumes">Storage volumes</a></li>
- <li><a href="/storage-snapshots.html">Storage snaphots</a></li>
- <li class="active"><a href="#blob">Blob storage</a></li>
- </ul>
-</ul>
-
- </div>
-</div>
-
-<h4>Get a list of all buckets</h4>
-
-<p>
-To return a list of all buckets belonging to the given cloud provider account use call <strong>GET /api/buckets</strong>. The response from the Deltacloud server includes the name and URI of each bucket but not the size or the list of blobs which the bucket contains. These details are available when a client requests (GETs) a specific bucket.
-</p>
-
-<p>Example request:</p>
-
-<pre>
-GET /api/buckets?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1
-Host: localhost:3001
-Accept: */*
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-HTTP/1.1 200 OK
-Content-Type: application/xml
-Content-Length: 597
-<?xml version='1.0' encoding='utf-8' ?>
-<buckets>
- <bucket href='http://localhost:3001/api/buckets/mybucket1' id='mybucket1'>
- <name>mybucket1</name>
- <size></size>
- </bucket>
- <bucket href='http://localhost:3001/api/buckets/mybucket2' id='mybucket2'>
- <name>mybucket2</name>
- <size></size>
- </bucket>
- <bucket href='http://localhost:3001/api/buckets/mybucket3' id='mybucket3'>
- <name>mybucket3</name>
- <size></size>
- </bucket>
- <bucket href='http://localhost:3001/api/buckets/mybucket4' id='mybucket4'>
- <name>mybucket4</name>
- <size></size>
- </bucket>
-</buckets>
-</pre>
-
-<h4>Get the details of a specific bucket</h4>
-
-<p>
-To return details of a specific bucket use call <strong>GET /api/buckets/:id</strong>. The Deltacloud server response includes the size of the bucket and the URI for each blob object that it contains.
-</p>
-
-<p>Example request:</p>
-
-<pre>
-GET /api/buckets/mybucket1?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1
-Host: localhost:3001
-Accept: */*
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-HTTP/1.1 200 OK
-Content-Type: application/xml
-Content-Length: 534
-<?xml version='1.0' encoding='utf-8' ?>
-<bucket href='http://localhost:3001/api/buckets/mybucket1' id='mybucket1'>
- <name>mybucket1</name>
- <size>4</size>
- <blob href='http://localhost:3001/api/buckets/mybucket1/myfile' id='myfile'></blob>
- <blob href='http://localhost:3001/api/buckets/mybucket1/an_object' id='an_object'></blob>
- <blob href='http://localhost:3001/api/buckets/mybucket1/picture_blob' id='picture_blob'></blob>
- <blob href='http://localhost:3001/api/buckets/mybucket1/some_blob id='some_blob'></blob>
-</bucket>
-</pre>
-
-<h4>Create a new bucket</h4>
-
-<p>
-To create a new bucket use call <strong>POST /api/buckets</strong>. You need to specify the name as a parameter. Optionally for Amazon S3 buckets, you can specify a bucket location with the location parameter, as per <a href="http://docs.amazonwebservices.com/general/latest/gr/index.html?rande.html">Regions and Endpoints for Amazon Simple Storage Service</a>. Valid values for S3 bucket location parameter are: "us-west-1", "EU", "ap-southeast-1", "ap-northeast-1" (while not specifying a location default to the "US Standard" region). Note that clients may specify parameters as multipart/form-data or using a content-type of application/x-www-form-urlencoded.
-</p>
-
-<p>
-On succesful creation this call will return a 201 HTTP status, specifying the URI of the newly created bucket in the <strong>Location</strong> header and the newly created bucket object in the response message body. The example request below shows how to create a new bucket in the EU (Ireland) region. If the given back-end cloud does not support locations then the location parameter is ignored.
-</p>
-
-<p>Example request:</p>
-
-<pre>
-POST /api/buckets?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1
-Host: localhost:3001
-Accept: */*
-Content-Length: 31
-Content-Type: application/x-www-form-urlencoded
-
-name=mybucketeurope&location=EU
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-HTTP/1.1 201 Created
-Location: http://localhost:3001/api/buckets/mybucketeurope
-Content-Type: application/xml
-Content-Length: 182
-
-<?xml version='1.0' encoding='utf-8' ?>
-<bucket href='http://localhost:3001/api/buckets/mybucketeurope' id='mybucketeurope'>
- <name>mybucketeurope</name>
- <size>0</size>
-</bucket>
-</pre>
-
-<h4>Delete a bucket</h4>
-
-<p>
-To delete the specified bucket use call <strong>DELETE /api/buckets/:id</strong>. The bucket must be empty (otherwise the call will fail with an error response). A succesful operation will return <strong>204 No Content</strong>.
-</p>
-
-<p>Example request:</p>
-
-<pre>
-DELETE /api/buckets/mybucketeurope?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
-</pre>
-
-<h4>Get the details of a blob</h4>
-
-<p>
-To retrieve the details of a specific blob use call <strong>GET /api/buckets/:bucket_id/:blob_id</strong>. The blob content is not returned as part of the response but rather a URI is given from which the content may be retrieved as shown below.
-</p>
-
-<p>Example request:</p>
-
-<pre>
-GET /api/buckets/mariosbucket1/some_more_blob_woo?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
-Content-Length: 586
-<?xml version='1.0' encoding='utf-8' ?>
-<blob href='http://localhost:3001/api/buckets/mariosbucket1/some_more_blob_woo' id='some_more_blob_woo'>
- <bucket>mariosbucket1</bucket>
- <content_length>86</content_length>
- <content_type>text/plain</content_type>
- <last_modified>Fri Jan 28 12:23:08 UTC 2011</last_modified>
- <user_metadata>
- <entry key='v'>
- <![CDATA[0.2.0]]>
- </entry>
- <entry key='test'>
- <![CDATA[value]]>
- </entry>
- </user_metadata>
- <content href='http://localhost:3001/api/buckets/mariosbucket1/some_more_blob_woo/content'></content>
-</blob>
-</pre>
-
-<h4>Get the actual blob content</h4>
-
-<p>
-To retrieve the actual blob content use call <strong>GET /api/buckets/:bucket_id/:blob_id/content</strong>. The location of blob content is specified in the content URI returned from the <strong>GET /api/buckets/:bucket_id/:blob_id</strong> call. The content is streamed through the deltacloud server as soon as it is received from the back-end cloud provider. The aim is to avoid the creation of a temporary file (especially significant in case of large blobs). The Deltacloud server sets <strong>Content-Disposition: attachment; filename=blob_name</strong> in the HTTP response headers.
-</p>
-
-<p>
-Example request:
-</p>
-
-<pre>
-GET /api/buckets/mariosanotherbucketohyeah/Im_a_blob_beholdme/content?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-Disposition: attachment; filename=Im_a_blob_beholdme
-Content-Type: text/plain
-Content-Length: 50
-
-<BLOB DATA HERE>
-</pre>
-
-<h4>Create a blob object</h4>
-
-<p>
-To create a blob object and set its content use call <strong>PUT /api/buckets/:bucket_id/:blob_id</strong>. If the blob already exists then its data and metadata are overwritten with those specified in this call. The request must specify the name of the blob and the name of the bucket, in which the blob is to be placed, in the call URI. The client must also specify the <strong>content_length</strong> of the blob data and the <strong>blob data</strong> itself in the HTTP headers. Optionally the call may also specify a <strong>content_type</strong> and any number of <strong>key:value</strong> pairs of user defined metadata. User metadata is defined using 'X-Deltacloud-Blobmeta-' header, e.g. X-Deltacloud-Blobmeta-Version:2.1.
-</p>
-
-<p>
-To eliminate the necessity of creating a local file at the deltacloud server for each blob created, the deltacloud server starts to stream the blob data to the back-end cloud provider as soon as the request headers are processed. A succesful operation will return the newly created blob object, as shown below:
-</p>
-
-<p>Example request:</p>
-
-<pre>
-PUT /api/buckets/mybucket/12Jul2011blob?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-Content-Type: text/plain
-Content-Length: 128988
-X-Deltacloud-Blobmeta-Version:2.1
-X-Deltacloud-Blobmeta-Author:msa
-
-... BLOB DATA ...
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-<?xml version='1.0' encoding='utf-8' ?>
-<blob href='http://localhost:3001/api/buckets/mybucket/12Jul2011blob' id='12Jul2011blob'>
- <bucket>mybucket</bucket>
- <content_length>128988</content_length>
- <content_type>text/plain</content_type>
- <last_modified>Wed Jul 13 13:27:22 UTC 2011</last_modified>
- <user_metadata>
- <entry key='author'>
- <![CDATA[msa]]>
- </entry>
- <entry key='version'>
- <![CDATA[2.1]]>
- </entry>
- </user_metadata>
- <content href='http://localhost:3001/api/buckets/mybucket/12Jul2011blob/content'>
- </content>
-</blob>
-</pre>
-
-<h4>Update a blob object</h4>
-
-<p>
-The Deltacloud server also responds to an alternative <strong>POST /api/buckets/:bucket_id</strong> route for creating or updating a blob object. As with the <strong>PUT</strong> method for creating/updating a blob, the client must specify the <strong>bucket</strong> in which the blob is to be created through the call URI (i.e. you <strong>POST</strong> to the specified bucket). The rest of the required fields, that is, the <strong>name</strong> of the blob, the <strong>blob_data</strong> and the <strong>content-length</strong> are specified by the client as <strong>multipart/form-data</strong> (i.e. in <strong>HTTP POST</strong> form fields).
-</p>
-
-<p>
-In order to specify the optional user metadata for a given blob the client must set the form field <strong>meta_params</strong> to specify the number of metadata key/value pairs. The metadata itself is then specified by the client with fields of the form <strong>meta_nameN</strong> and <strong>meta_valueN</strong> where N is an integer from 1 upto the number specified by the <strong>meta_params</strong> field (e.g. meta_name1=author, meta_value1=jrd).
-</p>
-
-<p>
-It should be noted that the <strong>POST</strong> method for creating a blob is non streaming - the Deltacloud server will create a temporary file with the blob data, before this is transferred to the backend cloud. Thus, it should only be used for blobs with a relatively small content-length and in general the <strong>PUT</strong> method should be preferred for larger blobs. This <strong>POST</strong> method is mainly provided for clients that cannot easily invoke a <strong>HTTP PUT</strong> operation (e.g. web browsers) and can be used for creating/updating a blob through the deltacloud HTML interface (provided for testing purposes).
-</p>
-
-<p>Example request:</p>
-
-<pre>
-POST /api/buckets/mybucket?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1 (i386-redhat-linux-gnu) libcurl/7.20.1 N
-Accept: */*
-Content-Length: 113582
-Expect: 100-continue
-Content-Type: multipart/form-data; boundary=----------------------------517f5f2df858
-
-------------------------------517f5f2df858
-Content-Disposition: form-data; name="blob"
-
-12Jul2011blob
-------------------------------517f5f2df858
-Content-Disposition: form-data; name="blob_data"; filename="small.txt"
-Content-Type: text/plain
-
-<THE_BLOB_DATA_HERE>
-
-------------------------------517f5f2df858
-Content-Disposition: form-data; name="meta_params"
-
-2
-------------------------------517f5f2df858
-Content-Disposition: form-data; name="meta_name1"
-
-author
-------------------------------517f5f2df858
-Content-Disposition: form-data; name="meta_value1"
-jjs
-------------------------------517f5f2df858
-Content-Disposition: form-data; name="meta_name2"
-
-version
-------------------------------517f5f2df858
-Content-Disposition: form-data; name="meta_value2"
-
-2.2
-------------------------------517f5f2df858--
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-<?xml version='1.0' encoding='utf-8' ?>
-<blob href='http://localhost:3001/api/buckets/mybucket/12Jul2011blob' id='12Jul2011blob'>
- <bucket>mybucket</bucket>
- <content_length>112766</content_length>
- <content_type>text/plain</content_type>
- <last_modified></last_modified>
- <user_metadata>
- <entry key='x-amz-meta-author'>
- <![CDATA[jjs]]>
- </entry>
- <entry key='x-amz-meta-version'>
- <![CDATA[2.2]]>
- </entry>
- </user_metadata>
- <content href='http://localhost:3001/api/buckets/mybucket/12Jul2011blob/content'>
- </content>
-</blob>
-</pre>
-
-<h4>Delete a blob object</h4>
-
-<p>
-To delete the specified blob object from the back-end cloud use call <strong>DELETE /api/buckets/:bucket_id/:blob_id</strong>. The names of the blob and the bucket in which this exists are specified the in call URI. After a succesful operation the Deltacloud server will respond with a <strong>HTTP 204</strong> (No Content) with no message body.
-</p>
-
-<p>Example request:</p>
-
-<pre>
-DELETE /api/buckets/mybucket/12Jul2011blob?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
-Connection: close
-Server: thin 1.2.11
-</pre>
-
-<h4>Get all metadata fields</h4>
-
-<p>
-To return all user defined metadata fields on a specified blob URI use the HTTP HEAD operation <strong>HEAD /api/buckets/:bucket_id/:blob_id</strong>. As per <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</a> this <strong>HEAD</strong> operation does not return a message body. Rather, the blob user metadata values are returned in the response X-Deltacloud-Blobmeta- headers (e.g., X-Deltacloud-Blobmeta-version:1.2).
-</p>
-
-<p>Example request:</p>
-
-<pre>
-HEAD /api/buckets/mybucket/myblob?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1
-Host: localhost:3001
-Accept: */*
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-HTTP/1.1 204 No Content
-X-Deltacloud-Blobmeta-version: 1.21
-X-Deltacloud-Blobmeta-author: jrd
-</pre>
-
-<h4>Update the user-defined blob metadata</h4>
-
-<p>
-To update the user-defined blob metadata use call <strong>POST /api/buckets/:bucket_id/:blob_id</strong> on the URI of a blob. This operation will overwrite all previously set user-metadata values (if any) and replace them with those specified in this call. The client must set the user-defined metadata in the X-Deltacloud-Blobmeta- headers (e.g., X-Deltacloud-Blobmeta-Model:2012).
-</p>
-
-<p>Example request:</p>
-
-<pre>
-POST /api/buckets/mybucket/myblob?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1
-Host: localhost:3001
-Accept: */*
-X-Deltacloud-Blobmeta-model: 2012
-X-Deltacloud-Blobmeta-paint: Stannite_Grey
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-HTTP/1.1 204 No Content
-X-Deltacloud-Blobmeta-model: 2012
-X-Deltacloud-Blobmeta-paint: Stannite_Grey
-</pre>
-
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/output/#credentials.md#
----------------------------------------------------------------------
diff --git a/site/output/#credentials.md# b/site/output/#credentials.md#
deleted file mode 100644
index 8b13789..0000000
--- a/site/output/#credentials.md#
+++ /dev/null
@@ -1 +0,0 @@
-
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/output/#getting-sources.md#
----------------------------------------------------------------------
diff --git a/site/output/#getting-sources.md# b/site/output/#getting-sources.md#
deleted file mode 100644
index 1a37cbd..0000000
--- a/site/output/#getting-sources.md#
+++ /dev/null
@@ -1,79 +0,0 @@
----
-site_name: Deltacloud API
-title: Getting the Sources
----
-<br/>
-
-<h2>Setting up a developers environment</h2>
-
-<h3>Installing dependencies</h3>
-<p>
-First, you will need all the installation dependencies for Deltacloud. Follow the steps in <a href="/install-deltacloud.html">Install Deltacloud</a> section to get these dependencies.
-</p>
-
-<h3>Getting the sources</h3>
-
-The Deltacloud repository is hosted at the Apache Software Foundation, using the <a href="http://git-scm.com/">Git</a> version control system. If you don't have Git already, use the yum or apt package managers:
-
-<pre>
-$ sudo yum install git
-</pre>
-or
-<pre>
-$ sudo apt-get install git
-</pre>
-
-The canonical Deltacloud repository is located at <a href="https://git-wip-us.apache.org/repos/asf/deltacloud.git">https://git-wip-us.apache.org/repos/asf/deltacloud.git</a> with read-only mirrors at <strong>git://git.apache.org/deltacloud.git</strong> and <strong>git://github.com/apache/deltacloud</strong>.
-
-Go to your root directory and run git to get the latest version of Deltacloud source code from git repository. You can also use a different directory, but remember, where you clone the code:
-
-<pre>
-$ git clone git://git.apache.org/deltacloud.git
-</pre>
-
-This will pull the latest version to the directory <strong>~/deltacloud</strong>.
-
-<h3>Development dependencies</h3>
-<p>
-Apart from installation dependecies, you have to install some additional libraries, in order to develop for Deltacloud. The Deltacloud source includes a Gemfile: <strong>/path/to/deltacloud/server/Gemfile</strong>, which lists these development dependencies.
-</p>
-
-<p>
-You can easily get all the development dependecies with <a href="http://gembundler.com/">Bundler</a>:
-</p>
-
-<p>Install Bundler (if you don't have it yet):</p>
-
-<pre>$ sudo gem install bundler</pre>
-
-<p>Then, get the required dependencies:</p>
-
-<pre>
-$ cd /path/to/deltacloud/server
-$ bundle install --system
-</pre>
-
-<h3>Building from source and installing the Deltacloud gem</h3>
-
-<p>
-Build and install the Deltacloud server gem:
-</p>
-
-<pre>
-$ cd path/to/DeltacloudProject/deltacloud/server
-$ rake package
-$ sudo gem install pkg/deltacloud-core-<version>.gem
-</pre>
-
-<p>
-Then install the Deltacloud client gem:
-</p>
-
-<pre>
-$ cd path/to/DeltacloudProject/deltacloud/client
-$ rake package
-$ sudo gem install pkg/deltacloud-client-<version>.gem
-</pre>
-
-<a class="btn btn-inverse btn-large" style="float: right" href="/how-to-contribute.html">Contribute</a>
-<br/>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/output/#how-to-contribute.md#
----------------------------------------------------------------------
diff --git a/site/output/#how-to-contribute.md# b/site/output/#how-to-contribute.md#
deleted file mode 100644
index 3a0571f..0000000
--- a/site/output/#how-to-contribute.md#
+++ /dev/null
@@ -1,94 +0,0 @@
----
-site_name: Deltacloud API
-title: How Can I Contribute?
----
-<br/>
-
-<h2 id="contribute">Contribute to Deltacloud</h2>
-Deltacloud project is a free open source software licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache Software Foundation</a> license. The developers community is open to anyone who wants to contribute. Contributors are required to sign an individual contributor <a href="http://www.apache.org/licenses/icla.txt">license agreement</a>. Do not hesitate to <a href="/contact.html">contact us</a> if you have any questions about contributing to the Deltacloud project.
-
-<h3>How can I contribute?</h3>
-
-<ul class="nav nav-list">
- <li class="nav-header"></li>
- <li>
- <a href="/send-patch.html">Send a patch</a>
- </li>
- <li>
- <a href="/write-new-driver.html">Write a provider driver</a>
- </li>
- <li>
- <a href="#bug">Report a bug</a>
- </li>
- <li>
- <a href="#idea">Propose an idea</a>
- </li>
- <li>
- <a href="#documentation">Write a documentation</a>
- </li>
-</ul>
-
-<br/>
-
-<h3>Overview of the Deltacloud directory structure</h3>
-
-<p>The following list contains paths to the most interesting files and directories for developers. It is intended as an aid to orientation in the project files for developers - for example to quickly identify where the Deltacloud cloud provider drivers are stored:</p>
-
-<div class="row">
- <div class="span1"></div>
- <div class="span10 offset1">
-<pre>
-deltacloud
-|-----------------------------------------------------------------------------------
-|-d-->tests Contains Cucumber tests
-|-----------------------------------------------------------------------------------
-|-d-->site Files for this website
-|-----------------------------------------------------------------------------------
-|-d-->client Contains the Deltacloud ruby client
-|-----------------------------------------------------------------------------------
-|-d-->clients Contains other Deltacloud clients (e.g. java)
-|-----------------------------------------------------------------------------------
-|-d--> server
- |----------------------------------------------------------------------------
- |-d-->bin Contains the Deltacloud executable deltacloudd
- |----------------------------------------------------------------------------
- |-d-->views Contains haml views for each collection
- |----------------------------------------------------------------------------
- |-d-->tests Contains unit tests for drivers
- |----------------------------------------------------------------------------
- |-d-->lib
- |----------------------------------------------------------------------
- |-d-->sinatra Contains rabbit DSL and various helpers
- |----------------------------------------------------------------------
- |-d-->deltacloud
- |----------------------------------------------------------------
- |-d-->models Definition of each collection model
- |----------------------------------------------------------------
- |-d-->drivers Contains the drivers for each cloud provider
- |----------------------------------------------------------------
- |-d-->helpers Various helper methods used by the drivers
- |----------------------------------------------------------------
- |-d-->base_driver Contains the Deltacloud base driver
- |----------------------------------------------------------------
- |-f-->server.rb Contains the sinatra routes
- |----------------------------------------------------------------
-</pre>
-
- </div>
-</div>
-
-<br/>
-
-<h3 id="bug">Reporting a bug</h3>
-We track bugs in <a href="https://issues.apache.org/jira/browse/DTACLOUD">Apache JIRA</a>. If you find a problem with Deltacloud, check if it is already known to the Deltacloud developers or <a href="https://issues.apache.org/jira/secure/CreateIssue!default.jspa">report it</a>.
-
-<h3 id="idea">Propose an idea</h3>
-<p>
-Our <a href="http://teambox.com/projects/deltacloud">Teambox</a> page is a place where we keep the latest task lists and where you can add comments or suggest new features for the project.
-</p>
-
-
-<h3 id="documentation">Writing a documentation</h3>
-
-
-
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/output/#images.md#
----------------------------------------------------------------------
diff --git a/site/output/#images.md# b/site/output/#images.md#
deleted file mode 100644
index 665169d..0000000
--- a/site/output/#images.md#
+++ /dev/null
@@ -1,286 +0,0 @@
----
-site_name: Deltacloud API
-title: Images
----
-
-<br/>
-
-<div class="row">
- <div class="span8">
-
-<h3 id="images">Images</h3>
-
-<p>
-Images are used to launch instances. Each image represents a virtual machine image in the back-end cloud, containing the root partition and initial storage for an instance operating system. An image has:
-</p>
-
-<ul>
- <li>a human-readable <strong>name</strong>,</li>
- <li>a <strong>description</strong>,</li>
- <li>an <strong>owner_id</strong>,</li>
- <li>an <strong>architecture</strong>,</li>
- <li>a <strong>state.</strong></li>
-</ul>
-
-<p>
-The <strong>owner_id</strong> identifies the user account to which the image belongs. The architecture attribute refers to whether the image will create an instance with 32 or 64-bit processor. The values that the Deltacloud server returns for this attribute are thus i386 and x86_64 respectively. The state attribute varies between back-end clouds (it depends on a cloud provider). For example, AWS EC2 image state can be one of AVAILABLE, PENDING or FAILED, whereas Rackspace Cloudservers image state can be one of UNKNOWN, PREPARING, ACTIVE, QUEUED or FAILED. Finally, each image also contains an <code><actions></code> attribute which specifies the URI to which a client may issue a <strong>HTTP POST</strong> for creation of an instance from the given image.
-</p>
-
- </div>
- <div class="span4">
-
-<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="/compute-resources.html#realms">Realms</a></li>
- <li><a href="/hardware-profiles.html">Hardware profiles</a></li>
- <li class="active"><a href="#images">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><a href="/load-balancers.html">Load balancers</a></li>
- </ul>
- <li><a href="/storage-resources.html">Storage resources</a></li>
-</ul>
-
- </div>
-</div>
-
-<br/>
-
-<ul class="nav nav-pills">
- <li class="active"><a href="#tab1" data-toggle="tab">Get a list of all images</a></li>
- <li><a href="#tab2" data-toggle="tab">Get the details of an image</a></li>
- <li><a href="#tab3" data-toggle="tab">Create/delete an image</a></li>
-</ul>
-
-<hr>
-
-<div class="tab-content">
- <div class="tab-pane active" id="tab1">
-
-<h4>Get the list of all images</h4>
-
-<p>
-To return a list of all images available in the back-end cloud use call <strong>GET /api/images</strong>. By default this call will return all images that are available to the given user account. Optionally a client may restrict the list of images returned by specifying the <strong>owner_id</strong> or <strong>architecture</strong> parameters in the request (architecture is one of x86_64 for 64-bit processors or i386 for 32-bit processors). The example below restricts the image list to 64-bit architecture images belonging to owner_id 023801271342.
-</p>
-
-<p>Example request:</p>
-
-<pre>
-GET /api/images?owner_id=023801271342&architecture=x86_64&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
-Content-Length: 1971
-
-<?xml version='1.0' encoding='utf-8' ?>
-<images>
- <image href='http://localhost:3001/api/images/ami-eea35787' id='ami-eea35787'>
- <name>sles-10-sp3-v1.00.x86_64</name>
- <owner_id>013907871322</owner_id>
- <description>SUSE Linux Enterprise Server 10 Service Pack 3 for x86_64 (v1.00)</description>
- <architecture>x86_64</architecture>
- <state></state>
- <actions>
- <link href='http://localhost:3001/api/instances;image_id=ami-eea35787' method='post' rel='create_instance' />
- </actions>
- </image>
- <image href='http://localhost:3001/api/images/ami-6e649707' id='ami-6e649707'>
- <name>sles-11-sp1-hvm-v1.00.x86_64</name>
- <owner_id>013907871322</owner_id>
- <description>SUSE Linux Enterprise Server 11 Service Pack 1 for HVM x86_64 (v1.00)</description>
- <architecture>x86_64</architecture>
- <state></state>
- <actions>
- <link href='http://localhost:3001/api/instances;image_id=ami-6e649707' method='post' rel='create_instance' />
- </actions>
- </image>
- <image href='http://localhost:3001/api/images/ami-e4a7558d' id='ami-e4a7558d'>
- <name>sles-11-sp1-hvm-v1.01.x86_64</name>
- <owner_id>013907871322</owner_id>
- <description>SUSE Linux Enterprise Server 11 Service Pack 1 for HVM x86_64 (v1.01)</description>
- <architecture>x86_64</architecture>
- <state></state>
- <actions>
- <link href='http://localhost:3001/api/instances;image_id=ami-e4a7558d' method='post' rel='create_instance' />
- </actions>
- </image>
- <image href='http://localhost:3001/api/images/ami-e4a3578d' id='ami-e4a3578d'>
- <name>sles-11-sp1-v1.00.x86_64</name>
- <owner_id>013907871322</owner_id>
- <description>SUSE Linux Enterprise Server 11 Service Pack 1 for x86_64 (v1.00)</description>
- <architecture>x86_64</architecture>
- <state></state>
- <actions>
- <link href='http://localhost:3001/api/instances;image_id=ami-e4a3578d' method='post' rel='create_instance' />
- </actions>
- </image>
-</images>
-</pre>
-
- </div>
- <div class="tab-pane" id="tab2">
-
-<h4>Get details of an image</h4>
-
-<p>To retrieve the description of a specific image use call <strong>GET /api/images/:id</strong>.</p>
-
-<p>Example request:</p>
-
-<pre>
-GET /api/images/14?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
-Host: localhost:3002
-Accept: */*
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-HTTP/1.1 200 OK
-Content-Type: application/xml
-Content-Length: 433
-
-<?xml version='1.0' encoding='utf-8' ?>
-<image href='http://localhost:3002/api/images/14' id='14'>
- <name>Red Hat Enterprise Linux 5.4</name>
- <owner_id>jsmith</owner_id>
- <description>Red Hat Enterprise Linux 5.4</description>
- <architecture>x86_64</architecture>
- <state>ACTIVE</state>
- <actions>
- <link href='http://localhost:3002/api/instances;image_id=14' method='post' rel='create_instance' />
- </actions>
-</image>
-</pre>
-
- </div>
- <div class="tab-pane" id="tab3">
-
-<h4>Create an image</h4>
-
-<p>
-To create a new image from an existing running instance use call <strong>POST /api/images</strong>. This operation is not available to all cloud providers and for some cloud providers this operation is not possible for all instances. For example, in the Amazon EC2 cloud, you can create a custom image from EBS backed instances but not from root-store instances.
-</p>
-
-<div class="alert alert-error">
- <a class="close" data-dismiss="alert" href="#">×</a>
- <strong>Note: </strong>
- <p>
- RHVE-M and vSphere provid
- </p>
-</div>
-
-
-<p>
-The Deltacloud API provides a mechanism with which clients can determine whether a given instance may be saved as a custom image. If an instance snapshot is possible, the instance XML <code><actions></code> list contains a <strong>create_image</strong> action. This action defines the client's URI which is used in creating the new image. For example:
-</p>
-
-<pre>
-...
-<actions>
- <link href='http://localhost:3002/api/instances/20109341/reboot' method='post' rel='reboot' />
- <link href='http://localhost:3002/api/instances/20109341/stop' method='post' rel='stop' />
- <link href='http://localhost:3002/api/instances/20109341/run;id=20109341' method='post' rel='run' />
- <link href='http://localhost:3002/api/images;instance_id=20109341' method='post' rel='create_image' />
-</actions>
-...
-</pre>
-
-<p>
-To create a new image the client must specify the <strong>instance_id</strong> of the running instance. Optionally, the client may also provide a <strong>name</strong> and a <strong>description</strong>. The parameters may be defined as multipart/form-data fields in the client POST.
-</p>
-
-<p>
-Alternatively, clients may also specify parameters using a content-type of application/x-www-form-urlencoded. The Deltacloud server will respond to a successful operation with <strong>HTTP 201 Created</strong> and provide details of the newly created image.
-</p>
-
-<p>Example request:</p>
-
-<pre>
-POST /api/images?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
-Host: localhost:3002
-Accept: */*
-Content-Length: 96
-Content-Type: application/x-www-form-urlencoded
-
-instance_id=20109341&name=customisedserver&description=jsmith%20cu
-stomised%20web%20server%20July%2021%202011
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-HTTP/1.1 201 Created
-Content-Type: application/xml
-Content-Length: 427
-
-<?xml version='1.0' encoding='utf-8' ?>
-<image href='http://localhost:3002/api/images/12346145' id='12346145'>
- <name>customisedserver</name>
- <owner_id>mandreou</owner_id>
- <description>customisedserver</description>
- <architecture>x86_64</architecture>
- <state>QUEUED</state>
- <actions>
- <link href='http://localhost:3002/api/instances;image_id=12346145' method='post' rel='create_instance' />
- </actions>
-</image>
-</pre>
-
-<div class="alert alert-error">
- <a class="close" data-dismiss="alert" href="#">×</a>
- <strong>Note: </strong>
- <p>When you create an image from a stopped instance in <strong>vSphere</strong> driver, this particular instance is marked as <strong>template</strong> and it is also removed from Instances.</p>
-
- <p>Unlike other providers, vSphere does not support assigning a <strong>name</strong> and a <strong>description</strong> to the image when you create an image from a stopped instance. The image created in vSphere ignores these attributes passed to the API during the creation.</p>
-</div>
-
-<h4>Delete an image</h4>
-
-<p>
-To delete the specified image from the back-end cloud use call <strong>DELETE /api/images/:id</strong>. The Deltacloud server will return a <strong>HTTP 204 No Content</strong> after a succesful operation:
-</p>
-
-<p>Example request:</p>
-
-<pre>
-DELETE /api/images/12346145?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
-Host: localhost:3002
-Accept: */*
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-HTTP/1.1 204 No Content
-</pre>
-
- </div>
-</div>
-
-
-<a class="btn btn-inverse btn-large" style="float: right" href="/instance-states.html">Instance states <i class="icon-arrow-right icon-white" style="vertical-align:baseline"> </i></a>
-
-<br/>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/output/#index.md#
----------------------------------------------------------------------
diff --git a/site/output/#index.md# b/site/output/#index.md#
deleted file mode 100644
index 4758afe..0000000
--- a/site/output/#index.md#
+++ /dev/null
@@ -1,77 +0,0 @@
----
-site_name: Deltacloud API
-title: Deltacloud API
----
-
-<div class="row">
-<div class="span12 intro">
- <div class="article-nav news well tweet"></div>
-</div>
-<div class="span4 grad1 about">
-<blockquote>
-<h3>What does Deltacloud give you?</h3>
-<ul>
- <li><span style="font-size:small">
- an opportunity to manage cloud instances the way you want
- </span></li>
- <li><span style="font-size:small">
- a way to protect your apps from cloud API changes and incompatitibilities
- </span></li>
- <li><span style="font-size:small">
- support for all major <a class="providers" href="#supported-providers.html" title="Supported providers">cloud service providers</a>
- </span></li>
-</ul>
-<br/>
-
-<a class="btn btn-large" style="float:right" href="/about.html">Learn more</a>
-
-</blockquote>
-</div>
-
-<div class="span4 grad1 about">
-<blockquote>
-<h3>Developers info</h3>
-<br/>
-<h6>Deltacloud:</h6>
-<ul>
- <li><span style="font-size:small">
- is an open source Apache project
- </span></li>
- <li><span style="font-size:small">
- is a <a href="#rest-api.html" title="API Documentation">REST-based API </a>for simple any-platform access
- </span></li>
- <li><span style="font-size:small">
- is written in Ruby
- </span></li>
- <br/>
- <br/>
-</ul>
-<br />
-
-<a class="btn btn-large" style="float:right" href="/how-to-contribute.html">Contribute to Deltacloud</a>
-<br/>
-
-</blockquote>
-</div>
-<div class="span4 grad1 about">
- <blockquote>
- <p>
- <strong>Current stable version:</strong><br>
- <a class="btn" href="/"> deltacloud-core-0.5.0</a>
- </p>
- <br/>
- <p>
- <strong>Found a bug?</strong><br>
- <a class="btn" href="/"> Report it!</a>
- </p>
- </blockquote>
-</div>
-
-<div class="span12">
-<br/>
-<p>
-Deltacloud makes it easy for cloud providers to <a href="/.html">add their cloud</a> to the Deltacloud API.
-</p>
-</div>
-
-</div>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/output/#instance-states.md#
----------------------------------------------------------------------
diff --git a/site/output/#instance-states.md# b/site/output/#instance-states.md#
deleted file mode 100644
index b423480..0000000
--- a/site/output/#instance-states.md#
+++ /dev/null
@@ -1,126 +0,0 @@
----
-site_name: Deltacloud API
-title: Instance states
----
-<br/>
-
-<div class="alert alert-info">
-<a class="close" data-dismiss="alert" href="#">×</a>
-This section is currently being updated.
-</div>
-
-<div class="row">
- <div class="span8">
-
-<h3 id="instance-states">Instance states</h3>
-
-<p>
-Each cloud defines a slightly different lifecycle model for instances. In some clouds, instances start running immediately after creation, in others, they enter a pending state and you need to start them explicitly.
-</p>
-
-<p>
-Differences between clouds are modelled by expressing the lifecycle of an instance as a finite state machine and capturing it in an instance states entity.The API defines the following states for an instance:</p>
-
-<dl>
- <dt>start</dt>
- <dd>an instance state before creation of an instance</dd>
- <dt>pending</dt>
- <dd>creation of an instance is in progress</dd>
- <dt>running</dt>
- <dd>an instance is running</dd>
- <dt>shutting-down</dt>
- <dd>a shutdown of an instance has been requested and is in progress</dd>
- <dt>stopped</dt>
- <dd>an instance is stopped</dd>
- <dt>finished</dt>
- <dd>all resources for an instance have now been freed</dd>
-</dl>
-
- </div>
- <div class="span4">
-
-<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 class="active"><a href="#instance-states">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><a href="/load-balancers.html">Load balancers</a></li>
- </ul>
- <li><a href="/storage-resources.html">Storage resources</a></li>
-</ul>
-
- </div>
-</div>
-
-<p>
-The details of a particular instance describes also the actions (state transitions) which can be performed on the instance. The possible instance actions are:
-</p>
-
-<dl>
- <dt>start</dt>
- <dd>starts the instance</dd>
- <dt>stop</dt>
- <dd>stops (and for some providers, shutdown) the instance</dd>
- <dt>reboot</dt>
- <dd>reboots the instance</dd>
- <dt>destroy</dt>
- <dd>stops the instance and completely destroys it</dd>
-</dl>
-
-<h4>Get an instance states entity</h4>
-
-To retrieve the instance_states entity for a back-end cloud use call <strong>GET /api/instance_states</strong>. The instance_states entity defines possible transitions between various states of an instance, specific for each back-end cloud. As a result, instance_states defines the finite state machine for instances from the given cloud.
-
-<p>Example request:</p>
-
-<pre>
-GET /api/instance_states?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
-Host: localhost:3002
-Accept: */*
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-HTTP/1.1 200 OK
-Content-Type: application/xml
-Content-Length: 583
-
-<states>
- <state name='start'>
- <transition action='create' to='pending'></transition>
- </state>
- <state name='pending'>
- <transition auto='true' to='running'></transition>
- </state>
- <state name='running'>
- <transition action='reboot' to='running'></transition>
- <transition action='stop' to='shutting_down'></transition>
- </state>
- <state name='shutting_down'>
- <transition auto='true' to='stopped'></transition>
- </state>
- <state name='stopped'>
- <transition auto='true' to='finish'></transition>
- </state>
- <state name='finish'>
- </state>
-</states>
-</pre>
-
-<a class="btn btn-inverse btn-large" style="float: right" href="/instances.html">Instances <i class="icon-arrow-right icon-white" style="vertical-align:baseline"> </i></a>
-
-<br/>