🔌 UI Plugin: Application Topology

[serenamarie125]

Goal

The goal of this epic is to develop a new Backstage UI plugin in the Janus repo. This UI plugin should provide similar functionality from the Application Topology view in the OpenShift Developer Perspective of the console. The current Application Topology supports a large set of features.

This plugin will provide an initial set of features, which will continue to be enhanced, based on the success metrics of the initial version of this plugin, including customer feedback.

• The plugin will initially be view only
• The plugin will initially only provide the graph view
• The plugin will visualize information/status in real time
• The visual representations of objects from a shape and hierarchy standpoint will be consistent with what is shown in OpenShift today.
• Nodes will display a pod ring so that users are easily able to see the status of the pods associated with the workloads
• Provide a route decorator
• Side panel showing details of the kubernetes objects
• Resource tab in the side panel showing the associated resources
• Implement the GH and DevSpaces decorator (stretch)

What problem does this solve? Please describe.

• Users want to be able to see the status of the workloads associated with a service in your catalog which is deployed to any kubernetes cluster.
• Users want one click access to pod logs
• Users want one click access to run their application which is running on kubernetes

Features
Need to look into this further

• Provide a Topology tab on the entity page which provides the graph view of the application topology ( list view will. come later)
  OR
• Provide a Topology Card on that visualizes the directly related workloads of the current entity.
• Provide a Topology Page which can be access from the Topology Card, and is able to view the workloads associated with the current entity as well as workloads associated with their relations.

Use cases
Coming after spike review

Acceptance criteria
Coming after spike review

Issues in Epic

• App Topology - Visualize resources of the Deployment kind as readonly #85
• App Topology - Topology view in backstage plugin should update based on selected theme (Dark/Light/System) #89
• App Topology - Finalize on architecture for Topology-plugin #90
• App Topology - Evaluate connecting Topology (backstage plugin) with cluster #91
• App Topology - Integrate k8s plugin with topology plugin #105
• Test topology plugin with minikube cluster #118
• App Topology: Add filter resources by cluster functionality in Topology view #121
• App topology: Show sidebar for the selected resource in topology view #122
• App Topology: Show decorator in topology for ingress associated to any deployment #123
• UI Review of Topology UI plugin #109 (once initial PR has been merged)
• Spike: Explore PatternFly usage with Backstage #70
• Spike: Explore PatternFly Topology usage with Backstage #72
• App Topology: Visualization of statefulsets, daemonsets, cronJobs, Jobs in topology view #183
• App Topology: Show ingress rules in topology workload node sidebar #229
• Topology plugin: Doc review #132
• Topology plugin: user docs #306

Stakeholder sign-off

• QE
• Doc

Reference screenshots from OpenShift Application Topology

Topology graph view

Topology graph view with side panel showing kubernetes details

Topology graph view with side panel showing associated resources

[taras]

It might be worth looking at the Catalog Graph plugin

[serenamarie125]

@taras thanks for the reference. I've started to more clearly articulate the goals of this plugin, hope this helps.

[taras]

Thank you. They're similar but your mockups are much prettier. The Graph plugin hasn't gotten a lot of love since it was created. What you folks are planning is exciting!

[serenamarie125]

FYI @invincibleJai note that I added #250 as a stretch

[invincibleJai]

@serenamarie125 / @rtaniwa we need to update this epic to move #250 to Topology V2 , as we discussed

[rtaniwa]

@serenamarie125 / @rtaniwa we need to update this epic to move #250 to Topology V2 , as we discussed

Done!

[rtaniwa]

@josephca @rnapoles-rh can one of you sign off for QE.
@hmanwani-rh @rkratky can one of you sign off for doc?