11 from concurrent
.futures
import CancelledError
12 from functools
import partial
13 from pathlib
import Path
16 from theblues
import charmstore
18 from .client
import client
19 from .client
import watcher
20 from .client
import connection
21 from .constraints
import parse
as parse_constraints
, normalize_key
22 from .delta
import get_entity_delta
23 from .delta
import get_entity_class
24 from .exceptions
import DeadEntityException
25 from .errors
import JujuError
, JujuAPIError
27 log
= logging
.getLogger(__name__
)
30 class _Observer(object):
31 """Wrapper around an observer callable.
33 This wrapper allows filter criteria to be associated with the
34 callable so that it's only called for changes that meet the criteria.
37 def __init__(self
, callable_
, entity_type
, action
, entity_id
, predicate
):
38 self
.callable_
= callable_
39 self
.entity_type
= entity_type
41 self
.entity_id
= entity_id
42 self
.predicate
= predicate
44 self
.entity_id
= str(self
.entity_id
)
45 if not self
.entity_id
.startswith('^'):
46 self
.entity_id
= '^' + self
.entity_id
47 if not self
.entity_id
.endswith('$'):
50 async def __call__(self
, delta
, old
, new
, model
):
51 await self
.callable_(delta
, old
, new
, model
)
53 def cares_about(self
, delta
):
54 """Return True if this observer "cares about" (i.e. wants to be
55 called) for a this delta.
58 if (self
.entity_id
and delta
.get_id() and
59 not re
.match(self
.entity_id
, str(delta
.get_id()))):
62 if self
.entity_type
and self
.entity_type
!= delta
.entity
:
65 if self
.action
and self
.action
!= delta
.type:
68 if self
.predicate
and not self
.predicate(delta
):
74 class ModelObserver(object):
75 async def __call__(self
, delta
, old
, new
, model
):
76 handler_name
= 'on_{}_{}'.format(delta
.entity
, delta
.type)
77 method
= getattr(self
, handler_name
, self
.on_change
)
78 await method(delta
, old
, new
, model
)
80 async def on_change(self
, delta
, old
, new
, model
):
81 """Generic model-change handler.
83 :param delta: :class:`juju.client.overrides.Delta`
84 :param old: :class:`juju.model.ModelEntity`
85 :param new: :class:`juju.model.ModelEntity`
86 :param model: :class:`juju.model.Model`
92 class ModelState(object):
93 """Holds the state of the model, including the delta history of all
94 entities in the model.
97 def __init__(self
, model
):
101 def _live_entity_map(self
, entity_type
):
102 """Return an id:Entity map of all the living entities of
103 type ``entity_type``.
107 entity_id
: self
.get_entity(entity_type
, entity_id
)
108 for entity_id
, history
in self
.state
.get(entity_type
, {}).items()
109 if history
[-1] is not None
113 def applications(self
):
114 """Return a map of application-name:Application for all applications
115 currently in the model.
118 return self
._live
_entity
_map
('application')
122 """Return a map of machine-id:Machine for all machines currently in
126 return self
._live
_entity
_map
('machine')
130 """Return a map of unit-id:Unit for all units currently in
134 return self
._live
_entity
_map
('unit')
136 def entity_history(self
, entity_type
, entity_id
):
137 """Return the history deque for an entity.
140 return self
.state
[entity_type
][entity_id
]
142 def entity_data(self
, entity_type
, entity_id
, history_index
):
143 """Return the data dict for an entity at a specific index of its
147 return self
.entity_history(entity_type
, entity_id
)[history_index
]
149 def apply_delta(self
, delta
):
150 """Apply delta to our state and return a copy of the
151 affected object as it was before and after the update, e.g.:
153 old_obj, new_obj = self.apply_delta(delta)
155 old_obj may be None if the delta is for the creation of a new object,
156 e.g. a new application or unit is deployed.
158 new_obj will never be None, but may be dead (new_obj.dead == True)
159 if the object was deleted as a result of the delta being applied.
164 .setdefault(delta
.entity
, {})
165 .setdefault(delta
.get_id(), collections
.deque())
168 history
.append(delta
.data
)
169 if delta
.type == 'remove':
172 entity
= self
.get_entity(delta
.entity
, delta
.get_id())
173 return entity
.previous(), entity
176 self
, entity_type
, entity_id
, history_index
=-1, connected
=True):
177 """Return an object instance for the given entity_type and id.
179 By default the object state matches the most recent state from
180 Juju. To get an instance of the object in an older state, pass
181 history_index, an index into the history deque for the entity.
185 if history_index
< 0 and history_index
!= -1:
186 history_index
+= len(self
.entity_history(entity_type
, entity_id
))
187 if history_index
< 0:
191 self
.entity_data(entity_type
, entity_id
, history_index
)
195 entity_class
= get_entity_class(entity_type
)
197 entity_id
, self
.model
, history_index
=history_index
,
201 class ModelEntity(object):
202 """An object in the Model tree"""
204 def __init__(self
, entity_id
, model
, history_index
=-1, connected
=True):
205 """Initialize a new entity
207 :param entity_id str: The unique id of the object in the model
208 :param model: The model instance in whose object tree this
210 :history_index int: The index of this object's state in the model's
211 history deque for this entity
212 :connected bool: Flag indicating whether this object gets live updates
216 self
.entity_id
= entity_id
218 self
._history
_index
= history_index
219 self
.connected
= connected
220 self
.connection
= model
.connection
223 return '<{} entity_id="{}">'.format(type(self
).__name
__,
226 def __getattr__(self
, name
):
227 """Fetch object attributes from the underlying data dict held in the
231 return self
.safe_data
[name
]
234 return bool(self
.data
)
236 def on_change(self
, callable_
):
237 """Add a change observer to this entity.
240 self
.model
.add_observer(
241 callable_
, self
.entity_type
, 'change', self
.entity_id
)
243 def on_remove(self
, callable_
):
244 """Add a remove observer to this entity.
247 self
.model
.add_observer(
248 callable_
, self
.entity_type
, 'remove', self
.entity_id
)
251 def entity_type(self
):
252 """A string identifying the entity type of this object, e.g.
253 'application' or 'unit', etc.
256 return self
.__class
__.__name
__.lower()
260 """Return True if this object represents the current state of the
261 entity in the underlying model.
263 This will be True except when the object represents an entity at a
264 non-latest state in history, e.g. if the object was obtained by calling
265 .previous() on another object.
268 return self
._history
_index
== -1
272 """Returns True if this entity no longer exists in the underlying
278 self
.model
.state
.entity_data(
279 self
.entity_type
, self
.entity_id
, -1) is None
284 """Returns True if this entity still exists in the underlying
292 """The data dictionary for this entity.
295 return self
.model
.state
.entity_data(
296 self
.entity_type
, self
.entity_id
, self
._history
_index
)
300 """The data dictionary for this entity.
302 If this `ModelEntity` points to the dead state, it will
303 raise `DeadEntityException`.
306 if self
.data
is None:
307 raise DeadEntityException(
308 "Entity {}:{} is dead - its attributes can no longer be "
309 "accessed. Use the .previous() method on this object to get "
310 "a copy of the object at its previous state.".format(
311 self
.entity_type
, self
.entity_id
))
315 """Return a copy of this object as was at its previous state in
318 Returns None if this object is new (and therefore has no history).
320 The returned object is always "disconnected", i.e. does not receive
324 return self
.model
.state
.get_entity(
325 self
.entity_type
, self
.entity_id
, self
._history
_index
- 1,
329 """Return a copy of this object at its next state in
332 Returns None if this object is already the latest.
334 The returned object is "disconnected", i.e. does not receive
335 live updates, unless it is current (latest).
338 if self
._history
_index
== -1:
341 new_index
= self
._history
_index
+ 1
343 new_index
== len(self
.model
.state
.entity_history(
344 self
.entity_type
, self
.entity_id
)) - 1
346 return self
.model
.state
.get_entity(
347 self
.entity_type
, self
.entity_id
, self
._history
_index
- 1,
351 """Return a copy of this object at its current state in the model.
353 Returns self if this object is already the latest.
355 The returned object is always "connected", i.e. receives
356 live updates from the model.
359 if self
._history
_index
== -1:
362 return self
.model
.state
.get_entity(self
.entity_type
, self
.entity_id
)
366 def __init__(self
, loop
=None):
367 """Instantiate a new connected Model.
369 :param loop: an asyncio event loop
372 self
.loop
= loop
or asyncio
.get_event_loop()
373 self
.connection
= None
374 self
.observers
= weakref
.WeakValueDictionary()
375 self
.state
= ModelState(self
)
377 self
._watcher
_task
= None
378 self
._watch
_shutdown
= asyncio
.Event(loop
=loop
)
379 self
._watch
_received
= asyncio
.Event(loop
=loop
)
380 self
._charmstore
= CharmStore(self
.loop
)
382 async def connect(self
, *args
, **kw
):
383 """Connect to an arbitrary Juju model.
385 args and kw are passed through to Connection.connect()
388 self
.connection
= await connection
.Connection
.connect(*args
, **kw
)
389 await self
._after
_connect
()
391 async def connect_current(self
):
392 """Connect to the current Juju model.
395 self
.connection
= await connection
.Connection
.connect_current()
396 await self
._after
_connect
()
398 async def connect_model(self
, model_name
):
399 """Connect to a specific Juju model by name.
401 :param model_name: Format [controller:][user/]model
404 self
.connection
= await connection
.Connection
.connect_model(model_name
)
405 await self
._after
_connect
()
407 async def _after_connect(self
):
408 """Run initialization steps after connecting to websocket.
412 await self
._watch
_received
.wait()
413 await self
.get_info()
415 async def disconnect(self
):
416 """Shut down the watcher task and close websockets.
419 self
._stop
_watching
()
420 if self
.connection
and self
.connection
.is_open
:
421 await self
._watch
_shutdown
.wait()
422 log
.debug('Closing model connection')
423 await self
.connection
.close()
424 self
.connection
= None
426 async def add_local_charm_dir(self
, charm_dir
, series
):
427 """Upload a local charm to the model.
429 This will automatically generate an archive from
432 :param charm_dir: Path to the charm directory
433 :param series: Charm series
436 fh
= tempfile
.NamedTemporaryFile()
437 CharmArchiveGenerator(charm_dir
).make_archive(fh
.name
)
440 self
.add_local_charm
, fh
, series
, os
.stat(fh
.name
).st_size
)
441 charm_url
= await self
.loop
.run_in_executor(None, func
)
443 log
.debug('Uploaded local charm: %s -> %s', charm_dir
, charm_url
)
446 def add_local_charm(self
, charm_file
, series
, size
=None):
447 """Upload a local charm archive to the model.
449 Returns the 'local:...' url that should be used to deploy the charm.
451 :param charm_file: Path to charm zip archive
452 :param series: Charm series
453 :param size: Size of the archive, in bytes
454 :return str: 'local:...' url for deploying the charm
455 :raises: :class:`JujuError` if the upload fails
457 Uses an https endpoint at the same host:port as the wss.
458 Supports large file uploads.
462 This method will block. Consider using :meth:`add_local_charm_dir`
466 conn
, headers
, path_prefix
= self
.connection
.https_connection()
467 path
= "%s/charms?series=%s" % (path_prefix
, series
)
468 headers
['Content-Type'] = 'application/zip'
470 headers
['Content-Length'] = size
471 conn
.request("POST", path
, charm_file
, headers
)
472 response
= conn
.getresponse()
473 result
= response
.read().decode()
474 if not response
.status
== 200:
475 raise JujuError(result
)
476 result
= json
.loads(result
)
477 return result
['charm-url']
479 def all_units_idle(self
):
480 """Return True if all units are idle.
483 for unit
in self
.units
.values():
484 unit_status
= unit
.data
['agent-status']['current']
485 if unit_status
!= 'idle':
489 async def reset(self
, force
=False):
490 """Reset the model to a clean state.
492 :param bool force: Force-terminate machines.
494 This returns only after the model has reached a clean state. "Clean"
495 means no applications or machines exist in the model.
498 log
.debug('Resetting model')
499 for app
in self
.applications
.values():
501 for machine
in self
.machines
.values():
502 await machine
.destroy(force
=force
)
503 await self
.block_until(
504 lambda: len(self
.machines
) == 0
507 async def block_until(self
, *conditions
, timeout
=None, wait_period
=0.5):
508 """Return only after all conditions are true.
512 while not all(c() for c
in conditions
):
513 await asyncio
.sleep(wait_period
)
514 await asyncio
.wait_for(_block(), timeout
)
517 def applications(self
):
518 """Return a map of application-name:Application for all applications
519 currently in the model.
522 return self
.state
.applications
526 """Return a map of machine-id:Machine for all machines currently in
530 return self
.state
.machines
534 """Return a map of unit-id:Unit for all units currently in
538 return self
.state
.units
540 async def get_info(self
):
541 """Return a client.ModelInfo object for this Model.
543 Retrieves latest info for this Model from the api server. The
544 return value is cached on the Model.info attribute so that the
545 valued may be accessed again without another api call, if
548 This method is called automatically when the Model is connected,
549 resulting in Model.info being initialized without requiring an
550 explicit call to this method.
553 facade
= client
.ClientFacade()
554 facade
.connect(self
.connection
)
556 self
.info
= await facade
.ModelInfo()
557 log
.debug('Got ModelInfo: %s', vars(self
.info
))
562 self
, callable_
, entity_type
=None, action
=None, entity_id
=None,
564 """Register an "on-model-change" callback
566 Once the model is connected, ``callable_``
567 will be called each time the model changes. ``callable_`` should
568 be Awaitable and accept the following positional arguments:
570 delta - An instance of :class:`juju.delta.EntityDelta`
571 containing the raw delta data recv'd from the Juju
574 old_obj - If the delta modifies an existing object in the model,
575 old_obj will be a copy of that object, as it was before the
576 delta was applied. Will be None if the delta creates a new
579 new_obj - A copy of the new or updated object, after the delta
580 is applied. Will be None if the delta removes an entity
583 model - The :class:`Model` itself.
585 Events for which ``callable_`` is called can be specified by passing
586 entity_type, action, and/or entitiy_id filter criteria, e.g.::
590 entity_type='application', action='add', entity_id='ubuntu')
592 For more complex filtering conditions, pass a predicate function. It
593 will be called with a delta as its only argument. If the predicate
594 function returns True, the ``callable_`` will be called.
597 observer
= _Observer(
598 callable_
, entity_type
, action
, entity_id
, predicate
)
599 self
.observers
[observer
] = callable_
602 """Start an asynchronous watch against this model.
604 See :meth:`add_observer` to register an onchange callback.
607 async def _start_watch():
608 self
._watch
_shutdown
.clear()
610 allwatcher
= watcher
.AllWatcher()
611 self
._watch
_conn
= await self
.connection
.clone()
612 allwatcher
.connect(self
._watch
_conn
)
614 results
= await allwatcher
.Next()
615 for delta
in results
.deltas
:
616 delta
= get_entity_delta(delta
)
617 old_obj
, new_obj
= self
.state
.apply_delta(delta
)
618 # XXX: Might not want to shield at this level
619 # We are shielding because when the watcher is
620 # canceled (on disconnect()), we don't want all of
621 # its children (every observer callback) to be
622 # canceled with it. So we shield them. But this means
623 # they can *never* be canceled.
624 await asyncio
.shield(
625 self
._notify
_observers
(delta
, old_obj
, new_obj
))
626 self
._watch
_received
.set()
627 except CancelledError
:
628 log
.debug('Closing watcher connection')
629 await self
._watch
_conn
.close()
630 self
._watch
_shutdown
.set()
631 self
._watch
_conn
= None
633 log
.debug('Starting watcher task')
634 self
._watcher
_task
= self
.loop
.create_task(_start_watch())
636 def _stop_watching(self
):
637 """Stop the asynchronous watch against this model.
640 log
.debug('Stopping watcher task')
641 if self
._watcher
_task
:
642 self
._watcher
_task
.cancel()
644 async def _notify_observers(self
, delta
, old_obj
, new_obj
):
645 """Call observing callbacks, notifying them of a change in model state
647 :param delta: The raw change from the watcher
648 (:class:`juju.client.overrides.Delta`)
649 :param old_obj: The object in the model that this delta updates.
651 :param new_obj: The object in the model that is created or updated
652 by applying this delta.
655 if new_obj
and not old_obj
:
659 'Model changed: %s %s %s',
660 delta
.entity
, delta
.type, delta
.get_id())
662 for o
in self
.observers
:
663 if o
.cares_about(delta
):
664 asyncio
.ensure_future(o(delta
, old_obj
, new_obj
, self
))
666 async def _wait(self
, entity_type
, entity_id
, action
, predicate
=None):
668 Block the calling routine until a given action has happened to the
671 :param entity_type: The entity's type.
672 :param entity_id: The entity's id.
673 :param action: the type of action (e.g., 'add' or 'change')
674 :param predicate: optional callable that must take as an
675 argument a delta, and must return a boolean, indicating
676 whether the delta contains the specific action we're looking
677 for. For example, you might check to see whether a 'change'
678 has a 'completed' status. See the _Observer class for details.
681 q
= asyncio
.Queue(loop
=self
.loop
)
683 async def callback(delta
, old
, new
, model
):
684 await q
.put(delta
.get_id())
686 self
.add_observer(callback
, entity_type
, action
, entity_id
, predicate
)
687 entity_id
= await q
.get()
688 return self
.state
._live
_entity
_map
(entity_type
)[entity_id
]
690 async def _wait_for_new(self
, entity_type
, entity_id
=None, predicate
=None):
691 """Wait for a new object to appear in the Model and return it.
693 Waits for an object of type ``entity_type`` with id ``entity_id``.
694 If ``entity_id`` is ``None``, it will wait for the first new entity
697 This coroutine blocks until the new object appears in the model.
700 # if the entity is already in the model, just return it
701 if entity_id
in self
.state
._live
_entity
_map
(entity_type
):
702 return self
.state
._live
_entity
_map
(entity_type
)[entity_id
]
703 # if we know the entity_id, we can trigger on any action that puts
704 # the enitty into the model; otherwise, we have to watch for the
705 # next "add" action on that entity_type
706 action
= 'add' if entity_id
is None else None
707 return await self
._wait
(entity_type
, entity_id
, action
, predicate
)
709 async def wait_for_action(self
, action_id
):
710 """Given an action, wait for it to complete."""
712 if action_id
.startswith("action-"):
713 # if we've been passed action.tag, transform it into the
714 # id that the api deltas will use.
715 action_id
= action_id
[7:]
717 def predicate(delta
):
718 return delta
.data
['status'] in ('completed', 'failed')
720 return await self
._wait
('action', action_id
, 'change', predicate
)
723 self
, spec
=None, constraints
=None, disks
=None, series
=None,
725 """Start a new, empty machine and optionally a container, or add a
726 container to a machine.
728 :param str spec: Machine specification
731 (None) - starts a new machine
732 'lxc' - starts a new machine with on lxc container
733 'lxc:4' - starts a new lxc container on machine 4
734 'ssh:user@10.10.0.3' - manually provisions a machine with ssh
735 'zone=us-east-1a' - starts a machine in zone us-east-1s on AWS
736 'maas2.name' - acquire machine maas2.name on MAAS
737 :param constraints: Machine constraints
738 :type constraints: :class:`juju.Constraints`
739 :param list disks: List of disk :class:`constraints <juju.Constraints>`
740 :param str series: Series
741 :param int count: Number of machines to deploy
743 Supported container types are: lxc, lxd, kvm
745 When deploying a container to an existing machine, constraints cannot
750 add_machines
= add_machine
752 async def add_relation(self
, relation1
, relation2
):
753 """Add a relation between two applications.
755 :param str relation1: '<application>[:<relation_name>]'
756 :param str relation2: '<application>[:<relation_name>]'
759 app_facade
= client
.ApplicationFacade()
760 app_facade
.connect(self
.connection
)
763 'Adding relation %s <-> %s', relation1
, relation2
)
766 result
= await app_facade
.AddRelation([relation1
, relation2
])
767 except JujuAPIError
as e
:
768 if 'relation already exists' not in e
.message
:
771 'Relation %s <-> %s already exists', relation1
, relation2
)
772 # TODO: if relation already exists we should return the
773 # Relation ModelEntity here
776 def predicate(delta
):
778 for endpoint
in delta
.data
['endpoints']:
779 endpoints
[endpoint
['application-name']] = endpoint
['relation']
780 return endpoints
== result
.endpoints
782 return await self
._wait
_for
_new
('relation', None, predicate
)
784 def add_space(self
, name
, *cidrs
):
785 """Add a new network space.
787 Adds a new space with the given name and associates the given
788 (optional) list of existing subnet CIDRs with it.
790 :param str name: Name of the space
791 :param \*cidrs: Optional list of existing subnet CIDRs
796 def add_ssh_key(self
, key
):
797 """Add a public SSH key to this model.
799 :param str key: The public ssh key
803 add_ssh_keys
= add_ssh_key
805 def add_subnet(self
, cidr_or_id
, space
, *zones
):
806 """Add an existing subnet to this model.
808 :param str cidr_or_id: CIDR or provider ID of the existing subnet
809 :param str space: Network space with which to associate
810 :param str \*zones: Zone(s) in which the subnet resides
815 def get_backups(self
):
816 """Retrieve metadata for backups in this model.
821 def block(self
, *commands
):
822 """Add a new block to this model.
824 :param str \*commands: The commands to block. Valid values are
825 'all-changes', 'destroy-model', 'remove-object'
830 def get_blocks(self
):
831 """List blocks for this model.
836 def get_cached_images(self
, arch
=None, kind
=None, series
=None):
837 """Return a list of cached OS images.
839 :param str arch: Filter by image architecture
840 :param str kind: Filter by image kind, e.g. 'lxd'
841 :param str series: Filter by image series, e.g. 'xenial'
846 def create_backup(self
, note
=None, no_download
=False):
847 """Create a backup of this model.
849 :param str note: A note to store with the backup
850 :param bool no_download: Do not download the backup archive
851 :return str: Path to downloaded archive
856 def create_storage_pool(self
, name
, provider_type
, **pool_config
):
857 """Create or define a storage pool.
859 :param str name: Name to give the storage pool
860 :param str provider_type: Pool provider type
861 :param \*\*pool_config: key/value pool configuration pairs
867 self
, no_tail
=False, exclude_module
=None, include_module
=None,
868 include
=None, level
=None, limit
=0, lines
=10, replay
=False,
870 """Get log messages for this model.
872 :param bool no_tail: Stop after returning existing log messages
873 :param list exclude_module: Do not show log messages for these logging
875 :param list include_module: Only show log messages for these logging
877 :param list include: Only show log messages for these entities
878 :param str level: Log level to show, valid options are 'TRACE',
879 'DEBUG', 'INFO', 'WARNING', 'ERROR,
880 :param int limit: Return this many of the most recent (possibly
881 filtered) lines are shown
882 :param int lines: Yield this many of the most recent lines, and keep
884 :param bool replay: Yield the entire log, and keep yielding
885 :param list exclude: Do not show log messages for these entities
891 self
, entity_url
, application_name
=None, bind
=None, budget
=None,
892 channel
=None, config
=None, constraints
=None, force
=False,
893 num_units
=1, plan
=None, resources
=None, series
=None, storage
=None,
895 """Deploy a new service or bundle.
897 :param str entity_url: Charm or bundle url
898 :param str application_name: Name to give the service
899 :param dict bind: <charm endpoint>:<network space> pairs
900 :param dict budget: <budget name>:<limit> pairs
901 :param str channel: Charm store channel from which to retrieve
902 the charm or bundle, e.g. 'development'
903 :param dict config: Charm configuration dictionary
904 :param constraints: Service constraints
905 :type constraints: :class:`juju.Constraints`
906 :param bool force: Allow charm to be deployed to a machine running
907 an unsupported series
908 :param int num_units: Number of units to deploy
909 :param str plan: Plan under which to deploy charm
910 :param dict resources: <resource name>:<file path> pairs
911 :param str series: Series on which to deploy
912 :param dict storage: Storage constraints TODO how do these look?
913 :param str to: Placement directive, e.g.::
916 'lxc:7' - new lxc container on machine 7
917 '24/lxc/3' - lxc container 3 or machine 24
919 If None, a new machine is provisioned.
924 - application_name is required; fill this in automatically if not
926 - series is required; how do we pick a default?
931 client
.Placement(**p
) for p
in to
938 k
: client
.Constraints(**v
)
939 for k
, v
in storage
.items()
943 entity_url
.startswith('local:') or
944 os
.path
.isdir(entity_url
)
946 entity_id
= await self
.charmstore
.entityId(entity_url
) \
947 if not is_local
else entity_url
949 app_facade
= client
.ApplicationFacade()
950 client_facade
= client
.ClientFacade()
951 app_facade
.connect(self
.connection
)
952 client_facade
.connect(self
.connection
)
954 is_bundle
= ((is_local
and
955 (Path(entity_id
) / 'bundle.yaml').exists()) or
956 (not is_local
and 'bundle/' in entity_id
))
959 handler
= BundleHandler(self
)
960 await handler
.fetch_plan(entity_id
)
961 await handler
.execute_plan()
962 extant_apps
= {app
for app
in self
.applications
}
963 pending_apps
= set(handler
.applications
) - extant_apps
965 # new apps will usually be in the model by now, but if some
966 # haven't made it yet we'll need to wait on them to be added
967 await asyncio
.gather(*[
968 asyncio
.ensure_future(
969 self
._wait
_for
_new
('application', app_name
))
970 for app_name
in pending_apps
972 return [app
for name
, app
in self
.applications
.items()
973 if name
in handler
.applications
]
976 'Deploying %s', entity_id
)
979 await client_facade
.AddCharm(channel
, entity_id
)
980 elif not entity_id
.startswith('local:'):
981 # We have a local charm dir that needs to be uploaded
982 charm_dir
= os
.path
.abspath(
983 os
.path
.expanduser(entity_id
))
984 series
= series
or get_charm_series(charm_dir
)
987 "Couldn't determine series for charm at {}. "
988 "Pass a 'series' kwarg to Model.deploy().".format(
990 entity_id
= await self
.add_local_charm_dir(charm_dir
, series
)
992 app
= client
.ApplicationDeploy(
993 application
=application_name
,
997 constraints
=parse_constraints(constraints
),
998 endpoint_bindings
=bind
,
1000 placement
=placement
,
1001 resources
=resources
,
1006 result
= await app_facade
.Deploy([app
])
1007 errors
= [r
.error
.message
for r
in result
.results
if r
.error
]
1009 raise JujuError('\n'.join(errors
))
1010 return await self
._wait
_for
_new
('application', application_name
)
1013 """Terminate all machines and resources for this model.
1018 async def destroy_unit(self
, *unit_names
):
1019 """Destroy units by name.
1022 app_facade
= client
.ApplicationFacade()
1023 app_facade
.connect(self
.connection
)
1026 'Destroying unit%s %s',
1027 's' if len(unit_names
) == 1 else '',
1028 ' '.join(unit_names
))
1030 return await app_facade
.DestroyUnits(list(unit_names
))
1031 destroy_units
= destroy_unit
1033 def get_backup(self
, archive_id
):
1034 """Download a backup archive file.
1036 :param str archive_id: The id of the archive to download
1037 :return str: Path to the archive file
1043 self
, num_controllers
=0, constraints
=None, series
=None, to
=None):
1044 """Ensure sufficient controllers exist to provide redundancy.
1046 :param int num_controllers: Number of controllers to make available
1047 :param constraints: Constraints to apply to the controller machines
1048 :type constraints: :class:`juju.Constraints`
1049 :param str series: Series of the controller machines
1050 :param list to: Placement directives for controller machines, e.g.::
1053 'lxc:7' - new lxc container on machine 7
1054 '24/lxc/3' - lxc container 3 or machine 24
1056 If None, a new machine is provisioned.
1061 def get_config(self
):
1062 """Return the configuration settings for this model.
1067 def get_constraints(self
):
1068 """Return the machine constraints for this model.
1073 def grant(self
, username
, acl
='read'):
1074 """Grant a user access to this model.
1076 :param str username: Username
1077 :param str acl: Access control ('read' or 'write')
1082 def import_ssh_key(self
, identity
):
1083 """Add a public SSH key from a trusted indentity source to this model.
1085 :param str identity: User identity in the form <lp|gh>:<username>
1089 import_ssh_keys
= import_ssh_key
1091 def get_machines(self
, machine
, utc
=False):
1092 """Return list of machines in this model.
1094 :param str machine: Machine id, e.g. '0'
1095 :param bool utc: Display time as UTC in RFC3339 format
1100 def get_shares(self
):
1101 """Return list of all users with access to this model.
1106 def get_spaces(self
):
1107 """Return list of all known spaces, including associated subnets.
1112 def get_ssh_key(self
):
1113 """Return known SSH keys for this model.
1117 get_ssh_keys
= get_ssh_key
1119 def get_storage(self
, filesystem
=False, volume
=False):
1120 """Return details of storage instances.
1122 :param bool filesystem: Include filesystem storage
1123 :param bool volume: Include volume storage
1128 def get_storage_pools(self
, names
=None, providers
=None):
1129 """Return list of storage pools.
1131 :param list names: Only include pools with these names
1132 :param list providers: Only include pools for these providers
1137 def get_subnets(self
, space
=None, zone
=None):
1138 """Return list of known subnets.
1140 :param str space: Only include subnets in this space
1141 :param str zone: Only include subnets in this zone
1146 def remove_blocks(self
):
1147 """Remove all blocks from this model.
1152 def remove_backup(self
, backup_id
):
1155 :param str backup_id: The id of the backup to remove
1160 def remove_cached_images(self
, arch
=None, kind
=None, series
=None):
1161 """Remove cached OS images.
1163 :param str arch: Architecture of the images to remove
1164 :param str kind: Image kind to remove, e.g. 'lxd'
1165 :param str series: Image series to remove, e.g. 'xenial'
1170 def remove_machine(self
, *machine_ids
):
1171 """Remove a machine from this model.
1173 :param str \*machine_ids: Ids of the machines to remove
1177 remove_machines
= remove_machine
1179 def remove_ssh_key(self
, *keys
):
1180 """Remove a public SSH key(s) from this model.
1182 :param str \*keys: Keys to remove
1186 remove_ssh_keys
= remove_ssh_key
1189 self
, bootstrap
=False, constraints
=None, archive
=None,
1190 backup_id
=None, upload_tools
=False):
1191 """Restore a backup archive to a new controller.
1193 :param bool bootstrap: Bootstrap a new state machine
1194 :param constraints: Model constraints
1195 :type constraints: :class:`juju.Constraints`
1196 :param str archive: Path to backup archive to restore
1197 :param str backup_id: Id of backup to restore
1198 :param bool upload_tools: Upload tools if bootstrapping a new machine
1203 def retry_provisioning(self
):
1204 """Retry provisioning for failed machines.
1209 def revoke(self
, username
, acl
='read'):
1210 """Revoke a user's access to this model.
1212 :param str username: Username to revoke
1213 :param str acl: Access control ('read' or 'write')
1218 def run(self
, command
, timeout
=None):
1219 """Run command on all machines in this model.
1221 :param str command: The command to run
1222 :param int timeout: Time to wait before command is considered failed
1227 def set_config(self
, **config
):
1228 """Set configuration keys on this model.
1230 :param \*\*config: Config key/values
1235 def set_constraints(self
, constraints
):
1236 """Set machine constraints on this model.
1238 :param :class:`juju.Constraints` constraints: Machine constraints
1243 def get_action_output(self
, action_uuid
, wait
=-1):
1244 """Get the results of an action by ID.
1246 :param str action_uuid: Id of the action
1247 :param int wait: Time in seconds to wait for action to complete
1252 def get_action_status(self
, uuid_or_prefix
=None, name
=None):
1253 """Get the status of all actions, filtered by ID, ID prefix, or action name.
1255 :param str uuid_or_prefix: Filter by action uuid or prefix
1256 :param str name: Filter by action name
1261 def get_budget(self
, budget_name
):
1262 """Get budget usage info.
1264 :param str budget_name: Name of budget
1269 def get_status(self
, filter_
=None, utc
=False):
1270 """Return the status of the model.
1272 :param str filter_: Service or unit name or wildcard ('*')
1273 :param bool utc: Display time as UTC in RFC3339 format
1280 self
, all_
=False, destination
=None, dry_run
=False, public
=False,
1281 source
=None, stream
=None, version
=None):
1282 """Copy Juju tools into this model.
1284 :param bool all_: Copy all versions, not just the latest
1285 :param str destination: Path to local destination directory
1286 :param bool dry_run: Don't do the actual copy
1287 :param bool public: Tools are for a public cloud, so generate mirrors
1289 :param str source: Path to local source directory
1290 :param str stream: Simplestreams stream for which to sync metadata
1291 :param str version: Copy a specific major.minor version
1296 def unblock(self
, *commands
):
1297 """Unblock an operation that would alter this model.
1299 :param str \*commands: The commands to unblock. Valid values are
1300 'all-changes', 'destroy-model', 'remove-object'
1305 def unset_config(self
, *keys
):
1306 """Unset configuration on this model.
1308 :param str \*keys: The keys to unset
1313 def upgrade_gui(self
):
1314 """Upgrade the Juju GUI for this model.
1320 self
, dry_run
=False, reset_previous_upgrade
=False,
1321 upload_tools
=False, version
=None):
1322 """Upgrade Juju on all machines in a model.
1324 :param bool dry_run: Don't do the actual upgrade
1325 :param bool reset_previous_upgrade: Clear the previous (incomplete)
1327 :param bool upload_tools: Upload local version of tools
1328 :param str version: Upgrade to a specific version
1333 def upload_backup(self
, archive_path
):
1334 """Store a backup archive remotely in Juju.
1336 :param str archive_path: Path to local archive
1342 def charmstore(self
):
1343 return self
._charmstore
1345 async def get_metrics(self
, *tags
):
1346 """Retrieve metrics.
1348 :param str \*tags: Tags of entities from which to retrieve metrics.
1349 No tags retrieves the metrics of all units in the model.
1350 :return: Dictionary of unit_name:metrics
1353 log
.debug("Retrieving metrics for %s",
1354 ', '.join(tags
) if tags
else "all units")
1356 metrics_facade
= client
.MetricsDebugFacade()
1357 metrics_facade
.connect(self
.connection
)
1359 entities
= [client
.Entity(tag
) for tag
in tags
]
1360 metrics_result
= await metrics_facade
.GetMetrics(entities
)
1362 metrics
= collections
.defaultdict(list)
1364 for entity_metrics
in metrics_result
.results
:
1365 error
= entity_metrics
.error
1367 if "is not a valid tag" in error
:
1368 raise ValueError(error
.message
)
1370 raise Exception(error
.message
)
1372 for metric
in entity_metrics
.metrics
:
1373 metrics
[metric
.unit
].append(vars(metric
))
1378 def get_charm_series(path
):
1379 """Inspects the charm directory at ``path`` and returns a default
1380 series from its metadata.yaml (the first item in the 'series' list).
1382 Returns None if no series can be determined.
1385 md
= Path(path
) / "metadata.yaml"
1388 data
= yaml
.load(md
.open())
1389 series
= data
.get('series')
1390 return series
[0] if series
else None
1393 class BundleHandler(object):
1395 Handle bundles by using the API to translate bundle YAML into a plan of
1396 steps and then dispatching each of those using the API.
1398 def __init__(self
, model
):
1400 self
.charmstore
= model
.charmstore
1402 self
.references
= {}
1403 self
._units
_by
_app
= {}
1404 for unit_name
, unit
in model
.units
.items():
1405 app_units
= self
._units
_by
_app
.setdefault(unit
.application
, [])
1406 app_units
.append(unit_name
)
1407 self
.client_facade
= client
.ClientFacade()
1408 self
.client_facade
.connect(model
.connection
)
1409 self
.app_facade
= client
.ApplicationFacade()
1410 self
.app_facade
.connect(model
.connection
)
1411 self
.ann_facade
= client
.AnnotationsFacade()
1412 self
.ann_facade
.connect(model
.connection
)
1414 async def _handle_local_charms(self
, bundle
):
1415 """Search for references to local charms (i.e. filesystem paths)
1416 in the bundle. Upload the local charms to the model, and replace
1417 the filesystem paths with appropriate 'local:' paths in the bundle.
1419 Return the modified bundle.
1421 :param dict bundle: Bundle dictionary
1422 :return: Modified bundle dictionary
1427 default_series
= bundle
.get('series')
1428 for app_name
in self
.applications
:
1429 app_dict
= bundle
['services'][app_name
]
1430 charm_dir
= os
.path
.abspath(os
.path
.expanduser(app_dict
['charm']))
1431 if not os
.path
.isdir(charm_dir
):
1434 app_dict
.get('series') or
1436 get_charm_series(charm_dir
)
1440 "Couldn't determine series for charm at {}. "
1441 "Add a 'series' key to the bundle.".format(charm_dir
))
1443 # Keep track of what we need to update. We keep a list of apps
1444 # that need to be updated, and a corresponding list of args
1445 # needed to update those apps.
1446 apps
.append(app_name
)
1447 args
.append((charm_dir
, series
))
1450 # If we have apps to update, spawn all the coroutines concurrently
1451 # and wait for them to finish.
1452 charm_urls
= await asyncio
.gather(*[
1453 self
.model
.add_local_charm_dir(*params
)
1456 # Update the 'charm:' entry for each app with the new 'local:' url.
1457 for app_name
, charm_url
in zip(apps
, charm_urls
):
1458 bundle
['services'][app_name
]['charm'] = charm_url
1462 async def fetch_plan(self
, entity_id
):
1463 is_local
= not entity_id
.startswith('cs:') and os
.path
.isdir(entity_id
)
1465 bundle_yaml
= (Path(entity_id
) / "bundle.yaml").read_text()
1467 bundle_yaml
= await self
.charmstore
.files(entity_id
,
1468 filename
='bundle.yaml',
1470 self
.bundle
= yaml
.safe_load(bundle_yaml
)
1471 self
.bundle
= await self
._handle
_local
_charms
(self
.bundle
)
1473 self
.plan
= await self
.client_facade
.GetBundleChanges(
1474 yaml
.dump(self
.bundle
))
1476 if self
.plan
.errors
:
1477 raise JujuError('\n'.join(self
.plan
.errors
))
1479 async def execute_plan(self
):
1480 for step
in self
.plan
.changes
:
1481 method
= getattr(self
, step
.method
)
1482 result
= await method(*step
.args
)
1483 self
.references
[step
.id_
] = result
1486 def applications(self
):
1487 return list(self
.bundle
['services'].keys())
1489 def resolve(self
, reference
):
1490 if reference
and reference
.startswith('$'):
1491 reference
= self
.references
[reference
[1:]]
1494 async def addCharm(self
, charm
, series
):
1496 :param charm string:
1497 Charm holds the URL of the charm to be added.
1499 :param series string:
1500 Series holds the series of the charm to be added
1501 if the charm default is not sufficient.
1503 # We don't add local charms because they've already been added
1504 # by self._handle_local_charms
1505 if charm
.startswith('local:'):
1508 entity_id
= await self
.charmstore
.entityId(charm
)
1509 log
.debug('Adding %s', entity_id
)
1510 await self
.client_facade
.AddCharm(None, entity_id
)
1513 async def addMachines(self
, params
=None):
1516 Dictionary specifying the machine to add. All keys are optional.
1519 series: string specifying the machine OS series.
1521 constraints: string holding machine constraints, if any. We'll
1522 parse this into the json friendly dict that the juju api
1525 container_type: string holding the type of the container (for
1526 instance ""lxd" or kvm"). It is not specified for top level
1529 parent_id: string holding a placeholder pointing to another
1530 machine change or to a unit change. This value is only
1531 specified in the case this machine is a container, in
1532 which case also ContainerType is set.
1535 params
= params
or {}
1538 params
= {normalize_key(k
): params
[k
] for k
in params
.keys()}
1540 # Fix up values, as necessary.
1541 if 'parent_id' in params
:
1542 params
['parent_id'] = self
.resolve(params
['parent_id'])
1544 params
['constraints'] = parse_constraints(
1545 params
.get('constraints'))
1546 params
['jobs'] = params
.get('jobs', ['JobHostUnits'])
1548 if params
.get('container_type') == 'lxc':
1549 log
.warning('Juju 2.0 does not support lxc containers. '
1550 'Converting containers to lxd.')
1551 params
['container_type'] = 'lxd'
1553 # Submit the request.
1554 params
= client
.AddMachineParams(**params
)
1555 results
= await self
.client_facade
.AddMachines([params
])
1556 error
= results
.machines
[0].error
1558 raise ValueError("Error adding machine: %s", error
.message
)
1559 machine
= results
.machines
[0].machine
1560 log
.debug('Added new machine %s', machine
)
1563 async def addRelation(self
, endpoint1
, endpoint2
):
1565 :param endpoint1 string:
1566 :param endpoint2 string:
1567 Endpoint1 and Endpoint2 hold relation endpoints in the
1568 "application:interface" form, where the application is always a
1569 placeholder pointing to an application change, and the interface is
1570 optional. Examples are "$deploy-42:web" or just "$deploy-42".
1572 endpoints
= [endpoint1
, endpoint2
]
1573 # resolve indirect references
1574 for i
in range(len(endpoints
)):
1575 parts
= endpoints
[i
].split(':')
1576 parts
[0] = self
.resolve(parts
[0])
1577 endpoints
[i
] = ':'.join(parts
)
1579 log
.info('Relating %s <-> %s', *endpoints
)
1580 return await self
.model
.add_relation(*endpoints
)
1582 async def deploy(self
, charm
, series
, application
, options
, constraints
,
1583 storage
, endpoint_bindings
, resources
):
1585 :param charm string:
1586 Charm holds the URL of the charm to be used to deploy this
1589 :param series string:
1590 Series holds the series of the application to be deployed
1591 if the charm default is not sufficient.
1593 :param application string:
1594 Application holds the application name.
1596 :param options map[string]interface{}:
1597 Options holds application options.
1599 :param constraints string:
1600 Constraints holds the optional application constraints.
1602 :param storage map[string]string:
1603 Storage holds the optional storage constraints.
1605 :param endpoint_bindings map[string]string:
1606 EndpointBindings holds the optional endpoint bindings
1608 :param resources map[string]int:
1609 Resources identifies the revision to use for each resource
1610 of the application's charm.
1612 # resolve indirect references
1613 charm
= self
.resolve(charm
)
1614 # stringify all config values for API
1615 options
= {k
: str(v
) for k
, v
in options
.items()}
1616 # build param object
1617 app
= client
.ApplicationDeploy(
1620 application
=application
,
1622 constraints
=parse_constraints(constraints
),
1624 endpoint_bindings
=endpoint_bindings
,
1625 resources
=resources
,
1628 log
.info('Deploying %s', charm
)
1629 await self
.app_facade
.Deploy([app
])
1630 # ensure the app is in the model for future operations
1631 await self
.model
._wait
_for
_new
('application', application
)
1634 async def addUnit(self
, application
, to
):
1636 :param application string:
1637 Application holds the application placeholder name for which a unit
1641 To holds the optional location where to add the unit, as a
1642 placeholder pointing to another unit change or to a machine change.
1644 application
= self
.resolve(application
)
1645 placement
= self
.resolve(to
)
1646 if self
._units
_by
_app
.get(application
):
1647 # enough units for this application already exist;
1648 # claim one, and carry on
1649 # NB: this should probably honor placement, but the juju client
1650 # doesn't, so we're not bothering, either
1651 unit_name
= self
._units
_by
_app
[application
].pop()
1652 log
.debug('Reusing unit %s for %s', unit_name
, application
)
1653 return self
.model
.units
[unit_name
]
1655 log
.debug('Adding new unit for %s%s', application
,
1656 ' to %s' % placement
if placement
else '')
1657 return await self
.model
.applications
[application
].add_unit(
1662 async def expose(self
, application
):
1664 :param application string:
1665 Application holds the placeholder name of the application that must
1668 application
= self
.resolve(application
)
1669 log
.info('Exposing %s', application
)
1670 return await self
.model
.applications
[application
].expose()
1672 async def setAnnotations(self
, id_
, entity_type
, annotations
):
1675 Id is the placeholder for the application or machine change
1676 corresponding to the entity to be annotated.
1678 :param entity_type EntityType:
1679 EntityType holds the type of the entity, "application" or
1682 :param annotations map[string]string:
1683 Annotations holds the annotations as key/value pairs.
1685 entity_id
= self
.resolve(id_
)
1687 entity
= self
.model
.state
.get_entity(entity_type
, entity_id
)
1689 entity
= await self
.model
._wait
_for
_new
(entity_type
, entity_id
)
1690 return await entity
.set_annotations(annotations
)
1693 class CharmStore(object):
1695 Async wrapper around theblues.charmstore.CharmStore
1697 def __init__(self
, loop
):
1699 self
._cs
= charmstore
.CharmStore()
1701 def __getattr__(self
, name
):
1703 Wrap method calls in coroutines that use run_in_executor to make them
1706 attr
= getattr(self
._cs
, name
)
1707 if not callable(attr
):
1708 wrapper
= partial(getattr, self
._cs
, name
)
1709 setattr(self
, name
, wrapper
)
1711 async def coro(*args
, **kwargs
):
1712 method
= partial(attr
, *args
, **kwargs
)
1713 return await self
.loop
.run_in_executor(None, method
)
1714 setattr(self
, name
, coro
)
1719 class CharmArchiveGenerator(object):
1720 def __init__(self
, path
):
1721 self
.path
= os
.path
.abspath(os
.path
.expanduser(path
))
1723 def make_archive(self
, path
):
1724 """Create archive of directory and write to ``path``.
1726 :param path: Path to archive
1730 * build/\* - This is used for packing the charm itself and any
1732 * \*/.\* - Hidden files are all ignored for now. This will most
1733 likely be changed into a specific ignore list
1737 zf
= zipfile
.ZipFile(path
, 'w', zipfile
.ZIP_DEFLATED
)
1738 for dirpath
, dirnames
, filenames
in os
.walk(self
.path
):
1739 relative_path
= dirpath
[len(self
.path
) + 1:]
1740 if relative_path
and not self
._ignore
(relative_path
):
1741 zf
.write(dirpath
, relative_path
)
1742 for name
in filenames
:
1743 archive_name
= os
.path
.join(relative_path
, name
)
1744 if not self
._ignore
(archive_name
):
1745 real_path
= os
.path
.join(dirpath
, name
)
1746 self
._check
_type
(real_path
)
1747 if os
.path
.islink(real_path
):
1748 self
._check
_link
(real_path
)
1749 self
._write
_symlink
(
1750 zf
, os
.readlink(real_path
), archive_name
)
1752 zf
.write(real_path
, archive_name
)
1756 def _check_type(self
, path
):
1760 if stat
.S_ISDIR(s
.st_mode
) or stat
.S_ISREG(s
.st_mode
):
1762 raise ValueError("Invalid Charm at % %s" % (
1763 path
, "Invalid file type for a charm"))
1765 def _check_link(self
, path
):
1766 link_path
= os
.readlink(path
)
1767 if link_path
[0] == "/":
1769 "Invalid Charm at %s: %s" % (
1770 path
, "Absolute links are invalid"))
1771 path_dir
= os
.path
.dirname(path
)
1772 link_path
= os
.path
.join(path_dir
, link_path
)
1773 if not link_path
.startswith(os
.path
.abspath(self
.path
)):
1775 "Invalid charm at %s %s" % (
1776 path
, "Only internal symlinks are allowed"))
1778 def _write_symlink(self
, zf
, link_target
, link_path
):
1779 """Package symlinks with appropriate zipfile metadata."""
1780 info
= zipfile
.ZipInfo()
1781 info
.filename
= link_path
1782 info
.create_system
= 3
1783 # Magic code for symlinks / py2/3 compat
1784 # 27166663808 = (stat.S_IFLNK | 0755) << 16
1785 info
.external_attr
= 2716663808
1786 zf
.writestr(info
, link_target
)
1788 def _ignore(self
, path
):
1789 if path
== "build" or path
.startswith("build/"):
1791 if path
.startswith('.'):