|
| 1 | += Enabling and configuring the JFrog Artifactory plugin |
| 2 | + |
| 3 | +JFrog Artifactory is a front-end plugin that displays the information about your container images stored in the JFrog Artifactory repository. JFrog Artifactory is preinstalled with {product-short} and disabled by default. To use it, you need to enable and configure it first. |
| 4 | + |
| 5 | +[IMPORTANT] |
| 6 | +==== |
| 7 | +The JFrog Artifactory 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 | +== Enablement |
| 17 | +The JFrog Artifactory plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the disabled property to `false` as follows: |
| 18 | + |
| 19 | +[source,yaml] |
| 20 | +---- |
| 21 | +global: |
| 22 | + dynamic: |
| 23 | + includes: |
| 24 | + - dynamic-plugins.default.yaml |
| 25 | + plugins: |
| 26 | + - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-jfrog-artifactory |
| 27 | + disabled: false |
| 28 | +---- |
| 29 | + |
| 30 | +== Configuration |
| 31 | +. Set the proxy to the desired JFrog Artifactory server in the `app-config.yaml` file as follows: |
| 32 | ++ |
| 33 | +[source,yaml] |
| 34 | +---- |
| 35 | +proxy: |
| 36 | + endpoints: |
| 37 | + ‘/jfrog-artifactory/api’: |
| 38 | + target: http://<hostname>:8082 # or https://<customer>.jfrog.io |
| 39 | + headers: |
| 40 | + # Authorization: 'Bearer <YOUR TOKEN>' |
| 41 | + # Change to "false" in case of using a self-hosted Artifactory instance with a self-signed certificate |
| 42 | + secure: true |
| 43 | +---- |
| 44 | + |
| 45 | +. Enable the *Image Registry* tab on the entity view page in `packages/app/src/components/catalog/EntityPage.tsx`: |
| 46 | ++ |
| 47 | +[source,yaml] |
| 48 | +---- |
| 49 | +import { |
| 50 | + isJfrogArtifactoryAvailable, |
| 51 | + JfrogArtifactoryPage, |
| 52 | +} from '@janus-idp/backstage-plugin-jfrog-artifactory'; |
| 53 | +
|
| 54 | +const serviceEntityPage = ( |
| 55 | + <EntityLayout> |
| 56 | + // ... |
| 57 | + {/* highlight-add-start */} |
| 58 | + <EntityLayout.Route |
| 59 | + if={isJfrogArtifactoryAvailable} |
| 60 | + path="/image-registry" |
| 61 | + title="Image Registry" |
| 62 | + > |
| 63 | + <JfrogArtifactoryPage /> |
| 64 | + </EntityLayout.Route> |
| 65 | + {/* highlight-add-end */} |
| 66 | + </EntityLayout> |
| 67 | +); |
| 68 | +---- |
| 69 | + |
| 70 | +. Annotate your entity using the following annotations: |
| 71 | ++ |
| 72 | +[source,yaml] |
| 73 | +---- |
| 74 | +metadata: |
| 75 | + annotations: |
| 76 | + 'jfrog-artifactory/image-name': '<IMAGE-NAME>' |
| 77 | +---- |
0 commit comments