+import asyncio
+import concurrent.futures
+import logging
+
+from . import tag
+from . import utils
+from .client import client
+from .client import connection
+from .client import watcher
+from .model import Model
+
+log = logging.getLogger(__name__)
+
+
class Controller(object):
- def add_model(self):
+ def __init__(self, loop=None):
+ """Instantiate a new Controller.
+
+ One of the connect_* methods will need to be called before this
+ object can be used for anything interesting.
+
+ :param loop: an asyncio event loop
+
+ """
+ self.loop = loop or asyncio.get_event_loop()
+ self.connection = None
+
+ async def connect(
+ self, endpoint, username, password, cacert=None, macaroons=None):
+ """Connect to an arbitrary Juju controller.
+
+ """
+ self.connection = await connection.Connection.connect(
+ endpoint, None, username, password, cacert, macaroons)
+
+ async def connect_current(self):
+ """Connect to the current Juju controller.
+
+ """
+ self.connection = (
+ await connection.Connection.connect_current_controller())
+
+ async def connect_controller(self, controller_name):
+ """Connect to a Juju controller by name.
+
+ """
+ self.connection = (
+ await connection.Connection.connect_controller(controller_name))
+
+ async def disconnect(self):
+ """Shut down the watcher task and close websockets.
+
+ """
+ if self.connection and self.connection.is_open:
+ log.debug('Closing controller connection')
+ await self.connection.close()
+ self.connection = None
+
+ async def add_model(
+ self, model_name, cloud_name=None, credential_name=None,
+ owner=None, config=None, region=None):
"""Add a model to this controller.
+ :param str model_name: Name to give the new model.
+ :param str cloud_name: Name of the cloud in which to create the
+ model, e.g. 'aws'. Defaults to same cloud as controller.
+ :param str credential_name: Name of the credential to use when
+ creating the model. Defaults to current credential. If you
+ pass a credential_name, you must also pass a cloud_name,
+ even if it's the default cloud.
+ :param str owner: Username that will own the model. Defaults to
+ the current user.
+ :param dict config: Model configuration.
+ :param str region: Region in which to create the model.
+
"""
- pass
+ model_facade = client.ModelManagerFacade()
+ model_facade.connect(self.connection)
+
+ owner = owner or self.connection.info['user-info']['identity']
+ cloud_name = cloud_name or await self.get_cloud()
+
+ if credential_name:
+ credential = tag.credential(
+ cloud_name,
+ tag.untag('user-', owner),
+ credential_name
+ )
+ else:
+ credential = None
+
+ log.debug('Creating model %s', model_name)
- def add_user(self):
+ model_info = await model_facade.CreateModel(
+ tag.cloud(cloud_name),
+ config,
+ credential,
+ model_name,
+ owner,
+ region,
+ )
+
+ # Add our ssh key to the model, to work around
+ # https://bugs.launchpad.net/juju/+bug/1643076
+ try:
+ ssh_key = await self.loop.run_in_executor(
+ concurrent.futures.ThreadPoolExecutor(),
+ utils.read_ssh_key
+ )
+ await utils.execute_process(
+ 'juju', 'add-ssh-key', '-m', model_name, ssh_key, log=log)
+ except Exception as e:
+ log.exception(
+ "Could not add ssh key to model. You will not be able "
+ "to ssh into machines in this model. "
+ "Manually running `juju add-ssh-key <key>` in the cli "
+ "may fix this problem.")
+
+ model = Model()
+ await model.connect(
+ self.connection.endpoint,
+ model_info.uuid,
+ self.connection.username,
+ self.connection.password,
+ self.connection.cacert,
+ self.connection.macaroons,
+ )
+
+ return model
+
+ async def destroy_models(self, *uuids):
+ """Destroy one or more models.
+
+ :param str \*uuids: UUIDs of models to destroy
+
+ """
+ model_facade = client.ModelManagerFacade()
+ model_facade.connect(self.connection)
+
+ log.debug(
+ 'Destroying model%s %s',
+ '' if len(uuids) == 1 else 's',
+ ', '.join(uuids)
+ )
+
+ await model_facade.DestroyModels([
+ client.Entity(tag.model(uuid))
+ for uuid in uuids
+ ])
+ destroy_model = destroy_models
+
+ def add_user(self, username, display_name=None, acl=None, models=None):
"""Add a user to this controller.
+ :param str username: Username
+ :param str display_name: Display name
+ :param str acl: Access control, e.g. 'read'
+ :param list models: Models to which the user is granted access
+
"""
pass
- def change_user_password(self):
+ def change_user_password(self, username, password):
"""Change the password for a user in this controller.
+ :param str username: Username
+ :param str password: New password
+
"""
pass
- def destroy(self):
+ def destroy(self, destroy_all_models=False):
"""Destroy this controller.
+ :param bool destroy_all_models: Destroy all hosted models in the
+ controller.
+
"""
pass
- def disable_user(self):
+ def disable_user(self, username):
"""Disable a user.
+ :param str username: Username
+
"""
pass
"""
pass
- def get_models(self):
+ async def get_cloud(self):
+ """
+ Get the name of the cloud that this controller lives on.
+ """
+ cloud_facade = client.CloudFacade()
+ cloud_facade.connect(self.connection)
+
+ result = await cloud_facade.Clouds()
+ cloud = list(result.clouds.keys())[0] # only lives on one cloud
+ return tag.untag('cloud-', cloud)
+
+ def get_models(self, all_=False, username=None):
"""Return list of available models on this controller.
+ :param bool all_: List all models, regardless of user accessibilty
+ (admin use only)
+ :param str username: User for which to list models (admin use only)
+
"""
pass
- def get_payloads(self):
+ def get_payloads(self, *patterns):
"""Return list of known payloads.
+ :param str \*patterns: Patterns to match against
+
+ Each pattern will be checked against the following info in Juju::
+
+ - unit name
+ - machine id
+ - payload type
+ - payload class
+ - payload id
+ - payload tag
+ - payload status
+
"""
pass
- def get_users(self):
+ def get_users(self, all_=False):
"""Return list of users that can connect to this controller.
+ :param bool all_: Include disabled users
+
"""
pass
"""
pass
- def logout(self):
+ def logout(self, force=False):
"""Log out of this controller.
+ :param bool force: Don't fail even if user not previously logged in
+ with a password
+
"""
pass
def get_model(self, name):
"""Get a model by name.
+ :param str name: Model name
+
"""
pass
- def get_user(self, name):
+ def get_user(self, username):
"""Get a user by name.
+ :param str username: Username
+
"""
pass
projects / osm / N2VC.git / blobdiff