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.
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
You have enabled the RHACS plugin installation in RHDH.
For more information, see Installing dynamic plugins using the Helm chart (RHDH documentation).
Procedure
Create an
app-config.yaml
file that contains theproxy
andacs
stanzas by using the following content:# ... proxy: endpoints: /acs: target: ${ACS_API_URL} headers: authorization: Bearer ${ACS_API_KEY} acs: acsUrl: ${ACS_API_URL} # ...
To enable the RHACS plugin, perform the following steps:
- Navigate to the dynamic plugins configuration file in your RHDH setup.
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 # ...
To add annotations for entities in the RHDH catalog, perform the following steps:
NoteTo 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
- Navigate to the entity configuration file for your service in your RHDH setup.
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
- In the RHDH portal, click Catalog.
- Click an entity and verify that the RHACS tab appears.
- To view the violations and vulnerability data, click the RHACS tab.