Skip to content

Commit 9a1f32a

Browse files
[release-1.4] RHIDP-4485: Topology plugin code block formatting (redhat-developer#993)
* Removed the extra lines and formatted the code block * minor change * Fabrice's comments * Incorporated Lindsey's comments * Incorporated Fabrice's comments * Incorporated Fabrice's comments * replaced link to xref * Minor changes * Minor changes --------- Co-authored-by: Priyanka Abel <[email protected]>
1 parent 0c6ce6f commit 9a1f32a

4 files changed

+44
-18
lines changed

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

+1-1
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/dynamic-plugins/assembly-using-topology-plugin.adoc[leveloffset=+1]
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-enable-users-to-use-topology-plugin.adoc[leveloffset=+1]
9+
10+
include::../modules/dynamic-plugins/proc-using-topology-plugin.adoc[leveloffset=+1]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
[id="enable-users-to-use-the-topology-plugin"]
2+
= Enable 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.
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,11 @@
1+
[id="using-the-topology-plugin"]
12
= Using the Topology plugin
2-
Topology is a front-end plugin that enables you to view the workloads as nodes that power any service on the Kubernetes cluster.
33

44
.Prerequisites
5-
* You have installed the Red Hat Developer Hub (RHDH).
5+
* Your {product} instance is installed and running.
66
* You have installed the Topology plugin.
77
//For the installation process, see Installation.
8-
* If the 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:
9-
+
10-
[source,bash]
11-
----
12-
g, user:default/<YOUR_USERNAME>, role:default/topology-viewer
13-
p, role:default/topology-viewer, topology.view.read, read, allow
14-
p, role:default/topology-viewer, kubernetes.proxy, use, allow
15-
p, role:default/topology-viewer, catalog-entity, read, allow
16-
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.
17-
----
8+
* You have xref:enable-users-to-use-the-topology-plugin[enabled the users to use the Topology plugin].
189

1910
.Procedure
2011

@@ -23,14 +14,14 @@ p, role:default/topology-viewer, topology.view.read, read, allow grants the user
2314
+
2415
image::rhdh-plugins-reference/topology-tab-user1.png[topology-user-1]
2516

26-
. Select a node and a pop-up appears on the right side, which contains two tabs: *Details* and *Resources*.
27-
28-
. The *Details* and *Resources* tabs contain the associated information and resources of the node.
17+
. Select a node and a pop-up appears on the right side that contains two tabs: *Details* and *Resources*.
18+
+
19+
The *Details* and *Resources* tabs contain the associated information and resources for the node.
2920
+
3021
image::rhdh-plugins-reference/topology-tab-user2.png[topology-user-2]
3122

32-
. Click on the *Open URL* button on the top of a node.
23+
. Click the *Open URL* button on the top of a node.
3324
+
3425
image::rhdh-plugins-reference/topology-tab-user3.png[topology-user-3]
3526
+
36-
When you click on the *Open URL* button, it allows you to access the associated *Ingresses* and runs your application in a new tab.
27+
Click the *Open URL* button to access the associated *Ingresses* and run your application in a new tab.

0 commit comments

Comments
 (0)