Skip to content

Commit 4817b5a

Browse files
pabel-rhpabel-rh
committed
Test day updates
1 parent 20582af commit 4817b5a

5 files changed

+28
-16
lines changed

‎artifacts/attributes.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,3 +168,6 @@
168168
:upgrading-book-title: Upgrading {product}
169169
:using-dynamic-plugins-book-link: {product-docs-link}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
170170
:using-dynamic-plugins-book-title: Using dynamic plugins
171+
172+
:scorecard-plugin-book-link: {product-docs-link}/html-single/understanding_and_visualizing_red_hat_developer_hub_project_health_using_scorecards/index
173+
:scorecard-plugin-book-link: Understanding and visualizing {product} project health using Scorecards

‎modules/observe/scorecards/proc-authenticating-and-managing-scorecard-plugins.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55

66
As an administrator, you can secure the connection to your metric providers by managing user access to the Scorecards using the Role-Based Access Control (RBAC) permissions. For users to view the Scorecard metrics, you must provide users with read access to the Scorecard metrics. You can configure these permissions either by modifying your RBAC csv file directly or by using the RBAC Web UI.
77

8+
.Prerequisite
9+
* You have {authorization-book-link}#enabling-and-giving-access-to-rbac[enabled RBAC, have a policy administrator role in Developer Hub, and have added scorecard to plugins with permission].
10+
811
.Procedure
912
. Set the required RBAC permissions using any of the following methods:
1013
** To use the csv file, in your csv file, you can directly add the following code:

‎modules/observe/scorecards/proc-configuring-github-scorecards-in-rhdh-instance.adoc‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ You can view GitHub metrics for software components registered in the {product-v
88
.Prerequisites
99

1010
* You have installed your {product-very-short} instance.
11-
* You have installed the Scorecard images.
11+
* You have {scorecard-plugin-book-link}#proc-installing-scorecard-plugin-in-rhdh-instance[installed the Scorecard images].
1212
* You must have permissions in GitHub to create and manage a https://docs.github.com/en/apps/overview[GitHub App].
1313
* You must have {configuring-book-link}[added a custom {product-very-short} application configuration] and have enough permissions to change it.
1414

@@ -46,6 +46,16 @@ integrations:
4646
${GITHUB_INTEGRATION_PRIVATE_KEY_FILE}
4747
----
4848

49+
. Configure the GitHub Scorecard plugin in your `{product-very-short} dynamic-plugins-config.yaml` by adding the following code to your `{product-very-short} dynamic-plugins-config.yaml`:
50+
+
51+
[source,yaml]
52+
----
53+
plugins:
54+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-scorecard-backend-module-github:bs_1.42.5__1.0.0!red-hat-developer-hub-backstage-plugin-scorecard-backend-module-github
55+
disabled: false
56+
----
57+
where:
58+
4959
. In your {product-very-short} entity that you want to configure for the GitHub Scorecard plugin, in the `catalog-info.yaml` file, link a component to the data source by adding the required annotations as shown in the following code:
5060
+
5161
[source,yaml]

‎modules/observe/scorecards/proc-configuring-jira-scorecards-in-rhdh-instance.adoc‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The following Jira versions are supported:
1313

1414
* You must have administrator privileges for Jira and {product-very-short}.
1515
* You have installed your {product-very-short} instance.
16-
* You have installed the Scorecard images.
16+
* You have {scorecard-plugin-book-link}#proc-installing-scorecard-plugin-in-rhdh-instance[installed the Scorecard images].
1717
* You must have {configuring-book-link}[added a custom {product-very-short} application configuration] and have enough permissions to change it.
1818

1919
.Procedure
@@ -35,6 +35,11 @@ echo -n 'your-atlassian-email:your-jira-api-token' | base64
3535
plugins:
3636
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-scorecard-backend-module-jira:pr_1499__0.1.0!red-hat-developer-hub-backstage-plugin-scorecard-backend-module-jira
3737
disabled: false
38+
----
39+
... In your `{product-very-short} {my-app-config-file}` file, add the following direct setup settings:
40+
+
41+
[source,yaml]
42+
----
3843
pluginConfig:
3944
jira:
4045
baseUrl: ${JIRA_BASE_URL}
@@ -46,6 +51,7 @@ where:
4651
`baseUrl`:: Enter the Jira URL.
4752
`token`:: Enter the Jira token (Base64 string for Cloud, PAT for Data Center). The Jira token must be added as a secret file in your {configuring-book-link}#provisioning-your-custom-configuration[`{product} app-config.yaml` file].
4853
`product`:: Enter the supported product: `cloud` or `datacenter`. (`cloud` is the preferred option)
54+
----
4955
5056
.. Use a proxy setup: In your `{product-very-short} dynamic-plugins-config.yaml`, add the following code:
5157
+
@@ -54,13 +60,9 @@ where:
5460
plugins:
5561
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-scorecard-backend-module-jira:pr_1499__0.1.0!red-hat-developer-hub-backstage-plugin-scorecard-backend-module-jira
5662
disabled: false
57-
pluginConfig:
58-
jira:
59-
proxyPath: /jira/api
60-
product: datacenter # Change to 'cloud' if using Jira Cloud
6163
----
6264
63-
... In your `{product-very-short} app-config.yaml` file, add the following proxy settings:
65+
... In your `{product-very-short} {my-app-config-file}` file, add the following proxy settings:
6466
+
6567
[source,yaml]
6668
----
@@ -73,6 +75,9 @@ proxy:
7375
Content-Type: 'application/json'
7476
X-Atlassian-Token: 'no-check'
7577
Authorization: ${JIRA_TOKEN} # Must be configured in your environment
78+
jira:
79+
proxyPath: /jira/api
80+
product: cloud # Change to 'datacenter' if using Jira Datacenter
7681
----
7782
where:
7883

‎modules/observe/scorecards/proc-installing-scorecard-plugin-in-rhdh-instance.adoc‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,6 @@ plugins:
3737
- isKind: component
3838
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-scorecard-backend:bs_1.42.5__1.0.0!red-hat-developer-hub-backstage-plugin-scorecard-backend
3939
disabled: false
40-
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-scorecard-backend-module-github:bs_1.42.5__1.0.0!red-hat-developer-hub-backstage-plugin-scorecard-backend-module-github
41-
disabled: false
42-
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-scorecard-backend-module-jira:bs_1.42.5__1.0.1!red-hat-developer-hub-backstage-plugin-scorecard-backend-module-jira
43-
disabled: false
44-
pluginConfig:
45-
jira:
46-
baseUrl: ${JIRA_BASE_URL}
47-
token: ${JIRA_TOKEN}
48-
product: datacenter
4940
----
5041
where:
5142

0 commit comments

Comments
 (0)