Skip to content

Commit 2e8af42

Browse files
Gerry-FordeGerry-Forde
authored
HIDP-3440-plugins-1-3-using-dynamic-plugins Manual cherrypick (#573)
1 parent 654aa82 commit 2e8af42

File tree

9 files changed

+197
-5
lines changed

9 files changed

+197
-5
lines changed

‎artifacts/rhdh-plugins-reference/argocd/argocd-plugin-user.adoc‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
= Using the Argo CD plugin
2+
3+
You can use the Argo CD plugin to visualize the Continuous Delivery (CD) workflows in OpenShift GitOps. This plugin provides a visual overview of the application’s status, deployment details, commit message, author of the commit, container image promoted to environment and deployment history.
4+
5+
.Prerequisites
6+
7+
* You have enabled the Argo CD plugin in {product} {product-very-short}.
8+
9+
.Procedures
10+
11+
. Select the *Catalog* tab and choose the component that you want to use.
12+
13+
. Select the *CD* tab to view insights into deployments managed by Argo CD.
14+
15+
+
16+
image::rhdh-plugins-reference/argocd.png[CD tab Argo CD]
17+
18+
. Select an appropriate card to view the deployment details (for example, commit message, author name, and deployment history).
19+
20+
+
21+
image::rhdh-plugins-reference/sidebar.png[Sidebar]
22+
23+
.. Click the link icon (image:rhdh-plugins-reference/link.png[Link icon]) to open the deployment details in Argo CD.
24+
25+
. Select the *Overview* tab and navigate to the Deployment summary section to review the summary of your application's deployment across namespaces. Additionally, select an appropriate Argo CD app to open the deployment details in Argo CD, or select a commit ID from the Revision column to review the changes in GitLab or GitHub.
26+
27+
+
28+
image::rhdh-plugins-reference/deployment_summary.png[Deployment summary]
29+
30+
31+
[role="_additional-resources"]
32+
.Additional resources
33+
34+
* For more information on dynamic plugins, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/configuring_plugins_in_red_hat_developer_hub/rhdh-installing-dynamic-plugins[Dynamic plugin installation].

‎artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-user.adoc‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
[id="rhdh-keycloak_{context}"]
2+
= Using Keycloak
3+
4+
The Keycloak backend plugin, which integrates Keycloak into {product-short}, has the following capabilities:
5+
6+
* Synchronization of Keycloak users in a realm.
7+
* Synchronization of Keycloak groups and their users in a realm.
8+
9+
== Importing users and groups in {product-short} using the Keycloak plugin
10+
11+
After configuring the plugin successfully, the plugin imports the users and groups each time when started.
12+
13+
[NOTE]
14+
====
15+
If you set up a schedule, users and groups will also be imported.
16+
====
17+
18+
After the first import is complete, you can select *User* to list the users from the catalog page:
19+
20+
image::rhdh-plugins-reference/users.jpg[catalog-list]
21+
22+
You can see the list of users on the page:
23+
24+
image::rhdh-plugins-reference/user-list.jpg[user-list]
25+
26+
When you select a user, you can see the information imported from Keycloak:
27+
28+
image::rhdh-plugins-reference/user2.jpg[user-profile]
29+
30+
You can also select a group, view the list, and select or view the information imported from Keycloak for a group:
31+
32+
image::rhdh-plugins-reference/group1.jpg[group-profile]

‎artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-user.adoc‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
= Using the Nexus Repository Manager plugin
2+
3+
The Nexus Repository Manager plugin displays the information about your build artifacts in your {product-short} application. The build artifacts are available in the Nexus Repository Manager.
4+
5+
[IMPORTANT]
6+
====
7+
The Nexus Repository Manager plugin is a Technology Preview feature only.
8+
9+
Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
10+
11+
For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Scope].
12+
13+
Additional detail on how Red Hat provides support for bundled community dynamic plugins is available on the https://access.redhat.com/policy/developerhub-support-policy[Red Hat Developer Support Policy] page.
14+
====
15+
16+
The Nexus Repository Manager is a front-end plugin that enables you to view the information about build artifacts.
17+
18+
.Prerequisites
19+
20+
- Your {product-short} application is installed and running.
21+
- You have installed the Nexus Repository Manager plugin.
22+
//For the installation process, see xref:installing-configuring-nexus-plugin[Installing and configuring the Nexus Repository Manager plugin].
23+
24+
.Procedure
25+
26+
1. Open your {product-short} application and select a component from the *Catalog* page.
27+
2. Go to the *BUILD ARTIFACTS* tab.
28+
+
29+
--
30+
The *BUILD ARTIFACTS* tab contains a list of build artifacts and related information, such as *VERSION*, *REPOSITORY*, *REPOSITORY TYPE*, *MANIFEST*, *MODIFIED*, and *SIZE*.
31+
32+
image::rhdh-plugins-reference/nexus-repository-manager.png[nexus-repository-manager-tab]
33+
--

