You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltacloud.apache.org by mf...@apache.org on 2012/06/25 14:34:17 UTC
[42/51] [partial] Site: Complete site revamp using bootstrap and docs
update
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/d3232da0/site/output/assets/js/jquery.tweet.js
----------------------------------------------------------------------
diff --git a/site/output/assets/js/jquery.tweet.js b/site/output/assets/js/jquery.tweet.js
new file mode 100644
index 0000000..2fd3fd4
--- /dev/null
+++ b/site/output/assets/js/jquery.tweet.js
@@ -0,0 +1,218 @@
+// jquery.tweet.js - See http://tweet.seaofclouds.com/ or https://github.com/seaofclouds/tweet for more info
+// Copyright (c) 2008-2011 Todd Matthews & Steve Purcell
+(function($) {
+ $.fn.tweet = function(o){
+ var s = $.extend({
+ username: null, // [string or array] required unless using the 'query' option; one or more twitter screen names (use 'list' option for multiple names, where possible)
+ list: null, // [string] optional name of list belonging to username
+ favorites: false, // [boolean] display the user's favorites instead of his tweets
+ query: null, // [string] optional search query (see also: http://search.twitter.com/operators)
+ avatar_size: null, // [integer] height and width of avatar if displayed (48px max)
+ count: 3, // [integer] how many tweets to display?
+ fetch: null, // [integer] how many tweets to fetch via the API (set this higher than 'count' if using the 'filter' option)
+ page: 1, // [integer] which page of results to fetch (if count != fetch, you'll get unexpected results)
+ retweets: true, // [boolean] whether to fetch (official) retweets (not supported in all display modes)
+ intro_text: null, // [string] do you want text BEFORE your your tweets?
+ outro_text: null, // [string] do you want text AFTER your tweets?
+ join_text: null, // [string] optional text in between date and tweet, try setting to "auto"
+ auto_join_text_default: "i said,", // [string] auto text for non verb: "i said" bullocks
+ auto_join_text_ed: "i", // [string] auto text for past tense: "i" surfed
+ auto_join_text_ing: "i am", // [string] auto tense for present tense: "i was" surfing
+ auto_join_text_reply: "i replied to", // [string] auto tense for replies: "i replied to" @someone "with"
+ auto_join_text_url: "i was looking at", // [string] auto tense for urls: "i was looking at" http:...
+ loading_text: null, // [string] optional loading text, displayed while tweets load
+ refresh_interval: null , // [integer] optional number of seconds after which to reload tweets
+ twitter_url: "twitter.com", // [string] custom twitter url, if any (apigee, etc.)
+ twitter_api_url: "api.twitter.com", // [string] custom twitter api url, if any (apigee, etc.)
+ twitter_search_url: "search.twitter.com", // [string] custom twitter search url, if any (apigee, etc.)
+ template: "{avatar}{time}{join}{text}", // [string or function] template used to construct each tweet <li> - see code for available vars
+ comparator: function(tweet1, tweet2) { // [function] comparator used to sort tweets (see Array.sort)
+ return tweet2["tweet_time"] - tweet1["tweet_time"];
+ },
+ filter: function(tweet) { // [function] whether or not to include a particular tweet (be sure to also set 'fetch')
+ return true;
+ }
+ }, o);
+
+ // See http://daringfireball.net/2010/07/improved_regex_for_matching_urls
+ var url_regexp = /\b((?:[a-z][\w-]+:(?:\/{1,3}|[a-z0-9%])|www\d{0,3}[.]|[a-z0-9.\-]+[.][a-z]{2,4}\/)(?:[^\s()<>]+|\(([^\s()<>]+|(\([^\s()<>]+\)))*\))+(?:\(([^\s()<>]+|(\([^\s()<>]+\)))*\)|[^\s`!()\[\]{};:'".,<>?«»“”‘’]))/gi;
+
+ // Expand values inside simple string templates with {placeholders}
+ function t(template, info) {
+ if (typeof template === "string") {
+ var result = template;
+ for(var key in info) {
+ var val = info[key];
+ result = result.replace(new RegExp('{'+key+'}','g'), val === null ? '' : val);
+ }
+ return result;
+ } else return template(info);
+ }
+ // Export the t function for use when passing a function as the 'template' option
+ $.extend({tweet: {t: t}});
+
+ function replacer (regex, replacement) {
+ return function() {
+ var returning = [];
+ this.each(function() {
+ returning.push(this.replace(regex, replacement));
+ });
+ return $(returning);
+ };
+ }
+
+ $.fn.extend({
+ linkUrl: replacer(url_regexp, function(match) {
+ var url = (/^[a-z]+:/i).test(match) ? match : "http://"+match;
+ return "<a href=\""+url+"\">"+match+"</a>";
+ }),
+ linkUser: replacer(/@(\w+)/gi, "@<a href=\"http://"+s.twitter_url+"/$1\">$1</a>"),
+ // Support various latin1 (\u00**) and arabic (\u06**) alphanumeric chars
+ linkHash: replacer(/(?:^| )[\#]+([\w\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff\u0600-\u06ff]+)/gi,
+ ' <a href="http://'+s.twitter_search_url+'/search?q=&tag=$1&lang=all'+((s.username && s.username.length == 1 && !s.list) ? '&from='+s.username.join("%2BOR%2B") : '')+'">#$1</a>'),
+ capAwesome: replacer(/\b(awesome)\b/gi, '<span class="awesome">$1</span>'),
+ capEpic: replacer(/\b(epic)\b/gi, '<span class="epic">$1</span>'),
+ makeHeart: replacer(/(<)+[3]/gi, "<tt class='heart'>♥</tt>")
+ });
+
+ function parse_date(date_str) {
+ // The non-search twitter APIs return inconsistently-formatted dates, which Date.parse
+ // cannot handle in IE. We therefore perform the following transformation:
+ // "Wed Apr 29 08:53:31 +0000 2009" => "Wed, Apr 29 2009 08:53:31 +0000"
+ return Date.parse(date_str.replace(/^([a-z]{3})( [a-z]{3} \d\d?)(.*)( \d{4})$/i, '$1,$2$4$3'));
+ }
+
+ function relative_time(date) {
+ var relative_to = (arguments.length > 1) ? arguments[1] : new Date();
+ var delta = parseInt((relative_to.getTime() - date) / 1000, 10);
+ var r = '';
+ if (delta < 60) {
+ r = delta + ' seconds ago';
+ } else if(delta < 120) {
+ r = 'a minute ago';
+ } else if(delta < (45*60)) {
+ r = (parseInt(delta / 60, 10)).toString() + ' minutes ago';
+ } else if(delta < (2*60*60)) {
+ r = 'an hour ago';
+ } else if(delta < (24*60*60)) {
+ r = '' + (parseInt(delta / 3600, 10)).toString() + ' hours ago';
+ } else if(delta < (48*60*60)) {
+ r = 'a day ago';
+ } else {
+ r = (parseInt(delta / 86400, 10)).toString() + ' days ago';
+ }
+ return 'about ' + r;
+ }
+
+ function build_auto_join_text(text) {
+ if (text.match(/^(@([A-Za-z0-9-_]+)) .*/i)) {
+ return s.auto_join_text_reply;
+ } else if (text.match(url_regexp)) {
+ return s.auto_join_text_url;
+ } else if (text.match(/^((\w+ed)|just) .*/im)) {
+ return s.auto_join_text_ed;
+ } else if (text.match(/^(\w*ing) .*/i)) {
+ return s.auto_join_text_ing;
+ } else {
+ return s.auto_join_text_default;
+ }
+ }
+
+ function build_api_url() {
+ var proto = ('https:' == document.location.protocol ? 'https:' : 'http:');
+ var count = (s.fetch === null) ? s.count : s.fetch;
+ if (s.list) {
+ return proto+"//"+s.twitter_api_url+"/1/"+s.username[0]+"/lists/"+s.list+"/statuses.json?page="+s.page+"&per_page="+count+"&callback=?";
+ } else if (s.favorites) {
+ return proto+"//"+s.twitter_api_url+"/favorites/"+s.username[0]+".json?page="+s.page+"&count="+count+"&callback=?";
+ } else if (s.query === null && s.username.length == 1) {
+ return proto+'//'+s.twitter_api_url+'/1/statuses/user_timeline.json?screen_name='+s.username[0]+'&count='+count+(s.retweets ? '&include_rts=1' : '')+'&page='+s.page+'&callback=?';
+ } else {
+ var query = (s.query || 'from:'+s.username.join(' OR from:'));
+ return proto+'//'+s.twitter_search_url+'/search.json?&q='+encodeURIComponent(query)+'&rpp='+count+'&page='+s.page+'&callback=?';
+ }
+ }
+
+ function extract_avatar_url(item, secure) {
+ if (secure) {
+ return ('user' in item) ?
+ item.user.profile_image_url_https :
+ extract_avatar_url(item, false);
+ } else {
+ return item.profile_image_url || item.user.profile_image_url;
+ }
+ }
+
+ // Convert twitter API objects into data available for
+ // constructing each tweet <li> using a template
+ function extract_template_data(item){
+ var o = {};
+ o.item = item;
+ o.source = item.source;
+ o.screen_name = item.from_user || item.user.screen_name;
+ o.avatar_size = s.avatar_size;
+ o.avatar_url = extract_avatar_url(item, (document.location.protocol === 'https:'));
+ o.retweet = typeof(item.retweeted_status) != 'undefined';
+ o.tweet_time = parse_date(item.created_at);
+ o.join_text = s.join_text == "auto" ? build_auto_join_text(item.text) : s.join_text;
+ o.tweet_id = item.id_str;
+ o.twitter_base = "http://"+s.twitter_url+"/";
+ o.user_url = o.twitter_base+o.screen_name;
+ o.tweet_url = o.user_url+"/status/"+o.tweet_id;
+ o.reply_url = o.twitter_base+"intent/tweet?in_reply_to="+o.tweet_id;
+ o.retweet_url = o.twitter_base+"intent/retweet?tweet_id="+o.tweet_id;
+ o.favorite_url = o.twitter_base+"intent/favorite?tweet_id="+o.tweet_id;
+ o.retweeted_screen_name = o.retweet && item.retweeted_status.user.screen_name;
+ o.tweet_relative_time = relative_time(o.tweet_time);
+ o.tweet_raw_text = o.retweet ? ('RT @'+o.retweeted_screen_name+' '+item.retweeted_status.text) : item.text; // avoid '...' in long retweets
+ o.tweet_text = $([o.tweet_raw_text]).linkUrl().linkUser().linkHash()[0];
+ o.tweet_text_fancy = $([o.tweet_text]).makeHeart().capAwesome().capEpic()[0];
+
+ // Default spans, and pre-formatted blocks for common layouts
+ o.user = t('<a class="tweet_user" href="{user_url}">{screen_name}</a>', o);
+ o.join = s.join_text ? t(' <span class="tweet_join">{join_text}</span> ', o) : ' ';
+ o.avatar = o.avatar_size ?
+ t('<a class="tweet_avatar" href="{user_url}"><img src="{avatar_url}" height="{avatar_size}" width="{avatar_size}" alt="{screen_name}\'s avatar" title="{screen_name}\'s avatar" border="0"/></a>', o) : '';
+ o.time = t('<span class="tweet_time"><a href="{tweet_url}" title="view tweet on twitter">{tweet_relative_time}</a></span>', o);
+ o.text = t('<span class="tweet_text">{tweet_text_fancy}</span>', o);
+ o.reply_action = t('<a class="tweet_action tweet_reply" href="{reply_url}">reply</a>', o);
+ o.retweet_action = t('<a class="tweet_action tweet_retweet" href="{retweet_url}">retweet</a>', o);
+ o.favorite_action = t('<a class="tweet_action tweet_favorite" href="{favorite_url}">favorite</a>', o);
+ return o;
+ }
+
+ return this.each(function(i, widget){
+ var list = $('<ul class="tweet_list">');
+ var intro = '<p class="tweet_intro">'+s.intro_text+'</p>';
+ var outro = '<p class="tweet_outro">'+s.outro_text+'</p>';
+ var loading = $('<p class="loading">'+s.loading_text+'</p>');
+
+ if(s.username && typeof(s.username) == "string"){
+ s.username = [s.username];
+ }
+
+ $(widget).bind("tweet:load", function(){
+ if (s.loading_text) $(widget).empty().append(loading);
+ $.getJSON(build_api_url(), function(data){
+ $(widget).empty().append(list);
+ if (s.intro_text) list.before(intro);
+ list.empty();
+
+ var tweets = $.map(data.results || data, extract_template_data);
+ tweets = $.grep(tweets, s.filter).sort(s.comparator).slice(0, s.count);
+ list.append($.map(tweets, function(o) { return "<li>" + t(s.template, o) + "</li>"; }).join('')).
+ children('li:first').addClass('tweet_first').end().
+ children('li:odd').addClass('tweet_even').end().
+ children('li:even').addClass('tweet_odd');
+
+ if (s.outro_text) list.after(outro);
+ $(widget).trigger("loaded").trigger((tweets.length === 0 ? "empty" : "full"));
+ if (s.refresh_interval) {
+ window.setTimeout(function() { $(widget).trigger("tweet:load"); }, 1000 * s.refresh_interval);
+ }
+ });
+ }).trigger("tweet:load");
+ });
+ };
+})(jQuery);
+
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/d3232da0/site/output/blob-storage.html
----------------------------------------------------------------------
diff --git a/site/output/blob-storage.html b/site/output/blob-storage.html
new file mode 100644
index 0000000..823b74c
--- /dev/null
+++ b/site/output/blob-storage.html
@@ -0,0 +1,600 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Blob storage</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-transition.js"></script>
+ <script src="/assets/js/bootstrap-alert.js"></script>
+ <script src="/assets/js/bootstrap-modal.js"></script>
+ <script src="/assets/js/bootstrap-scrollspy.js"></script>
+ <script src="/assets/js/bootstrap-tab.js"></script>
+ <script src="/assets/js/bootstrap-tooltip.js"></script>
+ <script src="/assets/js/bootstrap-popover.js"></script>
+ <script src="/assets/js/bootstrap-button.js"></script>
+ <script src="/assets/js/bootstrap-collapse.js"></script>
+ <script src="/assets/js/bootstrap-carousel.js"></script>
+ <script src="/assets/js/bootstrap-typeahead.js"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client Libraries</a></li>
+ <li><a href="/command-tools.html">Command Line Tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container content">
+
+ <p><br></p>
+
+<div class="row">
+ <div class="span9">
+
+<h3 id="blob">Blob Storage</h3>
+
+<p>
+Blob storage represents a generic key ==> value data store. It is implemented by Amazon S3 or Rackspace Cloudfiles. In Deltacloud, the organisational unit of blob storage is a bucket. Individual data items - blobs are exposed as a subcollection under each bucket.
+</p>
+
+<p>
+A bucket has
+</p>
+
+<ul>
+<li>a <strong>name</strong>;</li>
+ <li>a <strong>size</strong> (denotes the number of blobs it contains); and</li>
+ <li>a list of <strong>links to each blob</strong>.</li>
+</ul>
+<p>
+A blob has:
+</p>
+
+ </div>
+ <div class="span3">
+
+<ul class="nav nav-list well">
+<li class="nav-header">
+ REST API
+ </li>
+ <li><a href="rest-api.html">Introduction</a></li>
+ <li><a href="api-entry-point.html">API entry point</a></li>
+ <li><a href="compute-resources.html">Compute resources</a></li>
+ <li><a href="storage-resources.html">Storage resources</a></li>
+ <ul class="nav nav-list">
+<li><a href="storage-resources.html#volumes">Storage volumes</a></li>
+ <li><a href="storage-snapshots.html">Storage snaphots</a></li>
+ <li class="active"><a href="#blob">Blob storage</a></li>
+ </ul>
+</ul>
+</div>
+</div>
+
+<ul>
+<li>a <strong>content_length</strong>;</li>
+ <li>a <strong>content_type</strong>;</li>
+ <li>a <strong>last_modified</strong> timestamp;</li>
+ <li>a structure containing <strong>user_metadata</strong>;</li>
+ <li>a link to the blob <strong>content</strong>; and</li>
+ <li>a name of the bucket in which this blob exists.</li>
+</ul><p><br></p>
+
+<div class="tabbable">
+
+<ul class="nav nav-pills">
+<li class="active"><a href="#tab1" data-toggle="tab">Get a list of all buckets</a></li>
+ <li><a href="#tab2" data-toggle="tab">Get the details of a bucket</a></li>
+ <li><a href="#tab3" data-toggle="tab">Create/delete a bucket</a></li>
+ <li><a href="#tab4" data-toggle="tab">Get the details of a blob</a></li>
+ <li><a href="#tab5" data-toggle="tab">Create/delete a blob</a></li>
+ <li> </li>
+ <li><a href="#tab6" data-toggle="tab">Get/update blob metadata</a></li>
+</ul>
+<hr>
+<div class="tab-content">
+ <div class="tab-pane tab-fade active" id="tab1">
+
+<h4>Get a list of all buckets</h4>
+
+<p>
+To return a list of all buckets belonging to the given cloud provider account use call <strong>GET /api/buckets</strong>. The response from the Deltacloud server includes the name and URI of each bucket but not the size or the list of blobs which the bucket contains. These details are available when a client requests (GETs) a specific bucket.
+</p>
+
+<p>Example request:</p>
+
+<pre>
+GET /api/buckets?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1
+Host: localhost:3001
+Accept: */*
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+Content-Length: 597
+<?xml version='1.0' encoding='utf-8' ?>
+<buckets>
+ <bucket href='http://localhost:3001/api/buckets/mybucket1' id='mybucket1'>
+ <name>mybucket1</name>
+ <size></size>
+ </bucket>
+ <bucket href='http://localhost:3001/api/buckets/mybucket2' id='mybucket2'>
+ <name>mybucket2</name>
+ <size></size>
+ </bucket>
+ <bucket href='http://localhost:3001/api/buckets/mybucket3' id='mybucket3'>
+ <name>mybucket3</name>
+ <size></size>
+ </bucket>
+ <bucket href='http://localhost:3001/api/buckets/mybucket4' id='mybucket4'>
+ <name>mybucket4</name>
+ <size></size>
+ </bucket>
+</buckets>
+</pre>
+
+ </div>
+ <div class="tab-pane tab-fade" id="tab2">
+
+<h4>Get the details of a specific bucket</h4>
+
+<p>
+To return details of a specific bucket use call <strong>GET /api/buckets/:id</strong>. The Deltacloud server response includes the size of the bucket and the URI for each blob object that it contains.
+</p>
+
+<p>Example request:</p>
+
+<pre>
+GET /api/buckets/mybucket1?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1
+Host: localhost:3001
+Accept: */*
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+Content-Length: 534
+<?xml version='1.0' encoding='utf-8' ?>
+<bucket href='http://localhost:3001/api/buckets/mybucket1' id='mybucket1'>
+ <name>mybucket1</name>
+ <size>4</size>
+ <blob href='http://localhost:3001/api/buckets/mybucket1/myfile' id='myfile'></blob>
+ <blob href='http://localhost:3001/api/buckets/mybucket1/an_object' id='an_object'></blob>
+ <blob href='http://localhost:3001/api/buckets/mybucket1/picture_blob' id='picture_blob'></blob>
+ <blob href='http://localhost:3001/api/buckets/mybucket1/some_blob id='some_blob'></blob>
+</bucket>
+</pre>
+
+ </div>
+ <div class="tab-pane tab-fade" id="tab3">
+
+<h4>Create a new bucket</h4>
+
+<p>
+To create a new bucket use call <strong>POST /api/buckets</strong>. You need to specify the name as a parameter. Optionally for Amazon S3 buckets, you can specify a bucket location with the location parameter, as per <a href="http://docs.amazonwebservices.com/general/latest/gr/index.html?rande.html">Regions and Endpoints for Amazon Simple Storage Service</a>. Valid values for S3 bucket location parameter are: "us-west-1", "EU", "ap-southeast-1", "ap-northeast-1" (while not specifying a location default to the "US Standard" region). Note that clients may specify parameters as multipart/form-data or using a content-type of application/x-www-form-urlencoded.
+</p>
+
+<p>
+On succesful creation this call will return a 201 HTTP status, specifying the URI of the newly created bucket in the <strong>Location</strong> header and the newly created bucket object in the response message body. The example request below shows how to create a new bucket in the EU (Ireland) region. If the given back-end cloud does not support locations then the location parameter is ignored.
+</p>
+
+<p>Example request:</p>
+
+<pre>
+POST /api/buckets?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1
+Host: localhost:3001
+Accept: */*
+Content-Length: 31
+Content-Type: application/x-www-form-urlencoded
+
+name=mybucketeurope&location=EU
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 201 Created
+Location: http://localhost:3001/api/buckets/mybucketeurope
+Content-Type: application/xml
+Content-Length: 182
+
+<?xml version='1.0' encoding='utf-8' ?>
+<bucket href='http://localhost:3001/api/buckets/mybucketeurope' id='mybucketeurope'>
+ <name>mybucketeurope</name>
+ <size>0</size>
+</bucket>
+</pre>
+
+<h4>Delete a bucket</h4>
+
+<p>
+To delete the specified bucket use call <strong>DELETE /api/buckets/:id</strong>. The bucket must be empty (otherwise the call will fail with an error response). A succesful operation will return <strong>204 No Content</strong>.
+</p>
+
+<p>Example request:</p>
+
+<pre>
+DELETE /api/buckets/mybucketeurope?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
+Host: localhost:3001
+Accept: */*
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 204 No Content
+</pre>
+
+ </div>
+ <div class="tab-pane tab-fade" id="tab4">
+
+<h4>Get the details of a blob</h4>
+
+<p>
+To retrieve the details of a specific blob use call <strong>GET /api/buckets/:bucket_id/:blob_id</strong>. The blob content is not returned as part of the response but rather a URI is given from which the content may be retrieved as shown below.
+</p>
+
+<p>Example request:</p>
+
+<pre>
+GET /api/buckets/mariosbucket1/some_more_blob_woo?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
+Host: localhost:3001
+Accept: */*
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 200 OK
+Content-Type: application/xml
+Content-Length: 586
+<?xml version='1.0' encoding='utf-8' ?>
+<blob href='http://localhost:3001/api/buckets/mariosbucket1/some_more_blob_woo' id='some_more_blob_woo'>
+ <bucket>mariosbucket1</bucket>
+ <content_length>86</content_length>
+ <content_type>text/plain</content_type>
+ <last_modified>Fri Jan 28 12:23:08 UTC 2011</last_modified>
+ <user_metadata>
+ <entry key='v'>
+ <![CDATA[0.2.0]]>
+ </entry>
+ <entry key='test'>
+ <![CDATA[value]]>
+ </entry>
+ </user_metadata>
+ <content href='http://localhost:3001/api/buckets/mariosbucket1/some_more_blob_woo/content'></content>
+</blob>
+</pre>
+
+<h4>Get the actual blob content</h4>
+
+<p>
+To retrieve the actual blob content use call <strong>GET /api/buckets/:bucket_id/:blob_id/content</strong>. The location of blob content is specified in the content URI returned from the <strong>GET /api/buckets/:bucket_id/:blob_id</strong> call. The content is streamed through the Deltacloud server as soon as it is received from the back-end cloud provider. The aim is to avoid the creation of a temporary file (especially significant in case of large blobs). The Deltacloud server sets <strong>Content-Disposition: attachment; filename=blob_name</strong> in the HTTP response headers.
+</p>
+
+<p>
+Example request:
+</p>
+
+<pre>
+GET /api/buckets/mariosanotherbucketohyeah/Im_a_blob_beholdme/content?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
+Host: localhost:3001
+Accept: */*
+</pre>
+
+<p>
+Server response:
+</p>
+
+<pre>
+HTTP/1.1 200 OK
+Content-Disposition: attachment; filename=Im_a_blob_beholdme
+Content-Type: text/plain
+Content-Length: 50
+
+<BLOB DATA HERE>
+</pre>
+
+ </div>
+ <div class="tab-pane tab-fade" id="tab5">
+
+<h4>Create a blob object</h4>
+
+<p>
+To create a blob object and set its content use call <strong>PUT /api/buckets/:bucket_id/:blob_id</strong>. If the blob already exists then its data and metadata are overwritten with those specified in this call. The request must specify the name of the blob and the name of the bucket in which the blob is to be placed in the call URI. The client must also specify the <strong>content_length</strong> of the blob data and the <strong>blob data</strong> itself in the HTTP headers. Optionally the call may also specify a <strong>content_type</strong> and any number of <strong>key:value</strong> pairs of user defined metadata. User metadata is defined using 'X-Deltacloud-Blobmeta-' header, e.g. X-Deltacloud-Blobmeta-Version:2.1.
+</p>
+
+<p>
+To eliminate the necessity of creating a local file at the Deltacloud server for each blob created, the Deltacloud server starts to stream the blob data to the back-end cloud provider as soon as the request headers are processed. A succesful operation will return the newly created blob object, as shown below.
+</p>
+
+<p>Example request:</p>
+
+<pre>
+PUT /api/buckets/mybucket/12Jul2011blob?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+Content-Type: text/plain
+Content-Length: 128988
+X-Deltacloud-Blobmeta-Version:2.1
+X-Deltacloud-Blobmeta-Author:msa
+
+... BLOB DATA ...
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+<?xml version='1.0' encoding='utf-8' ?>
+<blob href='http://localhost:3001/api/buckets/mybucket/12Jul2011blob' id='12Jul2011blob'>
+ <bucket>mybucket</bucket>
+ <content_length>128988</content_length>
+ <content_type>text/plain</content_type>
+ <last_modified>Wed Jul 13 13:27:22 UTC 2011</last_modified>
+ <user_metadata>
+ <entry key='author'>
+ <![CDATA[msa]]>
+ </entry>
+ <entry key='version'>
+ <![CDATA[2.1]]>
+ </entry>
+ </user_metadata>
+ <content href='http://localhost:3001/api/buckets/mybucket/12Jul2011blob/content'>
+ </content>
+</blob>
+</pre>
+
+<p>
+The Deltacloud server also responds to an alternative <strong>POST /api/buckets/:bucket_id</strong> route for creating or updating a blob object. As with the <strong>PUT</strong> method for creating/updating a blob, the client must specify the <strong>bucket</strong> in which the blob is to be created through the call URI (i.e. you <strong>POST</strong> to the specified bucket). The rest of the required fields, that is, the <strong>name</strong> of the blob, the <strong>blob_data</strong> and the <strong>content-length</strong> are specified by the client as <strong>multipart/form-data</strong> (i.e. in <strong>HTTP POST</strong> form fields).
+</p>
+
+<p>
+In order to specify the optional user metadata for a given blob the client must set the form field <strong>meta_params</strong> to specify the number of metadata key/value pairs. The metadata itself is then specified by the client with fields of the form <strong>meta_nameN</strong> and <strong>meta_valueN</strong> where N is an integer from 1 up to the number specified by the <strong>meta_params</strong> field (e.g. meta_name1=author, meta_value1=jrd).
+</p>
+
+<p>
+It should be noted that the <strong>POST</strong> method for creating a blob is non streaming - the Deltacloud server will create a temporary file with the blob data, before the file is transferred to the backend cloud. Thus, it should only be used for blobs with a relatively small content-length and in general the <strong>PUT</strong> method should be preferred for larger blobs. This <strong>POST</strong> method is mainly provided for clients that cannot easily invoke a <strong>HTTP PUT</strong> operation (e.g. web browsers) and can be used for creating/updating a blob through the deltacloud HTML interface (provided for testing purposes).
+</p>
+
+<p>Example request:</p>
+
+<pre>
+POST /api/buckets/mybucket?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1 (i386-redhat-linux-gnu) libcurl/7.20.1 N
+Accept: */*
+Content-Length: 113582
+Expect: 100-continue
+Content-Type: multipart/form-data; boundary=----------------------------517f5f2df858
+
+------------------------------517f5f2df858
+Content-Disposition: form-data; name="blob"
+
+12Jul2011blob
+------------------------------517f5f2df858
+Content-Disposition: form-data; name="blob_data"; filename="small.txt"
+Content-Type: text/plain
+
+<THE_BLOB_DATA_HERE>
+
+------------------------------517f5f2df858
+Content-Disposition: form-data; name="meta_params"
+
+2
+------------------------------517f5f2df858
+Content-Disposition: form-data; name="meta_name1"
+
+author
+------------------------------517f5f2df858
+Content-Disposition: form-data; name="meta_value1"
+jjs
+------------------------------517f5f2df858
+Content-Disposition: form-data; name="meta_name2"
+
+version
+------------------------------517f5f2df858
+Content-Disposition: form-data; name="meta_value2"
+
+2.2
+------------------------------517f5f2df858--
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+<?xml version='1.0' encoding='utf-8' ?>
+<blob href='http://localhost:3001/api/buckets/mybucket/12Jul2011blob' id='12Jul2011blob'>
+ <bucket>mybucket</bucket>
+ <content_length>112766</content_length>
+ <content_type>text/plain</content_type>
+ <last_modified></last_modified>
+ <user_metadata>
+ <entry key='x-amz-meta-author'>
+ <![CDATA[jjs]]>
+ </entry>
+ <entry key='x-amz-meta-version'>
+ <![CDATA[2.2]]>
+ </entry>
+ </user_metadata>
+ <content href='http://localhost:3001/api/buckets/mybucket/12Jul2011blob/content'>
+ </content>
+</blob>
+</pre>
+
+<h4>Delete a blob object</h4>
+
+<p>
+To delete the specified blob object from the back-end cloud use call <strong>DELETE /api/buckets/:bucket_id/:blob_id</strong>. The names of the blob and the bucket in which this exists are specified the in call URI. After a succesful operation the Deltacloud server responds with a <strong>HTTP 204</strong> (No Content) with no message body.
+</p>
+
+<p>Example request:</p>
+
+<pre>
+DELETE /api/buckets/mybucket/12Jul2011blob?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1 (i386-redhat-linux-gnu)
+Host: localhost:3001
+Accept: */*
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 204 No Content
+Connection: close
+Server: thin 1.2.11
+</pre>
+
+ </div>
+ <div class="tab-pane tab-fade" id="tab6">
+
+<h4>Get all metadata fields</h4>
+
+<p>
+To return all user defined metadata fields on a specified blob URI use the HTTP HEAD operation <strong>HEAD /api/buckets/:bucket_id/:blob_id</strong>. As per <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</a> this <strong>HEAD</strong> operation does not return a message body. Rather, the blob user metadata values are returned in the response X-Deltacloud-Blobmeta- headers (e.g., X-Deltacloud-Blobmeta-version:1.2).
+</p>
+
+<p>Example request:</p>
+
+<pre>
+HEAD /api/buckets/mybucket/myblob?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1
+Host: localhost:3001
+Accept: */*
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 204 No Content
+X-Deltacloud-Blobmeta-version: 1.21
+X-Deltacloud-Blobmeta-author: jrd
+</pre>
+
+<h4>Update the user-defined blob metadata</h4>
+
+<p>
+To update the user-defined blob metadata use call <strong>POST /api/buckets/:bucket_id/:blob_id</strong> on the URI of a blob. This operation will overwrite all previously set user-metadata values (if any) and replace them with those specified in this call. The client must set the user-defined metadata in the X-Deltacloud-Blobmeta- headers (e.g., X-Deltacloud-Blobmeta-Model:2012).
+</p>
+
+<p>Example request:</p>
+
+<pre>
+POST /api/buckets/mybucket/myblob?format=xml HTTP/1.1
+Authorization: Basic AU1J3UB2121Afd1DdyQWxLaTYTmJMNF4zTXBoRGdhMDh2RUw5ZDAN9zVXVa==
+User-Agent: curl/7.20.1
+Host: localhost:3001
+Accept: */*
+X-Deltacloud-Blobmeta-model: 2012
+X-Deltacloud-Blobmeta-paint: Stannite_Grey
+</pre>
+
+<p>Server response:</p>
+
+<pre>
+HTTP/1.1 204 No Content
+X-Deltacloud-Blobmeta-model: 2012
+X-Deltacloud-Blobmeta-paint: Stannite_Grey
+</pre>
+
+</div>
+</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 -->
+
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/d3232da0/site/output/client-ruby.html
----------------------------------------------------------------------
diff --git a/site/output/client-ruby.html b/site/output/client-ruby.html
deleted file mode 100644
index 8c2e8b7..0000000
--- a/site/output/client-ruby.html
+++ /dev/null
@@ -1,262 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html>
- <head>
- <title>
- Deltacloud - Documentation
- </title>
- <meta content='' name='keywords' />
- <meta content='' name='description' />
- <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
- <link href='./styles/favicon.ico' rel='shortcut icon' type='image/x-icon' />
- <link href='./styles/default.css' rel='StyleSheet' title='Main style' type='text/css' />
- <link href='./styles/default-debug.css' rel='Alternate StyleSheet' title='Debug main style' type='text/css' />
- </head>
- <body>
- <div id='header'>
- <div class='container'>
- <div id='headerLogo' onclick="location.href='index.html';" style='cursor: pointer;'>
- <h1>
- Deltacloud - Many clouds. One API. No problem.
- </h1>
- </div>
- </div>
- </div>
- <div id='navigation'>
- <div class='container' id='menu'>
- <ul class='l0'>
- <li>
- <a class='inactive' href='./index.html' title='Deltacloud Home'>Home</a>
- </li>
- <li>
- <a class='inactive' href='./download.html' title='Get the latest releases'>Download</a>
- </li>
- <li>
- <a class='inactive' href='./developers.html' title='Information for developers'>Developers</a>
- </li>
- <li>
- <a class='active' href='./documentation.html' title='Project documentation'>Documentation</a>
- </li>
- <li>
- <a class='inactive' href='./contact.html' title='Contact us!'>Contact</a>
- </li>
- </ul>
- </div>
- </div>
- <div id='subnavigation'>
- <div class='container' id='submenu'>
- <ul class='l1'>
- <li>
- <a class='inactive' href='documentation.html'>
- Installation
- </a>
- </li>
- <li>
- <a class='inactive' href='api.html'>
- REST API
- </a>
- </li>
- <li>
- <a class='inactive' href='drivers.html'>
- Drivers
- </a>
- </li>
- <li>
- <a class='active' href='client-ruby.html'>
- Ruby Client
- </a>
- </li>
- <li>
- <a class='inactive' href='libdeltacloud.html'>
- Libdeltacloud
- </a>
- </li>
- </ul>
- </div>
- </div>
- <div id='frontpageHeader'></div>
- <div id='main'>
- <div class='container' id='content-deltacloud'>
- <h1>Deltacloud Client (Ruby)</h1>
-
- <p><ul class="toc">
- <li>
- <a href="#h1">API Docs</a>
- </li>
- <li>
- <a href="#h2">Basics</a>
- </li>
- <li>
- <a href="#h3">Connecting to a Deltacloud provider</a>
- </li>
- <li>
- <a href="#h4">Listing realms</a>
- </li>
- <li>
- <a href="#h5">Listing hardware profiles</a>
- </li>
- <li>
- <a href="#h6">Listing images</a>
- </li>
- <li>
- <a href="#h7">Listing instances</a>
- </li>
- <li>
- <a href="#h8">Launching instances</a>
- </li>
- <li>
- <a href="#h9">Manipulating instances</a>
- </li>
- </ul></p>
-
- <p>The Deltacloud project includes a Ruby client. Other language-bindings
- are possible and will be supported soon. The client aims to insulate
- users from having to deal with HTTP and REST directly.</p>
-
- <p>Each resource type has an associated model to ease usage. Where
- resource reference other resources, natural navigation across the
- object model is possible.</p>
-
- <p>For example</p>
-
- <pre><code>puts instance.image.name
puts instance.hardware_profile.architecture
</code></pre>
-
- <h2 id="h1">API Docs</h2>
-
- <p>API Docs are <a href="ruby-client/doc/index.html">available</a></p>
-
- <h2 id="h2">Basics</h2>
-
- <p>To use the client, you must require <code>deltacloud</code>.</p>
-
- <pre><code>require 'deltacloud'
</code></pre>
-
- <h2 id="h3">Connecting to a Deltacloud provider</h2>
-
- <pre><code>require 'deltacloud'

api_url = 'http://localhost:3001/api'
api_name = 'mockuser'
api_password = 'mockpassword'

client = DeltaCloud.new( api_name, api_password, api_url )

# work with client here
</code></pre>
-
- <p>In addition to creating a client, operations may occur within a block
- included on the initialization</p>
-
- <pre><code>DeltaCloud.new( api_name, api_password, api_url ) do |client|
 # work with client here
end
</code></pre>
-
- <p>In the event of a failure, any underlying HTTP transport exceptions
- will be thrown all the way out to the caller.</p>
-
- <h2 id="h4">Listing realms</h2>
-
- <p>You may retrieve a complete list of realms available to you</p>
-
- <pre><code>realms = client.realms
</code></pre>
-
- <p>You may retrieve a specific realm by its identifier</p>
-
- <pre><code>realm = client.realm( 'us' )
</code></pre>
-
- <h2 id="h5">Listing hardware profiles</h2>
-
- <p>You may retrieve a complete list of hardware profiles available for launching
- machines</p>
-
- <pre><code>hwp = client.hardware_profiles
</code></pre>
-
- <p>You may filter hardware profiles by architecture</p>
-
- <pre><code>hardware_profiles = client.hardware_profiles( :architecture=>'x86_64' )
</code></pre>
-
- <p>You may retrieve a specific hardware profile by its identifier</p>
-
- <pre><code>hardware_profile = client.hardware_profile( 'm1-small' )
</code></pre>
-
- <h2 id="h6">Listing images</h2>
-
- <p>You may retrieve a complete list of images</p>
-
- <pre><code>images = client.images
</code></pre>
-
- <p>You may retrieve a list of images owned by the currently authenticated
- user</p>
-
- <pre><code>images = client.images( :owner_id=>:self )
</code></pre>
-
- <p>You may retrieve a list of images visible to you but owned by a specific
- user</p>
-
- <pre><code>images = client.images( :owner_id=>'daryll' )
</code></pre>
-
- <p>You may retrieve a specific image by its identifier</p>
-
- <pre><code>image = client.image( 'ami-8675309' )
</code></pre>
-
- <h2 id="h7">Listing instances</h2>
-
- <p>You may retrieve a list of all instances visible to you</p>
-
- <pre><code>instances = client.instances
</code></pre>
-
- <p>You may retrieve a specific instance by its identifier</p>
-
- <pre><code>instance = client.instance( 'i-90125' )
</code></pre>
-
- <h2 id="h8">Launching instances</h2>
-
- <p>An instance may be launched using just an image identifier</p>
-
- <pre><code>image = client.image( 'ami-8675309' )
instance = client.create_instance( image.id )
</code></pre>
-
- <p>Optionally, a hardware profile or a realm may be specified</p>
-
- <pre><code>instance = client.create_instance( image.id, :hardware_profile=>'m1-small', :realm=>'us' )
</code></pre>
-
- <h2 id="h9">Manipulating instances</h2>
-
- <p>Given an instance, depending on its state, various actions <em>may</em> be available.</p>
-
- <p>To determine what's available, the <code>instance#actions</code> method may be used.</p>
-
- <pre><code>instance.actions # [ 'reboot', 'stop' ]
</code></pre>
-
- <p>For a valid action, the method matching the action with an exclamation point may be called.</p>
-
- <pre><code>instance.reboot!
</code></pre>
-
- <p>Upon invoking an action, the instance will refresh its contents, in case the state has changed.
- To determine later if the state has changed again, the instance must be refetched using
- the <code>client.instance(...)</code> method.</p>
- </div>
- </div>
- <div id='footer-deltacloud'>
- <div class='container'>
- <p>
- <a href='http://www.apache.org'>
- <img alt='Apache Software Foundation Logo' src='http://www.apache.org/images/asf_logo_wide.png' />
- </a>
- </p>
- <p id='disclaimer'>
- Apache Deltacloud is a top-level project at the Apache
- Software Foundation, having graduated from the ASF Incubator
- in October 2011. Through a collaborative and meritocratic
- development process, Apache projects deliver enterprise-grade,
- freely available software products that attract large communities of users.
- </p>
- </div>
- </div>
- </body>
- <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'>
- //<![CDATA[
- try {
- var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 2);
- piwikTracker.trackPageView();
- piwikTracker.enableLinkTracking();
- } catch( err ) {}
- //]]>
- </script>
- <noscript>
- <p>
- <img alt='' src='http://stats.salasaga.org/aeolus/piwik/piwik.php?idsite=2' style='border:0' />
- </p>
- </noscript>
-</html>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/d3232da0/site/output/clients.html
----------------------------------------------------------------------
diff --git a/site/output/clients.html b/site/output/clients.html
new file mode 100644
index 0000000..3ef6eff
--- /dev/null
+++ b/site/output/clients.html
@@ -0,0 +1,111 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Clients</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-transition.js"></script>
+ <script src="/assets/js/bootstrap-alert.js"></script>
+ <script src="/assets/js/bootstrap-modal.js"></script>
+ <script src="/assets/js/bootstrap-scrollspy.js"></script>
+ <script src="/assets/js/bootstrap-tab.js"></script>
+ <script src="/assets/js/bootstrap-tooltip.js"></script>
+ <script src="/assets/js/bootstrap-popover.js"></script>
+ <script src="/assets/js/bootstrap-button.js"></script>
+ <script src="/assets/js/bootstrap-collapse.js"></script>
+ <script src="/assets/js/bootstrap-carousel.js"></script>
+ <script src="/assets/js/bootstrap-typeahead.js"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client Libraries</a></li>
+ <li><a href="/command-tools.html">Command Line Tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container content">
+
+
+
+ <footer class="footer">
+ <p class="pull-right"><span class='icon-circle-arrow-up'> </span><a href="#">Back to top</a></p>
+ <div class='row'>
+ <div class='span3'>
+ <img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
+ </div>
+ <div class='span9'>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </div>
+ </div>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/d3232da0/site/output/clients/index.html
----------------------------------------------------------------------
diff --git a/site/output/clients/index.html b/site/output/clients/index.html
new file mode 100644
index 0000000..17b0cf7
--- /dev/null
+++ b/site/output/clients/index.html
@@ -0,0 +1,96 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Clients</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li class="active"><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Run API <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Use API <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/use-the-api">Using API</a></li>
+ <li><a href="/clients">Clients</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/how-to-contribute">How Can I Contribute?</a></li>
+ <li><a href="/getting-sources">Getting the Sources</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api">REST API</a></li>
+ <li><a href="/drivers">Drivers API</a></li>
+ <li><a href="/libdeltacloud">C library libdeltacloud</a></li>
+ </ul>
+ </li>
+ <li><a href="#contact">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container">
+
+
+
+ <footer class="footer">
+ <p class="footer-right">
+ <img src="/assets/img/asf_logo_wide.png" alt="Apache Software
+ Foundation"/>
+ </p>
+ <p>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </p>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/d3232da0/site/output/command-tools.html
----------------------------------------------------------------------
diff --git a/site/output/command-tools.html b/site/output/command-tools.html
new file mode 100644
index 0000000..e6dd5ac
--- /dev/null
+++ b/site/output/command-tools.html
@@ -0,0 +1,149 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Command Line Tools</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-transition.js"></script>
+ <script src="/assets/js/bootstrap-alert.js"></script>
+ <script src="/assets/js/bootstrap-modal.js"></script>
+ <script src="/assets/js/bootstrap-scrollspy.js"></script>
+ <script src="/assets/js/bootstrap-tab.js"></script>
+ <script src="/assets/js/bootstrap-tooltip.js"></script>
+ <script src="/assets/js/bootstrap-popover.js"></script>
+ <script src="/assets/js/bootstrap-button.js"></script>
+ <script src="/assets/js/bootstrap-collapse.js"></script>
+ <script src="/assets/js/bootstrap-carousel.js"></script>
+ <script src="/assets/js/bootstrap-typeahead.js"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client Libraries</a></li>
+ <li><a href="/command-tools.html">Command Line Tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container content">
+
+ <p><br></p>
+
+<h3 id="command">Using Deltacloud command tool</h3>
+
+<p>Installing the Deltacloud Ruby client also gives you the <strong>deltacloudc</strong> command line tool. This executable uses the Deltacloud client library to speak to the Deltacloud server through the <a href="rest-api.html">REST API</a>. This means that you can control your cloud infrastructure from the command line. The general usage pattern for deltacloudc is:</p><p>
+
+</p><pre>$ deltacloudc collection operation [options]</pre>
+
+<dl>
+<dt>Collection</dt>
+ <dd>
+ refers to the Deltacloud object collections, such as Instances, Images, Buckets, Realms etc., as described in a greater detail in the <a href="rest-api.html">REST API documentation</a>.
+ </dd>
+ <dt>Operation</dt>
+ <dd>
+ is collection dependant. All collections respond to 'index' and 'show' operations (retrieve details on all objects in a given collection or on a specific object). Some collections respond to 'create' and 'destroy' operations. The collection of instances (realized virtual servers) responds to operations for managing the instance lifecycle, such as 'stop' or 'reboot'.
+ </dd>
+ <dt>Options</dt>
+ <dd>
+ are listed by invoking <strong>deltacloudc -h</strong>. The important option is <strong>-u</strong>, which specifies the API_URL, where the Deltacloud server is running. The API_URL takes the form of <strong>http://[user]:[password]@[api_url]:[port]/[api]</strong>. Alternatively, you can set the API_URL environment variable (e.g., export API_URL=http://mockuser:mockpassword@localhost:3001/api). If your username or your password contains special characters, it's necessary to use options <strong>-U</strong> and <strong>-P</strong> in addition to the option <strong>-u</strong>. Check the <a href="supported-providers.html#credentials"> list of credentials</a> you need for each back-end cloud provider.
+ </dd>
+</dl><p>
+The following examples assume that the Deltacloud server is running on your local machine port 3001 (the <strong>deltacloudd</strong> server daemon defaults to 'localhost:3001') and that it was started with the 'mock' provider (i.e. deltacloudd -i mock ).</p>
+
+<p> List all <strong>collections</strong> available in the current driver:</p>
+
+<pre>$ deltacloudc -l -u http://mockuser:mockpassword@localhost:3001/api</pre>
+
+<p>Get a list of all <strong>images</strong>:</p>
+
+<pre>$ deltacloudc images index -u http://mockuser:mockpassword@localhost:3001/api</pre>
+
+<p>List all operations for the <strong>buckets</strong> collection:</p>
+
+<pre>$ deltacloudc buckets -l -u http://mockuser:mockpassword@localhost:3001/api</pre>
+
+<p>Create a new <strong>blob</strong> in the bucket called 'bucket1':</p>
+
+<pre>$ deltacloudc blob create -i 'my_new_blob' -b 'bucket1' -f /home/marios/file.txt</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 -->
+
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/d3232da0/site/output/compute-resources.html
----------------------------------------------------------------------
diff --git a/site/output/compute-resources.html b/site/output/compute-resources.html
new file mode 100644
index 0000000..f99387a
--- /dev/null
+++ b/site/output/compute-resources.html
@@ -0,0 +1,234 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Compute resources</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-transition.js"></script>
+ <script src="/assets/js/bootstrap-alert.js"></script>
+ <script src="/assets/js/bootstrap-modal.js"></script>
+ <script src="/assets/js/bootstrap-scrollspy.js"></script>
+ <script src="/assets/js/bootstrap-tab.js"></script>
+ <script src="/assets/js/bootstrap-tooltip.js"></script>
+ <script src="/assets/js/bootstrap-popover.js"></script>
+ <script src="/assets/js/bootstrap-button.js"></script>
+ <script src="/assets/js/bootstrap-collapse.js"></script>
+ <script src="/assets/js/bootstrap-carousel.js"></script>
+ <script src="/assets/js/bootstrap-typeahead.js"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client Libraries</a></li>
+ <li><a href="/command-tools.html">Command Line Tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container content">
+
+ <p><br></p>
+
+<div class="row">
+ <div class="span9">
+
+<h3 id="compute">Compute Resources</h3>
+
+<p>
+The compute resources are: instances, instance states, images, realms, hardware profiles, firewalls, load balancers, addresses and keys.
+</p>
+
+<h3 id="realms">Realms</h3>
+
+<p>
+A realm represents a boundary containing resources, such as a data center. The exact definition of a realm is given by the cloud provider. In some cases, a realm may represent different datacenters, different continents or different pools of resources within a single datacenter. A cloud provider may insist that all the resources exist within a single realm in order to cooperate. For instance, storage volumes may only be allowed to be mounted to instances within the same realm. Generally speaking, going from one realm to another within the same cloud may change many aspects of the cloud, such as SLA’s, pricing terms, etc.
+</p>
+
+<h4>Get a list of all realms</h4>
+
+<p>
+To list all realms use call <strong>GET /api/realms</strong>. You can filter the list by adding a request parameter <strong>architecture</strong> to the realms that support a specific architecture, such as <strong>i386</strong>. The example below shows the retrieval of all realms for the AWS EC2 driver, which correspond to EC2 "availability zones":
+</p>
+
+ </div>
+ <div class="span3">
+
+<ul class="nav nav-list well">
+<li class="nav-header">
+ REST API
+ </li>
+ <li><a href="rest-api.html">Introduction</a></li>
+ <li><a href="api-entry-point.html">API entry point</a></li>
+ <li class="active"><a href="compute-resources.html">Compute resources</a></li>
+ <ul class="nav nav-list">
+<li><a href="#realms">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><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/realms?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: 639
+<?xml version='1.0' encoding='utf-8' ?>
+<realms>
+ <realm href='http://localhost:3001/api/realms/us-east-1a' id='us-east-1a'>
+ <name>us-east-1a</name>
+ <state>available</state>
+ </realm>
+ <realm href='http://localhost:3001/api/realms/us-east-1b' id='us-east-1b'>
+ <name>us-east-1b</name>
+ <state>available</state>
+ </realm>
+ <realm href='http://localhost:3001/api/realms/us-east-1c' id='us-east-1c'>
+ <name>us-east-1c</name>
+ <state>available</state>
+ </realm>
+ <realm href='http://localhost:3001/api/realms/us-east-1d' id='us-east-1d'>
+ <name>us-east-1d</name>
+ <state>available</state>
+ </realm>
+</realms>
+</pre>
+
+<h4>Get the details of a realm</h4>
+
+<p>
+To provide the details of a realm use call <strong>GET /api/realms/:id</strong>. The server responds with a <strong>name</strong>, a <strong>state</strong> and a <strong>limit</strong> applicable to the current requester. The name is an arbitrary label with no specific meaning in the API. The <strong>state</strong> can be either <strong>AVAILABLE</strong> or <strong>UNAVAILABLE</strong>.
+</p>
+
+<p>
+The example below shows the realm for the Rackspace driver. Since Rackspace does not currently have a notion of realms, the Deltacloud Rackspace driver provides a single realm called 'US', signifying that all compute resources for that cloud provider are hosted in the United States:
+</p>
+
+<p>Example request:</p>
+
+<pre>
+GET /api/realms/us?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: 182
+
+<?xml version='1.0' encoding='utf-8' ?>
+<realm href='http://localhost:3001/api/realms/us' id='us'>
+ <name>United States</name>
+ <state>AVAILABLE</state>
+ <limit></limit>
+</realm>
+</pre>
+
+<p><a class="btn btn-inverse btn-large" style="float: right" href="hardware-profiles.html">Hardware profiles <i class="icon-arrow-right icon-white" style="vertical-align:baseline"> </i></a></p>
+
+<p><br></p>
+
+ <footer class="footer">
+ <p class="pull-right"><span class='icon-circle-arrow-up'> </span><a href="#">Back to top</a></p>
+ <div class='row'>
+ <div class='span3'>
+ <img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
+ </div>
+ <div class='span9'>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </div>
+ </div>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/d3232da0/site/output/contact.html
----------------------------------------------------------------------
diff --git a/site/output/contact.html b/site/output/contact.html
index 1ed690a..7187522 100644
--- a/site/output/contact.html
+++ b/site/output/contact.html
@@ -1,110 +1,122 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html>
+<!DOCTYPE html>
+<html lang="en">
<head>
- <title>
- Deltacloud - Contact
- </title>
- <meta content='' name='keywords' />
- <meta content='' name='description' />
- <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
- <link href='./styles/favicon.ico' rel='shortcut icon' type='image/x-icon' />
- <link href='./styles/default.css' rel='StyleSheet' title='Main style' type='text/css' />
- <link href='./styles/default-debug.css' rel='Alternate StyleSheet' title='Debug main style' type='text/css' />
+ <meta charset="utf-8">
+ <title>Contact</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 id='header'>
- <div class='container'>
- <div id='headerLogo' onclick="location.href='index.html';" style='cursor: pointer;'>
- <h1>
- Deltacloud - Many clouds. One API. No problem.
- </h1>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client Libraries</a></li>
+ <li><a href="/command-tools.html">Command Line Tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
</div>
</div>
+
</div>
- <div id='navigation'>
- <div class='container' id='menu'>
- <ul class='l0'>
- <li>
- <a class='inactive' href='./index.html' title='Deltacloud Home'>Home</a>
- </li>
- <li>
- <a class='inactive' href='./download.html' title='Get the latest releases'>Download</a>
- </li>
- <li>
- <a class='inactive' href='./developers.html' title='Information for developers'>Developers</a>
- </li>
- <li>
- <a class='inactive' href='./documentation.html' title='Project documentation'>Documentation</a>
- </li>
- <li>
- <a class='active' href='./contact.html' title='Contact us!'>Contact</a>
- </li>
- </ul>
- </div>
- </div>
- <div id='frontpageHeader'></div>
- <div id='main'>
- <div class='container' id='content-deltacloud'>
- <h1>Contact us!</h1>
-
- <p>We'd love to hear about your experiences with Deltacloud:</p>
-
- <ul>
- <li><a href="http://mail-archives.apache.org/mod_mbox/deltacloud-dev/">dev@deltacloud.apache.org</a>
- is our mailing list where you can ask questions or see all the latest patches and development activity
- at the bleeding edge of the project,</li>
- <li>The <a href="http://webchat.freenode.net/">#deltacloud</a> irc channel on Freenode is where
- the developers hang out and where you can usually get the fastest answers to your questions,</li>
- <li>Our <a href="http://teambox.com/projects/deltacloud">Teambox</a> page is where we keep the latest
- task lists and where you can comment on or suggest new features for the project,</li>
- <li>We have a <a href="https://github.com/apache/deltacloud">github</a> page which is a mirror of the
- apache git repo, if you prefer to get the code or contribute that way.</li>
- <li>We track bugs in <a href="https://issues.apache.org/jira/browse/DTACLOUD">Apache JIRA</a>. If you are
- have found a problem with Deltacloud you can check if it is already known to the Deltacloud
- developers or <a href="https://issues.apache.org/jira/secure/CreateIssue!default.jspa">report it here</a>.</li>
- </ul>
-
-
- <p>Please don't hesitate to get in touch if you have any questions about the project,
- if you've had any issues with installing or using Deltacloud or even just to tell us
- how great you think Deltacloud is! You might want to contribute a translation of
- the Deltacloud documentation (or even this webpage), you may want to contribute
- to the code and need some help getting started.</p>
- </div>
- </div>
- <div id='footer-deltacloud'>
- <div class='container'>
- <p>
- <a href='http://www.apache.org'>
- <img alt='Apache Software Foundation Logo' src='http://www.apache.org/images/asf_logo_wide.png' />
- </a>
- </p>
- <p id='disclaimer'>
- Apache Deltacloud is a top-level project at the Apache
- Software Foundation, having graduated from the ASF Incubator
- in October 2011. Through a collaborative and meritocratic
- development process, Apache projects deliver enterprise-grade,
- freely available software products that attract large communities of users.
- </p>
- </div>
- </div>
+
+ <div class="container content">
+
+ <p><br></p>
+<h2>Contact us!</h2>
+
+<p>We'd love to hear about your experiences with Deltacloud.</p>
+
+<ul>
+<li>
+ <a href="http://mail-archives.apache.org/mod_mbox/deltacloud-dev/">dev@deltacloud.apache.org</a> is our mailing list where you can ask questions or see all the latest patches and development activity at the bleeding edge of the project.
+ </li>
+ <li>The <a href="http://webchat.freenode.net/">#deltacloud</a> irc channel on Freenode is a place where the developers hang out and where you can usually get the fastest answers to your questions.
+ </li>
+</ul><p>Please don't hesitate to get in touch if you have any questions about the project, if you've had any issues with installing or using Deltacloud or even just to tell us how great you think Deltacloud is!</p>
+
+ <footer class="footer">
+ <p class="pull-right"><span class='icon-circle-arrow-up'> </span><a href="#">Back to top</a></p>
+ <div class='row'>
+ <div class='span3'>
+ <img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
+ </div>
+ <div class='span9'>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </div>
+ </div>
+ </footer>
+
+ </div> <!-- /container -->
+
</body>
- <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'>
- //<![CDATA[
- try {
- var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 2);
- piwikTracker.trackPageView();
- piwikTracker.enableLinkTracking();
- } catch( err ) {}
- //]]>
- </script>
- <noscript>
- <p>
- <img alt='' src='http://stats.salasaga.org/aeolus/piwik/piwik.php?idsite=2' style='border:0' />
- </p>
- </noscript>
</html>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/d3232da0/site/output/contribute.html
----------------------------------------------------------------------
diff --git a/site/output/contribute.html b/site/output/contribute.html
new file mode 100644
index 0000000..d4c826b
--- /dev/null
+++ b/site/output/contribute.html
@@ -0,0 +1,111 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Contribute</title>
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le JavaScript -->
+ <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
+ <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
+ <script src="/assets/js/application.js" type="text/javascript"></script>
+ <script src="/assets/js/bootstrap-transition.js"></script>
+ <script src="/assets/js/bootstrap-alert.js"></script>
+ <script src="/assets/js/bootstrap-modal.js"></script>
+ <script src="/assets/js/bootstrap-scrollspy.js"></script>
+ <script src="/assets/js/bootstrap-tab.js"></script>
+ <script src="/assets/js/bootstrap-tooltip.js"></script>
+ <script src="/assets/js/bootstrap-popover.js"></script>
+ <script src="/assets/js/bootstrap-button.js"></script>
+ <script src="/assets/js/bootstrap-collapse.js"></script>
+ <script src="/assets/js/bootstrap-carousel.js"></script>
+ <script src="/assets/js/bootstrap-typeahead.js"></script>
+
+ <!-- Le styles -->
+ <link href="/assets/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/css/application.css" rel="stylesheet">
+ <link rel="shortcut icon" href="/assets/img/favicon.ico">
+ </head>
+
+ <body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
+ alt="Deltacloud API"/></a>
+ <ul class="nav top-nav">
+ <li><a href="/">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/about.html">What is Deltacloud?</a></li>
+ <li><a href="/supported-providers.html">Supported Providers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
+ <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/usage.html#usingapi">Using API</a></li>
+ <li><a href="/usage.html#clients">Client Libraries</a></li>
+ <li><a href="/command-tools.html">Command Line Tools</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/getting-sources.html">Getting Sources</a></li>
+ <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/rest-api.html">REST API</a></li>
+ <li><a href="/drivers.html">Drivers API</a></li>
+ </ul>
+ </li>
+ <li><a href="/contact.html">Contact</a></li>
+</ul>
+
+ </div>
+ </div>
+
+ </div>
+
+ <div class="container content">
+
+
+
+ <footer class="footer">
+ <p class="pull-right"><span class='icon-circle-arrow-up'> </span><a href="#">Back to top</a></p>
+ <div class='row'>
+ <div class='span3'>
+ <img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
+ </div>
+ <div class='span9'>
+ <strong>Apache Deltacloud</strong> is a top-level project at the <a
+ href="http://www.apache.org">Apache Software Foundation</a>,
+ having graduated from the ASF Incubator in October
+ 2011. Through a collaborative and meritocratic development process, Apache
+ projects deliver enterprise-grade, freely available software products that
+ attract large communities of users.
+ </div>
+ </div>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>