-
Notifications
You must be signed in to change notification settings - Fork 45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add documentation for Radius Dashboard #1047
Changes from 4 commits
4bc0373
ef9b859
e1a2646
a2f2edf
da1d7e4
eba64f9
29b204d
798ce74
c88562f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
type: docs | ||
title: "Radius dashboard" | ||
linkTitle: "Dashboard" | ||
description: "Documentation on the Radius dashboard" | ||
weight: 100 | ||
--- |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
type: docs | ||
title: "Overview: Radius Dashboard" | ||
linkTitle: "Overview" | ||
description: "Learn about using the Radius Dashboard to visualize your application graph, environments, and recipes" | ||
weight: 100 | ||
categories: "Overview" | ||
tags: ["dashboard"] | ||
--- | ||
|
||
Radius Dashboard is the frontend experience for Radius and built on [Backstage](https://backstage.io/), 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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Small nit: do we want to call this "Radius Dashboard", or "The Radius Dashboard"? The latter seems more natural to me, but overall I'm good with both There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This first paragraph goes straight into implementation details which end-users may not necessarily care about. Instead, maybe the first paragraph should focus on why the Dashboard is useful to users, and then we have a dedicated section on implementation? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I like it, updated to reflect your suggestion. |
||
|
||
Key features of the Radius Dashboard currently include: | ||
|
||
- _Application graph visualization_: A visualization of the [application graph]({{< ref "guides/author-apps/application/overview#query-and-understand-your-application-with-the-radius-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]({{< ref "guides/author-apps/application/overview" >}}), [environments]({{< ref "guides/deploy-apps/environments/overview" >}}), and infrastructure. | ||
- _Recipes directory_: A listing of all the Radius [Recipes]({{< ref "guides/recipes/overview" >}}) available to the user for a given environment. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Instead of italics for the main points, I think bold text would look better here. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. good suggestion, updated |
||
|
||
{{< alert title="Dashboard installation" color="warning" >}} | ||
The Radius Dashboard is installed by default as a part of your Radius initialization and deployment. To opt-out of installing the dashboard, you can use the `--set dashboard.enabled=false` flag when running `rad install kubernetes`. See more instructions in the [CLI reference documentation]({{< ref "/reference/cli" >}}). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we want to point to the CLI reference here? Would the installation docs make more sense? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. agreed, updated |
||
{{< /alert >}} | ||
|
||
When you run your application with the `rad run` command, Radius creates a port-forward from `localhost` to port `7007` inside the container that you may use to access your Radius Dashboard. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we add some headers to break up this page into sections? Looks like we have Overview, Key Features, Usage, and Reference documentation. Will help break up large chunks of text. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. good suggestion, updated |
||
|
||
Alternatively, you can manually create a port-forward from `localhost` to the port number of your choice to provide access to your Radius Dashboard: | ||
|
||
```bash | ||
kubectl port-forward --namespace=radius-system svc/dashboard 7007:80 | ||
``` | ||
|
||
{{< image src="dashboard-home.png" alt="screenshot of an example Radius Dashboard home page" width=800 >}} | ||
|
||
## Reference documentation | ||
|
||
Visit the [API reference documentation]({{< ref "concepts/technical/api" >}}) to learn more about the underlying [Radius Application Graph]({{< ref "guides/author-apps/application/overview#query-and-understand-your-application-with-the-radius-application-graph" >}}) data on which the dashboard visualizations are built. | ||
|
||
{{< button text="API reference" page="concepts/technical/api" >}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the getting started guide, the environment name and application name are well known. Can we deep-link directly into the application graph page to drop the user directly into the application graph, so that they instantly go from authoring their app to seeing their app without needing to pause and navigate the UI?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
great idea, i've modified the link here to be deep-linked