How to manage actions

To list the actions defined for a deployed application, use the actions command followed by the deployed charm’s name. For example, assuming you’ve already deployed the git charm, you can find out the actions it supports as below:

juju actions git

This should output:

Action            Description
add-repo          Create a git repository.
add-repo-user     Give a user permissions to access a repository.
add-user          Create a new user.
get-repo          Return the repository's path.
list-repo-users   List all users who have access to a repository.
list-repos        List existing git repositories.
list-user-repos   List all the repositories a user has access to.
list-users        List all users.
remove-repo       Remove a git repository.
remove-repo-user  Revoke a user's permissions to access a repository.
remove-user       Remove a user.

By passing various options, you can also do a number of other things such as specify a model or an output format or request the full schema for all the actions of an application. Below we demonstrate the --schema and --format options:

juju actions git --schema --format yaml

Partial output:

add-repo:
  additionalProperties: false
  description: Create a git repository.
  properties:
    repo:
      description: Name of the git repository.
      type: string
  required:
  - repo
  title: add-repo
  type: object

See more: juju actions

To list the actions defined for a deployed application, use the get_actions() method on the Application object to get all the actions defined for this application.

await my_app.get_actions()

See more: Application (object), get_actions (method)

To see detailed information about an application action, use the show-action command followed by the name of the charm and the name of the action. For example, the code below will show detailed information about the backup action of the postgresql application.

juju show-action postgresql backup

See more: juju show-action

Seeing information about a particular action defined on a deployed application is not supported by the python-libjuju client. However, you can use the get_actions() method on the Application object to get all the actions defined for this application.

await my_app.get_actions()

See more: Application (object), get_actions (method)

To run an action on a unit, use the run command followed by the name of the unit and the name of the action you want to run.

juju run mysql/3 backup

By using various options, you can choose to run the action in the background, specify a timeout time, pass a list of actions in the form of a YAML file, etc. See the command reference doc for more.

Running an action returns the overall operation ID as well as the individual task ID(s) for each unit.

See more: juju run (before juju v.3.0, run-action)

To run an action on a unit, use the run_action() method on a Unit object of a deployed application.

Note that “running” an action on a unit, enqueues an action to be performed. The result will be an Action object to interact with. You will need to call action.wait() on that object to wait for the action to complete and retrieve the results.

# Assume we deployed a git application
my_app = await model.deploy('git', application_name='git', channel='stable')
my_unit = my_app.units[0]

action = await my_unit.run_action('add-repo', repo='myrepo')
await action.wait() # will return the result for the action

See more: Unit (object), Action (object), Unit.run_action (method), Action.wait() (method)

To drill down to the result of running an action on a specific unit (the stdout, stderror, log messages, etc.), use the show-task command followed by the task ID (returned by the run command). For example,

juju show-task 1

See more: juju show-task

The terraform juju client does not support this. Please use the juju client.

The python-libjuju client does not support this. Please use the juju client.

Suppose you’ve run an action but would now like to cancel the resulting pending or running task. You can do so using the cancel-task command. For example:

juju cancel-task 1

See more: juju cancel-task

The terraform juju client does not support this. Please use the juju client.

The python-libjuju client does not support this. Please use the juju client.

To view the pending, running, or completed status of each juju run ... <action> invocation, run the operations command:

juju operations

This will show the operations corresponding to the actions for all the application units. You can filter this by passing various options (e.g., --actions backup, --units mysql/0, --machines 0,1, --status pending,completed, etc.).

See more: juju operations

The terraform juju client does not support this. Please use the juju client.

The python-libjuju client does not support this. Please use the juju client.

To see the status of the individual tasks belonging to a given operation, run the show-operation command followed by the operation ID.

juju show-operation 1

As usual, by adding various options, you can specify an output format, choose to watch indefinitely or specify a timeout time, etc.

See more: juju show-operation

The terraform juju client does not support this. Please use the juju client.

The python-libjuju client does not support this. Please use the juju client.

To debug an action (or more), use the debug-hooks command followed by the name of the unit and the name(s) of the action(s). For example, if you want to check the add-repo action of the git charm, use:

juju debug-hooks git/0 add-repo

See more: juju debug-code, juju debug-hooks, Charm SDK | How to debug a charm

The terraform juju client does not support this. Please use the juju client.

The python-libjuju client does not support this. Please use the juju client.