‎artifacts/rhdh-plugins-reference/tekton/tekton-plugin-user.adoc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[[installation-and-configuration-tekton]]
2+
= Using the Tekton plugin
3+
4+
You can use the Tekton plugin to visualize the results of CI/CD pipeline runs on your Kubernetes or OpenShift clusters. The plugin allows users to visually see high level status of all associated tasks in the pipeline for their applications.
5+
6+
You can use the Tekton front-end plugin to view `PipelineRun` resources.
7+
8+
.Prerequisites
9+
* You have installed the Red Hat Developer Hub (RHDH).
10+
* You have installed the Tekton plugin. For the installation process, see xref:installation-and-configuration-tekton[Installing and configuring the Tekton plugin].
11+
12+
.Procedure
13+
. Open your RHDH application and select a component from the *Catalog* page.
14+
. Go to the *CI* tab.
15+
+
16+
The *CI* tab displays the list of PipelineRun resources associated with a Kubernetes cluster. The list contains pipeline run details, such as *NAME*, *VULNERABILITIES*, *STATUS*, *TASK STATUS*, *STARTED*, and *DURATION*.
17+
+
18+
image::rhdh-plugins-reference/tekton-plugin-pipeline.png[ci-cd-tab-tekton]
19+
20+
. Click the expand row button besides PipelineRun name in the list to view the PipelineRun visualization. The pipeline run resource includes tasks to complete. When you hover the mouse pointer on a task card, you can view the steps to complete that particular task.
21+
+
22+
image::rhdh-plugins-reference/tekton-plugin-pipeline-expand.png[ci-cd-tab-tekton]

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

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,20 @@
11
[id="rhdh-using-rhdh-plugins_{context}"]
2-
= Using {product-very-short} plugins
2+
= Using dynamic plugins
33

4-
//include::../modules/dynamic-plugins/con-rhdh-plugins.adoc[leveloffset=+1]
4+
// Ansible
5+
include::../modules/dynamic-plugins/con-ansible-plugin-user.adoc[leveloffset=+1]
6+
7+
// Argo CD
8+
include::../../artifacts/rhdh-plugins-reference/argocd/argocd-plugin-user.adoc[leveloffset=+1]
9+
10+
// Keycloak
11+
include::../../artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-user.adoc[leveloffset=+1]
12+
13+
// Nexus
14+
include::../../artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-user.adoc[leveloffset=+1]
15+
16+
// Tekton
17+
include::../../artifacts/rhdh-plugins-reference/tekton/tekton-plugin-user.adoc[leveloffset=+1]
18+
19+
// Topology
20+
include::../../modules/dynamic-plugins/proc-using-topology-plugin.adoc[leveloffset=+1]

‎modules/dynamic-plugins/con-ansible-plugin-user.adoc‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
= Using Ansible plug-ins for {product}
2+
3+
Ansible plug-ins for {product} deliver an Ansible-specific portal experience with curated learning paths,
4+
push-button content creation, integrated development tools, and other opinionated resources.
5+
6+
[IMPORTANT]
7+
====
8+
The Ansible plug-ins are a Technology Preview feature only.
9+
10+
Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
11+
12+
For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Scope].
13+
14+
Additional detail on how Red Hat provides support for bundled community dynamic plugins is available on the https://access.redhat.com/policy/developerhub-support-policy[Red Hat Developer Support Policy] page.
15+
====
16+
17+
To use the Ansible plugins, see
18+
link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/using_ansible_plug-ins_for_red_hat_developer_hub/index[_Using Ansible plug-ins for Red Hat Developer Hub_].
19+

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
= 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.
3+
4+
.Prerequisites
5+
* You have installed the Red Hat Developer Hub (RHDH).
6+
* You have installed the Topology plugin.
7+
//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+
----
18+
19+
.Procedure
20+
21+
. Open your {product-very-hort} application and select a component from the *Catalog* page.
22+
. Go to the *TOPOLOGY* tab and you can view the workloads such as deployments or pods as nodes.
23+
+
24+
image::rhdh-plugins-reference/topology-tab-user1.png[topology-user-1]
25+
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.
29+
+
30+
image::rhdh-plugins-reference/topology-tab-user2.png[topology-user-2]
31+
32+
. Click on the *Open URL* button on the top of a node.
33+
+
34+
image::rhdh-plugins-reference/topology-tab-user3.png[topology-user-3]
35+
+
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.

‎titles/plugins-rhdh-using/docinfo.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<title>{title}</title>
22
<productname>{product}</productname>
33
<productnumber>{product-version}</productnumber>
4-
<subtitle>{subtitle}
4+
<subtitle>
55
</subtitle>
66
<abstract>
77
<para>{abstract}</para>

‎titles/plugins-rhdh-using/master.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ include::artifacts/attributes.adoc[]
22
:context: title-plugins-rhdh-using
33
:doctype: book
44
:imagesdir: images
5-
:title: Using {product} plugins
5+
:title: Using dynamic plugins
66
:subtitle: Using {product-very-short} plugins as an end-user
7-
:abstract: This document describes how end-users can use dynamic plugins in {product-very-short}.
7+
:abstract: The following sections provide information about how you can use {product-very-short} dynamic plugins.
88
//[id="{context}"]
99
//= {title}
1010

0 commit comments

Comments
 (0)