Skip to content

Commit c2b95fa

Browse files
feat(topology): add virtual machine visualization in topology (#2027)
* feat(topology-vm) : adding visuals for vm node on topology * feat(topology-vm) : adding unit tests * feat(topology-vm) : updating readme file * feat(toplogy-vm ) : opening sidebar on clicking on vm node * feat(topology-vm) : removing css changes * feat(topology-vm) : moving vm-types to separate file * feat(topology-vm) : merging vm and workload code into one in data transformer * feat(topology-vm) : removing unused var * feat(topology-vm) : showing vm on topology dev * feat(topology-vm) : removing unused field from mock vm data * feat(topology-vm) : updating readme Co-authored-by: Debsmita Santra <[email protected]> --------- Co-authored-by: Debsmita Santra <[email protected]>
1 parent 055a465 commit c2b95fa

File tree

16 files changed

+639
-25
lines changed

16 files changed

+639
-25
lines changed

plugins/topology/README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Topology plugin for Backstage
22

3-
The Topology plugin enables you to visualize the workloads such as Deployment, Job, Daemonset, Statefulset, CronJob, and Pods powering any service on the Kubernetes cluster.
3+
The Topology plugin enables you to visualize the workloads such as Deployment, Job, Daemonset, Statefulset, CronJob, Pods and Virtual Machines powering any service on the Kubernetes cluster.
44

55
## For administrators
66

@@ -110,6 +110,38 @@ The following permission must be granted to the [`ClusterRole`](https://backstag
110110
plural: 'taskruns'
111111
```
112112

113+
##### To view the Virtual Machines
114+
115+
- Ensure that read access is granted to the VirtualMachines resource in the [`ClusterRole`](https://backstage.io/docs/features/kubernetes/configuration#role-based-access-control). You can use the following code to do so:
116+
117+
```yaml
118+
...
119+
apiVersion: rbac.authorization.k8s.io/v1
120+
kind: ClusterRole
121+
metadata:
122+
name: backstage-read-only
123+
rules:
124+
...
125+
- apiGroups:
126+
- kubevirt.io
127+
resources:
128+
- virtualmachines
129+
verbs:
130+
- get
131+
- list
132+
```
133+
134+
- The following code must be added to the `kubernetes.customResources` property in the [`app-config.yaml`](https://backstage.io/docs/features/kubernetes/configuration#configuring-kubernetes-clusters) file to view the VirtualMachine nodes on the topology plugin:
135+
136+
```yaml
137+
kubernetes:
138+
...
139+
customResources:
140+
- group: 'kubevirt.io'
141+
apiVersion: 'v1'
142+
plural: 'virtualmachines'
143+
```
144+
113145
##### To enable the Source Code Editor
114146

115147
- Ensure that read access is granted to the `CheClusters` resource in the [`ClusterRole`](https://backstage.io/docs/features/kubernetes/configuration#role-based-access-control) as shown in the following example code:

0 commit comments

Comments
 (0)