Skip to content

Commit 97cac47

Browse files
author
Agil Antony
committed
ROX28809 Updates to the Dev Hub integration documentation
ROX28809 Small correction ROX28809 SME feedback ROX28809 SME feedback
1 parent 15488a8 commit 97cac47

4 files changed

+40
-8
lines changed

configuration/configuring-and-integrating-the-rhacs-plugin-with-red-hat-developer-hub.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,11 @@ By configuring and integrating the {rh-rhacs-first} plugin with {rh-rhdh-first},
1212
include::snippets/technology-preview.adoc[]
1313

1414
//Viewing security information in {rh-rhdh}
15-
include::modules/viewing-security-information-in-red-hat-developer-hub.adoc[leveloffset=+1]
15+
include::modules/viewing-security-information-in-red-hat-developer-hub.adoc[leveloffset=+1]
16+
17+
[role="_additional-resources"]
18+
.Additional resources
19+
* xref:../configuration/configuring-and-integrating-the-rhacs-plugin-with-red-hat-developer-hub.adoc#rebuilding-the-oci-artifact_configuring-and-integrating-the-rhacs-plugin-with-red-hat-developer-hub[Rebuilding the OCI artifact]
20+
21+
//Rebuilding the OCI artifact
22+
include::modules/rebuilding-the-oci-artifact.adoc[leveloffset=+1]

modules/common-attributes.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ endif::[]
6161
:rhacs-version: 4.7.2
6262
:ocp-supported-version: 4.12
6363
:ocp-latest-version: 4.17
64+
:plugin-acs-latest-version: 0.0.4
6465
:product-rosa: Red{nbsp}Hat OpenShift Service on AWS
6566
:product-rosa-short: ROSA
6667
:product-title: Red{nbsp}Hat Advanced Cluster Security for Kubernetes
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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="rebuilding-the-oci-artifact_{context}"]
7+
= Rebuilding the OCI artifact
8+
9+
To rebuild the Open Container Initiative (OCI) artifact, update the `repo-ref` field in the `source.json` file to reference the new commit ID of the plugin repository.
10+
11+
.Procedure
12+
13+
* To rebuild the OCI artifact, update the `repo-ref` field in the `source.json` file, for example:
14+
+
15+
[IMPORTANT]
16+
====
17+
You can find the `source.json` file in the `workspaces/acs` directory of the `rhdh-plugin-export-overlays` repository.
18+
====
19+
+
20+
[source,json]
21+
----
22+
{"repo":"https://github.com/backstage/community-plugins","repo-ref":"19ddb7837c6823a253c87af9524f8aef26a90b35","repo-flat":false}
23+
----

modules/viewing-security-information-in-red-hat-developer-hub.adoc

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ For more information, see link:https://docs.redhat.com/en/documentation/red_hat_
1818
1919
.Procedure
2020

21-
. Create an `app-config.yaml` file that contains the `proxy` and `acs` stanzas by using the following content:
21+
. In the `app-config.yaml` file, add the `proxy` and `acs` stanzas by using the following content:
2222
+
2323
[source,yaml]
2424
----
@@ -38,19 +38,18 @@ acs:
3838
.. Navigate to the dynamic plugins configuration file in your {rh-rhdh} setup.
3939
.. To include the {product-title-short} plugin, add the following content to the configuration file, for example:
4040
+
41-
[source,yaml]
41+
[source,yaml,subs="attributes+"]
4242
----
4343
# ...
44-
- package: https://github.com/RedHatInsights/backstage-plugin-advanced-cluster-security/releases/download/v0.1.1/redhatinsights-backstage-plugin-acs-dynamic-0.1.1.tgz
45-
integrity: sha256-9JeRK2jN/Jgenf9kHwuvTvwTuVpqrRYsTGL6cpYAzn4=
44+
- package: "oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-acs:pr_986__{plugin-acs-latest-version}!backstage-community-plugin-acs"
4645
disabled: false
4746
pluginConfig:
4847
dynamicPlugins:
4948
frontend:
50-
redhatinsights.backstage-plugin-acs:
49+
backstage-community.plugin-acs:
5150
entityTabs:
5251
- path: /acs
53-
title: RHACS
52+
title: Security
5453
mountPoint: entity.page.acs
5554
mountPoints:
5655
- mountPoint: entity.page.acs/cards
@@ -100,4 +99,6 @@ metadata:
10099
101100
. In the {rh-rhdh} portal, click *Catalog*.
102101
. Click an entity and verify that the *{product-title-short}* tab appears.
103-
. To view the violations and vulnerability data, click the *{product-title-short}* tab.
102+
. To view the violations and vulnerability data, click the *{product-title-short}* tab.
103+
104+
After you configure and integrate the {product-title-short} plugin with {rh-rhdh}, you need to rebuild the Open Container Initiative (OCI) artifact. See "Rebuilding the OCI artifact" for instructions.

0 commit comments

Comments
 (0)