Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
3ad4462
RHIDP-7472-1 - Modularize plugins content in artifacts/rhdh-plugins-r…
Gerry-Forde Sep 9, 2025
6066adc
Modularize plugins content in artifacts/rhdh-plugins-reference:
Gerry-Forde Sep 9, 2025
6517171
RHIDP-7472-1 - iodularize plugins content in artifacts/rhdh-plugins-r…
Gerry-Forde Sep 9, 2025
83fe376
Modularize plugins content in artifacts/rhdh-plugins-reference
Gerry-Forde Sep 9, 2025
53bef84
RHIDP-7472-1 - Modularize plugins content in artifacts/rhdh-plugins-r…
Gerry-Forde Sep 9, 2025
bf6f392
RHIDP-7472-1 - Modularize plugins content in artifacts/rhdh-plugins-r…
Gerry-Forde Sep 9, 2025
9740888
RHIDP-7472-1 - Modularize plugins content in artifacts/rhdh-plugins-r…
Gerry-Forde Sep 9, 2025
7f849f5
Update modules/dynamic-plugins/proc-configuring-the-jfrog-plugin.adoc
Gerry-Forde Sep 9, 2025
5e2ccf6
Update modules/dynamic-plugins/proc-configuring-the-jfrog-plugin.adoc
Gerry-Forde Sep 9, 2025
9be2bb4
Update modules/dynamic-plugins/proc-enabling-the-tekton-plugin.adoc
Gerry-Forde Sep 9, 2025
67ca223
Update modules/dynamic-plugins/proc-enabling-the-tekton-plugin.adoc
Gerry-Forde Sep 9, 2025
fe62355
Update modules/dynamic-plugins/proc-enabling-the-tekton-plugin.adoc
Gerry-Forde Sep 9, 2025
0deb933
Update modules/dynamic-plugins/proc-enabling-argo-cd-rollouts.adoc
Gerry-Forde Sep 9, 2025
c868857
Update modules/dynamic-plugins/ref-configuring-the-keycloak-plugin.adoc
Gerry-Forde Sep 9, 2025
36370a3
Update modules/dynamic-plugins/ref-configuring-the-keycloak-plugin.adoc
Gerry-Forde Sep 9, 2025
af2253b
Update modules/dynamic-plugins/ref-configuring-the-keycloak-plugin.adoc
Gerry-Forde Sep 9, 2025
ba21a41
Update modules/dynamic-plugins/ref-configuring-the-keycloak-plugin.adoc
Gerry-Forde Sep 9, 2025
83558a9
Update modules/dynamic-plugins/proc-using-tekton.adoc
Gerry-Forde Sep 9, 2025
ff68c4c
Update modules/dynamic-plugins/proc-using-tekton.adoc
Gerry-Forde Sep 9, 2025
843032c
Update modules/dynamic-plugins/proc-enabling-the-tekton-plugin.adoc
Gerry-Forde Sep 9, 2025
93b7469
Update modules/dynamic-plugins/proc-using-nexus.adoc
Gerry-Forde Sep 9, 2025
fc64915
Update modules/dynamic-plugins/proc-enabling-argo-cd-rollouts.adoc
Gerry-Forde Sep 9, 2025
3169798
Update assemblies/dynamic-plugins/assembly-enabling-configuring-nexus…
Gerry-Forde Sep 9, 2025
43c04ba
Update modules/dynamic-plugins/proc-configuring-the-nexus-plugin.adoc
Gerry-Forde Sep 9, 2025
4bf6f85
Update modules/dynamic-plugins/proc-enabling-argo-cd-rollouts.adoc
Gerry-Forde Sep 9, 2025
3db6825
Update modules/dynamic-plugins/proc-enabling-argo-cd-rollouts.adoc
Gerry-Forde Sep 9, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 18 additions & 15 deletions assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc
Original file line number Diff line number Diff line change
@@ -1,26 +1,29 @@
[id="rhdh-configuring-rhdh-plugins_{context}"]
= Configuring dynamic plugins in {product}

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

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

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

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

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

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

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

// Overriding Core Backend Service Configuration
include::../modules/dynamic-plugins/proc-overriding-core-backend-services.adoc[leveloffset=+1]
include::../assembly-using-servicenow.adoc[leveloffset=+1]

