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


By configuring and integrating the Red Hat Advanced Cluster Security for Kubernetes (RHACS) plugin with Red Hat Developer Hub (RHDH), you can view the security information for your deployments in RHDH.

Important

Integration of vulnerability findings into the RHDH is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in 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 about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.

19.1. Viewing security information in Red Hat Developer Hub

By configuring and integrating the Red Hat Advanced Cluster Security for Kubernetes (RHACS) plugin with Red Hat Developer Hub (RHDH), you can access vulnerability data, assess risks, and take proactive security actions without leaving the RHDH environment.

Review the upstream plugin progress and details by visiting Community plugins for Backstage.

Prerequisites

Procedure

  1. Create an app-config.yaml file that contains 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}
    # ...
  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: https://github.com/RedHatInsights/backstage-plugin-advanced-cluster-security/releases/download/v0.1.1/redhatinsights-backstage-plugin-acs-dynamic-0.1.1.tgz
        integrity: sha256-9JeRK2jN/Jgenf9kHwuvTvwTuVpqrRYsTGL6cpYAzn4=
        disabled: false
        pluginConfig:
          dynamicPlugins:
            frontend:
              redhatinsights.backstage-plugin-acs:
                entityTabs:
                  - path: /acs
                    title: RHACS
                    mountPoint: entity.page.acs
                mountPoints:
                  - mountPoint: entity.page.acs/cards
                    importName: EntityACSContent
                    config:
                      layout:
                        gridColumnEnd:
                          lg: span 12
                          md: span 12
                          xs: span 12
      # ...
  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
      # ...

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.
Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.