Skip to content

Commit d6e8be0

Browse files
openshift-cherrypick-robotGerry-Fordejmagak
authored
[release-1.7] RHIDP-7472-1 - Modularize plugins content in artifacts/rhdh-plugins-reference (#1363)
* RHIDP-7472-1 - Modularize plugins content in artifacts/rhdh-plugins-reference * Modularize plugins content in artifacts/rhdh-plugins-reference: * RHIDP-7472-1 - iodularize plugins content in artifacts/rhdh-plugins-reference * Modularize plugins content in artifacts/rhdh-plugins-reference * RHIDP-7472-1 - Modularize plugins content in artifacts/rhdh-plugins-reference * RHIDP-7472-1 - Modularize plugins content in artifacts/rhdh-plugins-reference * RHIDP-7472-1 - Modularize plugins content in artifacts/rhdh-plugins-reference * Update modules/dynamic-plugins/proc-configuring-the-jfrog-plugin.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-configuring-the-jfrog-plugin.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-enabling-the-tekton-plugin.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-enabling-the-tekton-plugin.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-enabling-the-tekton-plugin.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-enabling-argo-cd-rollouts.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/ref-configuring-the-keycloak-plugin.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/ref-configuring-the-keycloak-plugin.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/ref-configuring-the-keycloak-plugin.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/ref-configuring-the-keycloak-plugin.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-using-tekton.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-using-tekton.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-enabling-the-tekton-plugin.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-using-nexus.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-enabling-argo-cd-rollouts.adoc Co-authored-by: Judith Magak <[email protected]> * Update assemblies/dynamic-plugins/assembly-enabling-configuring-nexus.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-configuring-the-nexus-plugin.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-enabling-argo-cd-rollouts.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/dynamic-plugins/proc-enabling-argo-cd-rollouts.adoc Co-authored-by: Judith Magak <[email protected]> --------- Co-authored-by: Gerry-Forde <[email protected]> Co-authored-by: Judith Magak <[email protected]>
1 parent 4318a48 commit d6e8be0

21 files changed

+915
-26
lines changed

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

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
11
[id="rhdh-configuring-rhdh-plugins_{context}"]
22
= Configuring dynamic plugins in {product}
33

4-
// Ansible
4+
// Ansible - no-change
55
include::../modules/dynamic-plugins/con-ansible-plugin-admin.adoc[leveloffset=+1]
66

7-
// Argo CD
8-
include::../../artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc[leveloffset=+1]
7+
// Argo CD - modularized
8+
include::assembly-installing-configuring-argo-cd.adoc[leveloffset=+1]
99

10-
//JFrog Artifactory
11-
include::../../artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-artifactory-plugin-admin.adoc[leveloffset=+1]
10+
// JFrog Artifactory
11+
include::assembly-enabling-configuring-jfrog.adoc[leveloffset=+1]
1212

13-
// Keycloak
14-
include::../../artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-admin.adoc[leveloffset=+1]
13+
// Keycloak - modularized
14+
include::assembly-enabling-configuring-keycloak.adoc[leveloffset=+1]
1515

16-
// Nexus
17-
include::../../artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-admin.adoc[leveloffset=+1]
16+
// Nexus - modularized
17+
include::assembly-enabling-configuring-nexus.adoc[leveloffset=+1]
1818

19-
// Tekton
20-
include::../../artifacts/rhdh-plugins-reference/tekton/tekton-plugin-admin.adoc[leveloffset=+1]
19+
// Tekton - modularized
20+
include::../../modules/dynamic-plugins/proc-enabling-the-tekton-plugin.adoc[leveloffset=+1]
2121

22-
// Topology
23-
include::../dynamic-plugins/assembly-install-topology-plugin.adoc[leveloffset=+1]
22+
// Topology - no-change
23+
include::assembly-install-topology-plugin.adoc[leveloffset=+1]
2424

25-
// Overriding Core Backend Service Configuration
26-
include::../modules/dynamic-plugins/proc-overriding-core-backend-services.adoc[leveloffset=+1]
25+
include::../assembly-using-servicenow.adoc[leveloffset=+1]
26+
27+
include::../assembly-using-kubernetes-custom-actions.adoc[leveloffset=+1]
28+
29+
include::../../modules/dynamic-plugins/proc-overriding-core-backend-services.adoc[leveloffset=+1]

‎assemblies/dynamic-plugins/assembly-enabling-configuring-jfrog.adoc‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="assembly-enabling-configuring-the-jfrog-plugin_{context}"]
3+
= Enabling and configuring the JFrog plugin
4+
:context: assembly-installing-configuring-jfrog
5+
6+
JFrog Artifactory is a front-end plugin that displays the information about your container images stored in the JFrog Artifactory repository. The JFrog Artifactory plugin is preinstalled with {product-short} and disabled by default. To use it, you need to enable and configure it first.
7+
8+
[IMPORTANT]
9+
====
10+
The JFrog Artifactory plugin is a Technology Preview feature only.
11+
12+
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.
13+
14+
For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Scope].
15+
16+
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.
17+
====
18+
19+
include::../modules/dynamic-plugins/proc-enabling-the-jfrog-plugin.adoc[leveloffset=+1]
20+
21+
include::../modules/dynamic-plugins/proc-configuring-the-jfrog-plugin.adoc[leveloffset=+1]

