@backstage-community/plugin-jfrog-artifactory

Jfrog Artifactory plugin for Backstage

The Jfrog Artifactory plugin displays information about your container images within the Jfrog Artifactory registry.

For administrators

Installation and configuration

Procedure

1. Run the following command to install the Jfrog Artifactory plugin:

   yarn workspace app add @backstage-community/plugin-jfrog-artifactory

2. Set the proxy to the desired Artifactory server in the app-config.yaml file as follows:

   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 self hosted artifactory instance with a self-signed certificate
         secure: true

3. Enable the JFROG ARTIFACTORY tab on the entity view page in packages/app/src/components/catalog/EntityPage.tsx:

   /* highlight-add-start */
   import {
     isJfrogArtifactoryAvailable,
     JfrogArtifactoryPage,
   } from '@backstage-community/plugin-jfrog-artifactory';
   
   /* highlight-add-end */
   
   const serviceEntityPage = (
     <EntityLayout>
       // ...
       {/* highlight-add-start */}
       <EntityLayout.Route
         if={isJfrogArtifactoryAvailable}
         path="/jfrog-artifactory"
         title="Jfrog Artifactory"
       >
         <JfrogArtifactoryPage />
       </EntityLayout.Route>
       {/* highlight-add-end */}
     </EntityLayout>
   );

4. Annotate your entity with the following annotations:

   metadata:
     annotations:
       'jfrog-artifactory/image-name': '<IMAGE-NAME>'

For users

Using the Jfrog Artifactory plugin in Backstage

Jfrog Artifactory is a front-end plugin that enables you to view the information about the container images that are available in your Jfrog Artifactory registry.

Prerequisites

• Your Backstage application is installed and running.
• You have installed the Jfrog Artifactory plugin. For installation and configuration steps, see Installation and configuration.

Procedure

1. Open your Backstage application and select a component from the Catalog page.

2. Go to the JFROG ARTIFACTORY tab.

   

   The JFROG ARTIFACTORY tab contains a list of container images and related information, such as VERSION, REPOSITORIES, MANIFEST, MODIFIED, and SIZE.