juju/controller.py

   1 import asyncio
   2 import logging
   3
   4 from . import tag
   5 from .client import client
   6 from .client import connection
   7 from .client import watcher
   8 from .model import Model
   9
  10 log = logging.getLogger(__name__)
  11
  12
  13 class Controller(object):
  14     def __init__(self, loop=None):
  15         """Instantiate a new Controller.
  16
  17         One of the connect_* methods will need to be called before this
  18         object can be used for anything interesting.
  19
  20         :param loop: an asyncio event loop
  21
  22         """
  23         self.loop = loop or asyncio.get_event_loop()
  24         self.connection = None
  25
  26     async def connect(
  27             self, endpoint, username, password, cacert=None, macaroons=None):
  28         """Connect to an arbitrary Juju controller.
  29
  30         """
  31         self.connection = await connection.Connection.connect(
  32             endpoint, None, username, password, cacert, macaroons)
  33
  34     async def connect_current(self):
  35         """Connect to the current Juju controller.
  36
  37         """
  38         self.connection = (
  39             await connection.Connection.connect_current_controller())
  40
  41     async def connect_controller(self, controller_name):
  42         """Connect to a Juju controller by name.
  43
  44         """
  45         self.connection = (
  46             await connection.Connection.connect_controller(controller_name))
  47
  48     async def disconnect(self):
  49         """Shut down the watcher task and close websockets.
  50
  51         """
  52         if self.connection and self.connection.is_open:
  53             log.debug('Closing controller connection')
  54             await self.connection.close()
  55             self.connection = None
  56
  57     async def add_model(
  58             self, model_name, cloud_name=None, credential_name=None,
  59             owner=None, config=None, region=None):
  60         """Add a model to this controller.
  61
  62         :param str model_name: Name to give the new model.
  63         :param str cloud_name: Name of the cloud in which to create the
  64             model, e.g. 'aws'. Defaults to same cloud as controller.
  65         :param str credential_name: Name of the credential to use when
  66             creating the model. Defaults to current credential. If you
  67             pass a credential_name, you must also pass a cloud_name,
  68             even if it's the default cloud.
  69         :param str owner: Username that will own the model. Defaults to
  70             the current user.
  71         :param dict config: Model configuration.
  72         :param str region: Region in which to create the model.
  73
  74         """
  75         model_facade = client.ModelManagerFacade()
  76         model_facade.connect(self.connection)
  77
  78         owner = owner or self.connection.info['user-info']['identity']
  79         cloud_name = cloud_name or await self.get_cloud()
  80
  81         if credential_name:
  82             credential = tag.credential(
  83                 cloud_name,
  84                 tag.untag('user-', owner),
  85                 credential_name
  86             )
  87         else:
  88             credential = None
  89
  90         log.debug('Creating model %s', model_name)
  91
  92         model_info = await model_facade.CreateModel(
  93             tag.cloud(cloud_name),
  94             config,
  95             credential,
  96             model_name,
  97             owner,
  98             region,
  99         )
 100
 101         model = Model()
 102         await model.connect(
 103             self.connection.endpoint,
 104             model_info.uuid,
 105             self.connection.username,
 106             self.connection.password,
 107             self.connection.cacert,
 108             self.connection.macaroons,
 109         )
 110
 111         return model
 112
 113     async def destroy_models(self, *uuids):
 114         """Destroy one or more models.
 115
 116         :param str \*uuids: UUIDs of models to destroy
 117
 118         """
 119         model_facade = client.ModelManagerFacade()
 120         model_facade.connect(self.connection)
 121
 122         log.debug(
 123             'Destroying model%s %s',
 124             '' if len(uuids) == 1 else 's',
 125             ', '.join(uuids)
 126         )
 127
 128         await model_facade.DestroyModels([
 129             client.Entity(tag.model(uuid))
 130             for uuid in uuids
 131         ])
 132     destroy_model = destroy_models
 133
 134     def add_user(self, username, display_name=None, acl=None, models=None):
 135         """Add a user to this controller.
 136
 137         :param str username: Username
 138         :param str display_name: Display name
 139         :param str acl: Access control, e.g. 'read'
 140         :param list models: Models to which the user is granted access
 141
 142         """
 143         pass
 144
 145     def change_user_password(self, username, password):
 146         """Change the password for a user in this controller.
 147
 148         :param str username: Username
 149         :param str password: New password
 150
 151         """
 152         pass
 153
 154     def destroy(self, destroy_all_models=False):
 155         """Destroy this controller.
 156
 157         :param bool destroy_all_models: Destroy all hosted models in the
 158             controller.
 159
 160         """
 161         pass
 162
 163     def disable_user(self, username):
 164         """Disable a user.
 165
 166         :param str username: Username
 167
 168         """
 169         pass
 170
 171     def enable_user(self):
 172         """Re-enable a previously disabled user.
 173
 174         """
 175         pass
 176
 177     def kill(self):
 178         """Forcibly terminate all machines and other associated resources for
 179         this controller.
 180
 181         """
 182         pass
 183
 184     async def get_cloud(self):
 185         """
 186         Get the name of the cloud that this controller lives on.
 187         """
 188         cloud_facade = client.CloudFacade()
 189         cloud_facade.connect(self.connection)
 190
 191         result = await cloud_facade.Clouds()
 192         cloud = list(result.clouds.keys())[0]  # only lives on one cloud
 193         return tag.untag('cloud-', cloud)
 194
 195     def get_models(self, all_=False, username=None):
 196         """Return list of available models on this controller.
 197
 198         :param bool all_: List all models, regardless of user accessibilty
 199             (admin use only)
 200         :param str username: User for which to list models (admin use only)
 201
 202         """
 203         pass
 204
 205     def get_payloads(self, *patterns):
 206         """Return list of known payloads.
 207
 208         :param str \*patterns: Patterns to match against
 209
 210         Each pattern will be checked against the following info in Juju::
 211
 212             - unit name
 213             - machine id
 214             - payload type
 215             - payload class
 216             - payload id
 217             - payload tag
 218             - payload status
 219
 220         """
 221         pass
 222
 223     def get_users(self, all_=False):
 224         """Return list of users that can connect to this controller.
 225
 226         :param bool all_: Include disabled users
 227
 228         """
 229         pass
 230
 231     def login(self):
 232         """Log in to this controller.
 233
 234         """
 235         pass
 236
 237     def logout(self, force=False):
 238         """Log out of this controller.
 239
 240         :param bool force: Don't fail even if user not previously logged in
 241             with a password
 242
 243         """
 244         pass
 245
 246     def get_model(self, name):
 247         """Get a model by name.
 248
 249         :param str name: Model name
 250
 251         """
 252         pass
 253
 254     def get_user(self, username):
 255         """Get a user by name.
 256
 257         :param str username: Username
 258
 259         """
 260         pass