6 from .client
import client
7 from .client
import connection
8 from .model
import Model
10 log
= logging
.getLogger(__name__
)
13 class Controller(object):
14 def __init__(self
, loop
=None):
15 """Instantiate a new Controller.
17 One of the connect_* methods will need to be called before this
18 object can be used for anything interesting.
20 :param loop: an asyncio event loop
23 self
.loop
= loop
or asyncio
.get_event_loop()
24 self
.connection
= None
25 self
.controller_name
= None
28 self
, endpoint
, username
, password
, cacert
=None, macaroons
=None):
29 """Connect to an arbitrary Juju controller.
32 self
.connection
= await connection
.Connection
.connect(
33 endpoint
, None, username
, password
, cacert
, macaroons
)
35 async def connect_current(self
):
36 """Connect to the current Juju controller.
40 await connection
.Connection
.connect_current_controller())
42 async def connect_controller(self
, controller_name
):
43 """Connect to a Juju controller by name.
47 await connection
.Connection
.connect_controller(controller_name
))
48 self
.controller_name
= controller_name
50 async def disconnect(self
):
51 """Shut down the watcher task and close websockets.
54 if self
.connection
and self
.connection
.is_open
:
55 log
.debug('Closing controller connection')
56 await self
.connection
.close()
57 self
.connection
= None
60 self
, model_name
, cloud_name
=None, credential_name
=None,
61 owner
=None, config
=None, region
=None):
62 """Add a model to this controller.
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
73 :param dict config: Model configuration.
74 :param str region: Region in which to create the model.
77 model_facade
= client
.ModelManagerFacade()
78 model_facade
.connect(self
.connection
)
80 owner
= owner
or self
.connection
.info
['user-info']['identity']
81 cloud_name
= cloud_name
or await self
.get_cloud()
84 credential
= tag
.credential(
86 tag
.untag('user-', owner
),
92 log
.debug('Creating model %s', model_name
)
94 model_info
= await model_facade
.CreateModel(
95 tag
.cloud(cloud_name
),
103 # Add our ssh key to the model, to work around
104 # https://bugs.launchpad.net/juju/+bug/1643076
106 ssh_key
= await utils
.read_ssh_key(loop
=self
.loop
)
108 if self
.controller_name
:
109 model_name
= "{}:{}".format(self
.controller_name
, model_name
)
111 cmd
= ['juju', 'add-ssh-key', '-m', model_name
, ssh_key
]
113 await utils
.execute_process(*cmd
, log
=log
, loop
=self
.loop
)
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.")
123 self
.connection
.endpoint
,
125 self
.connection
.username
,
126 self
.connection
.password
,
127 self
.connection
.cacert
,
128 self
.connection
.macaroons
,
134 async def destroy_models(self
, *uuids
):
135 """Destroy one or more models.
137 :param str \*uuids: UUIDs of models to destroy
140 model_facade
= client
.ModelManagerFacade()
141 model_facade
.connect(self
.connection
)
144 'Destroying model%s %s',
145 '' if len(uuids
) == 1 else 's',
149 await model_facade
.DestroyModels([
150 client
.Entity(tag
.model(uuid
))
153 destroy_model
= destroy_models
155 def add_user(self
, username
, display_name
=None, acl
=None, models
=None):
156 """Add a user to this controller.
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
164 raise NotImplementedError()
166 def change_user_password(self
, username
, password
):
167 """Change the password for a user in this controller.
169 :param str username: Username
170 :param str password: New password
173 raise NotImplementedError()
175 def destroy(self
, destroy_all_models
=False):
176 """Destroy this controller.
178 :param bool destroy_all_models: Destroy all hosted models in the
182 raise NotImplementedError()
184 def disable_user(self
, username
):
187 :param str username: Username
190 raise NotImplementedError()
192 def enable_user(self
):
193 """Re-enable a previously disabled user.
196 raise NotImplementedError()
199 """Forcibly terminate all machines and other associated resources for
203 raise NotImplementedError()
205 async def get_cloud(self
):
207 Get the name of the cloud that this controller lives on.
209 cloud_facade
= client
.CloudFacade()
210 cloud_facade
.connect(self
.connection
)
212 result
= await cloud_facade
.Clouds()
213 cloud
= list(result
.clouds
.keys())[0] # only lives on one cloud
214 return tag
.untag('cloud-', cloud
)
216 def get_models(self
, all_
=False, username
=None):
217 """Return list of available models on this controller.
219 :param bool all_: List all models, regardless of user accessibilty
221 :param str username: User for which to list models (admin use only)
224 raise NotImplementedError()
226 def get_payloads(self
, *patterns
):
227 """Return list of known payloads.
229 :param str \*patterns: Patterns to match against
231 Each pattern will be checked against the following info in Juju::
242 raise NotImplementedError()
244 def get_users(self
, all_
=False):
245 """Return list of users that can connect to this controller.
247 :param bool all_: Include disabled users
250 raise NotImplementedError()
253 """Log in to this controller.
256 raise NotImplementedError()
258 def logout(self
, force
=False):
259 """Log out of this controller.
261 :param bool force: Don't fail even if user not previously logged in
265 raise NotImplementedError()
267 def get_model(self
, name
):
268 """Get a model by name.
270 :param str name: Model name
273 raise NotImplementedError()
275 def get_user(self
, username
):
276 """Get a user by name.
278 :param str username: Username
281 raise NotImplementedError()