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
[4/5] SITE: addresses DTACLOUD-478, DTACLOUD-479 and removes crud
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/output/#instances.md#
----------------------------------------------------------------------
diff --git a/site/output/#instances.md# b/site/output/#instances.md#
deleted file mode 100644
index b53a9cd..0000000
--- a/site/output/#instances.md#
+++ /dev/null
@@ -1,630 +0,0 @@
----
-site_name: Deltacloud API
-title: Instances
----
-
-<br/>
-
-<div class="row">
- <div class="span8">
-
-<h3 id="instances">Instances</h3>
-
-<p>
-An instance represents the core of all cloud compute activity: a running virtual machine. An instance is created from an image, with a specified hardware profile and in a given realm. Each instance can have a number of other attributes, not all of which are exposed for all back-end cloud providers. The full list of possible instance attributes is:
-</p>
-
-<table class="table table-condensed table-striped">
- <thead>
- <tr>
- <th>Attribute</th>
- <th>Meaning</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>owner_id</td>
- <td>the id of the cloud provider account that launched the instance</td>
- </tr>
- <tr>
- <td>image_id</td>
- <td>the id of the image from which the instance was launched</td>
- </tr>
- <tr>
- <td>name</td>
- <td>a human readable name for the instance given at launch time</td>
- </tr>
- <tr>
- <td>realm_id</td>
- <td>realm into which the instance was launched</td>
- </tr>
- <tr>
- <td>state</td>
- <td>current state of the instance (e.g. 'running')</td>
- </tr>
- <tr>
- <td>actions</td>
- <td>actions that a client may effect on the instance, based on current state</td>
- </tr>
- <tr>
- <td>public_addresses</td>
- <td>the globally routable IP address of the instance</td>
- </tr>
- <tr>
- <td>private_addresses</td>
- <td>the private IP address of the instance, routable within its private network</td>
- </tr>
- <tr>
- <td>instance_profile</td>
- <td>the specific values of memory, cpu, storage</td>
- </tr>
- <tr>
- <td>launch_time</td>
- <td>timestamp at which the instance was launched</td>
- </tr>
- <tr>
- <td>keyname</td>
- <td>name of authentication Key, if this method is used for authentication (e.g. EC2)</td>
- </tr>
- <tr>
- <td>username</td>
- <td>the username for authentication when connecting to the instance</td>
- </tr>
- <tr>
- <td>password</td>
- <td>the password used together with username above</td>
- </tr>
- <tr>
- <td>firewalls</td>
- <td>the firewalls that this instance was launched into (EC2 specific)</td>
- </tr>
- </tbody>
-</table>
-
- </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</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 class="active"><a href="#instances">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>
-
-<ul class="nav nav-pills">
- <li class="active"><a href="#tab1" data-toggle="tab">Get a list of all instances</a></li>
- <li><a href="#tab2" data-toggle="tab">Get the details of an instance</a></li>
- <li><a href="#tab3" data-toggle="tab">Launch an action</a></li>
- <li><a href="#tab4" data-toggle="tab">Create an instance</a></li>
-</ul>
-
-<div class="tab-content">
- <div class="tab-pane active" id="tab1">
-
- <h4 id="list">Get a list of all current instances</h4>
-
- <p>
- To produce a list of all current instances in the given cloud (belonging to the specified account) use call <strong>GET /api/instances</strong>. The example below displays instances in the Amazon EC2 cloud.
- </p>
-
- <p>
- Example request:
- </p>
-
-<pre>
-GET /api/instances?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
-Host: localhost:3001
-Accept: */*
-</pre>
-
- <p>Client response:</p>
-
-<pre>
-HTTP/1.1 200 OK
-Content-Type: application/xml
-Content-Length: 2790
-<?xml version='1.0' encoding='utf-8' ?>
-<instances>
- <instance href='http://localhost:3001/api/instances/i-1fbc627e' id='i-1fbc627e'>
- <name>ami-f51aff9c</name>
- <owner_id>393485797142</owner_id>
- <image href='http://localhost:3001/api/images/ami-f51aff9c' id='ami-f51aff9c'></image>
- <realm href='http://localhost:3001/api/realms/us-east-1c' id='us-east-1c'></realm>
- <state>RUNNING</state>
- <hardware_profile href='http://localhost:3001/api/hardware_profiles/c1.medium' id='c1.medium'>
- </hardware_profile>
- <actions>
- <link href='http://localhost:3001/api/instances/i-1fbc627e/reboot' method='post' rel='reboot' />
- <link href='http://localhost:3001/api/instances/i-1fbc627e/stop' method='post' rel='stop' />
- <link href='http://localhost:3001/api/instances/i-1fbc627e/run;id=i-1fbc627e' method='post' rel='run' />
- </actions>
- <launch_time>2011-07-22T11:29:48.000Z</launch_time>
- <public_addresses><address>ec2-50-16-183-107.compute-1.amazonaws.com</address></public_addresses>
- <private_addresses><address>domU-12-31-39-0F-79-D4.compute-1.internal</address></private_addresses>
- <firewalls>
- <firewall href='http://localhost:3001/api/firewalls/default' id='default'></firewall>
- </firewalls>
- <authentication type='key'>
- <login>
- <keyname>eftah</keyname>
- </login>
- </authentication>
- </instance>
- <instance href='http://localhost:3001/api/instances/i-f3ba6492' id='i-f3ba6492'>
- <name>ami-2b5fba42</name>
- <owner_id>393485797142</owner_id>
- <image href='http://localhost:3001/api/images/ami-2b5fba42' id='ami-2b5fba42'></image>
- <realm href='http://localhost:3001/api/realms/us-east-1d' id='us-east-1d'></realm>
- <state>RUNNING</state>
- <hardware_profile href='http://localhost:3001/api/hardware_profiles/m1.small' id='m1.small'>
- </hardware_profile>
- <actions>
- <link href='http://localhost:3001/api/instances/i-f3ba6492/reboot' method='post' rel='reboot' />
- <link href='http://localhost:3001/api/instances/i-f3ba6492/stop' method='post' rel='stop' />
- <link href='http://localhost:3001/api/instances/i-f3ba6492/run;id=i-f3ba6492' method='post' rel='run' />
- </actions>
- <launch_time>2011-07-22T11:32:25.000Z</launch_time>
- <public_addresses><address>ec2-184-73-78-87.compute-1.amazonaws.com</address></public_addresses>
- <private_addresses><address>ip-10-196-89-221.ec2.internal</address></private_addresses>
- <firewalls>
- <firewall href='http://localhost:3001/api/firewalls/default' id='default'></firewall>
- <firewall href='http://localhost:3001/api/firewalls/test' id='test'></firewall>
- </firewalls>
- <authentication type='key'>
- <login>
- <keyname>eftah</keyname>
- </login>
- </authentication>
- </instance>
-</instances>
-</pre>
-
- </div>
- <div class="tab-pane" id="tab2">
-
- <h4 id="get-instance">Get the details of an instance</h4>
-
- <p>
- To get the details of a specific instance use call <strong>GET /api/instances/:id</strong>. The example below shows an instance launched in the Rackspace Cloudservers cloud. As you can see, the type of authentication is <strong>password</strong> but the username and password attributes are blank. The reason why these attributes are blank is that Rackspace only reports these values once, during instance creation and not for subsequent requests. To find an example of the response from an instance go to the <strong><em>Create an instance</em></strong> subsection.
- </p>
-
- <p>Example request:</p>
-
-<pre>
-GET /api/instances/20112212?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: 1167
-<?xml version='1.0' encoding='utf-8' ?>
-<instance href='http://localhost:3002/api/instances/20112212' id='20112212'>
- <name>myserver</name>
- <owner_id>mandreou</owner_id>
- <image href='http://localhost:3002/api/images/53' id='53'></image>
- <realm href='http://localhost:3002/api/realms/us' id='us'></realm>
- <state>RUNNING</state>
- <hardware_profile href='http://localhost:3002/api/hardware_profiles/1' id='1'>
- </hardware_profile>
- <actions>
- <link href='http://localhost:3002/api/instances/20112212/reboot' method='post' rel='reboot' />
- <link href='http://localhost:3002/api/instances/20112212/stop' method='post' rel='stop' />
- <link href='http://localhost:3002/api/instances/20112212/run;id=20112212' method='post' rel='run' />
- <link href='http://localhost:3002/api/images;instance_id=20112212' method='post' rel='create_image' />
- </actions>
- <public_addresses><address>50.57.116.72</address></public_addresses>
- <private_addresses><address>10.182.143.64</address></private_addresses>
- <authentication type='password'>
- <login>
- <username>root</username>
- <password></password>
- </login>
- </authentication>
-</instance>
-</pre>
-
- </div>
- <div class="tab-pane" id="tab3">
-
- <h4 id="actions">Launch an action on an instance</h4>
-
- <p>
- To launch an action on an instance use call <strong>POST /api/instances/:id/:action</strong>. The valid actions for an instance are specified by the instance_states entity. The set of permissible actions that a client may perform on an instance at a given time depends on the current instance state. These are reported by the <code><actions></code> attribute in the Deltacloud server response to the <strong>GET /api/instances/:id</strong> call (Get the details of an instance subsection). The first example below shows a <strong>reboot</strong> action on a currently running instance, followed by a <strong>stop</strong> action.
- </p>
-
- <p>
- After invoking the stop operation, the instance state may still be reported as <strong>RUNNING</strong> in the Deltacloud server response. It is because it may take some time for the instance state to change in the back-end cloud provider (and this will vary between providers). You can assure yourself that the action was performed correctly by requesting a list of instances or a by requesting a specific instance.
- </p>
-
- <p>
- The Deltacloud server also allows a special 'run-on-instance' action for some cloud provider instances.This enables a client to perform a command on a running instance over <strong>SSH</strong>. The Deltacloud server will return the output of that command to the client. This is reported as the <strong>run</strong> action in the list of instance actions, if it is available. The <strong>cmd</strong> parameter specifies the command, which is executed on a running instance.The <strong>private_key</strong> parameter specifies the authentication for cloud providers that expect key based authentication for connecting to instances . For those cloud providers that use <strong>username/password</strong> for authentication, the <strong>password</strong> parameter specifies the authentication. Examples below illustrate the 'run-on-instance' feature for an Amazon EC2 instance and a Rackspace Cloudservers instance. The examples differ in how authentication is performed (private RSA Key for EC2
and username/password for Rackspace).
- </p>
-
- <p>Example request (<strong>reboot</strong>):</p>
-
-<pre>
-POST /api/instances/i-f3ba6492/reboot?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: 1322
-
-<?xml version='1.0' encoding='utf-8' ?>
-<instance href='http://localhost:3001/api/instances/i-f3ba6492' id='i-f3ba6492'>
- <name>ami-f51aff9c</name>
- <owner_id>393485797142</owner_id>
- <image href='http://localhost:3001/api/images/ami-f51aff9c' id='ami-f51aff9c'></image>
- <realm href='http://localhost:3001/api/realms/us-east-1c' id='us-east-1c'></realm>
- <state>RUNNING</state>
- <hardware_profile href='http://localhost:3001/api/hardware_profiles/c1.medium' id='c1.medium'>
- </hardware_profile>
- <actions>
- <link href='http://localhost:3001/api/instances/i-f3ba6492/reboot' method='post' rel='reboot' />
- <link href='http://localhost:3001/api/instances/i-f3ba6492/stop' method='post' rel='stop' />
- <link href='http://localhost:3001/api/instances/i-f3ba6492/run;id=i-f3ba6492' method='post' rel='run' />
- </actions>
- <launch_time>2011-07-22T11:29:48.000Z</launch_time>
- <public_addresses><address>ec2-50-16-183-107.compute-1.amazonaws.com</address></public_addresses>
- <private_addresses><address>domU-12-31-39-0F-79-D4.compute-1.internal</address></private_addresses>
- <firewalls> <firewall href='http://localhost:3001/api/firewalls/default' id='default'></firewall></firewalls>
- <authentication type='key'>
- <login>
- <keyname>eftah</keyname>
- </login>
- </authentication>
-</instance>
-</pre>
-
- <p>Example request (<strong>stop</strong>):</p>
-
-<pre>
-POST /api/instances/20112212/stop?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: 1167
-
-<?xml version='1.0' encoding='utf-8' ?>
-<instance href='http://localhost:3002/api/instances/20112212' id='20112212'>
- <name>myserver</name>
- <owner_id>mandreou</owner_id>
- <image href='http://localhost:3002/api/images/53' id='53'></image>
- <realm href='http://localhost:3002/api/realms/us' id='us'></realm>
- <state>STOPPED</state>
- <hardware_profile href='http://localhost:3002/api/hardware_profiles/1' id='1'>
- </hardware_profile>
- <actions>
- <link href='http://localhost:3002/api/instances/20112212/reboot' method='post' rel='reboot' />
- <link href='http://localhost:3002/api/instances/20112212/stop' method='post' rel='stop' />
- <link href='http://localhost:3002/api/instances/20112212/run;id=20112212' method='post' rel='run' />
- <link href='http://localhost:3002/api/images;instance_id=20112212' method='post' rel='create_image' />
- </actions>
- <public_addresses><address>50.57.116.72</address></public_addresses>
- <private_addresses><address>10.182.143.64</address></private_addresses>
- <authentication type='password'>
- <login>
- <username>root</username>
- <password></password>
- </login>
- </authentication>
-</instance>
-</pre>
-
- <p>
- Example request (<strong>run-on-instance Amazon EC2</strong>):
- </p>
-
-<div class="alert alert-error">
- <a class="close" data-dismiss="alert" href="#">×</a>
- <strong>Note:</strong>
- <p>
- Run-on-instance requests to EC2 instances will fail with <strong>502 Bad Gateway - Execution Expired</strong> if the firewall in which the instance was launched does not grant SSH access (tcp, port 22) to the requesting client's IP address. This access may be given using the <a href="/firewalls.html">firewalls</a> collection.</p>
-</div>
-
-<pre>
-POST /api/instances/i-afde73ce/run?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
-Host: localhost:3001
-Content-Length: 1927
-Content-Type: multipart/form-data; boundary=----------------------------332ed6691ab8
-
-------------------------------332ed6691ab8
-Content-Disposition: form-data; name="cmd"
-
-uname -a; ls -l
-------------------------------332ed6691ab8
-Content-Disposition: form-data; name="private_key"
-
------BEGIN RSA PRIVATE KEY-----.BTTEpATBAAKDAQEA4t3R/PgUo3KDDuX4
-vZZpZuXFkAA/5X2lFRY2/xsQqbPz9utPOsUoPf9Aajy+.vGRJrO2KAJ9U/JTNDzr
-3NPbG3aHYPSnwsSxkFSG4Q6ukqYlxT9TPF/+wvdxfAtp3nYw3ZGuSX/DOtToWtQ8
-F/+GvHTHKDQSB+TeEs1Sa/PFwxpspB+RqHbqOTWPsFOHL+9sZGTqd6D4B.R6DBNh
-9Dabu9BVZrl5BTOKlbAgrKnzsGKvaBST/D2.AB/HB9/GOT36OoBmEr1y9gFwu4Xf
-aKw+AXVf9y9TKxVD3TE5uB.oDZG8s4gr2e691xHG9YGzBBBbNzfFh94b3Td5JBGS
-zRDTKYBfOgv+Zu5N+WyeaZ0ab50DwK9BXYB5hsRu5zbAqObbTZkwN9qwBOZHzATX
-wVTZU+eTz.39OZPqu4fQwrBN13lDbUoZxlqT9g2+haQBB9sTDzQEZ08QKBgQDJyw
-lBBZqQKBgQDz5E2rL59lNS5pBxDO9r6B9rXtBBTZ5tZUWNFRvyNsxY5nJT03.KDw
-qo2VP5WDZeOhRWEUY96./pWN3hNFDkT44vDpeXQUh3rBHyD5DWvWxAze9Ds+UTO/
-esuLwP5vXhfoYp6gV9XG.BEBzSVq8kZ2kZtlbWHTR/SGepTkDgYEA9zwHTDhtKR2
-KS8/BSFZQ884ZqFkbwT9fTW6s0rgUSBDTUDgYEA9W5HXTOEPGFDnqBhKPLN.xD9D
-vZZpZuXFkAA/5X2lFRY2/xsQqbPz9utPOsUoPf9Aajy+.vGRJrO2KAJ9U/JTNDzr
-lBBZqQKBgQDz5E2rL59lNS5pBxDO9r6B9rXtBBTZ5tZUWNFRvyNsxY5nJT03.KDw
-F/+GvHTHKDQSB+TeEs1Sa/PFwxpspB+RqHbqOTWPsFOHL+9sZGTqd6D4B.R6DBNh
-wVTZU+eTz.39OZPqu4fQwrBN13lDbUoZxlqT9g2+haQBB9sTDzQEZ08QKBgQDJyw
-lBBZqQKBgQDz5E2rL59lNS5pBxDO9r6B9rXtBBTZ5tZUWNFRvyNsxY5nJT03.KDw
-DAAeVWKU1OyDXfN4v6Zn1nNrhSkdrd+XV0nTLExsfg==.-----END RSA PRIVAT
-E KEY-----
-------------------------------332ed6691ab8--
-</pre>
-
- <p>Server response:</p>
-
-<pre>
-HTTP/1.1 200 OK
-Content-Type: application/xml
-Date: Mon, 25 Jul 2011 12:56:02 GMT
-Content-Length: 497
-
-<instance href='http://localhost:3001/api/instances/i-afde73ce' id='i-afde73ce'>
- <public_address>
- ec2-50-19-59-126.compute-1.amazonaws.com
- </public_address>
- <command>
- uname -a; ls -l
- </command>
- <output>Linux domU-12-31-39-0F-E1-78 2.6.21.7-2.fc8xen #1 SMP Fri Feb 15 12:39:36 EST 2008 i686 i686 i386 GNU/Linux
- total 140
- -rw-r--r-- 1 root root 137263 Mar 26 2008 ec2-ami-tools-1.3-19974.noarch.rpm
- -rw-r--r-- 1 root root 0 Mar 26 2008 firstlogin
- </output>
-</instance>
-</pre>
-
- <p>Example request (<strong>run-on-instance Rackspace Cloudservers</strong>):</p>
-
-<pre>
-POST /api/instances/20117112/run?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
-Host: localhost:3002
-Accept: */*
-Content-Length: 275
-Expect: 100-continue
-Content-Type: multipart/form-data; boundary=----------------------------9b05ece66f4d
-------------------------------9b05ece66f4d
-Content-Disposition: form-data; name="cmd"
-
-uname -a; ifconfig; pwd
-------------------------------9b05ece66f4d
-Content-Disposition: form-data; name="password"
-
-myserverqB2Uwk21I
-------------------------------9b05ece66f4d--
-</pre>
-
- <p>Server response:</p>
-
-<pre>
-HTTP/1.1 200 OK
-Content-Type: application/xml
-Date: Mon, 25 Jul 2011 13:02:15 GMT
-Content-Length: 1781
-
-<instance href='http://localhost:3002/api/instances/20117112' id='20117112'>
- <public_address>
- 50.57.117.249
- </public_address>
- <command>
- uname -a; ifconfig; pwd
- </command>
- <output>Linux myserver 2.6.35.4-rscloud #8 SMP Mon Sep 20 15:54:33 UTC 2010 x86_64 x86_64 x86_64 GNU/Linux
- eth0 Link encap:Ethernet HWaddr 40:40:B1:7A:52:7E
- inet addr:50.57.117.249 Bcast:50.57.117.255 Mask:255.255.255.0
- inet6 addr: fe80::4240:b1ff:fe7a:527e/64 Scope:Link
- UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
- RX packets:54 errors:0 dropped:0 overruns:0 frame:0
- TX packets:62 errors:0 dropped:0 overruns:0 carrier:0
- collisions:0 txqueuelen:1000
- RX bytes:5880 (5.7 KiB) TX bytes:6331 (6.1 KiB)
- Interrupt:24
-
- eth1 Link encap:Ethernet HWaddr 40:40:8E:4B:52:23
- inet addr:10.182.131.159 Bcast:10.182.159.255 Mask:255.255.224.0
- inet6 addr: fe80::4240:8eff:fe4b:5223/64 Scope:Link
- UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
- RX packets:3 errors:0 dropped:0 overruns:0 frame:0
- TX packets:12 errors:0 dropped:0 overruns:0 carrier:0
- collisions:0 txqueuelen:1000
- RX bytes:188 (188.0 b) TX bytes:720 (720.0 b)
- Interrupt:25
-
- lo Link encap:Local Loopback
- inet addr:127.0.0.1 Mask:255.0.0.0
- inet6 addr: ::1/128 Scope:Host
- UP LOOPBACK RUNNING MTU:16436 Metric:1
- RX packets:0 errors:0 dropped:0 overruns:0 frame:0
- TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
- collisions:0 txqueuelen:0
- RX bytes:0 (0.0 b) TX bytes:0 (0.0 b)
-
- /root</output>
-</instance>
-</pre>
-
- </div>
- <div class="tab-pane" id="tab4">
-
- <h4 id="post">Create a new instance</h4>
-
- <p>
- To create a new instance use call <strong>POST /api/instances</strong>. At least, clients must specify the image from which the virtual machine instance is created. Optionally, a client may also specify a hardware profile and a realm (with default values used otherwise). Clients can also provide a name for the new instance though this is not supported by all back-end cloud providers. You can check whether a given feature is available in the response to the Deltacloud server API entry point. The details of the new instance are returned in response to this operation.
- </p>
-
- <p>
- To create an instance in the Amazon EC2 cloud a client can also specify the name of the used EC2 keypair as well as the firewalls (EC2 security groups) that the instance should be launched into. The EC2 keypair is specified with the parameter keyname while firewalls are specified sequentially as firewalls1 ... firewalls2 ... etc.
- </p>
-
- <p>
- See the example below. The values for public and private addresses are blank in the server response, because they have not yet been assigned by the cloud provider. Subsequent requests for the instance details will provide these values.
- </p>
-
- <p>
- As with other POST operations in the Deltacloud API, clients may specify parameters as multipart/form-data or as x-www-url-form-urlencoded content type, as you can see in examples below.
- </p>
-
- <p>Client request (<strong>AWS EC2</strong>):</p>
-
-<pre>
-POST /api/instances?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
-Host: localhost:3001
-Accept: */*
-Content-Length: 107
-Content-Type: application/x-www-form-urlencoded
-
-keyname=eftah&image_id=ami-f51aff9c&realm_id=us-east-1c&hwp_id=c1.medium&
-firewalls1=default&firewalls2=test
-</pre>
-
- <p>Server response:</p>
-
-<pre>
-HTTP/1.1 201 Created
-Content-Type: application/xml
-Content-Length: 1183
-
-<?xml version='1.0' encoding='utf-8' ?>
-<instance href='http://localhost:3001/api/instances/i-cbb861aa' id='i-cbb861aa'>
- <name>ami-f51aff9c</name>
- <owner_id>393485797142</owner_id>
- <image href='http://localhost:3001/api/images/ami-f51aff9c' id='ami-f51aff9c'></image>
- <realm href='http://localhost:3001/api/realms/us-east-1c' id='us-east-1c'></realm>
- <state>PENDING</state>
- <hardware_profile href='http://localhost:3001/api/hardware_profiles/c1.medium' id='c1.medium'>
- </hardware_profile>
- <actions>
- <link href='http://localhost:3001/api/instances/i-cbb861aa/stop' method='post' rel='stop' />
- <link href='http://localhost:3001/api/instances/i-cbb861aa/run;id=i-cbb861aa' method='post' rel='run' />
- </actions>
- <launch_time>2011-07-22T16:09:45.000Z</launch_time>
- <public_addresses></public_addresses>
- <private_addresses></private_addresses>
- <firewalls>
- <firewall href='http://localhost:3001/api/firewalls/test' id='test'></firewall>
- <firewall href='http://localhost:3001/api/firewalls/default' id='default'></firewall>
- </firewalls>
- <authentication type='key'>
- <login>
- <keyname>eftah</keyname>
- </login>
- </authentication>
-</instance>
-</pre>
-
- <p>
- In the following example you can see that the client provides the optional name parameter and that the created instance uses <strong>password</strong> type of authentication. Furthermore, the client uses a content-type of application/x-www-form-urlencoded. The username and password are returned with the details of the new instance:
- </p>
-
- <p>Example request: (<strong>Rackspace Cloudservers</strong>)</p>
-
-<pre>
-POST /api/instances?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
-Host: localhost:3002
-Accept: */*
-Content-Length: 34
-Content-Type: application/x-www-form-urlencoded
-
-image_id=53&hwp_id=1&name=myserver
-</pre>
-
- <p>Server response:</p>
-
-<pre>
-HTTP/1.1 201 Created
-Content-Type: application/xml
-Content-Length: 883
-
-<?xml version='1.0' encoding='utf-8' ?>
-<instance href='http://localhost:3002/api/instances/20112212' id='20112212'>
- <name>myserver</name>
- <owner_id>mandreou</owner_id>
- <image href='http://localhost:3002/api/images/53' id='53'></image>
- <realm href='http://localhost:3002/api/realms/us' id='us'></realm>
- <state>PENDING</state>
- <hardware_profile href='http://localhost:3002/api/hardware_profiles/1' id='1'>
- </hardware_profile>
- <actions>
- <link href='http://localhost:3002/api/instances/20112212/run;id=20112212' method='post' rel='run' />
- </actions>
- <public_addresses><address>50.57.116.72</address></public_addresses>
- <private_addresses><address>10.182.143.64</address></private_addresses>
- <authentication type='password'>
- <login>
- <username>root</username>
- <password>myserver4OvKh7Ak3</password>
- </login>
- </authentication>
-</instance>
-</pre>
-
-<div class="alert alert-error">
- <a class="close" data-dismiss="alert" href="#">×</a>
- <h4 class="alert-heading">Note:</h4>
- <p>
- The Deltacloud does not report potential errors, if you are creating an instance in <strong>vSphere</strong>. When you launch an instance, Deltacloud does not wait until the task is finished. Instead of that, Deltacloud creates a YAML representation of the instance in vSphere datastore. The YAML instance is in a 'PENDING' state until the 'real' instance is created. If the real instance fails to create, the YAML representation is removed. However, Deltacloud does not send you any error message.
- </p>
-</div>
-
- </div>
-</div>
-
-<a class="btn btn-inverse btn-large" style="float: right" href="/keys.html">Keys <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/#keys.md#
----------------------------------------------------------------------
diff --git a/site/output/#keys.md# b/site/output/#keys.md#
deleted file mode 100644
index fcbb2ab..0000000
--- a/site/output/#keys.md#
+++ /dev/null
@@ -1,226 +0,0 @@
----
-site_name: Deltacloud API
-title: Keys
----
-
-<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="keys">Keys</h3>
-
-<p>
-A key captures the credentials required to access an Instance. The Deltacloud API supports two main types of keys: the <strong>password</strong> type of key which have username and password attributes and the <strong>key</strong> type which have fingerprint and pem (private key) attributes (public/private keypair). The key type is determined by the back-end cloud provider.
-</p>
-
-<p>
-Some cloud providers require the specification of the credentials used for connecting to an instance as a parameter for instance creation. An example is the Amazon EC2 cloud which uses <strong>key</strong> type of keys and where the identifier of the key used with a given instance is supplied within the keyname parameter to the <a href="/instances.html#post">POST /api/instances</a> call.
-</p>
-
-<p>
-Other cloud providers report the instance credentials in response to instance creation and make them available for subsequent retrieval. For example, the Gogrid Cloud the <strong>password</strong> type of keys (note: the Rackspace cloud also reports credentials during instance creation though it does not provide a mechanism with which to retrieve those passwords thereafter).
-</p>
-
-<h4 id="get">Get a list of all keys</h4>
-
-<p>
-To get a list of all available keys use call <strong>GET /api/keys</strong>. The example shown below is for keys from the Amazon EC2 cloud, which are of type <strong>key</strong>. Note that the XML response does not contain the private key attribute. This is because EC2 only provides the private key once, when the key is created (see <a href="#create">key creation</a> for an example):
-</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="/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 class="active"><a href="#keys">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>Example request:</p>
-
-<pre>
-GET /api/keys?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: Tue, 26 Jul 2011 08:09:26 GMT
-Content-Length: 733
-
-<?xml version='1.0' encoding='utf-8' ?>
-<keys>
- <key href='http://localhost:3001/api/keys/deltacloud_jsmith' id='deltacloud_jsmith' type='key'>
- <actions>
- <link href='http://localhost:3001/api/keys/deltacloud_jsmith' method='delete' rel='destroy' />
- </actions>
- <fingerprint>38:93:81:11:83:c2:c7:27:e8:79:17:e2:08:c9:13:99:73:90:8e:cc</fingerprint>
- <state>AVAILABLE</state>
- </key>
- <key href='http://localhost:3001/api/keys/the_key' id='the_key' type='key'>
- <actions>
- <link href='http://localhost:3001/api/keys/the_key' method='delete' rel='destroy' />
- </actions>
- <fingerprint>39:d3:9b:bb:93:92:97:27:e9:7d:b7:e2:09:9d:b3:dd:73:d0:9e:99</fingerprint>
- <state>AVAILABLE</state>
- </key>
-</keys>
-</pre>
-
-<h4>Get the description of a key</h4>
-
-<p>
-To get the XML description for a specific key use call <strong>GET /api/keys/:id</strong>. The example below shows a key of type <strong>password</strong> from the Gogrid cloud:
-</p>
-
-<p>Example request:</p>
-
-<pre>
-GET /api/keys/72398?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.21.2 (x86_64-apple-darwin10.3.1)
-Host: localhost:3001
-Accept: */*
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-HTTP/1.1 200 OK
-Content-Type: application/xml
-Date: Tue, 26 Jul 2011 11:13:25 GMT
-Content-Length: 269
-
-<?xml version='1.0' encoding='utf-8' ?>
-<key href='http://localhost:3001/api/keys/72398' id='72398' type='password'>
- <actions>
- </actions>
- <username><![CDATA[26648]]></username>
- <password><![CDATA[3woc7UWdJsJEcm8@]]></password>
- <state></state>
-</key>
-</pre>
-
-<h4 id="create">Create a new key</h4>
-
-<p>
-To create a new key use call <strong>POST /api/keys</strong>. Some back-end cloud providers allow a client to create new credentials for accessing Instances. The parameters (key attributes) required by this function will depend on the back-end and are specified in the relevant driver. At present only the Amazon EC2 cloud implements a key create method and this requires the key name to be specified as a parameter. It should be noted that the private key attribute of a newly created key is reported only once, in response to the create operation as shown in the example below. The client should save the private key for future use with instance authentication. In all subsequent calls, only the fingerprint attribute is displayed in the Deltacloud server response, as illustrated by the <a href="#get">GET /api/keys</a> call above.
-</p>
-
-<p>
-Note that as with other HTTP POST calls in the Deltacloud REST API, client requests may specify the required parameters as multipart/form-data, or using the application/x-www-form-urlencoded content type.
-</p>
-
-<p>Example request:</p>
-
-<pre>
-POST /api/keys?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
-Host: localhost:3001
-Accept: */*
-Content-Length: 19
-Content-Type: application/x-www-form-urlencoded
-
-name=jsmith_new_key
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-HTTP/1.1 201 Created
-Content-Type: application/xml
-Date: Tue, 26 Jul 2011 10:58:58 GMT
-Content-Length: 2062
-
-<?xml version='1.0' encoding='utf-8' ?>
-<key href='http://localhost:3001/api/keys/jsmith_new_key' id='jsmith_new_key' type='key'>
- <actions>
- <link href='http://localhost:3001/api/keys/jsmith_new_key' method='delete' rel='destroy' />
- </actions>
- <fingerprint>c6:80:5c:0a:b8:66:0d:58:5a:bf:0f:c2:5d:35:d3:c7:49:f3:5a:5f</fingerprint>
- <pem>
- <![CDATA[-----BEGIN RSA PRIVATE KEY-----
- MIIEpgIBAAKCAQEAsPIzLQEpoLkxd0WESPEWQ4AMn9e0T6jHIMl/a2GUx2TA2Q10n6i5h4VAXXrK
- m9fNnPJhw1uRbuL7Oz57QSftGUfz05EaLOsvIEq3OXA0HqnFPF7Dd4yvy07KfgNHe2c26NqIqxgw
- GCy6tfd/9iKQIlFCG8I/M6fgEG/vw30GP5EywYLS0J7lYfNHJAVAznjX0LoOWvT0zYajZ7gWJ30/
- sQ/IFaKxC3BpT6K2aQP+RgAimALHinFuoT4+07SsrQXEezLemAG/gdbw3+7DL9BGq0CCoY1RxeC7
- qNh9BJwHtq9QPYg/RKruiYak/TSoB71/VP67lJv0WEkCRJKEFpz5SQIDAQABAoIBAQChVyZcmdvI
- JjS5aVSWYeWIBMD+GmPZ4q428iPR2LcdHHxPLVqyndkVfeXTlrwZX6umuMd1pw+zyRmEypL+NRaW
- 36mutnbkkEl3K0loASw07V3fjxSx9EDyo1Q1lG3gUpuZtHG7eCGaWWahtxwhZSCBehBKWVLhmefP
- dRFs8Zn56LhfxByS/HcmHYddq1ggynFgg1DszYKTiJ0k5Zd/w4gh3GXH02S50cNFumJh9tbZNeDz
- yqa6a12N21loZ/VRRL7lEjpf3K2n0DCQ5pp0I9/FiwuwHMWr6qPSsQt9N/XclNiVg7fz+btNsqVY
- US1kBkvazoaANmF3VOXT9bmiFnuBAoGBAOkURD2uBe9UUl7xvWON7yS+tBcs1KyYDsTEhsS5dLdk
- n73/5vyEVzozdywTR7lQWVQhWWwkK/FJd9Xo/VV5bGXl+MK/JxIQHrEhLzO1OeYEBiw2eKhigyDb
- lm7pk/DuBNqgnA9YVnSvRYjpnvgBeb89CHvdhqn52GcbB2ShXurRAoGBAMJYyqNyl8CiIqesigts
- tlRk0UmS/LS6I58f7nbcrkgO3ZDsYhXhj9aKSJx56bpWTwoFdl7nTSUwkFgq2ts3g7EPQbYD/5G6
- kwpq0tvC23zZTfYvjExNVORh9PJBCrBl1tC/5nqYSrHC7H3Ys/SW3DF+0LPTdOtx5FwL5Utr3lT5
- AoGBAM3Y8EvpHaS5O+ZOaY07FTHGmxa8qTelM6XkS4ICqGovnEUZdM8fskncmit6+6VWqQ38RhWT
- /Jsk34k0NEkA7BMyf/i/CaqSQgj93co1C+VxOGJj2TwdhOHIDZv2/omSLQdJQYrr4a87/JVmftdZ
- tkSHiq6afwwvdEfbPzRIsKOBAoGBAK5EjEAP6z+So1yS/J3N95ipZnmA0hUErBhtu5jdvXFj0w22
- ySUxw5bvHLkjIJA0AF/OEhx7b9OfPm+wzdqwZugH9DZQU4TLNjqrGzRv//xtptjQPg/Vb//yToBE
- Dl+qkftReEwJ70CCtykJfiQeeofvXRlCzZ6p28kl6Y+9w/mRAoGBANI8AGB1iUDMQDiEfTAuH7jB
- nZTZUsfAaysoku3gyVmtcu1Zo7T02b8YW3ypuNu664KO7eNik9q68yKa7oDuLVrVj6Sh2DInoeW9
- vbjp2KcyMVEPHzWh86LV9IY5oHjQxlK/PMhQWMEeysi6j2qFqrx2rqRhG6kZUcFHFoHQpmv2
- -----END RSA PRIVATE KEY-----]]>
- </pem>
- <state>AVAILABLE</state>
-</key>
-</pre>
-
-<h4>Delete a key</h4>
-
-<p>
-To delete a key, specified by its <strong>:id</strong> attribute use call <strong>DELETE /api/keys/:id</strong>. Note that as with the :create operation, this feature is currently only available in the Amazon EC2 driver.
-</p>
-
-<p>Example request:</p>
-
-<pre>
-DELETE /api/keys/jsmith_new_key?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: Tue, 26 Jul 2011 10:18:38 GMT
-</pre>
-
-<a class="btn btn-inverse btn-large" style="float: right" href="/firewalls.html">Firewalls <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/#load-balancers.md#
----------------------------------------------------------------------
diff --git a/site/output/#load-balancers.md# b/site/output/#load-balancers.md#
deleted file mode 100644
index 0c79b4f..0000000
--- a/site/output/#load-balancers.md#
+++ /dev/null
@@ -1,317 +0,0 @@
----
-site_name: Deltacloud API
-title: Load balancers
----
-
-<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="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 and typically only instances within this realm may be 'attached' to the balancer. Each load_balancer also has a <strong>list of instances</strong>, a <strong>public address</strong> representing the IP address that the balancer will respond on to client requests, a <strong>created_at</strong> timestamp and a list of <strong>listeners</strong>. 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>
-
-<h4>Get a list of all buckets</h4>
-
-<p>
-To retrieve details of all load_balancers use call <strong>GET /api/load_balancers</strong>.
-</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="/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>
-
-<ul class="nav nav-pills">
- <li class="active"><a href="#tab1" data-toggle="tab">Get details</a></li>
- <li><a href="#tab2" data-toggle="tab">Get the deteails of an address</a></li>
- <li><a href="#tab3" data-toggle="tab">Create/delete an address</a></li>
- <li><a href="#tab4" data-toggle="tab">Associate/disassociate an address</a></li>
-</ul>
-
-<div class="tab-content">
- <div class="tab-pane active" id="tab1">
-
-
-<h4>Get a list of all buckets</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>
-
-<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>
-
-<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>
-
-<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>
-
-<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>
-
-<br/>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/output/#rest-api.md#
----------------------------------------------------------------------
diff --git a/site/output/#rest-api.md# b/site/output/#rest-api.md#
deleted file mode 100644
index 8b88754..0000000
--- a/site/output/#rest-api.md#
+++ /dev/null
@@ -1,184 +0,0 @@
----
-site_name: Deltacloud API
-title: REST API
----
-
-<br/>
-
-<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.
- <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 (e.g. 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>
-</dl>
-
-<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>
-Beyond 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 volume, 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, which is the basis for this document. Output is also available as JSON and as HTML (mostly for tesing). Clients can also explicitly request a specific response format by including the <strong>format=</strong> request parameter (e.g. http://deltacloudserver.foo/api?format=xml or http://deltacloudserver.foo/api?format=json).
-</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 (e.g. 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 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>
-Automatically generated documentation can be accessed 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/>
-
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/output/#run-deltacloud-server.md#
----------------------------------------------------------------------
diff --git a/site/output/#run-deltacloud-server.md# b/site/output/#run-deltacloud-server.md#
deleted file mode 100644
index c40199b..0000000
--- a/site/output/#run-deltacloud-server.md#
+++ /dev/null
@@ -1,50 +0,0 @@
----
-site_name: Deltacloud API
-title: Run the Deltacloud server
----
-<br/>
-<h2> Quick-start guide</h2>
-<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>
-
-<h2>Deltacloud HTML interface</h2>
-<p>After you start the server, you are ready to use the Deltacloud HTML interface.</p>
-<p>Open the following address in your web browser:</p>
-<pre>http://localhost:3001/api</pre>
-<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 credentials when you invoke an operation that requires authentication.</p>
-
-The '-h' flag will list all available options for deltacloudd. For example, to start the Deltacloud server with the Rackspace driver on port 10000 you can use:</p>
-
-<pre>$ deltacloudd -i rackspace -p 10000</pre>
-
-<p>You may want to install the server on another machine and make Deltacloud available on your local network. To do this you need to bind the Deltacloud server to an address other than 'localhost' (default). For instance, if you install and start Deltacloud on a machine with the IP address 192.168.10.200 you should start the server with:</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>.</p>
-
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/output/#send-patch.md#
----------------------------------------------------------------------
diff --git a/site/output/#send-patch.md# b/site/output/#send-patch.md#
deleted file mode 100644
index 0e41e0e..0000000
--- a/site/output/#send-patch.md#
+++ /dev/null
@@ -1,243 +0,0 @@
----
-site_name: Deltacloud API
-title: Send a Patch
----
-
-<br/>
-
-<h3>Formatting and sending patches</h3>
-
-<p>
-The Deltacloud community works with <a href="http://book.git-scm.com/">Git</a>. The process of contributing to the project we prefer contains these steps: <strong>local_branch → patch → review → accept → commit</strong> process for contributing to the project. This is how the typical workflow used by the core developers looks like:
-</p>
-
-<ol>
- <li>
- <p>
- Set the following settings inside the git configuration file. The config file is located in the root of the Deltacloud project in a hidden <strong>.git</strong> directory. Open the config file with your preferred editor:
- </p>
-
-<pre>
-$ vim deltacloud/.git/config
-</pre>
-
- <p>
- Add the following information to the configuration file and replace the relevant values with your own ones:
- </p>
-
-<pre>
-[sendemail]
-signedoffbycc = no
-chainreplyto = no
-smtpserver = your_smpt.server.address
-thread = yes
-from = your_email_address
-suppresscc = all
-to = dev@deltacloud.apache.org
-
-[core]
-whitespace = trailing-space,space-before-tab
-
-[apply]
-whitespace = error-all
-</pre>
-
- </li>
- <li>
- <p>
- Get the latest HEAD of the Deltacloud git repo. You will gain one local branch called master:
- </p>
-
-<pre>
-$ git branch
-* master
-</pre>
-
- </li>
- <li>
- <p>
- Fetch the latest changes from the git repo:
- </p>
-
-<pre>
-$ git pull
-</pre>
-
- </li>
- <li>
- <p>
- Create a new local branch for your edits and give it a name:
- </p>
-
-<pre>
-$ git checkout -b my_new_branch
-</pre>
-
- </li>
- <li>
- <p>
- Make your changes and then check, what you've edited:
- </p>
-
-<pre>
-$ git status
-</pre>
-
- </li>
- <li>
- <p>
- Commit these changes to your local branch:
- </p>
-
-<pre>
-$ git commit -a
-</pre>
-
- <p>
- This will open an editor (e.g. vi). Enter a commit message. The message should be short and succinct and individual lines shouldn't be longer than 80 characters. See the recent commits with their commit messages to find an inspiration:</p>
-
-<pre>
-$ git log
-</pre>
-
- <p>
- When you commit your changes to your local branch, the local branch will be different from your <strong>local master</strong> branch. Other developers may have already committed their changes to the <strong>remote master</strong> branch in the Apache git repo in the meantime. Thus, you need to fetch any new changes and merge them into your <strong>local master</strong>.
- </p>
-
- </li>
- <li>
- <p>
- Change to master and fetch upstream changes (it there are any):
- </p>
-
-<pre>
-$ git checkout master
-$ git pull
-</pre>
-
- <p>
- Your <strong>local</strong> master is now up-to-date with the <strong>remote</strong> master in the git repo.
- </p>
- </li>
- <li>
- <p>
- Rebase the local master onto the branch containing your changes:
- </p>
-
-<pre>
-$ git rebase master my_new_branch
-</pre>
-
- <p>
- This allows you to make patches against master and send them to the Deltacloud mailing list.
- </p>
-
-<pre>
-$ git format-patch -o /path/to/where/you/keep/patches/ master
-$ git send-email --compose --subject 'some subject'
- --thread /path/to/where/you/keep/patches/*
-</pre>
-
- <p>
- The other members of the community will review your patches. The patch has to receive at least one <strong>ACK </strong>and no <strong>NACK</strong> to be approved. Then the patch will be committed by one of the Deltacloud developers with commit rights to the Apache repo. If noone is responding to your patch sent to mailing list, feel free to remind yourself after few days.
- </p>
- </li>
-</ol>
-
-<p>
-You can also contribute to the project by reviewing patches sent by other contributors:
-</p>
-
-<ol>
- <li>
- <p>
- Make a new branch where you will apply the patches and test:
- </p>
-
-<pre>
-$ git checkout -b jsmith_patches
-</pre>
-
- </li>
- <li>
- <p>
- Save the patches to a known location and make sure you're on the right branch . Then apply.
- </p>
-
-<pre>
-$ git checkout jsmith_patches
-
-$ cat /path/to/patches/0001-name-of-patch.txt | git apply
-</pre>
-or
-<pre>
-$ git am /path/to/patches/0001-name-of-patch.eml
-</pre>
-
- <p>
- You can use <strong>git am</strong> ("apply mail") to apply patches in mail format, or <strong>git apply</strong> for plain-text patches. If you use <strong>git apply</strong>, you will only apply the patches, whereas <strong>git am</strong> will also commit the patches to the local branch (preserving the author's commit messages). However, the difference between <strong>git am</strong> and <strong>git apply</strong> is insignificant for the purpose of reviewing patches. It depends on whether you want to save the patches as plain-text or in .mbox email format.
- </p>
-
- </li>
- <li>
-
-<p>
-If you think the patches are working correctly, send an <strong>ACK</strong> to the Deltacloud <a href="http://mail-archives.apache.org/mod_mbox/deltacloud-dev/">mailing list</a>. Similarly, if you think the patches could cause a problem, send a <strong>NACK</strong> and explain the issue you have found.
-</p>
- </li>
-</ol>
-
-<a class="btn btn-inverse btn-large" style="float: right" data-toggle="modal" href="#tests">Test the driver</a>
-
-<br/>
-
-<div class="modal hide" id="tests">
- <div class="modal-header">
- <button class="close" data-dismiss="modal">×</button>
- <h3>Writing and running tests</h3>
- </div>
- <div class="modal-body">
-
-<p>
-You should add a test to every new feature or new driver you create to make sure, that everything is running as expected. There are two different directories in the Deltacloud project, where the tests are stored: <strong>/deltacloud/server/tests</strong> for Unit tests for drivers and <strong>/deltacloud/tests</strong> for Cucumber tests.
-</p>
-
-<p>Initiate the Unit tests:</p>
-
-<pre>
-$ cd /path/to/deltacloud/server
-$ rake test
-</pre>
-
-<p>This will invoke all Unit tests defined in <strong>/deltacloud/server/tests</strong> by inspecting the Rakefile in <strong>/deltacloud/server</strong>. To invoke a specific driver tests type:</p>
-
-<pre>
-$ cd /path/to/deltacloud/server
-$ rake test:rackspace
- _OR_
-$ rake test:mock
- _etc_
-</pre>
-
-<p>Initiate the Cucumber tests:</p>
-
-<pre>
-$ cd /path/to/deltacloud/server
-$ rake cucumber
-</pre>
-
-<p>Alternatively, you can invoke the cucumber tests directly without using Rakefile: </p>
-
-<pre>
-$ cd /path/to/deltacloud/server
-$ cucumber ../tests/mock
- _OR_
-$ cucumber ../tests/ec2
- _etc_
-</pre>
-
- </div>
- <div class="modal-footer">
- <a href="#" class="btn" data-dismiss="modal">Close</a>
- </div>
-</div>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/c7f4d022/site/output/#storage-resources.md#
----------------------------------------------------------------------
diff --git a/site/output/#storage-resources.md# b/site/output/#storage-resources.md#
deleted file mode 100644
index 582436d..0000000
--- a/site/output/#storage-resources.md#
+++ /dev/null
@@ -1,333 +0,0 @@
----
-site_name: Deltacloud API
-title: Storage resources
----
-
-<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="resources">Storage resources</h3>
-
-<p>
-Storage resources are divided into two groups: storage volumes can be attached to a running instance (accessible by the instance OS), and blob storage which represents a generic 'key <−−> value' based data store, as implemented by Rackspace CloudFiles or Amazon S3. Storage snapshots represent a storage volume, a backup which is created at a particular point of time (a snapshot).
-</p>
-
-<h3 id="volumes">Storage Volumes</h3>
-
-<p style="margin-bottom:0px">
-A storage_volume has a <strong>capacity</strong> expressed in Gigabytes, a <strong>created</strong> timestamp, a <strong>realm_id</strong> specifying the realm in which the volume exists, a <strong>state</strong> (for Amazon EC2 this is one of creating | available | in-use | deleting | deleted | error) and a set of <strong>actions</strong>. When attached to an instance, a storage_volume will also expose a <strong>mount</strong> element
-</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 class="active"><a href="#resources">Storage resources</a></li>
- <ul class="nav nav-list">
- <li><a href="#volumes">Storage volumes</a></li>
- <li><a href="/storage-snapshots.html">Storage snaphots</a></li>
- <li><a href="/blob-storage.html">Blob storage</a></li>
- </ul>
-</ul>
-
- </div>
-</div>
-
-
-<p style="margin-top:0px">
-which contains the attributes <strong>instance </strong>and <strong>device</strong>, specifying the instance to which the volume is attached and the mount point (e.g. /dev/sdh), respectively.
-</p>
-
-<h4>Get a list of all storage volumes</h4>
-
-<p>
-To list all storage volumes use call <strong>GET /api/storage_volumes</strong>.
-</p>
-
-<p>
-Example request:
-</p>
-
-<pre>
-GET /api/storage_volumes?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 21:04:09 GMT
-Content-Length: 1341
-
-<?xml version='1.0' encoding='utf-8' ?>
-<storage_volumes>
- <storage_volume href='http://localhost:3001/api/storage_volumes/vol-0bc0de60' id='vol-0bc0de60'>
- <created>Thu Jul 28 20:44:18 UTC 2011</created>
- <capacity unit='GB'>10</capacity>
- <realm_id>us-east-1c</realm_id>
- <state>AVAILABLE</state>
- <actions>
- <link href='http://localhost:3001/api/storage_volumes/vol-0bc0de60/attach' method='post' rel='attach' />
- <link href='http://localhost:3001/api/storage_volumes/vol-0bc0de60/detach' method='post' rel='detach' />
- <link href='http://localhost:3001/api/storage_volumes/vol-0bc0de60' method='delete' rel='destroy' />
- </actions>
- </storage_volume>
- <storage_volume href='http://localhost:3001/api/storage_volumes/vol-99fbe5f2' id='vol-99fbe5f2'>
- <created>Thu Jul 28 20:56:07 UTC 2011</created>
- <capacity unit='GB'>15</capacity>
- <realm_id>us-east-1c</realm_id>
- <state>AVAILABLE</state>
- <actions>
- <link href='http://localhost:3001/api/storage_volumes/vol-99fbe5f2/attach' method='post' rel='attach' />
- <link href='http://localhost:3001/api/storage_volumes/vol-99fbe5f2/detach' method='post' rel='detach' />
- <link href='http://localhost:3001/api/storage_volumes/vol-99fbe5f2' method='delete' rel='destroy' />
- </actions>
- </storage_volume>
-</storage_volumes>
-</pre>
-
-<h4>Get the details for a storage volume</h4>
-
-<p>
-To retrieve the details for the specified storage_volume use call <strong>GET /api/storage_volumes/:id</strong>.
-</p>
-
-<p>Example request:</p>
-
-<pre>
-GET /api/storage_volumes/vol-99fbe5f2?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 21:06:39 GMT
-Content-Length: 794
-<?xml version='1.0' encoding='utf-8' ?>
-<storage_volume href='http://localhost:3001/api/storage_volumes/vol-99fbe5f2' id='vol-99fbe5f2'>
- <created>Thu Jul 28 20:56:07 UTC 2011</created>
- <capacity unit='GB'>15</capacity>
- <realm_id>us-east-1c</realm_id>
- <state>IN-USE</state>
- <mount>
- <instance href='i-b100b3d0' id='i-b100b3d0'></instance>
- <device name='/dev/sdh'></device>
- </mount>
- <actions>
- <link href='http://localhost:3001/api/storage_volumes/vol-99fbe5f2/attach' method='post' rel='attach' />
- <link href='http://localhost:3001/api/storage_volumes/vol-99fbe5f2/detach' method='post' rel='detach' />
- <link href='http://localhost:3001/api/storage_volumes/vol-99fbe5f2' method='delete' rel='destroy' />
- </actions>
-</storage_volume>
-</pre>
-
-<h4>Create a new storage volume</h4>
-
-<p>
-To create a new storage_volume use call <strong>POST /api/storage_volumes</strong>. A client may specify a <strong>snapshot_id</strong> from which to instantiate the storage_volume though this is optional. The <strong>capacity</strong> parameter, expressed in Gigabytes, is also optional and will default to 1 Gigabyte. Finally clients may also specify the <strong>realm_id</strong> as a storage_volume can typically only be attached to instances running within the specified realm. If the realm is not specified it will default to the first realm returned by the cloud provider. A succesful operation will return <strong>HTTP 201 Created</strong> with the details of the newly created storage_volume.
-</p>
-
-<p>
-As with the other <strong>POST</strong> operations in the Deltacloud API, clients may choose to specify operation parameters as multipart/form-data or as application/x-www-form-urlencoded data.
-</p>
-
-<p>Example request:</p>
-
-<pre>
-POST /api/storage_volumes?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
-Host: localhost:3001
-Accept: */*
-Content-Length: 31
-Content-Type: application/x-www-form-urlencoded
-
-capacity=10&realm_id=us-east-1c
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-HTTP/1.1 201 Created
-Date: Thu, 28 Jul 2011 20:44:27 GMT
-Content-Length: 649
-
-<?xml version='1.0' encoding='utf-8' ?>
-<storage_volume href='http://localhost:3001/api/storage_volumes/vol-0bc0de60' id='vol-0bc0de60'>
- <created>Thu Jul 28 20:44:18 UTC 2011</created>
- <capacity unit='GB'>10</capacity>
- <realm_id>us-east-1c</realm_id>
- <state>CREATING</state>
- <actions>
- <link href='http://localhost:3001/api/storage_volumes/vol-0bc0de60/attach' method='post' rel='attach' />
- <link href='http://localhost:3001/api/storage_volumes/vol-0bc0de60/detach' method='post' rel='detach' />
- <link href='http://localhost:3001/api/storage_volumes/vol-0bc0de60' method='delete' rel='destroy' />
- </actions>
-</storage_volume>
-</pre>
-
-<h4>Delete a storage volume</h4>
-
-<p>
-To delete the specified storage_volume use call <strong>DELETE /api/storage_volumes/:id</strong>. The operation will return a <strong>HTTP 204 No Content</strong> after a succesful operation. Note that the operation will fail if the given storage_volume is currently attached to an instance.
-</p>
-
-<p>Example request:</p>
-
-<pre>
-DELETE /api/storage_volumes/vol-0bc0de60?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 22:34:29 GMT
-</pre>
-
-<p>Example request: (error deleting a volume currently attached to an instance)</p>
-
-<pre>
-DELETE /api/storage_volumes/vol-0bc0de60?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 502 Bad Gateway
-Content-Type: application/xml
-Date: Thu, 28 Jul 2011 22:30:07 GMT
-Content-Length: 617
-
-<error status='502' url='/api/storage_volumes/vol-0bc0de60?format=xml'>
- <kind>backend_error</kind>
- <backend driver='ec2'>
- <code>502</code>
- </backend>
- <message><![CDATA[Client.VolumeInUse: Volume vol-0bc0de60 is currently attached to i-b100b3d0
- REQUEST=ec2.us-east-1.amazonaws.com:443/?AWSAccessKeyId=AKIAJATNOR5HKG3FK27Q&Action=DeleteVolume&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2011-07-28T22%3A30%3A00.000Z&Version=2010-08-31&VolumeId=vol-0bc0de60&Signature=WnZTd9vFaUZEwfuifyo3%2FWa2HBEG1S7R8Iv%2FHqc%2BmqE%3D
- REQUEST ID=5dff67bb-d63a-4055-b550-f323fa16e185]]></message>
-</error>
-</pre>
-
-<h4>Attach a storage volume to a running instance</h4>
-
-<p>
-To attach the specified storage_volume to a running instance use call <strong>POST /api/storage_volumes/:id/attach</strong>. Clients must specify the <strong>instance_id</strong> and the <strong>device</strong> as parameters. The device parameter is used as the 'mount point', that is, the location at which the storage_volume will be exposed to the given instance (e.g., /dev/sdh). The Deltacloud server will respond with a <strong>HTTP 202 Accepted</strong> after a succesful attach operation together with details of the storage_volume. Note in the example below that the state is reported as 'unknown' although the <strong>mount</strong> element is present, as the processing has not yet been completed (hence the 202 status code). Clients may specify the required parameters as multipart/form-data or as application/x-www-form-urlencoded data.
-</p>
-
-<p>Example request:</p>
-
-<pre>
-POST /api/storage_volumes/vol-0bc0de60/attach?format=xml HTTP/1.1
-Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
-User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
-Host: localhost:3001
-Accept: */*
-Content-Length: 38
-Content-Type: application/x-www-form-urlencoded
-
-instance_id=i-b100b3d0&device=/dev/sdi
-</pre>
-
-<p>Server response:</p>
-
-<pre>
-HTTP/1.1 202 Accepted
-Date: Thu, 28 Jul 2011 21:36:17 GMT
-Content-Length: 709
-
-<?xml version='1.0' encoding='utf-8' ?>
-<storage_volume href='http://localhost:3001/api/storage_volumes/vol-0bc0de60' id='vol-0bc0de60'>
- <capacity unit='GB'></capacity>
- <device>/dev/sdi</device>
- <state>unknown</state>
- <mount>
- <instance href='i-b100b3d0' id='i-b100b3d0'></instance>
- <device name='/dev/sdi'></device>
- </mount>
- <actions>
- <link href='http://localhost:3001/api/storage_volumes/vol-0bc0de60/attach' method='post' rel='attach' />
- <link href='http://localhost:3001/api/storage_volumes/vol-0bc0de60/detach' method='post' rel='detach' />
- <link href='http://localhost:3001/api/storage_volumes/vol-0bc0de60' method='delete' rel='destroy' />
- </actions>
-</storage_volume>
-</pre>
-
-<h4>Detach a storage volume from an instance</h4>
-
-<p>
-To detache the given storage_volume from the instance to which it is currently attached use call <strong>POST /api/storage_volumes/:id/detach</strong>. A succesful operation will return <strong>HTTP 201 Accepted</strong> together with details of the storage_volume. Note in the example that like the attach operation above, <strong>state</strong> is reported as 'unknown' and the <strong>mount</strong> element is still present as the processing has not yet been completed (hence the 202 status code).
-</p>
-
-<p>Example request:</p>
-
-<pre>
-POST /api/storage_volumes/vol-0bc0de60/detach?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 202 Accepted
-Content-Type: application/xml
-Date: Thu, 28 Jul 2011 21:29:18 GMT
-Content-Length: 709
-
-<?xml version='1.0' encoding='utf-8' ?>
-<storage_volume href='http://localhost:3001/api/storage_volumes/vol-0bc0de60' id='vol-0bc0de60'>
- <capacity unit='GB'></capacity>
- <device>/dev/sdi</device>
- <state>unknown</state>
- <mount>
- <instance href='i-b100b3d0' id='i-b100b3d0'></instance>
- <device name='/dev/sdi'></device>
- </mount>
- <actions>
- <link href='http://localhost:3001/api/storage_volumes/vol-0bc0de60/attach' method='post' rel='attach' />
- <link href='http://localhost:3001/api/storage_volumes/vol-0bc0de60/detach' method='post' rel='detach' />
- <link href='http://localhost:3001/api/storage_volumes/vol-0bc0de60' method='delete' rel='destroy' />
- </actions>
-</storage_volume>
-</pre>
-
-<a class="btn btn-inverse btn-large" style="float: right" href="/storage-snapshots.html">Storage snapshots <i class="icon-arrow-right icon-white" style="vertical-align:baseline"> </i></a>
-
-<br/>
-