/radius-dashboard

Frontend experience for Project Radius

Primary LanguageTypeScript

Radius Dashboard

Radius Dashboard is the frontend experience for Radius, a cloud-native application platform that enables developers and the platform engineers that support them to collaborate on delivering and managing cloud-native applications that follow organizational best practices for cost, operations and security, by default. Radius is an open-source project that supports deploying applications across private cloud, Microsoft Azure, and Amazon Web Services, with more cloud providers to come.

NOTE: Radius Dashboard is currently in a prototype stage and thus is not yet packaged into Radius and its releases, though we are planning to add it to the Radius installation soon. The best way to use Radius Dashboard right now is to manually install it in your cluster, or clone the repo and run it locally. See the contribution guide for instructions on how to build and run the code.

The Radius Dashboard is built on Backstage, an open-source platform for building developer portals that provides a rich set of components to accelerate UI development. The Radius Dashboard is a skinned deployment of Backstage that includes a set of plugins that provide the Radius experience. The components that make up the dashboard are built with extensibility in mind so that they can be used in other contexts beyond Backstage in the future.

Key features of the Radius Dashboard currently include:

  • Application graph visualization: A visualization of the application graph that shows how resources within an application are connected to each other and the underlying infrastructure.
  • Resource overview and details: Detailed information about resources within Radius, including applications, environments, and infrastructure.
  • Recipes directory: A listing of all the Radius Recipes available to the user for a given environment.

Kubernetes installation

NOTE: The Radius Dashboard is currently in a prototype stage and is distributed separately from the main Radius project. The best way to use Radius Dashboard right now is to manually install it in your cluster:

  1. Make sure you have a Kubernetes cluster running and kubectl installed and configured to point to your cluster.

  2. Ensure you have Radius installed and running in your cluster. If you don't have Radius installed, you can follow the Radius installation guide

  3. Apply the Radius Dashboard manifest to your cluster:

    kubectl apply -f https://raw.githubusercontent.com/radius-project/dashboard/main/deploy/dashboard.yaml
  4. Once the manifest is applied and the resources are created, port-forward the dashboard service to your local machine:

    kubectl port-forward --namespace=radius-system svc/dashboard 3000:80
  5. Access the dashboard at http://localhost:3000

Getting help

  • Have a question? - Visit our Discord server to post your question and we'll get back to you ASAP
  • ⚠️ Found an issue? - Refer to our Issues guide for instructions on filing a bug report
  • 💡 Have a proposal? - Refer to our Issues guide for instructions on filing a feature request

Contributing to Radius Dashboard

Visit Contributing for more information on how to contribute to Radius Dashboard.

Community

We welcome your contributions and suggestions! One of the easiest ways to contribute is to participate in Issue discussions, chat on Discord server or the monthly community calls. For more information on the community engagement, developer and contributing guidelines and more, head over to the Radius community repo.

Repositories

Dashboard is the Radius Dashboard repository. It contains all of Dashboard code and documentation. In addition, the Radius project has the below repositories:

Repo Description
Radius This is the main Radius repository that contains the source code for core Radius.
Docs This repository contains the Radius documentation source for Radius.
Samples This repository contains the source code for quickstarts, reference apps, and tutorials for Radius.
Recipes This repo contains commonly used Recipe templates for Radius Environments.
Website This repository contains the source code for the Radius website.
Bicep This repository contains source code for Bicep, which is a DSL for deploying cloud resources types.
AWS Bicep Types This repository contains the tooling for Bicep support for AWS resource types.

Security

Please refer to our guide on Reporting security vulnerabilities.

Code of conduct

Please refer to our Radius Community Code of Conduct