juju/controller.py

   1 import asyncio
   2 import logging
   3
   4 from . import tag
   5 from . import utils
   6 from .client import client
   7 from .client import connection
   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         self.controller_name = None
  26
  27     async def connect(
  28             self, endpoint, username, password, cacert=None, macaroons=None):
  29         """Connect to an arbitrary Juju controller.
  30
  31         """
  32         self.connection = await connection.Connection.connect(
  33             endpoint, None, username, password, cacert, macaroons)
  34
  35     async def connect_current(self):
  36         """Connect to the current Juju controller.
  37
  38         """
  39         self.connection = (
  40             await connection.Connection.connect_current_controller())
  41
  42     async def connect_controller(self, controller_name):
  43         """Connect to a Juju controller by name.
  44
  45         """
  46         self.connection = (
  47             await connection.Connection.connect_controller(controller_name))
  48         self.controller_name = controller_name
  49
  50     async def disconnect(self):
  51         """Shut down the watcher task and close websockets.
  52
  53         """
  54         if self.connection and self.connection.is_open:
  55             log.debug('Closing controller connection')
  56             await self.connection.close()
  57             self.connection = None
  58
  59     async def add_model(
  60             self, model_name, cloud_name=None, credential_name=None,
  61             owner=None, config=None, region=None):
  62         """Add a model to this controller.
  63
  64         :param str model_name: Name to give the new model.
  65         :param str cloud_name: Name of the cloud in which to create the
  66             model, e.g. 'aws'. Defaults to same cloud as controller.
  67         :param str credential_name: Name of the credential to use when
  68             creating the model. Defaults to current credential. If you
  69             pass a credential_name, you must also pass a cloud_name,
  70             even if it's the default cloud.
  71         :param str owner: Username that will own the model. Defaults to
  72             the current user.
  73         :param dict config: Model configuration.
  74         :param str region: Region in which to create the model.
  75
  76         """
  77         model_facade = client.ModelManagerFacade.from_connection(
  78             self.connection)
  79
  80         owner = owner or self.connection.info['user-info']['identity']
  81         cloud_name = cloud_name or await self.get_cloud()
  82
  83         if credential_name:
  84             credential = tag.credential(
  85                 cloud_name,
  86                 tag.untag('user-', owner),
  87                 credential_name
  88             )
  89         else:
  90             credential = None
  91
  92         log.debug('Creating model %s', model_name)
  93
  94         model_info = await model_facade.CreateModel(
  95             tag.cloud(cloud_name),
  96             config,
  97             credential,
  98             model_name,
  99             owner,
 100             region
 101         )
 102
 103         # Add our ssh key to the model, to work around
 104         # https://bugs.launchpad.net/juju/+bug/1643076
 105         try:
 106             ssh_key = await utils.read_ssh_key(loop=self.loop)
 107
 108             if self.controller_name:
 109                 model_name = "{}:{}".format(self.controller_name, model_name)
 110
 111             cmd = ['juju', 'add-ssh-key', '-m', model_name, ssh_key]
 112
 113             await utils.execute_process(*cmd, log=log, loop=self.loop)
 114         except Exception:
 115             log.exception(
 116                 "Could not add ssh key to model. You will not be able "
 117                 "to ssh into machines in this model. "
 118                 "Manually running `juju add-ssh-key <key>` in the cli "
 119                 "may fix this problem.")
 120
 121         model = Model()
 122         await model.connect(
 123             self.connection.endpoint,
 124             model_info.uuid,
 125             self.connection.username,
 126             self.connection.password,
 127             self.connection.cacert,
 128             self.connection.macaroons,
 129             loop=self.loop,
 130         )
 131
 132         return model
 133
 134     async def destroy_models(self, *uuids):
 135         """Destroy one or more models.
 136
 137         :param str \*uuids: UUIDs of models to destroy
 138
 139         """
 140         model_facade = client.ModelManagerFacade.from_connection(
 141             self.connection)
 142
 143         log.debug(
 144             'Destroying model%s %s',
 145             '' if len(uuids) == 1 else 's',
 146             ', '.join(uuids)
 147         )
 148
 149         await model_facade.DestroyModels([
 150             client.Entity(tag.model(uuid))
 151             for uuid in uuids
 152         ])
 153     destroy_model = destroy_models
 154
 155     async def add_user(self, username, password=None, display_name=None):
 156         """Add a user to this controller.
 157
 158         :param str username: Username
 159         :param str display_name: Display name
 160         :param str acl: Access control, e.g. 'read'
 161         :param list models: Models to which the user is granted access
 162
 163         """
 164         if not display_name:
 165             display_name = username
 166         user_facade = client.UserManagerFacade.from_connection(self.connection)
 167         users = [{'display_name': display_name,
 168                   'password': password,
 169                   'username': username}]
 170         return await user_facade.AddUser(users)
 171
 172     async def change_user_password(self, username, password):
 173         """Change the password for a user in this controller.
 174
 175         :param str username: Username
 176         :param str password: New password
 177
 178         """
 179         user_facade = client.UserManagerFacade.from_connection(self.connection)
 180         entity = client.EntityPassword(password, tag.user(username))
 181         return await user_facade.SetPassword([entity])
 182
 183     async def destroy(self, destroy_all_models=False):
 184         """Destroy this controller.
 185
 186         :param bool destroy_all_models: Destroy all hosted models in the
 187             controller.
 188
 189         """
 190         controller_facade = client.ControllerFacade.from_connection(
 191             self.connection)
 192         return await controller_facade.DestroyController(destroy_all_models)
 193
 194     async def disable_user(self, username):
 195         """Disable a user.
 196
 197         :param str username: Username
 198
 199         """
 200         user_facade = client.UserManagerFacade.from_connection(self.connection)
 201         entity = client.Entity(tag.user(username))
 202         return await user_facade.DisableUser([entity])
 203
 204     async def enable_user(self, username):
 205         """Re-enable a previously disabled user.
 206
 207         """
 208         user_facade = client.UserManagerFacade.from_connection(self.connection)
 209         entity = client.Entity(tag.user(username))
 210         return await user_facade.EnableUser([entity])
 211
 212     def kill(self):
 213         """Forcibly terminate all machines and other associated resources for
 214         this controller.
 215
 216         """
 217         raise NotImplementedError()
 218
 219     async def get_cloud(self):
 220         """
 221         Get the name of the cloud that this controller lives on.
 222         """
 223         cloud_facade = client.CloudFacade.from_connection(self.connection)
 224
 225         result = await cloud_facade.Clouds()
 226         cloud = list(result.clouds.keys())[0]  # only lives on one cloud
 227         return tag.untag('cloud-', cloud)
 228
 229     async def get_models(self, all_=False, username=None):
 230         """Return list of available models on this controller.
 231
 232         :param bool all_: List all models, regardless of user accessibilty
 233             (admin use only)
 234         :param str username: User for which to list models (admin use only)
 235
 236         """
 237         controller_facade = client.ControllerFacade.from_connection(
 238             self.connection)
 239         return await controller_facade.AllModels()
 240
 241
 242     def get_payloads(self, *patterns):
 243         """Return list of known payloads.
 244
 245         :param str \*patterns: Patterns to match against
 246
 247         Each pattern will be checked against the following info in Juju::
 248
 249             - unit name
 250             - machine id
 251             - payload type
 252             - payload class
 253             - payload id
 254             - payload tag
 255             - payload status
 256
 257         """
 258         raise NotImplementedError()
 259
 260     def get_users(self, all_=False):
 261         """Return list of users that can connect to this controller.
 262
 263         :param bool all_: Include disabled users
 264
 265         """
 266         raise NotImplementedError()
 267
 268     def login(self):
 269         """Log in to this controller.
 270
 271         """
 272         raise NotImplementedError()
 273
 274     def logout(self, force=False):
 275         """Log out of this controller.
 276
 277         :param bool force: Don't fail even if user not previously logged in
 278             with a password
 279
 280         """
 281         raise NotImplementedError()
 282
 283     def get_model(self, name):
 284         """Get a model by name.
 285
 286         :param str name: Model name
 287
 288         """
 289         raise NotImplementedError()
 290
 291     async def get_user(self, username, include_disabled=False):
 292         """Get a user by name.
 293
 294         :param str username: Username
 295
 296         """
 297         client_facade = client.UserManagerFacade.from_connection(
 298             self.connection)
 299         user = tag.user(username)
 300         return await client_facade.UserInfo([client.Entity(user)], include_disabled)
 301
 302     async def grant(self, username, acl='login'):
 303         """Set access level of the given user on the controller
 304
 305         :param str username: Username
 306         :param str acl: Access control ('login', 'add-model' or 'superuser')
 307
 308         """
 309         controller_facade = client.ControllerFacade.from_connection(
 310             self.connection)
 311         user = tag.user(username)
 312         await self.revoke(username)
 313         changes = client.ModifyControllerAccess(acl, 'grant', user)
 314         return await controller_facade.ModifyControllerAccess([changes])
 315
 316     async def revoke(self, username):
 317         """Removes all access from a controller
 318
 319         :param str username: username
 320
 321         """
 322         controller_facade = client.ControllerFacade.from_connection(
 323             self.connection)
 324         user = tag.user(username)
 325         changes = client.ModifyControllerAccess('login', 'revoke', user)
 326         return await controller_facade.ModifyControllerAccess([changes])