480813c78a86298e1fde7ccaa704af0b47bf2ee0
3 from .client
import client
4 from .client
import watcher
5 from .delta
import get_entity_delta
7 log
= logging
.getLogger(__name__
)
10 class ModelObserver(object):
11 def __call__(self
, delta
, old
, new
, model
):
12 if old
is None and new
is not None:
16 handler_name
= 'on_{}_{}'.format(delta
.entity
, type_
)
17 method
= getattr(self
, handler_name
, self
.on_change
)
19 'Model changed: %s %s %s',
20 delta
.entity
, delta
.type, delta
.get_id())
21 method(delta
, old
, new
, model
)
23 def on_change(self
, delta
, old
, new
, model
):
27 class ModelEntity(object):
28 """An object in the Model tree"""
30 def __init__(self
, data
, model
):
31 """Initialize a new entity
33 :param data: dict of data from a watcher delta
34 :param model: The model instance in whose object tree this
40 self
.connection
= model
.connection
42 def __getattr__(self
, name
):
43 return self
.data
[name
]
47 def __init__(self
, connection
):
48 """Instantiate a new connected Model.
50 :param connection: `juju.client.connection.Connection` instance
53 self
.connection
= connection
54 self
.observers
= set()
56 self
._watching
= False
59 def applications(self
):
60 return self
.state
.get('application', {})
64 return self
.state
.get('unit', {})
66 def stop_watching(self
):
67 self
.connection
.cancel()
68 self
._watching
= False
70 def add_observer(self
, callable_
):
71 """Register an "on-model-change" callback
73 Once a watch is started (Model.watch() is called), ``callable_``
74 will be called each time the model changes. callable_ should
75 accept the following positional arguments:
77 delta - An instance of :class:`juju.delta.EntityDelta`
78 containing the raw delta data recv'd from the Juju
81 old_obj - If the delta modifies an existing object in the model,
82 old_obj will be a copy of that object, as it was before the
83 delta was applied. Will be None if the delta creates a new
86 new_obj - A copy of the new or updated object, after the delta
87 is applied. Will be None if the delta removes an entity
90 model - The :class:`Model` itself.
93 self
.observers
.add(callable_
)
95 async def watch(self
):
96 """Start an asynchronous watch against this model.
98 See :meth:`add_observer` to register an onchange callback.
101 self
._watching
= True
102 allwatcher
= watcher
.AllWatcher()
103 allwatcher
.connect(await self
.connection
.clone())
104 while self
._watching
:
105 results
= await allwatcher
.Next()
106 for delta
in results
.deltas
:
107 delta
= get_entity_delta(delta
)
108 old_obj
, new_obj
= self
._apply
_delta
(delta
)
109 self
._notify
_observers
(delta
, old_obj
, new_obj
)
111 def _apply_delta(self
, delta
):
112 """Apply delta to our model state and return the a copy of the
113 affected object as it was before and after the update, e.g.:
115 old_obj, new_obj = self._apply_delta(delta)
117 old_obj may be None if the delta is for the creation of a new object,
118 e.g. a new application or unit is deployed.
120 new_obj may be None if no object was created or updated, or if an
121 object was deleted as a result of the delta being applied.
124 old_obj
, new_obj
= None, None
126 if (delta
.entity
in self
.state
and
127 delta
.get_id() in self
.state
[delta
.entity
]):
128 old_obj
= self
.state
[delta
.entity
][delta
.get_id()]
129 if delta
.type == 'remove':
130 del self
.state
[delta
.entity
][delta
.get_id()]
131 return old_obj
, new_obj
133 new_obj
= self
.state
.setdefault(delta
.entity
, {})[delta
.get_id()] = (
134 self
._create
_model
_entity
(delta
))
136 return old_obj
, new_obj
138 def _create_model_entity(self
, delta
):
139 """Return an object instance representing the entity created or
143 entity_class
= delta
.get_entity_class()
144 return entity_class(delta
.data
, self
)
146 def _notify_observers(self
, delta
, old_obj
, new_obj
):
147 """Call observing callbacks, notifying them of a change in model state
149 :param delta: The raw change from the watcher
150 (:class:`juju.client.overrides.Delta`)
151 :param old_obj: The object in the model that this delta updates.
153 :param new_obj: The object in the model that is created or updated
154 by applying this delta.
157 for o
in self
.observers
:
158 o(delta
, old_obj
, new_obj
, self
)
161 self
, spec
=None, constraints
=None, disks
=None, series
=None,
163 """Start a new, empty machine and optionally a container, or add a
164 container to a machine.
166 :param str spec: Machine specification
169 (None) - starts a new machine
170 'lxc' - starts a new machine with on lxc container
171 'lxc:4' - starts a new lxc container on machine 4
172 'ssh:user@10.10.0.3' - manually provisions a machine with ssh
173 'zone=us-east-1a' - starts a machine in zone us-east-1s on AWS
174 'maas2.name' - acquire machine maas2.name on MAAS
175 :param constraints: Machine constraints
176 :type constraints: :class:`juju.Constraints`
177 :param list disks: List of disk :class:`constraints <juju.Constraints>`
178 :param str series: Series
179 :param int count: Number of machines to deploy
181 Supported container types are: lxc, lxd, kvm
183 When deploying a container to an existing machine, constraints cannot
188 add_machines
= add_machine
190 def add_relation(self
, relation1
, relation2
):
191 """Add a relation between two services.
193 :param str relation1: '<service>[:<relation_name>]'
194 :param str relation2: '<service>[:<relation_name>]'
199 def add_space(self
, name
, *cidrs
):
200 """Add a new network space.
202 Adds a new space with the given name and associates the given
203 (optional) list of existing subnet CIDRs with it.
205 :param str name: Name of the space
206 :param \*cidrs: Optional list of existing subnet CIDRs
211 def add_ssh_key(self
, key
):
212 """Add a public SSH key to this model.
214 :param str key: The public ssh key
218 add_ssh_keys
= add_ssh_key
220 def add_subnet(self
, cidr_or_id
, space
, *zones
):
221 """Add an existing subnet to this model.
223 :param str cidr_or_id: CIDR or provider ID of the existing subnet
224 :param str space: Network space with which to associate
225 :param str \*zones: Zone(s) in which the subnet resides
230 def get_backups(self
):
231 """Retrieve metadata for backups in this model.
236 def block(self
, *commands
):
237 """Add a new block to this model.
239 :param str \*commands: The commands to block. Valid values are
240 'all-changes', 'destroy-model', 'remove-object'
245 def get_blocks(self
):
246 """List blocks for this model.
251 def get_cached_images(self
, arch
=None, kind
=None, series
=None):
252 """Return a list of cached OS images.
254 :param str arch: Filter by image architecture
255 :param str kind: Filter by image kind, e.g. 'lxd'
256 :param str series: Filter by image series, e.g. 'xenial'
261 def create_backup(self
, note
=None, no_download
=False):
262 """Create a backup of this model.
264 :param str note: A note to store with the backup
265 :param bool no_download: Do not download the backup archive
266 :return str: Path to downloaded archive
271 def create_storage_pool(self
, name
, provider_type
, **pool_config
):
272 """Create or define a storage pool.
274 :param str name: Name to give the storage pool
275 :param str provider_type: Pool provider type
276 :param \*\*pool_config: key/value pool configuration pairs
282 self
, no_tail
=False, exclude_module
=None, include_module
=None,
283 include
=None, level
=None, limit
=0, lines
=10, replay
=False,
285 """Get log messages for this model.
287 :param bool no_tail: Stop after returning existing log messages
288 :param list exclude_module: Do not show log messages for these logging
290 :param list include_module: Only show log messages for these logging
292 :param list include: Only show log messages for these entities
293 :param str level: Log level to show, valid options are 'TRACE',
294 'DEBUG', 'INFO', 'WARNING', 'ERROR,
295 :param int limit: Return this many of the most recent (possibly
296 filtered) lines are shown
297 :param int lines: Yield this many of the most recent lines, and keep
299 :param bool replay: Yield the entire log, and keep yielding
300 :param list exclude: Do not show log messages for these entities
306 self
, entity_url
, service_name
=None, bind
=None, budget
=None,
307 channel
=None, config
=None, constraints
=None, force
=False,
308 num_units
=1, plan
=None, resources
=None, series
=None, storage
=None,
310 """Deploy a new service or bundle.
312 :param str entity_url: Charm or bundle url
313 :param str service_name: Name to give the service
314 :param dict bind: <charm endpoint>:<network space> pairs
315 :param dict budget: <budget name>:<limit> pairs
316 :param str channel: Charm store channel from which to retrieve
317 the charm or bundle, e.g. 'development'
318 :param dict config: Charm configuration dictionary
319 :param constraints: Service constraints
320 :type constraints: :class:`juju.Constraints`
321 :param bool force: Allow charm to be deployed to a machine running
322 an unsupported series
323 :param int num_units: Number of units to deploy
324 :param str plan: Plan under which to deploy charm
325 :param dict resources: <resource name>:<file path> pairs
326 :param str series: Series on which to deploy
327 :param dict storage: Storage constraints TODO how do these look?
328 :param str to: Placement directive, e.g.::
331 'lxc:7' - new lxc container on machine 7
332 '24/lxc/3' - lxc container 3 or machine 24
334 If None, a new machine is provisioned.
339 - entity_url must have a revision; look up latest automatically if
340 not provided by caller
341 - service_name is required; fill this in automatically if not
343 - series is required; how do we pick a default?
347 constraints
= client
.Value(**constraints
)
351 client
.Placement(**p
) for p
in to
358 k
: client
.Constraints(**v
)
359 for k
, v
in storage
.items()
362 app_facade
= client
.ApplicationFacade()
363 client_facade
= client
.ClientFacade()
364 app_facade
.connect(self
.connection
)
365 client_facade
.connect(self
.connection
)
368 'Deploying %s', entity_url
)
370 await client_facade
.AddCharm(channel
, entity_url
)
371 app
= client
.ApplicationDeploy(
372 application
=service_name
,
374 charm_url
=entity_url
,
376 constraints
=constraints
,
377 endpoint_bindings
=bind
,
385 return await app_facade
.Deploy([app
])
388 """Terminate all machines and resources for this model.
393 def get_backup(self
, archive_id
):
394 """Download a backup archive file.
396 :param str archive_id: The id of the archive to download
397 :return str: Path to the archive file
403 self
, num_controllers
=0, constraints
=None, series
=None, to
=None):
404 """Ensure sufficient controllers exist to provide redundancy.
406 :param int num_controllers: Number of controllers to make available
407 :param constraints: Constraints to apply to the controller machines
408 :type constraints: :class:`juju.Constraints`
409 :param str series: Series of the controller machines
410 :param list to: Placement directives for controller machines, e.g.::
413 'lxc:7' - new lxc container on machine 7
414 '24/lxc/3' - lxc container 3 or machine 24
416 If None, a new machine is provisioned.
421 def get_config(self
):
422 """Return the configuration settings for this model.
427 def get_constraints(self
):
428 """Return the machine constraints for this model.
433 def grant(self
, username
, acl
='read'):
434 """Grant a user access to this model.
436 :param str username: Username
437 :param str acl: Access control ('read' or 'write')
442 def import_ssh_key(self
, identity
):
443 """Add a public SSH key from a trusted indentity source to this model.
445 :param str identity: User identity in the form <lp|gh>:<username>
449 import_ssh_keys
= import_ssh_key
451 def get_machines(self
, machine
, utc
=False):
452 """Return list of machines in this model.
454 :param str machine: Machine id, e.g. '0'
455 :param bool utc: Display time as UTC in RFC3339 format
460 def get_shares(self
):
461 """Return list of all users with access to this model.
466 def get_spaces(self
):
467 """Return list of all known spaces, including associated subnets.
472 def get_ssh_key(self
):
473 """Return known SSH keys for this model.
477 get_ssh_keys
= get_ssh_key
479 def get_storage(self
, filesystem
=False, volume
=False):
480 """Return details of storage instances.
482 :param bool filesystem: Include filesystem storage
483 :param bool volume: Include volume storage
488 def get_storage_pools(self
, names
=None, providers
=None):
489 """Return list of storage pools.
491 :param list names: Only include pools with these names
492 :param list providers: Only include pools for these providers
497 def get_subnets(self
, space
=None, zone
=None):
498 """Return list of known subnets.
500 :param str space: Only include subnets in this space
501 :param str zone: Only include subnets in this zone
506 def remove_blocks(self
):
507 """Remove all blocks from this model.
512 def remove_backup(self
, backup_id
):
515 :param str backup_id: The id of the backup to remove
520 def remove_cached_images(self
, arch
=None, kind
=None, series
=None):
521 """Remove cached OS images.
523 :param str arch: Architecture of the images to remove
524 :param str kind: Image kind to remove, e.g. 'lxd'
525 :param str series: Image series to remove, e.g. 'xenial'
530 def remove_machine(self
, *machine_ids
):
531 """Remove a machine from this model.
533 :param str \*machine_ids: Ids of the machines to remove
537 remove_machines
= remove_machine
539 def remove_ssh_key(self
, *keys
):
540 """Remove a public SSH key(s) from this model.
542 :param str \*keys: Keys to remove
546 remove_ssh_keys
= remove_ssh_key
549 self
, bootstrap
=False, constraints
=None, archive
=None,
550 backup_id
=None, upload_tools
=False):
551 """Restore a backup archive to a new controller.
553 :param bool bootstrap: Bootstrap a new state machine
554 :param constraints: Model constraints
555 :type constraints: :class:`juju.Constraints`
556 :param str archive: Path to backup archive to restore
557 :param str backup_id: Id of backup to restore
558 :param bool upload_tools: Upload tools if bootstrapping a new machine
563 def retry_provisioning(self
):
564 """Retry provisioning for failed machines.
569 def revoke(self
, username
, acl
='read'):
570 """Revoke a user's access to this model.
572 :param str username: Username to revoke
573 :param str acl: Access control ('read' or 'write')
578 def run(self
, command
, timeout
=None):
579 """Run command on all machines in this model.
581 :param str command: The command to run
582 :param int timeout: Time to wait before command is considered failed
587 def set_config(self
, **config
):
588 """Set configuration keys on this model.
590 :param \*\*config: Config key/values
595 def set_constraints(self
, constraints
):
596 """Set machine constraints on this model.
598 :param :class:`juju.Constraints` constraints: Machine constraints
603 def get_action_output(self
, action_uuid
, wait
=-1):
604 """Get the results of an action by ID.
606 :param str action_uuid: Id of the action
607 :param int wait: Time in seconds to wait for action to complete
612 def get_action_status(self
, uuid_or_prefix
=None, name
=None):
613 """Get the status of all actions, filtered by ID, ID prefix, or action name.
615 :param str uuid_or_prefix: Filter by action uuid or prefix
616 :param str name: Filter by action name
621 def get_budget(self
, budget_name
):
622 """Get budget usage info.
624 :param str budget_name: Name of budget
629 def get_status(self
, filter_
=None, utc
=False):
630 """Return the status of the model.
632 :param str filter_: Service or unit name or wildcard ('*')
633 :param bool utc: Display time as UTC in RFC3339 format
640 self
, all_
=False, destination
=None, dry_run
=False, public
=False,
641 source
=None, stream
=None, version
=None):
642 """Copy Juju tools into this model.
644 :param bool all_: Copy all versions, not just the latest
645 :param str destination: Path to local destination directory
646 :param bool dry_run: Don't do the actual copy
647 :param bool public: Tools are for a public cloud, so generate mirrors
649 :param str source: Path to local source directory
650 :param str stream: Simplestreams stream for which to sync metadata
651 :param str version: Copy a specific major.minor version
656 def unblock(self
, *commands
):
657 """Unblock an operation that would alter this model.
659 :param str \*commands: The commands to unblock. Valid values are
660 'all-changes', 'destroy-model', 'remove-object'
665 def unset_config(self
, *keys
):
666 """Unset configuration on this model.
668 :param str \*keys: The keys to unset
673 def upgrade_gui(self
):
674 """Upgrade the Juju GUI for this model.
680 self
, dry_run
=False, reset_previous_upgrade
=False,
681 upload_tools
=False, version
=None):
682 """Upgrade Juju on all machines in a model.
684 :param bool dry_run: Don't do the actual upgrade
685 :param bool reset_previous_upgrade: Clear the previous (incomplete)
687 :param bool upload_tools: Upload local version of tools
688 :param str version: Upgrade to a specific version
693 def upload_backup(self
, archive_path
):
694 """Store a backup archive remotely in Juju.
696 :param str archive_path: Path to local archive