Skip to content

Commit

Permalink
feat(topology): small doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
PatAKnight committed May 21, 2024
1 parent 65463bd commit 6866e31
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions plugins/topology/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -337,15 +337,16 @@ Topology is a front-end plugin that enables you to view the workloads as nodes t

- Your Backstage application is installed and running.
- You have installed the Topology plugin. For the installation process, see [Installation](#installation).
- If RBAC permission framework is enabled, ensure adding the following permission policies in an external permission policies configuration file named `rbac-policy.csv` to allow the rbac admins or your desired user(s)/group(s) to access the topology plugin:
- If RBAC permission framework is enabled, ensure to add the following permission policies in an external permission policies configuration file named `rbac-policy.csv` to allow the rbac admins or your desired user(s)/group(s) to access the topology plugin:

```csv rbac-policy.csv
g, user:default/<YOUR_USERNAME>, role:default/topology-viewer
p, role:default/topology-viewer, topology.view.read, read, allow
p, role:default/topology-viewer, kubernetes.proxy, use, allow
p, role:default/topology-viewer, catalog-entity, read, allow
```

`p, role:default/topology-viewer, topology.view.read, read, allow` grants the user the ability to see the Topology panel. `p, role:default/topology-viewer, kubernetes.proxy, use, allow` grants the user the ability to view the pod logs.
`p, role:default/topology-viewer, topology.view.read, read, allow` grants the user the ability to see the Topology panel. `p, role:default/topology-viewer, kubernetes.proxy, use, allow` grants the user the ability to view the pod logs. `p, role:default/topology-viewer, catalog-entity, read, allow` grants the user the ability to see the catalog item.

#### Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ const TopologyViewWorkloadComponent = ({
) ? (
<TopologyEmptyState
title="Permission required"
description="To view Topology, contact your administrator to give you the topology.view.read permission"
description="To view Topology, contact your administrator to give you the topology.view.read and catalog.entity.read permissions"
/>
) : (
<VisualizationSurface state={{ selectedIds: [selectedId] }} />
Expand Down

0 comments on commit 6866e31

Please sign in to comment.