Skip to content

Commit 2bcafd6

Browse files
[release-1.4] HACDOCS-975: Adding JFrog Artifactory plugin content (redhat-developer#866)
* adding artifactory plugin content * minor update * bit more info * reviews feedback * removing a config step * updated package path --------- Co-authored-by: Olga Tikhomirova <[email protected]>
1 parent 952e6c7 commit 2bcafd6

File tree

5 files changed

+90
-0
lines changed

5 files changed

+90
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
[id="installing-configuring-jfrog-artifactory_{context}"]
2+
= Installing and configuring the JFrog Artifactory plugin
3+
4+
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.
5+
6+
[IMPORTANT]
7+
====
8+
The JFrog Artifactory plugin is 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+
== Installation
18+
The JFrog Artifactory plugin is preinstalled in {product-short} with basic configuration properties. To enable it, set the disabled property to `false` as follows:
19+
20+
[source,yaml]
21+
----
22+
global:
23+
dynamic:
24+
includes:
25+
- dynamic-plugins.default.yaml
26+
plugins:
27+
- package: ./dynamic-plugins/dist/backstage-community-plugin-jfrog-artifactory
28+
disabled: false
29+
----
30+
31+
== Configuration
32+
. Set the proxy to the desired JFrog Artifactory server in the `app-config.yaml` file as follows:
33+
+
34+
[source,yaml]
35+
----
36+
proxy:
37+
endpoints:
38+
‘/jfrog-artifactory/api’:
39+
target: http://<hostname>:8082 # or https://<customer>.jfrog.io
40+
headers:
41+
# Authorization: 'Bearer <YOUR TOKEN>'
42+
# Change to "false" in case of using a self-hosted Artifactory instance with a self-signed certificate
43+
secure: true
44+
----
45+
46+
. Add the following annotation to the entity’s `catalog-info.yaml` file to enable the JFrog Artifactory plugin features in RHDH components:
47+
+
48+
[source,yaml]
49+
----
50+
metadata:
51+
annotations:
52+
'jfrog-artifactory/image-name': '<IMAGE-NAME>'
53+
----
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[id="using-jfrog-artifactory_{context}"]
2+
= Using the JFrog Artifactory plugin
3+
4+
The JFrog Artifactory plugin displays information about your container images within the Jfrog Artifactory registry.
5+
6+
[IMPORTANT]
7+
====
8+
The JFrog Artifactory plugin is 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+
.Prerequisites
18+
19+
* Your {product-short} application is installed and running.
20+
* You have enabled the JFrog Artifactory plugin.
21+
22+
.Procedure
23+
24+
. Open your {product-short} application and select a component from the *Catalog* page.
25+
. Go to the *Image Registry* tab.
26+
27+
+
28+
The *Image Registry* tab contains a list of container images within your Jfrog Artifactory repository and related information, such as *Version*, *Repositories*, *Manifest*, *Modified*, and *Size*.
29+
30+
+
31+
image::rhdh-plugins-reference/jfrog-artifactory.png[image-registry-tab-jfrog-artifactory]

Diff for: assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc

+3
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ include::../modules/dynamic-plugins/con-ansible-plugin-admin.adoc[leveloffset=+1
77
// Argo CD
88
include::../../artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc[leveloffset=+1]
99

10+
//JFrog Artifactory
11+
include::../../artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-artifactory-plugin-admin.adoc[leveloffset=+1]
12+
1013
// Keycloak
1114
include::../../artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-admin.adoc[leveloffset=+1]
1215

Diff for: assemblies/dynamic-plugins/assembly-using-rhdh-plugins.adoc

+3
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ include::../modules/dynamic-plugins/con-ansible-plugin-user.adoc[leveloffset=+1]
77
// Argo CD
88
include::../../artifacts/rhdh-plugins-reference/argocd/argocd-plugin-user.adoc[leveloffset=+1]
99

10+
//JFrog Artifactory
11+
include::../../artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-artifactory-plugin-user.adoc[leveloffset=+1]
12+
1013
// Keycloak
1114
include::../../artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-user.adoc[leveloffset=+1]
1215

Diff for: images/rhdh-plugins-reference/jfrog-artifactory.png

66.5 KB
Loading

0 commit comments

Comments
 (0)