Skip to content

Commit 4ca6dce

Browse files
committed
Incorporated Fabrice's comments
1 parent 848df04 commit 4ca6dce

File tree

4 files changed

+38
-31
lines changed

4 files changed

+38
-31
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: using-topology-plugin
3+
[id="{context}"]
4+
= Using the Topology plugin
5+
6+
Topology is a front-end plugin that enables you to view the workloads as nodes that power any service on the Kubernetes cluster.
7+
8+
include::modules/dynamic-plugins/proc-enabling-users-to-use-topology-plugin.adoc[leveloffset=+1]
9+
10+
include::modules/dynamic-plugins/proc-using-topology-plugin.adoc[leveloffset=+1]

assemblies/dynamic-plugins/assembly-using-rhdh-plugins.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ include::../../artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-r
2020
include::../../artifacts/rhdh-plugins-reference/tekton/tekton-plugin-user.adoc[leveloffset=+1]
2121

2222
// Topology
23-
include::../../modules/dynamic-plugins/proc-using-topology-plugin.adoc[leveloffset=+1]
23+
include::../../assemblies/assembly-using-topology-plugin.adoc[leveloffset=+1]
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
[id="enabling-users-to-use-the-topology-plugin"]
2+
= Enabling users to use the Topology plugin
3+
4+
The Topology plugin is defining additional permissions. When link:{authorization-book-url}[{authorization-book-title}] is enabled, to enable users to use the Topology plugin, grant them:
5+
6+
* The `topology.view.read` `read` permission to view the Topology panel.
7+
* The `kubernetes.proxy` `use` permission to view the pod logs.
8+
* The `catalog-entity` `read` permission to view the {product} software catalog items.
9+
10+
.Prerequisites
11+
* You are link:{authorization-book-url}#managing-authorizations-by-using-external-files[managing {authorization-book-title} by using external files].
12+
13+
.Procedure
14+
* Add the following permission policies to your `rbac-policy.csv` file to create a `topology-viewer` role that has access to the Topology plugin features, and add the role to the users requiring this authorization:
15+
+
16+
[source]
17+
----
18+
g, user:default/<YOUR_USERNAME>, role:default/topology-viewer
19+
p, role:default/topology-viewer, topology.view.read, read, allow <1>
20+
p, role:default/topology-viewer, kubernetes.proxy, use, allow <2>
21+
p, role:default/topology-viewer, catalog-entity, read, allow <3>
22+
----
23+
<1> Grants the user the ability to see the Topology panel.
24+
<2> Grants the user the ability to view the pod logs.
25+
<3> Grants the user the ability to see the catalog item.

modules/dynamic-plugins/proc-using-topology-plugin.adoc

Lines changed: 2 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,11 @@
1+
[id="using-the-topology-plugin"]
12
= Using the Topology plugin
23

3-
Topology is a front-end plugin that enables you to view the workloads as nodes that power any service on the Kubernetes cluster.
4-
5-
== Enabling users to use the Topology plugin
6-
7-
The Topology plugin is defining additional permissions. When link:{authorization-book-url}[{autorization-book-title}] is enabled, to enable users to use the Topology plugin, grant them:
8-
9-
* The `topology.view.read` `read` permission to view the Topology panel.
10-
* The `kubernetes.proxy` `use` permission to view the pod logs.
11-
* The `catalog-entity` `read` permission to view the {product} software catalog items.
12-
13-
.Prerequisites
14-
* You are link:{authorization-book-url}#managing-authorizations-by-using-external-files[managing {autorization-book-title} by using external files].
15-
16-
.Procedure
17-
* Add the following permission policies to your `rbac-policy.csv` file to create a `topology-viewer` role that has access to the Topology plugin features, and add the role to the users requiring this authorization:
18-
19-
== Using the Topology plugin
20-
214
.Prerequisites
225
* Your {product} instance is installed and running.
236
* You have installed the Topology plugin.
247
//For the installation process, see Installation.
25-
* You have enabled the users to use the Topology plugin.
26-
+
27-
[source]
28-
----
29-
g, user:default/<YOUR_USERNAME>, role:default/topology-viewer
30-
p, role:default/topology-viewer, topology.view.read, read, allow <1>
31-
p, role:default/topology-viewer, kubernetes.proxy, use, allow <2>
32-
p, role:default/topology-viewer, catalog-entity, read, allow <3>
33-
----
34-
<1> Grants the user the ability to see the Topology panel.
35-
<2> Grants the user the ability to view the pod logs.
36-
<3> Grants the user the ability to see the catalog item.
8+
* You have link:{plugins-configure-book-url}#proc-enabling-users-to-use-topology-plugin.adoc[enabled the users to use the Topology plugin].
379

3810
.Procedure
3911

0 commit comments

Comments
 (0)