|
| 1 | +// Module included in the following assemblies: |
| 2 | +// |
| 3 | +// * configuration/configuring-and-integrating-the-rhacs-plugin-with-red-hat-developer-hub.adoc |
| 4 | + |
| 5 | +:_mod-docs-content-type: PROCEDURE |
| 6 | +[id="viewing-security-information-in-red-hat-developer-hub_{context}"] |
| 7 | += Viewing security information in Red Hat Developer Hub |
| 8 | + |
| 9 | +By configuring and integrating the {rh-rhacs-first} plugin with {rh-rhdh-first}, you can access vulnerability data, assess risks, and take proactive security actions without leaving the {rh-rhdh} environment. |
| 10 | + |
| 11 | +.Prerequisites |
| 12 | + |
| 13 | +* You have enabled the {product-title-short} plugin installation in {rh-rhdh}. |
| 14 | ++ |
| 15 | +For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{rhdh-latest-version}/html/installing_and_viewing_plugins_in_red_hat_developer_hub/rhdh-installing-rhdh-plugins_title-plugins-rhdh-about#con-install-dynamic-plugin-helm_rhdh-installing-rhdh-plugins[Installing dynamic plugins using the Helm chart] ({rh-rhdh} documentation). |
| 16 | +
|
| 17 | +.Procedure |
| 18 | + |
| 19 | +. Create an `app-config.yaml` file that contains the `proxy` and `acs` stanzas by using the following content: |
| 20 | ++ |
| 21 | +[source,yaml] |
| 22 | +---- |
| 23 | +# ... |
| 24 | +proxy: |
| 25 | + endpoints: |
| 26 | + /acs: |
| 27 | + target: ${ACS_API_URL} |
| 28 | + headers: |
| 29 | + authorization: Bearer ${ACS_API_KEY} |
| 30 | +acs: |
| 31 | + acsUrl: ${ACS_API_URL} |
| 32 | +# ... |
| 33 | +---- |
| 34 | + |
| 35 | +. To enable the {product-title-short} plugin, perform the following steps: |
| 36 | +.. Navigate to the dynamic plugins configuration file in your {rh-rhdh} setup. |
| 37 | +.. To include the {product-title-short} plugin, add the following content to the configuration file, for example: |
| 38 | ++ |
| 39 | +[source,yaml] |
| 40 | +---- |
| 41 | +# ... |
| 42 | +- package: https://github.com/RedHatInsights/backstage-plugin-advanced-cluster-security/releases/download/v0.1.1/redhatinsights-backstage-plugin-acs-dynamic-0.1.1.tgz |
| 43 | + integrity: sha256-9JeRK2jN/Jgenf9kHwuvTvwTuVpqrRYsTGL6cpYAzn4= |
| 44 | + disabled: false |
| 45 | + pluginConfig: |
| 46 | + dynamicPlugins: |
| 47 | + frontend: |
| 48 | + redhatinsights.backstage-plugin-acs: |
| 49 | + entityTabs: |
| 50 | + - path: /acs |
| 51 | + title: RHACS |
| 52 | + mountPoint: entity.page.acs |
| 53 | + mountPoints: |
| 54 | + - mountPoint: entity.page.acs/cards |
| 55 | + importName: EntityACSContent |
| 56 | + config: |
| 57 | + layout: |
| 58 | + gridColumnEnd: |
| 59 | + lg: span 12 |
| 60 | + md: span 12 |
| 61 | + xs: span 12 |
| 62 | +# ... |
| 63 | +---- |
| 64 | + |
| 65 | +. To add annotations for entities in the {rh-rhdh} catalog, perform the following steps: |
| 66 | ++ |
| 67 | +[NOTE] |
| 68 | +==== |
| 69 | +To display the vulnerability data, each component entity in the {rh-rhdh} catalog must reference the {product-title-short} deployments. |
| 70 | + |
| 71 | +The following values are associated with the entities in the {rh-rhdh} catalog: |
| 72 | + |
| 73 | +** `API` |
| 74 | +** `Component` |
| 75 | +** `Domain` |
| 76 | +** `Group` |
| 77 | +** `Location` |
| 78 | +** `Resource` |
| 79 | +** `System` |
| 80 | +** `Template` |
| 81 | +** `User` |
| 82 | +==== |
| 83 | +.. Navigate to the entity configuration file for your service in your {rh-rhdh} setup. |
| 84 | +.. Add the following annotation to the configuration file, for example: |
| 85 | ++ |
| 86 | +[source,yaml] |
| 87 | +---- |
| 88 | +apiVersion: backstage.io/v1alpha1 |
| 89 | +kind: Component |
| 90 | +metadata: |
| 91 | + name: test-service |
| 92 | + annotations: |
| 93 | + acs/deployment-name: test-deployment-1,test-deployment-2,test-deployment-3 |
| 94 | +# ... |
| 95 | +---- |
| 96 | + |
| 97 | +.Verification |
| 98 | + |
| 99 | +. In the {rh-rhdh} portal, click *Catalog*. |
| 100 | +. Click an entity and verify that the *{product-title-short}* tab appears. |
| 101 | +. To view the violations and vulnerability data, click the *{product-title-short}* tab. |
0 commit comments