The Juju dashboard
See also: Charmhub |
juju-dashboard, How to manage the Juju dashboard
The JAAS dashboard is the Juju GUI. It is intended to supplement the CLI experience with aggregate views and at a glance health checks. In particular, it provides a quick way to view details for all the entities in your Juju environment (models, controllers, etc.), and in places also provides functionality related to the ongoing maintenance of your estate.
Starting with juju v.3.0, the Juju dashboard no longer comes automatically with every controller; instead, it is set up by deploying the juju-dashboard charm in the controller model and integrating it with the controller application.
Contents:
- Models view
- Model details view
- Controllers view
- Model access management
- Running actions from the dashboard
Models view
The models view lists all the models associated with the connected controllers that you have some form of access to. The list displays the models across clouds. This allows you to access the health of all the models at a glance, surfacing any relevant errors so you can quickly investigate what has happened.
Group by
The list can be grouped by status, cloud, or owner. The default grouping is by status, which brings the models with errors to the top of the list.
Search and filtering
The dashboard provides comprehensive search and filter functionality. This allows you to perform complex filtering of the models list which can be shared via the URL.
Model details view
The purpose of the model details view is to provide a list of the applications running on that model. In this view you can also manage access to the model.
Unit view
The unit view scopes your list of units to the model and application you are inspecting. This view will give fine-grained information about the status of each unit and information on this public availability.
Machine view
The machine view details all machine information for the selected machine. Machine view is accessible via an application deployed to a model. The machine details view shows a list of the units running on the machine and the applications associated with the units.
Machine view is only available in none Kubernetes environments.
Relations view
The relations view (sometimes called integrations) displays the information about each relation in a model. This view is accessible from the model details view as an option in the tabbed navigation at the top of the page.
This view provides information about each relation and acts as an at a glance overview of the health of your models relations and a status to help you debug any issues.
Controllers view
The controllers view offers a top level view, monitoring across different controllers, and the possibility to add, edit, and manage controllers. It displays a set of aggregate charts to represent the status of the controllers connected to the current JAAS instance. It also displays a table listing each controller and the usage of each entity hosted by the controller.
Register a controller
The dashboard supports multiple controllers and so you can register your own controllers with this dashboard. While your access to view the controllers hasn’t changed, the Controller view is no longer restricted to only administrators on the controllers. This means that you can now register additional controllers to your dashboard and have the controllers and models appear in the same lists as the ones that were available via your primary controller.
This allows users of JAAS 2.x or greater to register additional self-bootstrapped controllers into the same dashboard.
It also allows users who manage multiple self-bootstrapped controllers the ability to view all of those controllers and their models in a single dashboard.
Model access management
If you have admin rights on a model, the dashboard allows you to add, remove, or modify other users’ access to the model. Once model access has been granted, the model will automatically appear in that user’s model list.
To add a user, enter the username of the person you want to grant access too. Then select the permission level you would like to grant. Finally, click the “Add user” button.
Running actions from the dashboard
If you have write or admin permissions on a model, you can trigger any available action the charmed application provides. If the action requires options, the UI will provide these as a form with help text to describe the options and the default values.
Actions are run on the unit level. To view and trigger actions, visit an application’s unit view, select the units you would like the action to run on, and click the Run actions button. This will bring up a side panel with a list of available actions. Find and select the action you wish to run, provide any necessary options, and click “Run action”.
Viewing action logs
Once an action has been triggered, the action log displays the status and latest result of the action.
Last updated 10 days ago.