‎assemblies/dynamic-plugins/assembly-enabling-configuring-keycloak.adoc‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="assembly-enabling-configuring-the-keycloak-plugin_{context}"]
3+
= Enabling and configuring the Keycloak plugin
4+
:context: assembly-installing-configuring-keycloak
5+
6+
The Keycloak backend plugin, which integrates Keycloak into {product-short}, has the following capabilities:
7+
8+
* Synchronization of Keycloak users in a realm.
9+
* Synchronization of Keycloak groups and their users in a realm.
10+
11+
[NOTE]
12+
====
13+
The supported {rhbk-brand-name} ({rhbk}) version is `{keycloak-version}`.
14+
====
15+
16+
include::../modules/dynamic-plugins/proc-enabling-the-keycloak-plugin.adoc[leveloffset=+1]
17+
18+
include::../modules/dynamic-plugins/ref-configuring-the-keycloak-plugin.adoc[leveloffset=+1]

‎assemblies/dynamic-plugins/assembly-enabling-configuring-nexus.adoc‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="assembly-enabling-configuring-the-nexus-plugin_{context}"]
3+
= Enabling and configuring the Nexus Repository Manager plugin
4+
:context: assembly-installing-configuring-nexus
5+
6+
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.
7+
8+
[IMPORTANT]
9+
====
10+
The Nexus Repository Manager plugin is a Technology Preview feature only.
11+
12+
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.
13+
14+
For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Scope].
15+
16+
Additional detail on how {company-name} 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.
17+
====
18+
19+
include::../modules/dynamic-plugins/proc-enabling-the-nexus-plugin.adoc[leveloffset=+1]
20+
21+
include::../modules/dynamic-plugins/proc-configuring-the-nexus-plugin.adoc[leveloffset=+1]

‎assemblies/dynamic-plugins/assembly-install-topology-plugin.adoc‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,4 @@ include::../modules/dynamic-plugins/proc-topology-install.adoc[leveloffset=+2]
55

66
include::../assembly-topology-plugin-configure.adoc[leveloffset=+1]
77

8-
include::../assembly-managing-labels-annotations-topology.adoc[leveloffset=+1]
9-
10-
11-
include::../assembly-using-servicenow.adoc[leveloffset=+1]
12-
13-
include::../assembly-using-kubernetes-custom-actions.adoc[leveloffset=+1]
8+
include::../assembly-managing-labels-annotations-topology.adoc[leveloffset=+1]

‎assemblies/dynamic-plugins/assembly-installing-configuring-argo-cd.adoc‎

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+
[id="assembly-installing-configuring-argo-cd.adoc_{context}"]
3+
= Installing and configuring Argo CD
4+
:context: assembly-installing-configuring-argo-cd
5+
6+
You can use the Argo CD plugin to visualize the Continuous Delivery (CD) workflows in OpenShift GitOps.
7+
8+
include::../modules/dynamic-plugins/proc-enabling-the-argo-cd-plugin.adoc[leveloffset=+1]
9+
10+
include::../modules/dynamic-plugins/proc-enabling-argo-cd-rollouts.adoc[leveloffset=+1]

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,20 @@
55
include::../modules/dynamic-plugins/con-ansible-plugin-user.adoc[leveloffset=+1]
66

