juju.application

Summary

Application

Methods: add_relation add_unit add_units allocate attach collect_metrics destroy destroy_relation destroy_unit destroy_units expose get_actions get_config get_constraints get_metrics get_resources latest next on_change on_remove on_unit_add on_unit_remove previous remove remove_relation run set_annotations set_config set_constraints set_meter_status set_plan unexpose update_allocation upgrade_charm

Reference

class juju.application.Application(entity_id, model, history_index=-1, connected=True)

Bases: juju.model.ModelEntity

coroutine add_relation(local_relation, remote_relation)

Add a relation to another application.

Parameters:

• local_relation (str) – Name of relation on this application
• remote_relation (str) – Name of relation on the other application in the form ‘<application>[:<relation_name>]’

coroutine add_unit(count=1, to=None)

Add one or more units to this application.

Parameters:

• count (int) – Number of units to add
• to (str) –

  Placement directive, e.g.:: ‘23’ - machine 23 ‘lxc:7’ - new lxc container on machine 7 ‘24/lxc/3’ - lxc container 3 or machine 24

  If None, a new machine is provisioned.

coroutine add_units(count=1, to=None)

Add one or more units to this application.

Parameters:

• count (int) – Number of units to add
• to (str) –

  Placement directive, e.g.:: ‘23’ - machine 23 ‘lxc:7’ - new lxc container on machine 7 ‘24/lxc/3’ - lxc container 3 or machine 24

  If None, a new machine is provisioned.

allocate(budget, value)

Allocate budget to this application.

Parameters:

• budget (str) – Name of budget
• value (int) – Budget limit

attach(resource_name, file_path)

Upload a file as a resource for this application.

Parameters:

• resource (str) – Name of the resource
• file_path (str) – Path to the file to upload

collect_metrics()

Collect metrics on this application.

coroutine destroy()

Remove this application from the model.

coroutine destroy_relation(local_relation, remote_relation)

Remove a relation to another application.

Parameters:

• local_relation (str) – Name of relation on this application
• remote_relation (str) – Name of relation on the other application in the form ‘<application>[:<relation_name>]’

coroutine destroy_unit(*unit_names)

Destroy units by name.

coroutine destroy_units(*unit_names)

Destroy units by name.

coroutine expose()

Make this application publicly available over the network.

get_actions(schema=False)

Get actions defined for this application.

Parameters:schema (bool) – Return the full action schema

coroutine get_config()

Return the configuration settings dict for this application.

coroutine get_constraints()

Return the machine constraints dict for this application.

coroutine get_metrics()

Get metrics for this application’s units.

Returns:Dictionary of unit_name:metrics

get_resources(details=False)

Return resources for this application.

Parameters:details (bool) – Include detailed info about resources used by each unit

on_unit_add(callable_)

Add a “unit added” observer to this entity, which will be called whenever a unit is added to this application.

on_unit_remove(callable_)

Add a “unit removed” observer to this entity, which will be called whenever a unit is removed from this application.

coroutine remove()

Remove this application from the model.

coroutine remove_relation(local_relation, remote_relation)

Remove a relation to another application.

Parameters:

• local_relation (str) – Name of relation on this application
• remote_relation (str) – Name of relation on the other application in the form ‘<application>[:<relation_name>]’

coroutine run(command, timeout=None)

Run command on all units for this application.

Parameters:

• command (str) – The command to run
• timeout (int) – Time to wait before command is considered failed

coroutine set_annotations(annotations)

Set annotations on this application.

Parameters:map[string]string (annotations) – the annotations as key/value pairs.

coroutine set_config(config, to_default=False)

Set configuration options for this application.

Parameters:

• config – Dict of configuration to set
• to_default (bool) – Set application options to default values

coroutine set_constraints(constraints)

Set machine constraints for this application.

Parameters:constraints (dict) – Dict of machine constraints

set_meter_status(status, info=None)

Set the meter status on this status.

Parameters:

• status (str) – Meter status, e.g. ‘RED’, ‘AMBER’
• info (str) – Extra info message

set_plan(plan_name)

Set the plan for this application, effective immediately.

Parameters:plan_name (str) – Name of plan

status

Get the application status, as set by the charm’s leader.

status_message

Get the application status message, as set by the charm’s leader.

tag

coroutine unexpose()

Remove public availability over the network for this application.

units

update_allocation(allocation)

Update existing allocation for this application.

Parameters:allocation (int) – The allocation to set

coroutine upgrade_charm(channel=None, force_series=False, force_units=False, path=None, resources=None, revision=None, switch=None)

Upgrade the charm for this application.

Parameters:

• channel (str) – Channel to use when getting the charm from the charm store, e.g. ‘development’
• force_series (bool) – Upgrade even if series of deployed application is not supported by the new charm
• force_units (bool) – Upgrade all units immediately, even if in error state
• path (str) – Uprade to a charm located at path
• resources (dict) – Dictionary of resource name/filepath pairs
• revision (int) – Explicit upgrade revision
• switch (str) – Crossgrade charm url