You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2011/11/05 17:41:27 UTC
svn commit: r1197985 - in /libcloud/site/trunk:
content/docs/load-balancer-base-api.mdtext
content/docs/load-balancer-overview.mdtext
content/docs/storage-examples.mdtext templates/blocks/menu_docs.html
Author: tomaz
Date: Sat Nov 5 16:41:26 2011
New Revision: 1197985
URL: http://svn.apache.org/viewvc?rev=1197985&view=rev
Log:
Load balancer docs.
Added:
libcloud/site/trunk/content/docs/load-balancer-base-api.mdtext
libcloud/site/trunk/content/docs/load-balancer-overview.mdtext
Modified:
libcloud/site/trunk/content/docs/storage-examples.mdtext
libcloud/site/trunk/templates/blocks/menu_docs.html
Added: libcloud/site/trunk/content/docs/load-balancer-base-api.mdtext
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/docs/load-balancer-base-api.mdtext?rev=1197985&view=auto
==============================================================================
--- libcloud/site/trunk/content/docs/load-balancer-base-api.mdtext (added)
+++ libcloud/site/trunk/content/docs/load-balancer-base-api.mdtext Sat Nov 5 16:41:26 2011
@@ -0,0 +1,79 @@
+title: Load Balancer -> Base API
+
+## Base API ##
+
+* [list_protocols](#list_protocols)
+* [list_balancers](#list_balancers)
+* [balancer_list_members](#balancer_list_members)
+* [get_balancer](#get_balancer)
+* [create_balancer](#create_balancer)
+* [destroy_balancer](#destroy_balancer)
+* [balancer_attach_member](#balancer_attach_member)
+* [balancer_attach_compute_node](#balancer_attach_compute_node)
+* [balancer_detach_member](#balancer_detach_member)
+
+<h3 id="list_protocols">list_protocols</h3>
+
+**Method signature**:
+[driver.list_protocols()](/apidocs/current/libcloud.loadbalancer.base.Driver.html#list_protocols)
+**Description**: Return a list of protocols which can be load balanced
+and are supported by the provider.
+
+<h3 id="list_balancers">list_balancers</h3>
+
+**Method signature**:
+[driver.list_balancers()](/apidocs/current/libcloud.loadbalancer.base.Driver.html#list_balancers)
+**Description**: Return a list of the available LoadBalancer instances.
+
+
+<h3 id="balancer_list_members">balancer_list_members</h3>
+
+**Method signature**:
+[driver.balancer_list_members(balancer)](/apidocs/current/libcloud.loadbalancer.base.Driver.html#balancer_list_members),
+[balancer.list_members()](/apidocs/current/libcloud.loadbalancer.base.LoadBalancer.html#list_members)
+**Description**: Return a list of the Member objects which are attached to this
+load balancer.
+
+<h3 id="get_balancer">get_balancer</h3>
+
+**Method signature**:
+[driver.get_balancer(balancer_id)](/apidocs/current/libcloud.loadbalancer.base.Driver.html#get_balancer)
+**Description**: Return a LoadBalancer instance. This method is useful if you
+know the load balancer id and want to obtain a reference to perform operations with
+it.
+
+<h3 id="create_balancer">create_balancer</h3>
+
+**Method signature**:
+[driver.create_balancer(name, port, protocol, algorithm, members)](/apidocs/current/libcloud.loadbalancer.base.Driver.html#create_balancer)
+**Description**: Create a new load balancer and optionally attach initial
+members to it.
+
+<h3 id="destroy_balancer">destroy_balancer</h3>
+
+**Method signature**:
+[driver.destroy_balancer(balancer)](/apidocs/current/libcloud.loadbalancer.base.Driver.html#destroy_balancer)
+**Description**: Destroy a load balancer.
+
+<h3 id="balancer_attach_member">balancer_attach_member</h3>
+
+**Method signature**:
+[driver.balancer_attach_member(balancer, member)](/apidocs/current/libcloud.loadbalancer.base.Driver.html#balancer_attach_member),
+[balancer.attach_member(member)](/apidocs/current/libcloud.loadbalancer.base.LoadBalancer.html#attach_member)
+**Description**: Add a new member to the load balancer.
+
+<h3 id="balancer_attach_compute_node">balancer_attach_compute_node</h3>
+
+**Method signature**:
+[driver.balancer_attach_compute_node(balancer, node)](/apidocs/current/libcloud.loadbalancer.base.Driver.html#balancer_attach_compute_node),
+[balancer.attach_compute_node(node)](/apidocs/current/libcloud.loadbalancer.base.LoadBalancer.html#attach_compute_node)
+**Description**: Add a new member to the load balancer. This method expected a
+Node object from the compute API as an argument. It automatically reads Node's
+first public IP address before adding a new member.
+
+<h3 id="balancer_detach_member">balancer_detach_member</h3>
+
+**Method signature**:
+[driver.balancer_detach_member(balancer, member)](/apidocs/current/libcloud.loadbalancer.base.Driver.html#balancer_detach_member),
+[balancer.detach_member(member)](/apidocs/current/libcloud.loadbalancer.base.LoadBalancer.html#detach_member)
+**Description**: Remove a member from the load balancer.
Added: libcloud/site/trunk/content/docs/load-balancer-overview.mdtext
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/docs/load-balancer-overview.mdtext?rev=1197985&view=auto
==============================================================================
--- libcloud/site/trunk/content/docs/load-balancer-overview.mdtext (added)
+++ libcloud/site/trunk/content/docs/load-balancer-overview.mdtext Sat Nov 5 16:41:26 2011
@@ -0,0 +1,18 @@
+title: Load Balancers -> Overview
+
+## Overview ##
+
+Load Balancer API allows you to manage Load Balancers as a service and services such as
+[Rackspace Cloud Load Balancers][1], [GoGrid Load Balancers][2] and [Ninefold
+Load Balancers][3].
+
+### Terminology ###
+
+* **LoadBalancer** - represents a load balancer instance.
+* **Member** - represents a load balancer member.
+* **Algorithm** - represents a load balancing algorithm (round-robin, random,
+* etc.).
+
+[1]: http://www.rackspace.com/cloud/cloud_hosting_products/loadbalancers/
+[2]: http://www.gogrid.com/cloud-hosting/load-balancers.php
+[3]: https://ninefold.com/support/display/SPT/Load+Balancing
Modified: libcloud/site/trunk/content/docs/storage-examples.mdtext
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/docs/storage-examples.mdtext?rev=1197985&r1=1197984&r2=1197985&view=diff
==============================================================================
--- libcloud/site/trunk/content/docs/storage-examples.mdtext (original)
+++ libcloud/site/trunk/content/docs/storage-examples.mdtext Sat Nov 5 16:41:26 2011
@@ -1,4 +1,4 @@
-tityle: Storage -> Examples
+title: Storage -> Examples
## Examples
Modified: libcloud/site/trunk/templates/blocks/menu_docs.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/templates/blocks/menu_docs.html?rev=1197985&r1=1197984&r2=1197985&view=diff
==============================================================================
--- libcloud/site/trunk/templates/blocks/menu_docs.html (original)
+++ libcloud/site/trunk/templates/blocks/menu_docs.html Sat Nov 5 16:41:26 2011
@@ -17,6 +17,8 @@
</ul>
<li class="title">Load Balancer</li>
<ul>
+ <li><a href="load-balancer-overview.html">Overview</a></li>
+ <li><a href="load-balancer-base-api.html">Base API</a></li>
<li><a href="load-balancer-examples.html">Examples</a></li>
</ul>
</ul>