Chapter 7. Install the Topology plugin

Procedure

1. To view OpenShift routes, grant read access to the routes resource in the ClusterRole:

     apiVersion: rbac.authorization.k8s.io/v1
     kind: ClusterRole
     metadata:
       name: backstage-read-only
     rules:
       ...
       - apiGroups:
           - route.openshift.io
         resources:
           - routes
         verbs:
           - get
           - list

2. Also add the following in kubernetes.customResources property in your app-config.yaml file:

   kubernetes:
       ...
       customResources:
         - group: 'route.openshift.io'
           apiVersion: 'v1'
           	  plural: 'routes'

Procedure

1. To view the Tekton PipelineRuns, grant read access to the pipelines, pipelineruns, and taskruns resources in the ClusterRole:

    ...
     apiVersion: rbac.authorization.k8s.io/v1
     kind: ClusterRole
     metadata:
       name: backstage-read-only
     rules:
       ...
       - apiGroups:
           - tekton.dev
         resources:
           - pipelines
           - pipelineruns
           - taskruns
         verbs:
           - get
           - list

2. To view the Tekton PipelineRuns list in the side panel and the latest PipelineRuns status in the Topology node decorator, add the following code to the kubernetes.customResources property in your app-config.yaml file:

   kubernetes:
       ...
       customResources:
         - group: 'tekton.dev'
           apiVersion: 'v1'
           plural: 'pipelines'
         - group: 'tekton.dev'
           apiVersion: 'v1'
           plural: 'pipelineruns'
         - group: 'tekton.dev'
           apiVersion: 'v1'
           plural: 'taskruns'

Procedure

1. Grant read access to the VirtualMachines resource in the ClusterRole:

    ...
     apiVersion: rbac.authorization.k8s.io/v1
     kind: ClusterRole
     metadata:
       name: backstage-read-only
     rules:
       ...
       - apiGroups:
           - kubevirt.io
         resources:
           - virtualmachines
           - virtualmachineinstances
         verbs:
           - get
           - list

2. To view the virtual machine nodes on the topology plugin, add the following code to the kubernetes.customResources property in the app-config.yaml file:

   kubernetes:
       ...
       customResources:
         - group: 'kubevirt.io'
           apiVersion: 'v1'
           plural: 'virtualmachines'
         - group: 'kubevirt.io'
           apiVersion: 'v1'
           plural: 'virtualmachineinstances'

Procedure

1. Grant read access to the CheClusters resource in the ClusterRole:

    ...
     apiVersion: rbac.authorization.k8s.io/v1
     kind: ClusterRole
     metadata:
       name: backstage-read-only
     rules:
       ...
       - apiGroups:
           - org.eclipse.che
         resources:
           - checlusters
         verbs:
           - get
           - list

2. Add the following configuration to the kubernetes.customResources property in your app-config.yaml file:

    kubernetes:
       ...
       customResources:
         - group: 'org.eclipse.che'
           apiVersion: 'v2'
           plural: 'checlusters'

Procedure

1. Add the following annotations to workload resources, such as Deployments, to navigate to the Git repository of the associated application using the source code editor:

   annotations:
     app.openshift.io/vcs-uri: <GIT_REPO_URL>

2. Optional: Add the following annotation to navigate to a specific branch:

   annotations:
     app.openshift.io/vcs-ref: <GIT_REPO_BRANCH>

3. Optional: Add the app.openshift.io/edit-link annotation with the edit URL that you want to access using the decorator.

   Note

   If Red Hat OpenShift Dev Spaces is installed and configured and Git URL annotations are also added to the workload YAML file, then clicking on the edit code decorator redirects you to the Red Hat OpenShift Dev Spaces instance.

   Note

   When you deploy your application using the OCP Git import flows, you do not need to add the labels as import flows do that. Otherwise, you need to add the labels manually to the workload YAML file.

Procedure

1. Add the following annotation to the catalog-info.yaml file of the entity:

   annotations:
     backstage.io/kubernetes-id: <BACKSTAGE_ENTITY_NAME>

2. Add the following label to the resources so that the Kubernetes plugin gets the Kubernetes resources from the requested entity:

   labels:
     backstage.io/kubernetes-id: <BACKSTAGE_ENTITY_NAME>

   Note

   When using the label selector, the mentioned labels must be present on the resource.

Procedure

1. Add the backstage.io/kubernetes-label-selector annotation to the catalog-info.yaml file of the entity. The label selector takes precedence over the ID annotations:

   annotations:
     backstage.io/kubernetes-label-selector: 'app=my-app,component=front-end'

2. Optional: If you have many entities while Red Hat Dev Spaces is configured and want multmanyities to support the edit code decorator that redirects to the Red Hat Dev Spaces instance, add the backstage.io/kubernetes-label-selector annotation to the catalog-info.yaml file for each entity:

   annotations:
     backstage.io/kubernetes-label-selector: 'component in (<BACKSTAGE_ENTITY_NAME>,che)'

3. If you are using the previous label selector, add the following labels to your resources so that the Kubernetes plugin gets the Kubernetes resources from the requested entity:

   labels:
     component: che # add this label to your che cluster instance
   labels:
     component: <BACKSTAGE_ENTITY_NAME> # add this label to the other resources associated with your entity

   You can also write your own custom query for the label selector with unique labels to differentiate your entities. However, you need to ensure that you add those labels to the resources associated with your entities including your CheCluster instance.