Update changelog for 0.4.0

[osm/N2VC.git] / juju / juju.py

diff --git a/juju/juju.py b/juju/juju.py
index b1dcabd..a9fcbbe 100644 (file)
--- a/juju/juju.py
+++ b/juju/juju.py
@@ -1,93 +1,118 @@
 class Juju(object):
-    def add_cloud(self):
+    def add_cloud(self, name, definition, replace=False):
         """Add a user-defined cloud to Juju from among known cloud types.
 
+        :param str name: Name of cloud
+        :param dict definition: Cloud definition
+
+        Example cloud definition, as yaml::
+
+            type: openstack
+            auth-types: [ userpass ]
+            regions:
+              london:
+                endpoint: https://london.mycloud.com:35574/v3.0/
+
         """
-        pass
+        raise NotImplementedError()
 
-    def agree(self):
+    def agree(self, *terms):
         """Agree to the terms of a charm.
 
+        :param str \*terms: Terms to agree to
+
         """
-        pass
+        raise NotImplementedError()
 
     def autoload_credentials(self):
         """Finds cloud credentials and caches them for use by Juju when
         bootstrapping.
 
         """
-        pass
+        raise NotImplementedError()
 
     def create_budget(self):
         """Create a new budget.
 
         """
-        pass
+        raise NotImplementedError()
 
     def get_agreements(self):
         """Return list of terms to which the current user has agreed.
 
         """
-        pass
+        raise NotImplementedError()
 
     def get_budgets(self):
         """Return list of available budgets.
 
         """
-        pass
+        raise NotImplementedError()
 
     def get_clouds(self):
         """Return list of all available clouds.
 
         """
-        pass
+        raise NotImplementedError()
 
     def get_controllers(self):
         """Return list of all available controllers.
 
         (maybe move this to Cloud?)
         """
-        pass
+        raise NotImplementedError()
 
-    def get_plans(self, charm_name):
+    def get_plans(self, charm_url):
         """Return list of plans available for the specified charm.
 
+        :param str charm_url: Charm url
+
         """
-        pass
+        raise NotImplementedError()
 
     def register(self, registration_string):
         """Register a user to a controller.
 
+        :param str registration_string: The registration string
+
         """
-        pass
+        raise NotImplementedError()
+
+    def set_budget(self, name, limit):
+        """Set a monthly budget limit.
 
-    def set_budget(self, name, amount):
-        """Set a budget limit.
+        :param str name: Name of budget
+        :param int limit: Monthly limit
 
         """
-        pass
+        raise NotImplementedError()
 
     def get_cloud(self, name):
         """Get a cloud by name.
 
+        :param str name: Name of cloud
+
         """
-        pass
+        raise NotImplementedError()
 
-    def get_controller(self):
+    def get_controller(self, name, include_passwords=False):
         """Get a controller by name.
 
+        :param str name: Name of controller
+        :param bool include_passwords: Include passwords for accounts
+
         (maybe move this to Cloud?)
         """
-        pass
+        raise NotImplementedError()
 
     def update_clouds(self):
         """Update public cloud info available to Juju.
 
         """
-        pass
+        raise NotImplementedError()
 
     def version(self):
         """Return the Juju version.
 
         """
-        pass
+        raise NotImplementedError()