Skip to content

canonical/juju-dashboard

Repository files navigation

Juju Dashboard

View the real-time status of your Juju or JAAS environment.


codecov Licence: LGPLv3


Juju Dashboard


Juju Dashboard displays your controllers and models, allowing you to see the status of your deployments, manage access, run actions and configure applications. The dashboard can be used with your local Juju environments and can also be found as a part of JAAS.

Deploy

Juju Dashboard can be deployed in your controller model using either the VM charm or Kubernetes charm (pre Juju 3.0 controllers included Juju Dashboard automatically).

To deploy the dashboard, first switch to the controller model:

juju switch controller

Next deploy the charm. For VM deployments run:

juju deploy juju-dashboard dashboard

For Kubernetes deployments run:

juju deploy juju-dashboard-k8s dashboard

Then integrate the controller and the dashboard:

juju integrate dashboard controller

Finally, expose the dashboard:

juju expose dashboard

Now you can access the dashboard by running:

juju dashboard

This command will open a connection to the dashboard output the dashboard address and credentials.

For further details see the docs on managing the dashboard.

Docs

Learn more about the Juju Dashboard in the Juju docs.

If you're new to Juju you may also like to take a look at the getting started docs.

If you think there's something that needs documenting or an issue with the current docs let us know either via the community or file an issue.

Community

Whether you need help, have suggestions or want to get in contact for any reason you can join us in the Juju Discourse or find us on Mattermost.

Issues

If you've found a bug then please let us know by filing an issue. If you're not sure if it's a bug you can discuss the issue with us first.

Juju Dashboard integrates with a number of parts of the Juju ecosystem. Filing bugs for the relevant codebase will help the issue to be seen by the right team:

Contributing

Juju Dashboard is open source and we welcome contributions. Take a look at the contribution guide guide to find out how to contribute to the project.

Development

Juju dashboard is built using a number of open source tools including React, Redux Toolkit and TypeScript as well as some internal libraries, such as Jujulib, bakeryjs, Vanilla Framework, Vanilla React Components and last but not least Juju.

To get started working on the dashboard take a look at our development guide.

Release

Check out the release guide for details about how to release Juju Dashboard and its dependencies.

Licence

Juju Dashboard is licensed under the LGPLv3 by Canonical Ltd.


Want to work on projects like this? We're hiring!

With ♥ from Canonical