Merge lp:~jkakar/landscape-client/cloud-capacity into lp:~landscape/landscape-client/trunk

[Jamu Kakar]

This branch introduces the following changes:

- The EUCALYPTUS_INFO message type defines a new (optional)
  'capacity_info' field.

- The output of 'euca-describe-availability-zones verbose' is
  included in messages produced by the Eucalyptus plugin.

Right now, for Cloud Deck, we're planning to implement a very simple
"instance cap" which we know is very basic, but it allows us to
solve the problem of one user DoS'ing a cloud. A better solution,
which I've been discussing with James Troup in the background, will
require us to know the total capacity of the cloud. This change is
about making that information available to Landscape in time for the
client changes to land in Ubuntu 10.10.

[Sidnei da Silva (sidnei)]

Looks good, +1.

review: Approve

[Free Ekanayaka (free.ekanayaka)]

Nice branch! Thanks for the improved docstrings.

[1]

+ A string matching the following format is returned::

Is the double ":" at the end of the sentence intended? There are several spots like this.

[2]

+ optional=["capacity_info"])

Why is it optional? It seems that the code always include that capacity_info in the created message. Also removing the "optional" flag makes no tests fail.

review: Approve

[Jamu Kakar (jkakar)]

Free:

[1]

Yes, the double-colon means that the following text (indented by two
spaces typically) is an example. It will be rendered in a
fixed-width font in generated documentation. I usually use it for
code examples or for ASCII art diagrams.

[2]

I made it optional because the same message type is used by old
clients. I didn't want to break the messages they report.

[Free Ekanayaka (free.ekanayaka)]

Makes all sense, thanks for explaining.

=== modified file 'landscape/manager/eucalyptus.py'
--- landscape/manager/eucalyptus.py	2010-06-02 16:00:31 +0000
+++ landscape/manager/eucalyptus.py	2010-06-28 13:02:24 +0000
@@ -14,7 +14,11 @@
         self._tools = tools
 
     def get_version_info(self):
-        """Return information about the version of Eucalyptus in use.
+        """Get information about the version of Eucalyptus in use.
+
+        A string matching the following format is returned::
+
+          Eucalyptus version: 1.6.2
 
         @return: A L{Deferred} firing with the string output of the
            C{--version} command.
@@ -22,37 +26,80 @@
         return succeed(self._tools._runTool("euca_conf", ["--version"]))
 
     def get_walrus_info(self):
-        """Return information about the registered walruses (S3).
-
-        @return: a L{Deferred} firing with the string output of the
+        """Get information about the registered walruses (S3).
+
+        A string matching the following format is returned::
+
+          registered walruses:
+            walrus 10.0.1.113
+
+        @return: A L{Deferred} firing with the string output of the
             C{--list-walruses} command.
         """
         return succeed(self._tools._runTool("euca_conf", ["--list-walruses"]))
 
     def get_cluster_controller_info(self):
-        """Return information about the registered cluster controllers..
-
-        @return: a L{Deferred} firing with the string output of the
+        """Get information about the registered cluster controllers..
+
+        A string matching the following format is returned::
+
+          registered clusters:
+            dynamite 10.0.1.113
+
+        @return: A L{Deferred} firing with the string output of the
             C{--list-clusters} command.
         """
         return succeed(self._tools._runTool("euca_conf", ["--list-clusters"]))
 
     def get_storage_controller_info(self):
-        """Return information about the registered storage controllers (EBS).
-
-        @return: a L{Deferred} firing with the string output of the
+        """Get information about the registered storage controllers (EBS).
+
+        A string matching the following format is returned::
+
+          registered storage controllers:
+            dynamite 10.0.1.113
+
+        @return: A L{Deferred} firing with the string output of the
             C{--list-scs} command.
         """
         return succeed(self._tools._runTool("euca_conf", ["--list-scs"]))
 
     def get_node_controller_info(self):
-        """Return information about the registered node controller.
-
-        @return: a L{Deferred} firing with the string output of the
+        """Get information about the registered node controller.
+
+        A string matching the following format is returned::
+
+          registered nodes:
+            10.1.1.71  canyonedge   i-2DC5056F i-5DE5176D
+            10.1.1.72  canyonedge
+            10.1.1.73  canyonedge
+            10.1.1.74  canyonedge
+            10.1.1.75  canyonedge
+
+        @return: A L{Deferred} firing with the string output of the
             C{--list-nodes} command.
         """
         return succeed(self._tools._runTool("euca_conf", ["--list-nodes"]))
 
