Chapter 19. Configuring and integrating the RHACS plugin with Red Hat Developer Hub

Procedure

1. In the app-config.yaml file, add the proxy and acs stanzas by using the following content:

   # ...
   proxy:
     endpoints:
       /acs:
         target: ${ACS_API_URL}
         headers:
           authorization: Bearer ${ACS_API_KEY}
   acs:
     acsUrl: ${ACS_API_URL}
   # ...

   Copy to Clipboard Toggle word wrap

2. To enable the RHACS plugin, perform the following steps:

   1. Navigate to the dynamic plugins configuration file in your RHDH setup.

   2. To include the RHACS plugin, add the following content to the configuration file, for example:

      # ...
      - package: "oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-acs:pr_986__0.0.4!backstage-community-plugin-acs"
        disabled: false
        pluginConfig:
          dynamicPlugins:
            frontend:
              backstage-community.plugin-acs:
                entityTabs:
                  - path: /acs
                    title: Security
                    mountPoint: entity.page.acs
                mountPoints:
                  - mountPoint: entity.page.acs/cards
                    importName: EntityACSContent
                    config:
                      layout:
                        gridColumnEnd:
                          lg: span 12
                          md: span 12
                          xs: span 12
      # ...

      Copy to Clipboard Toggle word wrap

3. To add annotations for entities in the RHDH catalog, perform the following steps:

   Note

   To display the vulnerability data, each component entity in the RHDH catalog must reference the RHACS deployments.

   The following values are associated with the entities in the RHDH catalog:

   • API
   • Component
   • Domain
   • Group
   • Location
   • Resource
   • System
   • Template
   • User
   1. Navigate to the entity configuration file for your service in your RHDH setup.

   2. Add the following annotation to the configuration file, for example:

      apiVersion: backstage.io/v1alpha1
      kind: Component
      metadata:
        name: test-service
        annotations:
          acs/deployment-name: test-deployment-1,test-deployment-2,test-deployment-3
      # ...

      Copy to Clipboard Toggle word wrap

Verification

1. In the RHDH portal, click Catalog.
2. Click an entity and verify that the RHACS tab appears.
3. To view the violations and vulnerability data, click the RHACS tab.