77
// Argo CD
8-
include::../../artifacts/rhdh-plugins-reference/argocd/argocd-plugin-user.adoc[leveloffset=+1]
8+
include::../../modules/dynamic-plugins/proc-using-argo-cd.adoc[leveloffset=+1]
99

1010
//JFrog Artifactory
11-
include::../../artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-artifactory-plugin-user.adoc[leveloffset=+1]
11+
//include::../../artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-artifactory-plugin-user.adoc[leveloffset=+1]
12+
include::../../modules/dynamic-plugins/proc-using-jfrog-artifactory-plugin.adoc[leveloffset=+1]
1213

1314
// Keycloak
14-
include::../../artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-user.adoc[leveloffset=+1]
15+
include::../../modules/dynamic-plugins/proc-using-keycloak.adoc[leveloffset=+1]
1516

1617
// Nexus
17-
include::../../artifacts/rhdh-plugins-reference/nexus-repository-manager/nexus-repository-manager-plugin-user.adoc[leveloffset=+1]
18+
include::../../modules/dynamic-plugins/proc-using-nexus.adoc[leveloffset=+1]
1819

1920
// Tekton
20-
include::../../artifacts/rhdh-plugins-reference/tekton/tekton-plugin-user.adoc[leveloffset=+1]
21+
include::../../modules/dynamic-plugins/proc-using-tekton.adoc[leveloffset=+1]
2122

2223
// Topology
2324
include::../../assemblies/dynamic-plugins/assembly-using-topology-plugin.adoc[leveloffset=+1]

‎modules/dynamic-plugins/proc-configuring-the-jfrog-plugin.adoc‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
[id="proc-configuring-the-jfrog-plugin"]
2+
= Configuring the JFrog Artifactory plugin
3+
4+
.Procedure
5+
. Set the proxy to the desired JFrog Artifactory server in the {my-app-config-file} file as follows:
6+
+
7+
[source,yaml]
8+
----
9+
proxy:
10+
endpoints:
11+
‘/jfrog-artifactory/api’:
12+
target: http://<hostname>:8082 # or https://<customer>.jfrog.io
13+
headers:
14+
# Authorization: 'Bearer <YOUR TOKEN>'
15+
# Change to "false" in case of using a self-hosted Artifactory instance with a self-signed certificate
16+
secure: true
17+
----
18+
19+
. Add the following annotation to the entity’s `catalog-info.yaml` file to enable the JFrog Artifactory plugin features in {product-very-short} components:
20+
+
21+
[source,yaml]
22+
----
23+
metadata:
24+
annotations:
25+
'jfrog-artifactory/image-name': '<IMAGE-NAME>'
26+
----

‎modules/dynamic-plugins/proc-configuring-the-nexus-plugin.adoc‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="configuring-the-nexus-plugin_{context}"]
3+
= Configuring the Nexus Repository Manager plugin
4+
5+
. Set the proxy to the desired Nexus Repository Manager server in the `{my-app-config-file}` file as follows:
6+
+
7+
[source,yaml]
8+
----
9+
proxy:
10+
'/nexus-repository-manager':
11+
target: 'https://<NEXUS_REPOSITORY_MANAGER_URL>'
12+
headers:
13+
X-Requested-With: 'XMLHttpRequest'
14+
# Uncomment the following line to access a private Nexus Repository Manager using a token
15+
# Authorization: 'Bearer <YOUR TOKEN>'
16+
changeOrigin: true
17+
# Change to "false" in case of using self hosted Nexus Repository Manager instance with a self-signed certificate
18+
secure: true
19+
----
20+
21+
. Optional: Change the base URL of Nexus Repository Manager proxy as follows:
22+
+
23+
[source,yaml]
24+
----
25+
nexusRepositoryManager:
26+
# default path is `/nexus-repository-manager`
27+
proxyPath: /custom-path
28+
----
29+
30+
. Optional: Enable the following experimental annotations:
31+
+
32+
[source,yaml]
33+
----
34+
nexusRepositoryManager:
35+
experimentalAnnotations: true
36+
----
37+
38+
. Annotate your entity using the following annotations:
39+
+
40+
[source,yaml]
41+
----
42+
metadata:
43+
annotations:
44+
# insert the chosen annotations here
45+
# example
46+
nexus-repository-manager/docker.image-name: `<ORGANIZATION>/<REPOSITORY>`,
47+
----

0 commit comments

Comments
 (0)