+    def get_capacity_info(self):
+        """Get information about the capacity of the cloud.
+
+        A string matching the following format is returned::
+
+          AVAILABILITYZONE	bruterobe	10.0.1.113
+          AVAILABILITYZONE	|- vm types	free / max   cpu   ram  disk
+          AVAILABILITYZONE	|- m1.small	0008 / 0008   1    128     2
+          AVAILABILITYZONE	|- c1.medium	0008 / 0008   1    256     5
+          AVAILABILITYZONE	|- m1.large	0004 / 0004   2    512    10
+          AVAILABILITYZONE	|- m1.xlarge	0004 / 0004   2   1024    20
+          AVAILABILITYZONE	|- c1.xlarge	0002 / 0002   4   2048    20
+
+        @return: A L{Deferred} firing with the string output of the
+            C{euca-describe-availability-zones verbose} command.
+        """
+        return succeed(self._tools._runTool("euca-describe-availability-zones",
+                                            ["verbose"]))
+
 
 class Eucalyptus(ManagerPlugin):
     """A management plugin for a Eucalyptus cloud."""
@@ -122,11 +169,13 @@
             info.get_walrus_info(),
             info.get_cluster_controller_info(),
             info.get_storage_controller_info(),
-            info.get_node_controller_info()]
+            info.get_node_controller_info(),
+            info.get_capacity_info()]
 
         def create_message(result):
             (version_info, walrus_info, cluster_controller_info,
-             storage_controller_info, node_controller_info) = result
+             storage_controller_info, node_controller_info,
+             capacity_info) = result
             version = version_info.split()[-1]
             data = {"access_key": credentials.accessKey,
                     "secret_key": credentials.secretKey,
@@ -140,7 +189,8 @@
                     "walrus_info": walrus_info,
                     "cluster_controller_info": cluster_controller_info,
                     "storage_controller_info": storage_controller_info,
-                    "node_controller_info": node_controller_info}
+                    "node_controller_info": node_controller_info,
+                    "capacity_info": capacity_info}
         return gather_results(deferred_list).addCallback(create_message)
 
     def _get_error_message(self, failure):

=== modified file 'landscape/manager/tests/test_eucalyptus.py'
--- landscape/manager/tests/test_eucalyptus.py	2010-06-02 16:00:31 +0000
+++ landscape/manager/tests/test_eucalyptus.py	2010-06-28 13:02:24 +0000
@@ -40,18 +40,30 @@
   10.1.1.75  canyonedge
 """
 
+fake_capacity_output = """\
+AVAILABILITYZONE	bruterobe	10.0.1.113
+AVAILABILITYZONE	|- vm types	free / max   cpu   ram  disk
+AVAILABILITYZONE	|- m1.small	0008 / 0008   1    128     2
+AVAILABILITYZONE	|- c1.medium	0008 / 0008   1    256     5
+AVAILABILITYZONE	|- m1.large	0004 / 0004   2    512    10
+AVAILABILITYZONE	|- m1.xlarge	0004 / 0004   2   1024    20
+AVAILABILITYZONE	|- c1.xlarge	0002 / 0002   4   2048    20
+"""
+
 
 class FakeEucalyptusInfo(object):
     """A fake version of L{EucalyptusInfo} for use in tests."""
 
     def __init__(self, version_output=None, walrus_output=None,
                  cluster_controller_output=None,
-                 storage_controller_output=None, node_controller_output=None):
+                 storage_controller_output=None, node_controller_output=None,
+                 capacity_output=None):
         self._version_output = version_output
         self._walrus_output = walrus_output
         self._cluster_controller_output = cluster_controller_output
         self._storage_controller_output = storage_controller_output
         self._node_controller_output = node_controller_output
+        self._capacity_output = capacity_output
 
     def get_version_info(self):
         return succeed(self._version_output)
@@ -68,6 +80,9 @@
     def get_node_controller_info(self):
         return succeed(self._node_controller_output)
 
+    def get_capacity_info(self):
+        return succeed(self._capacity_output)
+
 
 class FakeServiceHub(object):
 
@@ -101,7 +116,7 @@
             eucalyptus_info_factory=lambda tools: FakeEucalyptusInfo(
                 fake_version_output, fake_walrus_output,
                 fake_cluster_controller_output, fake_storage_controller_output,
-                fake_node_controller_output))
+                fake_node_controller_output, fake_capacity_output))
         self.manager.add(plugin)
         return plugin
 
@@ -139,7 +154,8 @@
                 "cluster_controller_info": fake_cluster_controller_output,
                 "node_controller_info": fake_node_controller_output,
                 "storage_controller_info": fake_storage_controller_output,
-                "walrus_info": fake_walrus_output}
+                "walrus_info": fake_walrus_output,
+                "capacity_info": fake_capacity_output}
             self.assertMessages(
                 self.broker_service.message_store.get_pending_messages(),
                 [expected])

=== modified file 'landscape/message_schemas.py'
--- landscape/message_schemas.py	2010-06-11 10:14:25 +0000
+++ landscape/message_schemas.py	2010-06-28 13:02:24 +0000
@@ -351,7 +351,9 @@
      "walrus_info": String(),
      "cluster_controller_info": String(),
      "storage_controller_info": String(),
-     "node_controller_info": String()})
+     "node_controller_info": String(),
+     "capacity_info": String()},
+    optional=["capacity_info"])
 
 EUCALYPTUS_INFO_ERROR = Message(
     "eucalyptus-info-error",