include::../assembly-using-kubernetes-custom-actions.adoc[leveloffset=+1]

include::../../modules/dynamic-plugins/proc-overriding-core-backend-services.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
:_mod-docs-content-type: ASSEMBLY
[id="assembly-enabling-configuring-the-jfrog-plugin_{context}"]
= Enabling and configuring the JFrog plugin

Check warning on line 3 in assemblies/dynamic-plugins/assembly-enabling-configuring-jfrog.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [RedHat.Spelling] Verify the word 'JFrog'. It is not in the American English spelling dictionary used by Vale. Raw Output: {"message": "[RedHat.Spelling] Verify the word 'JFrog'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "assemblies/dynamic-plugins/assembly-enabling-configuring-jfrog.adoc", "range": {"start": {"line": 3, "column": 32}}}, "severity": "WARNING"}
:context: assembly-installing-configuring-jfrog

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.

Check warning on line 6 in assemblies/dynamic-plugins/assembly-enabling-configuring-jfrog.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [RedHat.Spelling] Verify the word 'JFrog'. It is not in the American English spelling dictionary used by Vale. Raw Output: {"message": "[RedHat.Spelling] Verify the word 'JFrog'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "assemblies/dynamic-plugins/assembly-enabling-configuring-jfrog.adoc", "range": {"start": {"line": 6, "column": 147}}}, "severity": "WARNING"}

Check warning on line 6 in assemblies/dynamic-plugins/assembly-enabling-configuring-jfrog.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [RedHat.Spelling] Verify the word 'JFrog'. It is not in the American English spelling dictionary used by Vale. Raw Output: {"message": "[RedHat.Spelling] Verify the word 'JFrog'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "assemblies/dynamic-plugins/assembly-enabling-configuring-jfrog.adoc", "range": {"start": {"line": 6, "column": 113}}}, "severity": "WARNING"}

Check warning on line 6 in assemblies/dynamic-plugins/assembly-enabling-configuring-jfrog.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [RedHat.Spelling] Verify the word 'JFrog'. It is not in the American English spelling dictionary used by Vale. Raw Output: {"message": "[RedHat.Spelling] Verify the word 'JFrog'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "assemblies/dynamic-plugins/assembly-enabling-configuring-jfrog.adoc", "range": {"start": {"line": 6, "column": 1}}}, "severity": "WARNING"}

[IMPORTANT]
====
The JFrog Artifactory plugin is a Technology Preview feature only.

Check warning on line 10 in assemblies/dynamic-plugins/assembly-enabling-configuring-jfrog.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [RedHat.Spelling] Verify the word 'JFrog'. It is not in the American English spelling dictionary used by Vale. Raw Output: {"message": "[RedHat.Spelling] Verify the word 'JFrog'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "assemblies/dynamic-plugins/assembly-enabling-configuring-jfrog.adoc", "range": {"start": {"line": 10, "column": 5}}}, "severity": "WARNING"}

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.

For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Scope].

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.
====

include::../modules/dynamic-plugins/proc-enabling-the-jfrog-plugin.adoc[leveloffset=+1]

include::../modules/dynamic-plugins/proc-configuring-the-jfrog-plugin.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
:_mod-docs-content-type: ASSEMBLY
[id="assembly-enabling-configuring-the-keycloak-plugin_{context}"]
= Enabling and configuring the Keycloak plugin
:context: assembly-installing-configuring-keycloak

The Keycloak backend plugin, which integrates Keycloak into {product-short}, has the following capabilities:

* Synchronization of Keycloak users in a realm.
* Synchronization of Keycloak groups and their users in a realm.

[NOTE]
====
The supported {rhbk-brand-name} ({rhbk}) version is `{keycloak-version}`.
====

include::../modules/dynamic-plugins/proc-enabling-the-keycloak-plugin.adoc[leveloffset=+1]

include::../modules/dynamic-plugins/ref-configuring-the-keycloak-plugin.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
:_mod-docs-content-type: ASSEMBLY
[id="assembly-enabling-configuring-the-nexus-plugin_{context}"]
= Enabling and configuring the Nexus Repository Manager plugin
:context: assembly-installing-configuring-nexus

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.

[IMPORTANT]
====
The Nexus Repository Manager plugin is a Technology Preview feature only.

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.

For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Scope].

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.
====

include::../modules/dynamic-plugins/proc-enabling-the-nexus-plugin.adoc[leveloffset=+1]

include::../modules/dynamic-plugins/proc-configuring-the-nexus-plugin.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,4 @@ include::../modules/dynamic-plugins/proc-topology-install.adoc[leveloffset=+2]

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

include::../assembly-managing-labels-annotations-topology.adoc[leveloffset=+1]


include::../assembly-using-servicenow.adoc[leveloffset=+1]

include::../assembly-using-kubernetes-custom-actions.adoc[leveloffset=+1]
include::../assembly-managing-labels-annotations-topology.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
:_mod-docs-content-type: ASSEMBLY
[id="assembly-installing-configuring-argo-cd.adoc_{context}"]
= Installing and configuring Argo CD
:context: assembly-installing-configuring-argo-cd

You can use the Argo CD plugin to visualize the Continuous Delivery (CD) workflows in OpenShift GitOps.

include::../modules/dynamic-plugins/proc-enabling-the-argo-cd-plugin.adoc[leveloffset=+1]

include::../modules/dynamic-plugins/proc-enabling-argo-cd-rollouts.adoc[leveloffset=+1]
11 changes: 6 additions & 5 deletions assemblies/dynamic-plugins/assembly-using-rhdh-plugins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,20 @@
include::../modules/dynamic-plugins/con-ansible-plugin-user.adoc[leveloffset=+1]

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

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

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

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

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

// Topology
include::../../assemblies/dynamic-plugins/assembly-using-topology-plugin.adoc[leveloffset=+1]
26 changes: 26 additions & 0 deletions modules/dynamic-plugins/proc-configuring-the-jfrog-plugin.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
[id="proc-configuring-the-jfrog-plugin"]
= Configuring the JFrog Artifactory plugin

.Procedure
. Set the proxy to the desired JFrog Artifactory server in the {my-app-config-file} file as follows:
+
[source,yaml]
----
proxy:
endpoints:
‘/jfrog-artifactory/api’:
target: http://<hostname>:8082 # or https://<customer>.jfrog.io
headers:
# Authorization: 'Bearer <YOUR TOKEN>'
# Change to "false" in case of using a self-hosted Artifactory instance with a self-signed certificate
secure: true
----

. Add the following annotation to the entity’s `catalog-info.yaml` file to enable the JFrog Artifactory plugin features in {product-very-short} components:
+
[source,yaml]
----
metadata:
annotations:
'jfrog-artifactory/image-name': '<IMAGE-NAME>'
----
47 changes: 47 additions & 0 deletions modules/dynamic-plugins/proc-configuring-the-nexus-plugin.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
:_mod-docs-content-type: PROCEDURE
[id="configuring-the-nexus-plugin_{context}"]
= Configuring the Nexus Repository Manager plugin

. Set the proxy to the desired Nexus Repository Manager server in the `{my-app-config-file}` file as follows:
+
[source,yaml]
----
proxy:
'/nexus-repository-manager':
target: 'https://<NEXUS_REPOSITORY_MANAGER_URL>'
headers:
X-Requested-With: 'XMLHttpRequest'
# Uncomment the following line to access a private Nexus Repository Manager using a token
# Authorization: 'Bearer <YOUR TOKEN>'
changeOrigin: true
# Change to "false" in case of using self hosted Nexus Repository Manager instance with a self-signed certificate
secure: true
----

. Optional: Change the base URL of Nexus Repository Manager proxy as follows:
+
[source,yaml]
----
nexusRepositoryManager:
# default path is `/nexus-repository-manager`
proxyPath: /custom-path
----

. Optional: Enable the following experimental annotations:
+
[source,yaml]
----
nexusRepositoryManager:
experimentalAnnotations: true
----

. Annotate your entity using the following annotations:
+
[source,yaml]
----
metadata:
annotations:
# insert the chosen annotations here
# example
nexus-repository-manager/docker.image-name: `<ORGANIZATION>/<REPOSITORY>`,
----
Loading