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/01/03 14:14:39 UTC
svn commit: r1428326 [1/2] - in /deltacloud/trunk/site: content/
layouts/partials/default/ output/
Author: marios
Date: Thu Jan 3 13:14:38 2013
New Revision: 1428326
URL: http://svn.apache.org/viewvc?rev=1428326&view=rev
Log:
SITE: Adds CIMI REST API and cURL Examples (incomplete)
Added:
deltacloud/trunk/site/content/cimi-curl.md
deltacloud/trunk/site/content/cimi-rest-collections.md
deltacloud/trunk/site/content/cimi-rest-entry-point.md
deltacloud/trunk/site/content/cimi-rest-machine-images.md
deltacloud/trunk/site/content/cimi-rest.md
deltacloud/trunk/site/output/cimi-curl.html
deltacloud/trunk/site/output/cimi-rest-collections.html
deltacloud/trunk/site/output/cimi-rest-entry-point.html
deltacloud/trunk/site/output/cimi-rest-machine-images.html
deltacloud/trunk/site/output/cimi-rest.html
Modified:
deltacloud/trunk/site/layouts/partials/default/nav.html
Added: deltacloud/trunk/site/content/cimi-curl.md
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/content/cimi-curl.md?rev=1428326&view=auto
==============================================================================
--- deltacloud/trunk/site/content/cimi-curl.md (added)
+++ deltacloud/trunk/site/content/cimi-curl.md Thu Jan 3 13:14:38 2013
@@ -0,0 +1,106 @@
+---
+site_name: Deltacloud API
+title: CIMI cURL Examples
+---
+
+<br/>
+
+<div class="row">
+
+ <div class="span8">
+
+ <h3 id="command">Working with cURL against the Deltacloud CIMI frontend</h3>
+
+ <p> The <a href="http://curl.haxx.se/docs/">cURL documentation</a> is pretty comprehensive, but the following are some general points to remember for using cURL against Deltacloud. All the examples on this page assume the deltacloud server is running at localhost:3001: </p>
+
+ <ul>
+ <li>
+ Credentials are specified with <strong> --user "name:password" </strong>
+ </li>
+ <li>
+ Request headers are specified with <strong> -H "header: value" </strong>. For the "Accept" header Deltacloud offers a convenient way of specifying the desired response format; you can include the <strong>"?format="</strong> parameter into the request URL rather than setting the Accept header
+ </li>
+ <li>
+ HTTP verbs are specified with <strong>-X VERB</strong>
+ </li>
+ <li>
+ The <strong> -i </strong> flag will show you the response headers and the <strong> -v </strong> flag will show you request and response headers as well as info about cURL activity:
+ <pre>
+curl -v -X DELETE --user "username:password" -H "Accept: application/xml" http://localhost:3001/cimi/images/my_image
+ </pre>
+ </li>
+ </ul>
+
+ </div>
+
+ <div class="span4">
+
+ <ul class="nav nav-list well">
+ <li class="nav-header">cURL as a deltacloud client</li>
+ <li><a href="#machines">Work with Machines</a></li>
+ <li><a href="#machine-images">Work with Machine Images</a></li>
+ </ul>
+
+ </div>
+</div>
+
+<hr/>
+
+<h4 id="machines">Working with Machines</h4>
+
+<p>Retrieve the Machine Collection in json format:</p>
+
+<pre> curl --user "user:pass" -H "Accept: application/json" http://localhost:3001/cimi/machines </pre>
+
+<p>Create a new Machine with the message body in XML format:</p>
+
+<pre>
+curl -v --user "mockuser:mockpassword" -X POST -H "Content-Type: application/xml" -H "Accept: application/xml" -d '<MachineCreate xmlns="http://schemas.dmtf.org/cimi/1"> <name> myMachine1 </name> <description> my machine description </description> <machineTemplate> <machineConfig href="http://localhost:3001/cimi/machine_configurations/m1-small"> </machineConfig> <machineImage href="http://localhost:3001/cimi/machine_images/img1"> </machineImage> </machineTemplate> </MachineCreate>'
+</pre>
+
+<p>Alternatively, specifying the message body in JSON:</p>
+<pre>
+ curl -v --user "user:password" -X POST -H "Content-Type: application/json" -H "Accept: application/xml" -d '{ "resourceURI": "http://schemas.dmtf.org/cimi/1/MachineCreate", "name": "myMachine3", "description": "My very first json machine", "machineTemplate": { "machineConfig": { "href": "http://localhost:3001/cimi/machine_configurations/m1.small" }, "machineImage": { "href": "http://localhost:3001/cimi/machine_images/ami-48aa4921" } } }' http://localhost:3001/cimi/machines
+</pre>
+
+<p>Perform a Machine operation - stop - with the message body in XML format:</p>
+
+<pre>
+curl -v -X POST --user "mockuser:mockpassword" -H "Content-Type: application/xml" -H "Accept: application/xml" -d '<Action xmlns="http://schemas.dmtf.org/cimi/1"><action> http://http://schemas.dmtf.org/cimi/1/action/stop </action> </Action>' http://localhost:3001/cimi/machines/inst3/stop
+</pre>
+
+<p>Alternatively, specifying the message body in JSON:</p>
+<pre>
+ curl -v -X POST --user "user:password" -H "Accept: application/json" -H "Content-Type: application/json" -d '{"resourceURI": "http://www.dmtf.org/cimi/1/Action", "action":"http://www.dmtf.org/cimi/action/stop"}' http://localhost:3001/cimi/machines/i-5feb7c20/stop
+</pre>
+
+<br/>
+
+<hr/>
+
+<h4 id="machine-images">Working with Machine Images</h4>
+
+<p>Retrieve the Machine Image Collection:</p>
+
+<pre>
+curl --user "user:pass" -H "Accept: application/json" http://localhost:3001/cimi/machine_images
+</pre>
+
+<p>Create a new Machine Image from an existing Machine, with message body in JSON:</p>
+
+<pre>
+curl --user "mockuser:mockpassword" -X POST -H "Content-Type: application/json" -H "Accept: application/json" -d '{"resourceURI":"http://schemas.dmtf.org/cimi/1/MachineImage", "name":"new_image","description":"my new machine image","type":"IMAGE", "imageLocation":"http://localhost:3001/cimi/machines/inst1"}' http://localhost:3001/cimi/machine_images
+</pre>
+
+
+<p>Alternatively, specifying the message body in XML:</p>
+
+<pre>
+curl -v --user "mockuser:mockpassword" -H "Content-Type: application/xml" -H "Accept: application/xml" -X POST -d "<MachineImage><name>some_name</name><description>my new machine image</description><type>IMAGE</type><imageLocation>http://localhost:3001/cimi/machines/inst1</imageLocation></MachineImage>" http://localhost:3001/cimi/machine_images
+</pre>
+
+
+<p>Delete a Machine Image:</p>
+
+<pre>curl -X DELETE --user "user:pass" http://localhost:3001/cimi/machine_images/my_image </pre>
+
Added: deltacloud/trunk/site/content/cimi-rest-collections.md
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/content/cimi-rest-collections.md?rev=1428326&view=auto
==============================================================================
--- deltacloud/trunk/site/content/cimi-rest-collections.md (added)
+++ deltacloud/trunk/site/content/cimi-rest-collections.md Thu Jan 3 13:14:38 2013
@@ -0,0 +1,304 @@
+---
+site_name: Deltacloud API
+title: CIMI Resource Collections - Machine
+---
+
+<br/>
+
+<div class="row">
+ <div class="span9">
+
+<h3 id="cimi-entry-point">CIMI Resources and Collections</h3>
+
+<p> We are continually improving CIMI support in Deltacloud. If you come across any inconsistencies or errors in the Deltacloud CIMI implementation we'll be very glad to <a href="/contact.html">hear about them</a>.</p>
+
+<p>
+In the following sections, the textual definitions following the title of each resource (e.g. "Machine") that are rendered in bold and italic type are taken from the CIMI 1.0.1 specification, available from the DMTF <a href="http://dmtf.org/cloud">Cloud Management Initiative</a> (DSP0263).
+</p>
+
+<hr/>
+
+<h3 id="cimi-machine">Machine</h3>
+<p>
+<strong><em>
+An instantiated compute resource that encapsulates both CPU and Memory.
+A Machine Collection resource represents the collection of Machine resources within a Provider
+</em></strong>
+</p>
+
+ </div>
+
+ <div class="span3">
+
+<ul class="nav nav-list well">
+ <li class="nav-header">
+ CIMI REST API
+ </li>
+ <li><a href="/cimi-rest.html">Introduction</a></li>
+ <li><a href="/cimi-rest-entry-point.html">Cloud Entry Point</a></li>
+ <li><a href="/cimi-rest-collections.html">CIMI Resources</a></li>
+ <ul class="nav nav-list">
+ <li class="active"><a href="/cimi-rest-collections.html">Machine</a></li>
+ <li><a href="/cimi-rest-machine-images.html">MachineImage</a></li>
+ </ul>
+
+</ul>
+
+ </div>
+
+</div>
+
+<ul class="nav nav-pills">
+ <li class="active"><a href="#tab1" data-toggle="tab">Retrieve the Machine Collection</a></li>
+ <li><a href="#single-machine" data-toggle="tab">Retrieve a single Machine</a></li>
+ <li><a href="#create-machine" data-toggle="tab">Create a new Machine</a></li>
+ <li><a href="#machine-action" data-toggle="tab">Perform a Machine Operation</a></li>
+</ul>
+
+<hr>
+
+<div class="tab-content">
+ <div class="tab-pane active" id="tab1">
+
+<h4>Retrieve the Machine Collection</h4>
+
+Note the 'add' URI of the Machine Collection resource in the example response below. This is the URI that is used for creating a new Machine (adding to the Machine Collection).
+<br/>
+<br/>
+
+<p>Example request:</p>
+
+<pre>
+GET /cimi/machines HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Accept: application/xml
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+CIMI-Specification-Version: 1.0.1
+Content-Length: 2293
+ETag: 5c6dc8cfbceeb1f3c610765a4aa600dd
+Cache-Control: max-age=0, private, must-revalidate
+Date: Fri, 28 Dec 2012 11:08:27 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+
+<Collection xmlns="http://schemas.dmtf.org/cimi/1"
+ resourceURI="http://schemas.dmtf.org/cimi/1/MachineCollection">
+ <id>http://localhost:3001/cimi/machines</id>
+ <count>2</count>
+ <Machine>
+ <id>http://localhost:3001/cimi/machines/inst0</id>
+ <name>Mock Instance With Profile Change</name>
+ <description>No description set for Machine Mock Instance With Profile Change</description>
+ <created>2012-12-28T13:08:27+02:00</created>
+ <property key="machine_image">http://localhost:3001/cimi/machine_images/img1</property>
+ <property key="credential">http://localhost:3001/cimi/credentials</property>
+ <state>STARTED</state>
+ <cpu>1</cpu>
+ <memory>12582912</memory>
+ <disks href="http://localhost:3001/cimi/machines/inst0/disks" />
+ <volumes href="http://localhost:3001/cimi/machines/inst0/volumes" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/restart"
+ href="http://localhost:3001/cimi/machines/inst0/restart" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/stop"
+ href="http://localhost:3001/cimi/machines/inst0/stop" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/capture"
+ href="http://localhost:3001/cimi/machine_images" />
+ </Machine>
+ <Machine>
+ <id>http://localhost:3001/cimi/machines/inst1</id>
+ <name>MockUserInstance</name>
+ <description>No description set for Machine MockUserInstance</description>
+ <created>2012-12-28T13:08:27+02:00</created>
+ <property key="machine_image">http://localhost:3001/cimi/machine_images/img3</property>
+ <property key="credential">http://localhost:3001/cimi/credentials</property>
+ <state>STARTED</state>
+ <cpu>1</cpu>
+ <memory>1782579</memory>
+ <disks href="http://localhost:3001/cimi/machines/inst1/disks" />
+ <volumes href="http://localhost:3001/cimi/machines/inst1/volumes" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/restart"
+ href="http://localhost:3001/cimi/machines/inst1/restart" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/stop"
+ href="http://localhost:3001/cimi/machines/inst1/stop" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/capture"
+ href="http://localhost:3001/cimi/machine_images" />
+ </Machine>
+ <operation rel="add" href="http://localhost:3001/cimi/machines" />
+</Collection>
+
+
+</pre>
+
+ </div>
+ <div class="tab-pane" id="single-machine">
+
+<h4>Retrieve a single Machine</h4>
+
+<p>Example request:</p>
+
+<pre>
+GET /cimi/machines/inst0 HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Accept: application/xml
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+CIMI-Specification-Version: 1.0.1
+Content-Length: 1092
+ETag: 2d57aa01f1a50b2d13c04f0c51f08ab9
+Cache-Control: max-age=0, private, must-revalidate
+Date: Fri, 28 Dec 2012 11:20:28 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+
+<Machine xmlns="http://schemas.dmtf.org/cimi/1"
+ resourceURI="http://schemas.dmtf.org/cimi/1/Machine">
+ <id>http://localhost:3001/cimi/machines/inst0</id>
+ <name>Mock Instance With Profile Change</name>
+ <description>No description set for Machine Mock Instance With Profile Change</description>
+ <created>2012-12-28T13:20:28+02:00</created>
+ <property key="machine_image">http://localhost:3001/cimi/machine_images/img1</property>
+ <property key="credential">http://localhost:3001/cimi/credentials</property>
+ <state>STARTED</state>
+ <cpu>1</cpu>
+ <memory>12582912</memory>
+ <disks href="http://localhost:3001/cimi/machines/inst0/disks" />
+ <volumes href="http://localhost:3001/cimi/machines/inst0/volumes" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/restart"
+ href="http://localhost:3001/cimi/machines/inst0/restart" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/stop"
+ href="http://localhost:3001/cimi/machines/inst0/stop" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/capture"
+ href="http://localhost:3001/cimi/machine_images" />
+</Machine>
+
+
+</pre>
+
+ </div>
+
+ <div class="tab-pane" id="create-machine">
+
+<h4>Create a new Machine</h4>
+
+<p>
+The 'add' URI of the Machine Collection is used to create a new Machine. This is returned when retrieving the Machine Collection resource.
+</p>
+
+<p>Example request:</p>
+
+<pre>
+POST /cimi/machines HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Content-Type: application/xml
+Accept: application/xml
+Content-Length: 370
+
+<MachineCreate xmlns="http://schemas.dmtf.org/cimi/1">
+ <name> myMachine1 </name>
+ <description> my machine description </description>
+ <machineTemplate>
+ <machineConfig href="http://localhost:3001/cimi/machine_configurations/m1-small">
+ </machineConfig>
+ <machineImage href="http://localhost:3001/cimi/machine_images/img1">
+ </machineImage>
+ </machineTemplate>
+</MachineCreate>
+
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 201 Created
+Content-Type: application/xml
+Location: http://localhost:3001/cimi/machines/inst3
+CIMI-Specification-Version: 1.0.1
+Content-Length: 1030
+ETag: 360992481f1450f9d475f439e5105f9d
+Cache-Control: max-age=0, private, must-revalidate
+Date: Fri, 28 Dec 2012 11:47:58 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+
+<Machine xmlns="http://schemas.dmtf.org/cimi/1" resourceURI="http://schemas.dmtf.org/cimi/1/Machine">
+ <id>http://localhost:3001/cimi/machines/inst3</id>
+ <name> myMachine1 </name>
+ <description> my machine description </description>
+ <created>2012-12-28T13:47:58+02:00</created>
+ <property key="machine_image">http://localhost:3001/cimi/machine_images/img1</property>
+ <property key="credential">http://localhost:3001/cimi/credentials</property>
+ <state>STARTED</state>
+ <cpu>1</cpu>
+ <memory>1782579</memory>
+ <disks href="http://localhost:3001/cimi/machines/inst3/disks" />
+ <volumes href="http://localhost:3001/cimi/machines/inst3/volumes" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/restart"
+ href="http://localhost:3001/cimi/machines/inst3/restart" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/stop"
+ href="http://localhost:3001/cimi/machines/inst3/stop" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/capture"
+ href="http://localhost:3001/cimi/machine_images" />
+</Machine>
+
+
+</pre>
+
+
+ </div>
+
+
+ <div class="tab-pane" id="machine-action">
+
+<h4>Perform a Machine Operation</h4>
+
+<p>
+The list of Machine operations is returned when the URI of a specific Machine resource is dereferenced. Examples of operations are 'stop', 'restart' and 'capture'. An 'Action' resource is used in the POST message body corresponding to the operation to be executed. The example below shows the 'stop' action.
+</p>
+
+<p>Example request:</p>
+<pre>
+POST /cimi/machines/inst3/stop HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Content-Type: application/xml
+Accept: application/xml
+Content-Length: 125
+
+<Action xmlns="http://schemas.dmtf.org/cimi/1">
+ <action> http://http://schemas.dmtf.org/cimi/1/action/stop </action>
+</Action>
+</pre>
+
+<p>Server response:</p>
+<pre>
+HTTP/1.1 202 Accepted
+CIMI-Specification-Version: 1.0.1
+Content-Length: 0
+Date: Fri, 28 Dec 2012 14:01:43 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+</pre>
+
+
+ </div>
+
+
+</div>
Added: deltacloud/trunk/site/content/cimi-rest-entry-point.md
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/content/cimi-rest-entry-point.md?rev=1428326&view=auto
==============================================================================
--- deltacloud/trunk/site/content/cimi-rest-entry-point.md (added)
+++ deltacloud/trunk/site/content/cimi-rest-entry-point.md Thu Jan 3 13:14:38 2013
@@ -0,0 +1,91 @@
+---
+site_name: Deltacloud API
+title: CIMI Cloud Entry Point
+---
+
+<br/>
+
+<div class="row">
+ <div class="span9">
+
+<h3 id="cimi-entry-point">The CIMI Cloud Entry Point</h3>
+
+<p>
+<strong><em>The Cloud Entry Point represents the entry point into the cloud defined by the CIMI Model. The Cloud
+Entry Point implements a catalog of resources, such as Systems, System Templates, Machines, Machine
+Templates, etc., that can be queried and browsed by the Consumer.</em></strong>
+</p>
+<p>
+A deltacloud server exposes the CIMI Cloud Entry Point at /cimi/cloudEntryPoint. When dereferencing this URI, the resources listed in the response include only those that are supported by the current deltacloud driver - whether the 'default' driver the server was started with, or that specified with the <a href="/drivers.html">X-Deltacloud-Driver</a> header.
+</p>
+
+ </div>
+
+ <div class="span3">
+
+<ul class="nav nav-list well">
+ <li class="nav-header">
+ CIMI REST API
+ </li>
+ <li><a href="/cimi-rest.html">Introduction</a></li>
+ <li class="active"><a href="/cimi-rest-entry-point.html">Cloud Entry Point</a></li>
+ <li><a href="/cimi-rest-collections.html">CIMI Resources</a></li>
+</ul>
+
+ </div>
+
+</div>
+
+<p>
+Example request:
+</p>
+<pre>
+ GET /cimi/cloudEntryPoint HTTP/1.1
+ Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+ User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+ Host: localhost:3001
+ Accept: application/xml
+</pre>
+
+<p>
+Example response:
+</p>
+
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+CIMI-Specification-Version: 1.0.1
+Content-Length: 1754
+ETag: 503bc06f24d1a51eddc62b33b870c70f
+Cache-Control: max-age=0, private, must-revalidate
+Date: Thu, 27 Dec 2012 15:23:23 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+
+<CloudEntryPoint xmlns="http://schemas.dmtf.org/cimi/1" resourceURI="http://schemas.dmtf.org/cimi/1/CloudEntryPoint">
+ <id>http://localhost:3001/cimi/cloudEntryPoint</id>
+ <name>mock</name>
+ <description>Cloud Entry Point for the Deltacloud mock driver</description>
+ <created>2012-12-27T17:23:23+02:00</created>
+ <baseURI>http://localhost:3001/cimi/</baseURI>
+ <resourceMetadata href="http://localhost:3001/cimi/resource_metadata" />
+ <machines href="http://localhost:3001/cimi/machines" />
+ <machineTemplates href="http://localhost:3001/cimi/machine_templates" />
+ <machineImages href="http://localhost:3001/cimi/machine_images" />
+ <credentials href="http://localhost:3001/cimi/credentials" />
+ <volumes href="http://localhost:3001/cimi/volumes" />
+ <volumeImages href="http://localhost:3001/cimi/volume_images" />
+ <networks href="http://localhost:3001/cimi/networks" />
+ <networkTemplates href="http://localhost:3001/cimi/network_templates" />
+ <networkPorts href="http://localhost:3001/cimi/network_ports" />
+ <networkPortTemplates href="http://localhost:3001/cimi/network_port_templates" />
+ <addresses href="http://localhost:3001/cimi/addresses" />
+ <addressTemplates href="http://localhost:3001/cimi/address_templates" />
+ <forwardingGroups href="http://localhost:3001/cimi/forwarding_groups" />
+ <forwardingGroupTemplates href="http://localhost:3001/cimi/forwarding_group_templates" />
+ <volumeConfigs href="http://localhost:3001/cimi/volume_configurations" />
+ <machineConfigs href="http://localhost:3001/cimi/machine_configurations" />
+ <networkConfigs href="http://localhost:3001/cimi/network_configurations" />
+ <networkPortConfigs href="http://localhost:3001/cimi/network_port_configurations" />
+</CloudEntryPoint>
+</pre>
Added: deltacloud/trunk/site/content/cimi-rest-machine-images.md
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/content/cimi-rest-machine-images.md?rev=1428326&view=auto
==============================================================================
--- deltacloud/trunk/site/content/cimi-rest-machine-images.md (added)
+++ deltacloud/trunk/site/content/cimi-rest-machine-images.md Thu Jan 3 13:14:38 2013
@@ -0,0 +1,239 @@
+---
+site_name: Deltacloud API
+title: CIMI Resource Collections - Machine Image
+---
+
+<br/>
+
+<div class="row">
+ <div class="span9">
+
+<h3 id="cimi-machine-image">Machine Image</h3>
+<p>
+<strong><em>
+This resource represents the information necessary for hardware virtualized resources to create a Machine Instance; it contains configuration data such as startup instructions, including possible combinations of the following items, depending on the 'type' of Machine Image created: the software image, installation software, both a disk image and a set of software and parameters. <br/> <br/>
+A Machine Image Collection resource represents the collection of Machine Image resources within a Provider.
+</em></strong>
+</p>
+
+ </div>
+ <div class="span3">
+
+<ul class="nav nav-list well">
+ <li class="nav-header">
+ CIMI REST API
+ </li>
+ <li><a href="/cimi-rest.html">Introduction</a></li>
+ <li><a href="/cimi-rest-entry-point.html">Cloud Entry Point</a></li>
+ <li><a href="/cimi-rest-collections.html">CIMI Resources</a></li>
+ <ul class="nav nav-list">
+ <li><a href="/cimi-rest-collections.html">Machine</a></li>
+ <li class="active"><a href="/cimi-rest-machine-images.html">MachineImage</a></li>
+ </ul>
+
+</ul>
+
+ </div>
+
+</div>
+
+<ul class="nav nav-pills">
+ <li class="active"><a href="#image-collection" data-toggle="tab">Retrieve the Machine Image Collection</a></li>
+ <li><a href="#single-image" data-toggle="tab">Retrieve a single Machine Image</a></li>
+ <li><a href="#create-image" data-toggle="tab">Create or Delete a Machine Image</a></li>
+</ul>
+
+<hr>
+
+<div class="tab-content">
+ <div class="tab-pane active" id="image-collection">
+
+<h4>Retrieve the Machine Image Collection</h4>
+
+<p>
+Note the 'add' URI of the Machine Image Collection resource in the example response below. This is the URI that is used for creating a new Machine Image (adding to the Machine Image Collection). This URI is also returned when dereferencing a Machine resource, as the href attribute of the 'capture' operation (when this is possible for the given Machine on the particular Cloud Provider).
+</p>
+
+<p>Example request:</p>
+<pre>
+GET /cimi/machine_images HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Accept: application/xml
+</pre>
+
+<p>Server response:</p>
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+CIMI-Specification-Version: 1.0.1
+Content-Length: 1195
+ETag: e2f73ed48eb2abeae77322eea56dfc5d
+Cache-Control: max-age=0, private, must-revalidate
+Date: Fri, 28 Dec 2012 14:23:35 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+
+<Collection xmlns="http://schemas.dmtf.org/cimi/1"
+ resourceURI="http://schemas.dmtf.org/cimi/1/MachineImageCollection">
+ <id>http://localhost:3001/cimi/machine_images</id>
+ <count>3</count>
+ <MachineImage>
+ <id>http://localhost:3001/cimi/machine_images/img1</id>
+ <name>img1</name>
+ <description>Fedora 10</description>
+ <created>2012-12-28T16:23:35+02:00</created>
+ <state>AVAILABLE</state>
+ <type>IMAGE</type>
+ <imageLocation>mock://img1</imageLocation>
+ </MachineImage>
+ <MachineImage>
+ <id>http://localhost:3001/cimi/machine_images/img2</id>
+ <name>img2</name>
+ <description>Fedora 10</description>
+ <created>2012-12-28T16:23:35+02:00</created>
+ <state>AVAILABLE</state>
+ <type>IMAGE</type>
+ <imageLocation>mock://img2</imageLocation>
+ </MachineImage>
+ <MachineImage>
+ <id>http://localhost:3001/cimi/machine_images/img3</id>
+ <name>img3</name>
+ <description>JBoss</description>
+ <created>2012-12-28T16:23:35+02:00</created>
+ <state>AVAILABLE</state>
+ <type>IMAGE</type>
+ <imageLocation>mock://img3</imageLocation>
+ </MachineImage>
+ <operation rel="add" href="http://localhost:3001/cimi/machine_images" />
+</Collection>
+</pre>
+
+ </div>
+ <div class="tab-pane" id="single-image">
+
+<h4>Retrieve a single Machine Image</h4>
+
+<p>Example request:</p>
+
+<pre>
+GET /cimi/machine_images/img1 HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Accept: application/xml
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+CIMI-Specification-Version: 1.0.1
+Content-Length: 385
+ETag: 130f8e9592138afc544d65d73039e540
+Cache-Control: max-age=0, private, must-revalidate
+Date: Fri, 28 Dec 2012 14:55:42 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+
+<MachineImage xmlns="http://schemas.dmtf.org/cimi/1"
+ resourceURI="http://schemas.dmtf.org/cimi/1/MachineImage">
+ <id>http://localhost:3001/cimi/machine_images/img1</id>
+ <name>img1</name>
+ <description>Fedora 10</description>
+ <created>2012-12-28T16:55:42+02:00</created>
+ <state>AVAILABLE</state>
+ <type>IMAGE</type>
+ <imageLocation>mock://img1</imageLocation>
+</MachineImage>
+</pre>
+
+ </div>
+
+ <div class="tab-pane" id="create-image">
+
+
+<h4>Create a new Machine Image</h4>
+
+<p>
+The example below shows the creation of a new Machine Image resource from an existing Machine resource. When supported by the Machine and the given Cloud Provider, the href attribute of the serialized Machine resource's 'capture' operation provides the URI to which the request body should be sent with HTTP POST in order to create the new Machine Image. The message body is the representation of the to be created Machine Image resource, with the 'imageLocation' attribute referring to the Machine resource from which the Machine Image is to be created, as shown in the example below:
+</p>
+
+<p>Example request:</p>
+
+<pre>
+POST /cimi/machine_images HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Content-Type: application/xml
+Accept: application/xml
+Content-Length: 188
+<MachineImage>
+ <name>some_name</name>
+ <description>my new machine_image</description>
+ <type>IMAGE</type>
+ <imageLocation>http://localhost:3001/cimi/machines/inst1</imageLocation>
+</MachineImage>
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 201 Created
+Content-Type: application/xml
+Location: http://localhost:3001/cimi/machine_images/some_name
+CIMI-Specification-Version: 1.0.1
+Content-Length: 411
+ETag: c929191a65da6564f9f69301d38eb6fc
+Cache-Control: max-age=0, private, must-revalidate
+Date: Fri, 28 Dec 2012 15:10:12 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+
+<MachineImage xmlns="http://schemas.dmtf.org/cimi/1"
+ resourceURI="http://schemas.dmtf.org/cimi/1/MachineImage">
+ <id>http://localhost:3001/cimi/machine_images/some_name</id>
+ <name>some_name</name>
+ <description>my new machine image</description>
+ <created>2012-12-28T17:10:12+02:00</created>
+ <state>AVAILABLE</state>
+ <type>IMAGE</type>
+ <imageLocation>mock://some_name</imageLocation>
+</MachineImage>
+</pre>
+
+<br/>
+<hr/>
+
+<h4>Delete a Machine Image</h4>
+
+<p>Example request:</p>
+
+<pre>
+DELETE /cimi/machine_images/some_name HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Accept: application/xml
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 200 OK
+X-Frame-Options: SAMEORIGIN
+X-XSS-Protection: 1; mode=block
+X-Content-Type-Options: nosniff
+Content-Type: text/html;charset=utf-8
+CIMI-Specification-Version: 1.0.1
+Content-Length: 0
+Date: Fri, 28 Dec 2012 15:21:14 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+</pre>
+
+ </div>
+</div>
Added: deltacloud/trunk/site/content/cimi-rest.md
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/content/cimi-rest.md?rev=1428326&view=auto
==============================================================================
--- deltacloud/trunk/site/content/cimi-rest.md (added)
+++ deltacloud/trunk/site/content/cimi-rest.md Thu Jan 3 13:14:38 2013
@@ -0,0 +1,67 @@
+---
+site_name: Deltacloud API
+title: CIMI REST Examples
+---
+
+<br/>
+
+<div class="row">
+ <div class="span9">
+
+<h3 id="rest">The CIMI REST API</h3>
+
+<p>
+Apache Deltacloud exposes the DMTF <a href="http://dmtf.org/cloud">Cloud Infrastructure Management Interface</a> (CIMI) as an alternative to the native <a href="/rest-api.html">Deltacloud API</a>. This means that clients can 'speak' the CIMI API to a Deltacloud server on the frontend, managing resources in any of the backend cloud providers <a href="/drivers.html#drivers">supported by Deltacloud</a>.
+</p>
+
+
+<div class="alert alert-error">
+ <strong>Note: </strong>
+ <p>
+ This is <strong> NOT </strong> a definitive guide to the DMTF CIMI specification. The full CIMI spec is available from the DMTF <a href="http://dmtf.org/cloud">Cloud Management Initiative</a> (DSP0263).
+ </p>
+</div>
+
+ </div>
+
+ <div class="span3">
+
+<ul class="nav nav-list well">
+ <li class="nav-header">
+ CIMI REST API
+ </li>
+ <li class="active"><a href="/cimi-rest.html">Introduction</a></li>
+ <li><a href="/cimi-rest-entry-point.html">Cloud Entry Point</a></li>
+ <li><a href="/cimi-rest-collections.html">CIMI Resources</a></li>
+</ul>
+
+ </div>
+
+</div>
+<p>
+This page shows examples of interactions with the CIMI interface exposed by a Deltacloud server. The examples here cover the CIMI resources and collections that are currently supported in Deltacloud; we are constantly improving our CIMI implementation. If you come across any bugs or inconsistencies we'd be very happy to <a href="/contact.html">hear about them</a>.
+</p>
+
+<hr>
+
+<h3 id="cimi_rest_introduction">Starting Deltacloud with the CIMI interface</h3>
+
+The <strong> --frontends (-f)</strong> flag is used to specify which frontends a deltacloud server should expose:
+<br/>
+<br/>
+<pre>
+
+[user@name ~]$ deltacloudd -i ec2 -f cimi
+Starting Deltacloud API :: ec2 :: http://localhost:3001/cimi/cloudEntryPoint
+
+>> Thin web server (v1.5.0 codename Knife)
+>> Debugging ON
+>> Maximum connections set to 1024
+>> Listening on localhost:3001, CTRL+C to stop
+
+</pre>
+<br/>
+The example above shows the deltacloud server with the CIMI interface and the EC2 driver. You can even expose both the deltacloud and the CIMI frontends with a single server, e.g. <strong> -f cimi,deltacloud </strong>.
+
+As can be seen above, starting deltacloud in this way will expose the CIMI <a href="/cimi-rest-entry-point.html">cloud entry point</a> at localhost:3001/cimi/cloudEntryPoint.
+
Modified: deltacloud/trunk/site/layouts/partials/default/nav.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/layouts/partials/default/nav.html?rev=1428326&r1=1428325&r2=1428326&view=diff
==============================================================================
--- deltacloud/trunk/site/layouts/partials/default/nav.html (original)
+++ deltacloud/trunk/site/layouts/partials/default/nav.html Thu Jan 3 13:14:38 2013
@@ -37,5 +37,12 @@
<li><a href="/drivers.html">Drivers API</a></li>
</ul>
</li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">CIMI<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/cimi-rest.html">CIMI REST API</a></li>
+ <li><a href="/cimi-curl.html">CIMI cURL Examples</a></li>
+ </ul>
+ </li>
<li><a href="/contact.html">Contact</a></li>
</ul>
Added: deltacloud/trunk/site/output/cimi-curl.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/output/cimi-curl.html?rev=1428326&view=auto
==============================================================================
--- deltacloud/trunk/site/output/cimi-curl.html (added)
+++ deltacloud/trunk/site/output/cimi-curl.html Thu Jan 3 13:14:38 2013
@@ -0,0 +1,223 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>CIMI cURL Examples</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-transition.js"></script>
+ <script src="/assets/js/bootstrap-alert.js"></script>
+ <script src="/assets/js/bootstrap-modal.js"></script>
+ <script src="/assets/js/bootstrap-scrollspy.js"></script>
+ <script src="/assets/js/bootstrap-tab.js"></script>
+ <script src="/assets/js/bootstrap-tooltip.js"></script>
+ <script src="/assets/js/bootstrap-popover.js"></script>
+ <script src="/assets/js/bootstrap-button.js"></script>
+ <script src="/assets/js/bootstrap-collapse.js"></script>
+ <script src="/assets/js/bootstrap-carousel.js"></script>
+ <script src="/assets/js/bootstrap-typeahead.js"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li><a href="/download.html">Download</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client Libraries</a></li>
+ <li><a href="/command-tools.html">Command Line Tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">CIMI<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/cimi-rest.html">CIMI REST API</a></li>
+ <li><a href="/cimi-curl.html">CIMI cURL Examples</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container content">
+
+ <p><br></p>
+
+<div class="row">
+
+ <div class="span8">
+
+ <h3 id="command">Working with cURL against the Deltacloud CIMI frontend</h3>
+
+ <p> The <a href="http://curl.haxx.se/docs/">cURL documentation</a> is pretty comprehensive, but the following are some general points to remember for using cURL against Deltacloud. All the examples on this page assume the deltacloud server is running at localhost:3001: </p>
+
+ <ul>
+<li>
+ Credentials are specified with <strong> --user "name:password" </strong>
+ </li>
+ <li>
+ Request headers are specified with <strong> -H "header: value" </strong>. For the "Accept" header Deltacloud offers a convenient way of specifying the desired response format; you can include the <strong>"?format="</strong> parameter into the request URL rather than setting the Accept header
+ </li>
+ <li>
+ HTTP verbs are specified with <strong>-X VERB</strong>
+ </li>
+ <li>
+ The <strong> -i </strong> flag will show you the response headers and the <strong> -v </strong> flag will show you request and response headers as well as info about cURL activity:
+ <pre>
+curl -v -X DELETE --user "username:password" -H "Accept: application/xml" http://localhost:3001/cimi/images/my_image
+ </pre>
+ </li>
+ </ul>
+</div>
+
+ <div class="span4">
+
+ <ul class="nav nav-list well">
+<li class="nav-header">cURL as a deltacloud client</li>
+ <li><a href="#machines">Work with Machines</a></li>
+ <li><a href="#machine-images">Work with Machine Images</a></li>
+ </ul>
+</div>
+</div>
+
+<hr><h4 id="machines">Working with Machines</h4>
+
+<p>Retrieve the Machine Collection in json format:</p>
+
+<pre> curl --user "user:pass" -H "Accept: application/json" http://localhost:3001/cimi/machines </pre>
+
+<p>Create a new Machine with the message body in XML format:</p>
+
+<pre>
+curl -v --user "mockuser:mockpassword" -X POST -H "Content-Type: application/xml" -H "Accept: application/xml" -d '<MachineCreate xmlns="http://schemas.dmtf.org/cimi/1"> <name> myMachine1 </name> <description> my machine description </description> <machineTemplate> <machineConfig href="http://localhost:3001/cimi/machine_configurations/m1-small"> </machineConfig> <machineImage href="http://localhost:3001/cimi/machine_images/img1"> </machineImage> </machineTemplate> </MachineCreate>'
+</pre>
+
+<p>Alternatively, specifying the message body in JSON:</p>
+<pre>
+ curl -v --user "user:password" -X POST -H "Content-Type: application/json" -H "Accept: application/xml" -d '{ "resourceURI": "http://schemas.dmtf.org/cimi/1/MachineCreate", "name": "myMachine3", "description": "My very first json machine", "machineTemplate": { "machineConfig": { "href": "http://localhost:3001/cimi/machine_configurations/m1.small" }, "machineImage": { "href": "http://localhost:3001/cimi/machine_images/ami-48aa4921" } } }' http://localhost:3001/cimi/machines
+</pre>
+
+<p>Perform a Machine operation - stop - with the message body in XML format:</p>
+
+<pre>
+curl -v -X POST --user "mockuser:mockpassword" -H "Content-Type: application/xml" -H "Accept: application/xml" -d '<Action xmlns="http://schemas.dmtf.org/cimi/1"><action> http://http://schemas.dmtf.org/cimi/1/action/stop </action> </Action>' http://localhost:3001/cimi/machines/inst3/stop
+</pre>
+
+<p>Alternatively, specifying the message body in JSON:</p>
+<pre>
+ curl -v -X POST --user "user:password" -H "Accept: application/json" -H "Content-Type: application/json" -d '{"resourceURI": "http://www.dmtf.org/cimi/1/Action", "action":"http://www.dmtf.org/cimi/action/stop"}' http://localhost:3001/cimi/machines/i-5feb7c20/stop
+</pre>
+
+<p><br></p>
+
+<hr><h4 id="machine-images">Working with Machine Images</h4>
+
+<p>Retrieve the Machine Image Collection:</p>
+
+<pre>
+curl --user "user:pass" -H "Accept: application/json" http://localhost:3001/cimi/machine_images
+</pre>
+
+<p>Create a new Machine Image from an existing Machine, with message body in JSON:</p>
+
+<pre>
+curl --user "mockuser:mockpassword" -X POST -H "Content-Type: application/json" -H "Accept: application/json" -d '{"resourceURI":"http://schemas.dmtf.org/cimi/1/MachineImage", "name":"new_image","description":"my new machine image","type":"IMAGE", "imageLocation":"http://localhost:3001/cimi/machines/inst1"}' http://localhost:3001/cimi/machine_images
+</pre>
+
+<p>Alternatively, specifying the message body in XML:</p>
+
+<pre>
+curl -v --user "mockuser:mockpassword" -H "Content-Type: application/xml" -H "Accept: application/xml" -X POST -d "<MachineImage><name>some_name</name><description>my new machine image</description><type>IMAGE</type><imageLocation>http://localhost:3001/cimi/machines/inst1</imageLocation></MachineImage>" http://localhost:3001/cimi/machine_images
+</pre>
+
+<p>Delete a Machine Image:</p>
+
+<pre>curl -X DELETE --user "user:pass" http://localhost:3001/cimi/machine_images/my_image </pre>
+
+ <footer class="footer">
+ <p class="pull-right"><span class='icon-circle-arrow-up'> </span><a href="#">Back to top</a></p>
+ <div class='row'>
+ <div class='span3'>
+ <img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
+ </div>
+ <div class='span9'>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </div>
+ </div>
+ </footer>
+
+ </div> <!-- /container -->
+
+<!-- Piwik -->
+<script type="text/javascript">
+var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.salasaga.org/aeolus/piwik/" : "http://stats.salasaga.org/aeolus/piwik/");
+document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
+</script><script type="text/javascript">
+try {
+var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 2);
+piwikTracker.trackPageView();
+piwikTracker.enableLinkTracking();
+} catch( err ) {}
+</script><noscript><p><img src="http://stats.salasaga.org/aeolus/piwik/piwik.php?idsite=2" style="border:0" alt="" /></p></noscript>
+<!-- End Piwik Tracking Code -->
+
+ </body>
+</html>
Added: deltacloud/trunk/site/output/cimi-rest-collections.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/output/cimi-rest-collections.html?rev=1428326&view=auto
==============================================================================
--- deltacloud/trunk/site/output/cimi-rest-collections.html (added)
+++ deltacloud/trunk/site/output/cimi-rest-collections.html Thu Jan 3 13:14:38 2013
@@ -0,0 +1,420 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>CIMI Resource Collections - Machine</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-transition.js"></script>
+ <script src="/assets/js/bootstrap-alert.js"></script>
+ <script src="/assets/js/bootstrap-modal.js"></script>
+ <script src="/assets/js/bootstrap-scrollspy.js"></script>
+ <script src="/assets/js/bootstrap-tab.js"></script>
+ <script src="/assets/js/bootstrap-tooltip.js"></script>
+ <script src="/assets/js/bootstrap-popover.js"></script>
+ <script src="/assets/js/bootstrap-button.js"></script>
+ <script src="/assets/js/bootstrap-collapse.js"></script>
+ <script src="/assets/js/bootstrap-carousel.js"></script>
+ <script src="/assets/js/bootstrap-typeahead.js"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li><a href="/download.html">Download</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client Libraries</a></li>
+ <li><a href="/command-tools.html">Command Line Tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">CIMI<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/cimi-rest.html">CIMI REST API</a></li>
+ <li><a href="/cimi-curl.html">CIMI cURL Examples</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container content">
+
+ <p><br></p>
+
+<div class="row">
+ <div class="span9">
+
+<h3 id="cimi-entry-point">CIMI Resources and Collections</h3>
+
+<p> We are continually improving CIMI support in Deltacloud. If you come across any inconsistencies or errors in the Deltacloud CIMI implementation we'll be very glad to <a href="contact.html">hear about them</a>.</p>
+
+<p>
+In the following sections, the textual definitions following the title of each resource (e.g. "Machine") that are rendered in bold and italic type are taken from the CIMI 1.0.1 specification, available from the DMTF <a href="http://dmtf.org/cloud">Cloud Management Initiative</a> (DSP0263).
+</p>
+
+<hr>
+<h3 id="cimi-machine">Machine</h3>
+<p>
+<strong><em>
+An instantiated compute resource that encapsulates both CPU and Memory.
+A Machine Collection resource represents the collection of Machine resources within a Provider
+</em></strong>
+</p>
+
+ </div>
+
+ <div class="span3">
+
+<ul class="nav nav-list well">
+<li class="nav-header">
+ CIMI REST API
+ </li>
+ <li><a href="cimi-rest.html">Introduction</a></li>
+ <li><a href="cimi-rest-entry-point.html">Cloud Entry Point</a></li>
+ <li><a href="cimi-rest-collections.html">CIMI Resources</a></li>
+ <ul class="nav nav-list">
+<li class="active"><a href="cimi-rest-collections.html">Machine</a></li>
+ <li><a href="cimi-rest-machine-images.html">MachineImage</a></li>
+ </ul>
+</ul>
+</div>
+
+</div>
+
+<ul class="nav nav-pills">
+<li class="active"><a href="#tab1" data-toggle="tab">Retrieve the Machine Collection</a></li>
+ <li><a href="#single-machine" data-toggle="tab">Retrieve a single Machine</a></li>
+ <li><a href="#create-machine" data-toggle="tab">Create a new Machine</a></li>
+ <li><a href="#machine-action" data-toggle="tab">Perform a Machine Operation</a></li>
+</ul><hr><div class="tab-content">
+ <div class="tab-pane active" id="tab1">
+
+<h4>Retrieve the Machine Collection</h4>
+
+Note the 'add' URI of the Machine Collection resource in the example response below. This is the URI that is used for creating a new Machine (adding to the Machine Collection).
+<br><br><p>Example request:</p>
+
+<pre>
+GET /cimi/machines HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Accept: application/xml
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+CIMI-Specification-Version: 1.0.1
+Content-Length: 2293
+ETag: 5c6dc8cfbceeb1f3c610765a4aa600dd
+Cache-Control: max-age=0, private, must-revalidate
+Date: Fri, 28 Dec 2012 11:08:27 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+
+<Collection xmlns="http://schemas.dmtf.org/cimi/1"
+ resourceURI="http://schemas.dmtf.org/cimi/1/MachineCollection">
+ <id>http://localhost:3001/cimi/machines</id>
+ <count>2</count>
+ <Machine>
+ <id>http://localhost:3001/cimi/machines/inst0</id>
+ <name>Mock Instance With Profile Change</name>
+ <description>No description set for Machine Mock Instance With Profile Change</description>
+ <created>2012-12-28T13:08:27+02:00</created>
+ <property key="machine_image">http://localhost:3001/cimi/machine_images/img1</property>
+ <property key="credential">http://localhost:3001/cimi/credentials</property>
+ <state>STARTED</state>
+ <cpu>1</cpu>
+ <memory>12582912</memory>
+ <disks href="http://localhost:3001/cimi/machines/inst0/disks" />
+ <volumes href="http://localhost:3001/cimi/machines/inst0/volumes" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/restart"
+ href="http://localhost:3001/cimi/machines/inst0/restart" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/stop"
+ href="http://localhost:3001/cimi/machines/inst0/stop" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/capture"
+ href="http://localhost:3001/cimi/machine_images" />
+ </Machine>
+ <Machine>
+ <id>http://localhost:3001/cimi/machines/inst1</id>
+ <name>MockUserInstance</name>
+ <description>No description set for Machine MockUserInstance</description>
+ <created>2012-12-28T13:08:27+02:00</created>
+ <property key="machine_image">http://localhost:3001/cimi/machine_images/img3</property>
+ <property key="credential">http://localhost:3001/cimi/credentials</property>
+ <state>STARTED</state>
+ <cpu>1</cpu>
+ <memory>1782579</memory>
+ <disks href="http://localhost:3001/cimi/machines/inst1/disks" />
+ <volumes href="http://localhost:3001/cimi/machines/inst1/volumes" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/restart"
+ href="http://localhost:3001/cimi/machines/inst1/restart" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/stop"
+ href="http://localhost:3001/cimi/machines/inst1/stop" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/capture"
+ href="http://localhost:3001/cimi/machine_images" />
+ </Machine>
+ <operation rel="add" href="http://localhost:3001/cimi/machines" />
+</Collection>
+
+
+</pre>
+
+ </div>
+ <div class="tab-pane" id="single-machine">
+
+<h4>Retrieve a single Machine</h4>
+
+<p>Example request:</p>
+
+<pre>
+GET /cimi/machines/inst0 HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Accept: application/xml
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+CIMI-Specification-Version: 1.0.1
+Content-Length: 1092
+ETag: 2d57aa01f1a50b2d13c04f0c51f08ab9
+Cache-Control: max-age=0, private, must-revalidate
+Date: Fri, 28 Dec 2012 11:20:28 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+
+<Machine xmlns="http://schemas.dmtf.org/cimi/1"
+ resourceURI="http://schemas.dmtf.org/cimi/1/Machine">
+ <id>http://localhost:3001/cimi/machines/inst0</id>
+ <name>Mock Instance With Profile Change</name>
+ <description>No description set for Machine Mock Instance With Profile Change</description>
+ <created>2012-12-28T13:20:28+02:00</created>
+ <property key="machine_image">http://localhost:3001/cimi/machine_images/img1</property>
+ <property key="credential">http://localhost:3001/cimi/credentials</property>
+ <state>STARTED</state>
+ <cpu>1</cpu>
+ <memory>12582912</memory>
+ <disks href="http://localhost:3001/cimi/machines/inst0/disks" />
+ <volumes href="http://localhost:3001/cimi/machines/inst0/volumes" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/restart"
+ href="http://localhost:3001/cimi/machines/inst0/restart" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/stop"
+ href="http://localhost:3001/cimi/machines/inst0/stop" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/capture"
+ href="http://localhost:3001/cimi/machine_images" />
+</Machine>
+
+
+</pre>
+
+ </div>
+
+ <div class="tab-pane" id="create-machine">
+
+<h4>Create a new Machine</h4>
+
+<p>
+The 'add' URI of the Machine Collection is used to create a new Machine. This is returned when retrieving the Machine Collection resource.
+</p>
+
+<p>Example request:</p>
+
+<pre>
+POST /cimi/machines HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Content-Type: application/xml
+Accept: application/xml
+Content-Length: 370
+
+<MachineCreate xmlns="http://schemas.dmtf.org/cimi/1">
+ <name> myMachine1 </name>
+ <description> my machine description </description>
+ <machineTemplate>
+ <machineConfig href="http://localhost:3001/cimi/machine_configurations/m1-small">
+ </machineConfig>
+ <machineImage href="http://localhost:3001/cimi/machine_images/img1">
+ </machineImage>
+ </machineTemplate>
+</MachineCreate>
+
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 201 Created
+Content-Type: application/xml
+Location: http://localhost:3001/cimi/machines/inst3
+CIMI-Specification-Version: 1.0.1
+Content-Length: 1030
+ETag: 360992481f1450f9d475f439e5105f9d
+Cache-Control: max-age=0, private, must-revalidate
+Date: Fri, 28 Dec 2012 11:47:58 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+
+<Machine xmlns="http://schemas.dmtf.org/cimi/1" resourceURI="http://schemas.dmtf.org/cimi/1/Machine">
+ <id>http://localhost:3001/cimi/machines/inst3</id>
+ <name> myMachine1 </name>
+ <description> my machine description </description>
+ <created>2012-12-28T13:47:58+02:00</created>
+ <property key="machine_image">http://localhost:3001/cimi/machine_images/img1</property>
+ <property key="credential">http://localhost:3001/cimi/credentials</property>
+ <state>STARTED</state>
+ <cpu>1</cpu>
+ <memory>1782579</memory>
+ <disks href="http://localhost:3001/cimi/machines/inst3/disks" />
+ <volumes href="http://localhost:3001/cimi/machines/inst3/volumes" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/restart"
+ href="http://localhost:3001/cimi/machines/inst3/restart" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/stop"
+ href="http://localhost:3001/cimi/machines/inst3/stop" />
+ <operation rel="http://schemas.dmtf.org/cimi/1/action/capture"
+ href="http://localhost:3001/cimi/machine_images" />
+</Machine>
+
+
+</pre>
+
+
+ </div>
+
+
+ <div class="tab-pane" id="machine-action">
+
+<h4>Perform a Machine Operation</h4>
+
+<p>
+The list of Machine operations is returned when the URI of a specific Machine resource is dereferenced. Examples of operations are 'stop', 'restart' and 'capture'. An 'Action' resource is used in the POST message body corresponding to the operation to be executed. The example below shows the 'stop' action.
+</p>
+
+<p>Example request:</p>
+<pre>
+POST /cimi/machines/inst3/stop HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Content-Type: application/xml
+Accept: application/xml
+Content-Length: 125
+
+<Action xmlns="http://schemas.dmtf.org/cimi/1">
+ <action> http://http://schemas.dmtf.org/cimi/1/action/stop </action>
+</Action>
+</pre>
+
+<p>Server response:</p>
+<pre>
+HTTP/1.1 202 Accepted
+CIMI-Specification-Version: 1.0.1
+Content-Length: 0
+Date: Fri, 28 Dec 2012 14:01:43 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+</pre>
+
+
+ </div>
+
+
+</div>
+
+ <footer class="footer">
+ <p class="pull-right"><span class='icon-circle-arrow-up'> </span><a href="#">Back to top</a></p>
+ <div class='row'>
+ <div class='span3'>
+ <img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
+ </div>
+ <div class='span9'>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </div>
+ </div>
+ </footer>
+
+ </div> <!-- /container -->
+
+<!-- Piwik -->
+<script type="text/javascript">
+var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.salasaga.org/aeolus/piwik/" : "http://stats.salasaga.org/aeolus/piwik/");
+document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
+</script><script type="text/javascript">
+try {
+var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 2);
+piwikTracker.trackPageView();
+piwikTracker.enableLinkTracking();
+} catch( err ) {}
+</script><noscript><p><img src="http://stats.salasaga.org/aeolus/piwik/piwik.php?idsite=2" style="border:0" alt="" /></p></noscript>
+<!-- End Piwik Tracking Code -->
+
+ </body>
+</html>
Added: deltacloud/trunk/site/output/cimi-rest-entry-point.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/output/cimi-rest-entry-point.html?rev=1428326&view=auto
==============================================================================
--- deltacloud/trunk/site/output/cimi-rest-entry-point.html (added)
+++ deltacloud/trunk/site/output/cimi-rest-entry-point.html Thu Jan 3 13:14:38 2013
@@ -0,0 +1,216 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>CIMI Cloud Entry Point</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-transition.js"></script>
+ <script src="/assets/js/bootstrap-alert.js"></script>
+ <script src="/assets/js/bootstrap-modal.js"></script>
+ <script src="/assets/js/bootstrap-scrollspy.js"></script>
+ <script src="/assets/js/bootstrap-tab.js"></script>
+ <script src="/assets/js/bootstrap-tooltip.js"></script>
+ <script src="/assets/js/bootstrap-popover.js"></script>
+ <script src="/assets/js/bootstrap-button.js"></script>
+ <script src="/assets/js/bootstrap-collapse.js"></script>
+ <script src="/assets/js/bootstrap-carousel.js"></script>
+ <script src="/assets/js/bootstrap-typeahead.js"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li><a href="/download.html">Download</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client Libraries</a></li>
+ <li><a href="/command-tools.html">Command Line Tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">CIMI<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/cimi-rest.html">CIMI REST API</a></li>
+ <li><a href="/cimi-curl.html">CIMI cURL Examples</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container content">
+
+ <p><br></p>
+
+<div class="row">
+ <div class="span9">
+
+<h3 id="cimi-entry-point">The CIMI Cloud Entry Point</h3>
+
+<p>
+<strong><em>The Cloud Entry Point represents the entry point into the cloud defined by the CIMI Model. The Cloud
+Entry Point implements a catalog of resources, such as Systems, System Templates, Machines, Machine
+Templates, etc., that can be queried and browsed by the Consumer.</em></strong>
+</p>
+<p>
+A deltacloud server exposes the CIMI Cloud Entry Point at /cimi/cloudEntryPoint. When dereferencing this URI, the resources listed in the response include only those that are supported by the current deltacloud driver - whether the 'default' driver the server was started with, or that specified with the <a href="drivers.html">X-Deltacloud-Driver</a> header.
+</p>
+
+ </div>
+
+ <div class="span3">
+
+<ul class="nav nav-list well">
+<li class="nav-header">
+ CIMI REST API
+ </li>
+ <li><a href="cimi-rest.html">Introduction</a></li>
+ <li class="active"><a href="cimi-rest-entry-point.html">Cloud Entry Point</a></li>
+ <li><a href="cimi-rest-collections.html">CIMI Resources</a></li>
+</ul>
+</div>
+
+</div>
+
+<p>
+Example request:
+</p>
+<pre>
+ GET /cimi/cloudEntryPoint HTTP/1.1
+ Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+ User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+ Host: localhost:3001
+ Accept: application/xml
+</pre>
+
+<p>
+Example response:
+</p>
+
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+CIMI-Specification-Version: 1.0.1
+Content-Length: 1754
+ETag: 503bc06f24d1a51eddc62b33b870c70f
+Cache-Control: max-age=0, private, must-revalidate
+Date: Thu, 27 Dec 2012 15:23:23 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+
+<CloudEntryPoint xmlns="http://schemas.dmtf.org/cimi/1" resourceURI="http://schemas.dmtf.org/cimi/1/CloudEntryPoint">
+ <id>http://localhost:3001/cimi/cloudEntryPoint</id>
+ <name>mock</name>
+ <description>Cloud Entry Point for the Deltacloud mock driver</description>
+ <created>2012-12-27T17:23:23+02:00</created>
+ <baseURI>http://localhost:3001/cimi/</baseURI>
+ <resourceMetadata href="http://localhost:3001/cimi/resource_metadata" />
+ <machines href="http://localhost:3001/cimi/machines" />
+ <machineTemplates href="http://localhost:3001/cimi/machine_templates" />
+ <machineImages href="http://localhost:3001/cimi/machine_images" />
+ <credentials href="http://localhost:3001/cimi/credentials" />
+ <volumes href="http://localhost:3001/cimi/volumes" />
+ <volumeImages href="http://localhost:3001/cimi/volume_images" />
+ <networks href="http://localhost:3001/cimi/networks" />
+ <networkTemplates href="http://localhost:3001/cimi/network_templates" />
+ <networkPorts href="http://localhost:3001/cimi/network_ports" />
+ <networkPortTemplates href="http://localhost:3001/cimi/network_port_templates" />
+ <addresses href="http://localhost:3001/cimi/addresses" />
+ <addressTemplates href="http://localhost:3001/cimi/address_templates" />
+ <forwardingGroups href="http://localhost:3001/cimi/forwarding_groups" />
+ <forwardingGroupTemplates href="http://localhost:3001/cimi/forwarding_group_templates" />
+ <volumeConfigs href="http://localhost:3001/cimi/volume_configurations" />
+ <machineConfigs href="http://localhost:3001/cimi/machine_configurations" />
+ <networkConfigs href="http://localhost:3001/cimi/network_configurations" />
+ <networkPortConfigs href="http://localhost:3001/cimi/network_port_configurations" />
+</CloudEntryPoint>
+</pre>
+
+ <footer class="footer">
+ <p class="pull-right"><span class='icon-circle-arrow-up'> </span><a href="#">Back to top</a></p>
+ <div class='row'>
+ <div class='span3'>
+ <img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
+ </div>
+ <div class='span9'>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </div>
+ </div>
+ </footer>
+
+ </div> <!-- /container -->
+
+<!-- Piwik -->
+<script type="text/javascript">
+var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.salasaga.org/aeolus/piwik/" : "http://stats.salasaga.org/aeolus/piwik/");
+document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
+</script><script type="text/javascript">
+try {
+var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 2);
+piwikTracker.trackPageView();
+piwikTracker.enableLinkTracking();
+} catch( err ) {}
+</script><noscript><p><img src="http://stats.salasaga.org/aeolus/piwik/piwik.php?idsite=2" style="border:0" alt="" /></p></noscript>
+<!-- End Piwik Tracking Code -->
+
+ </body>
+</html>
Added: deltacloud/trunk/site/output/cimi-rest-machine-images.html
URL: http://svn.apache.org/viewvc/deltacloud/trunk/site/output/cimi-rest-machine-images.html?rev=1428326&view=auto
==============================================================================
--- deltacloud/trunk/site/output/cimi-rest-machine-images.html (added)
+++ deltacloud/trunk/site/output/cimi-rest-machine-images.html Thu Jan 3 13:14:38 2013
@@ -0,0 +1,357 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>CIMI Resource Collections - Machine Image</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-transition.js"></script>
+ <script src="/assets/js/bootstrap-alert.js"></script>
+ <script src="/assets/js/bootstrap-modal.js"></script>
+ <script src="/assets/js/bootstrap-scrollspy.js"></script>
+ <script src="/assets/js/bootstrap-tab.js"></script>
+ <script src="/assets/js/bootstrap-tooltip.js"></script>
+ <script src="/assets/js/bootstrap-popover.js"></script>
+ <script src="/assets/js/bootstrap-button.js"></script>
+ <script src="/assets/js/bootstrap-collapse.js"></script>
+ <script src="/assets/js/bootstrap-carousel.js"></script>
+ <script src="/assets/js/bootstrap-typeahead.js"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li><a href="/download.html">Download</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client Libraries</a></li>
+ <li><a href="/command-tools.html">Command Line Tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">CIMI<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/cimi-rest.html">CIMI REST API</a></li>
+ <li><a href="/cimi-curl.html">CIMI cURL Examples</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container content">
+
+ <p><br></p>
+
+<div class="row">
+ <div class="span9">
+
+<h3 id="cimi-machine-image">Machine Image</h3>
+<p>
+<strong><em>
+This resource represents the information necessary for hardware virtualized resources to create a Machine Instance; it contains configuration data such as startup instructions, including possible combinations of the following items, depending on the 'type' of Machine Image created: the software image, installation software, both a disk image and a set of software and parameters. <br><br>
+A Machine Image Collection resource represents the collection of Machine Image resources within a Provider.
+</em></strong>
+</p>
+
+ </div>
+ <div class="span3">
+
+<ul class="nav nav-list well">
+<li class="nav-header">
+ CIMI REST API
+ </li>
+ <li><a href="cimi-rest.html">Introduction</a></li>
+ <li><a href="cimi-rest-entry-point.html">Cloud Entry Point</a></li>
+ <li><a href="cimi-rest-collections.html">CIMI Resources</a></li>
+ <ul class="nav nav-list">
+<li><a href="cimi-rest-collections.html">Machine</a></li>
+ <li class="active"><a href="cimi-rest-machine-images.html">MachineImage</a></li>
+ </ul>
+</ul>
+</div>
+
+</div>
+
+<ul class="nav nav-pills">
+<li class="active"><a href="#image-collection" data-toggle="tab">Retrieve the Machine Image Collection</a></li>
+ <li><a href="#single-image" data-toggle="tab">Retrieve a single Machine Image</a></li>
+ <li><a href="#create-image" data-toggle="tab">Create or Delete a Machine Image</a></li>
+</ul><hr><div class="tab-content">
+ <div class="tab-pane active" id="image-collection">
+
+<h4>Retrieve the Machine Image Collection</h4>
+
+<p>
+Note the 'add' URI of the Machine Image Collection resource in the example response below. This is the URI that is used for creating a new Machine Image (adding to the Machine Image Collection). This URI is also returned when dereferencing a Machine resource, as the href attribute of the 'capture' operation (when this is possible for the given Machine on the particular Cloud Provider).
+</p>
+
+<p>Example request:</p>
+<pre>
+GET /cimi/machine_images HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Accept: application/xml
+</pre>
+
+<p>Server response:</p>
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+CIMI-Specification-Version: 1.0.1
+Content-Length: 1195
+ETag: e2f73ed48eb2abeae77322eea56dfc5d
+Cache-Control: max-age=0, private, must-revalidate
+Date: Fri, 28 Dec 2012 14:23:35 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+
+<Collection xmlns="http://schemas.dmtf.org/cimi/1"
+ resourceURI="http://schemas.dmtf.org/cimi/1/MachineImageCollection">
+ <id>http://localhost:3001/cimi/machine_images</id>
+ <count>3</count>
+ <MachineImage>
+ <id>http://localhost:3001/cimi/machine_images/img1</id>
+ <name>img1</name>
+ <description>Fedora 10</description>
+ <created>2012-12-28T16:23:35+02:00</created>
+ <state>AVAILABLE</state>
+ <type>IMAGE</type>
+ <imageLocation>mock://img1</imageLocation>
+ </MachineImage>
+ <MachineImage>
+ <id>http://localhost:3001/cimi/machine_images/img2</id>
+ <name>img2</name>
+ <description>Fedora 10</description>
+ <created>2012-12-28T16:23:35+02:00</created>
+ <state>AVAILABLE</state>
+ <type>IMAGE</type>
+ <imageLocation>mock://img2</imageLocation>
+ </MachineImage>
+ <MachineImage>
+ <id>http://localhost:3001/cimi/machine_images/img3</id>
+ <name>img3</name>
+ <description>JBoss</description>
+ <created>2012-12-28T16:23:35+02:00</created>
+ <state>AVAILABLE</state>
+ <type>IMAGE</type>
+ <imageLocation>mock://img3</imageLocation>
+ </MachineImage>
+ <operation rel="add" href="http://localhost:3001/cimi/machine_images" />
+</Collection>
+</pre>
+
+ </div>
+ <div class="tab-pane" id="single-image">
+
+<h4>Retrieve a single Machine Image</h4>
+
+<p>Example request:</p>
+
+<pre>
+GET /cimi/machine_images/img1 HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Accept: application/xml
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+CIMI-Specification-Version: 1.0.1
+Content-Length: 385
+ETag: 130f8e9592138afc544d65d73039e540
+Cache-Control: max-age=0, private, must-revalidate
+Date: Fri, 28 Dec 2012 14:55:42 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+
+<MachineImage xmlns="http://schemas.dmtf.org/cimi/1"
+ resourceURI="http://schemas.dmtf.org/cimi/1/MachineImage">
+ <id>http://localhost:3001/cimi/machine_images/img1</id>
+ <name>img1</name>
+ <description>Fedora 10</description>
+ <created>2012-12-28T16:55:42+02:00</created>
+ <state>AVAILABLE</state>
+ <type>IMAGE</type>
+ <imageLocation>mock://img1</imageLocation>
+</MachineImage>
+</pre>
+
+ </div>
+
+ <div class="tab-pane" id="create-image">
+
+
+<h4>Create a new Machine Image</h4>
+
+<p>
+The example below shows the creation of a new Machine Image resource from an existing Machine resource. When supported by the Machine and the given Cloud Provider, the href attribute of the serialized Machine resource's 'capture' operation provides the URI to which the request body should be sent with HTTP POST in order to create the new Machine Image. The message body is the representation of the to be created Machine Image resource, with the 'imageLocation' attribute referring to the Machine resource from which the Machine Image is to be created, as shown in the example below:
+</p>
+
+<p>Example request:</p>
+
+<pre>
+POST /cimi/machine_images HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Content-Type: application/xml
+Accept: application/xml
+Content-Length: 188
+<MachineImage>
+ <name>some_name</name>
+ <description>my new machine_image</description>
+ <type>IMAGE</type>
+ <imageLocation>http://localhost:3001/cimi/machines/inst1</imageLocation>
+</MachineImage>
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 201 Created
+Content-Type: application/xml
+Location: http://localhost:3001/cimi/machine_images/some_name
+CIMI-Specification-Version: 1.0.1
+Content-Length: 411
+ETag: c929191a65da6564f9f69301d38eb6fc
+Cache-Control: max-age=0, private, must-revalidate
+Date: Fri, 28 Dec 2012 15:10:12 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+
+<MachineImage xmlns="http://schemas.dmtf.org/cimi/1"
+ resourceURI="http://schemas.dmtf.org/cimi/1/MachineImage">
+ <id>http://localhost:3001/cimi/machine_images/some_name</id>
+ <name>some_name</name>
+ <description>my new machine image</description>
+ <created>2012-12-28T17:10:12+02:00</created>
+ <state>AVAILABLE</state>
+ <type>IMAGE</type>
+ <imageLocation>mock://some_name</imageLocation>
+</MachineImage>
+</pre>
+
+<br><hr>
+<h4>Delete a Machine Image</h4>
+
+<p>Example request:</p>
+
+<pre>
+DELETE /cimi/machine_images/some_name HTTP/1.1
+Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
+User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
+Host: localhost:3001
+Accept: application/xml
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 200 OK
+X-Frame-Options: SAMEORIGIN
+X-XSS-Protection: 1; mode=block
+X-Content-Type-Options: nosniff
+Content-Type: text/html;charset=utf-8
+CIMI-Specification-Version: 1.0.1
+Content-Length: 0
+Date: Fri, 28 Dec 2012 15:21:14 GMT
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+</pre>
+
+ </div>
+</div>
+
+ <footer class="footer">
+ <p class="pull-right"><span class='icon-circle-arrow-up'> </span><a href="#">Back to top</a></p>
+ <div class='row'>
+ <div class='span3'>
+ <img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
+ </div>
+ <div class='span9'>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </div>
+ </div>
+ </footer>
+
+ </div> <!-- /container -->
+
+<!-- Piwik -->
+<script type="text/javascript">
+var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.salasaga.org/aeolus/piwik/" : "http://stats.salasaga.org/aeolus/piwik/");
+document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
+</script><script type="text/javascript">
+try {
+var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 2);
+piwikTracker.trackPageView();
+piwikTracker.enableLinkTracking();
+} catch( err ) {}
+</script><noscript><p><img src="http://stats.salasaga.org/aeolus/piwik/piwik.php?idsite=2" style="border:0" alt="" /></p></noscript>
+<!-- End Piwik Tracking Code -->
+
+ </body>
+</html>