Skip to content

Commit 846a104

Browse files
committed
Dominika's comments - some of them
1 parent 3be3417 commit 846a104

4 files changed

+19
-35
lines changed

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

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -23,28 +23,4 @@ See {authorization-book-link}#ref-rbac-permission-policies_title-authorization[P
2323
... To enable read access for the Scorecard plugin, add a policy with the following details and click *Next*:
2424
**** *Permission*: `scorecard.metric.read`
2525
**** *Action*: `read`
26-
**** *Effect*: `allow`
27-
28-
. Provide users access to specific metrics by their identifiers by using a conditional policy to restrict access, for example, only to the GitHub Open PRs metric (`github.open_prs`) using any of the following ways:
29-
** {audit-log-book-link}#managing-authorizations-by-using-the-web-ui[Using the Web UI].
30-
** defining the conditional policies in an `rbac-conditional-policies.yaml` file as shown in the following code:
31-
+
32-
[source,yaml]
33-
----
34-
result: CONDITIONAL
35-
roleEntityRef: "role:default/scorecard-viewer"
36-
pluginId: scorecard
37-
resourceType: scorecard-metric
38-
permissionMapping:
39-
- read
40-
conditions:
41-
rule: HAS_METRIC_ID
42-
resourceType: scorecard-metric
43-
params:
44-
metricIds: [_<your_metric_id>_]
45-
----
46-
+
47-
where:
48-
`metricIds`:: Enter the metric ID you want to give access to a user. For example: `github.open_prs`.
49-
50-
This policy would allow users to read only the GitHub Open PRs metric, while restricting access to other available metrics.
26+
**** *Effect*: `allow`

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ You can view GitHub metrics for software components registered in the {product-v
99

1010
* You have installed your {product-very-short} instance.
1111
* You have installed the Scorecard images.
12-
* You must have permissions in GitHub to create and manage a GitHub App.
13-
* You must have permissions to add and change the custom {product-very-short} application configuration.
12+
* You must have permissions in GitHub to create and manage a https://docs.github.com/en/apps/overview[GitHub App].
13+
* You must have {configuring-book-link}[added a custom {product-very-short} application configuration] and have enough permissions to change it.
1414

1515
.Procedure
1616

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

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,9 @@ The following Jira versions are supported:
1414
* You must have administrator privileges for Jira and {product-very-short}.
1515
* You have installed your {product-very-short} instance.
1616
* You have installed the Scorecard images.
17-
* You must have added a custom {product-very-short} application configuration.
17+
* You must have {configuring-book-link}[added a custom {product-very-short} application configuration] and have enough permissions to change it.
1818

19-
---
20-
== Procedure
19+
.Procedure
2120

2221
. Create a Jira configuration token using one of the following methods, depending on your Jira product:
2322
** Jira Cloud: https://id.atlassian.com/manage-profile/security/api-tokens[Create a personal token]. You must then create a `Base64-encoded` string using the following plain text format: `your-atlassian-email:your-jira-api-token`.
@@ -29,7 +28,7 @@ echo -n 'your-atlassian-email:your-jira-api-token' | base64
2928
** Jira datacenter: Create and use a Personal Access Token (PAT) in your Jira datacenter account. For more information, see the https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html[Atlassian] documentation.
3029

3130
. Configure the Jira Scorecard plugin in your `{product-very-short} dynamic-plugins-config.yaml` using either a direct setup or a proxy setup.
32-
.. Use a direct setup (Recommended for simpler environments): Add the following code to your `{product-very-short} dynamic-plugins-config.yaml`:
31+
.. Use a direct setup: Add the following code to your `{product-very-short} dynamic-plugins-config.yaml`:
3332
+
3433
[source,yaml]
3534
----
@@ -43,11 +42,12 @@ plugins:
4342
product: datacenter # Change to 'cloud' if using Jira Cloud
4443
----
4544
where:
45+
4646
`baseUrl`:: Enter the Jira URL.
4747
`token`:: Enter the Jira token (Base64 string for Cloud, PAT for Data Center).
4848
`product`:: Enter the supported product: `cloud` or `datacenter`.
4949

50-
.. Use a proxy setup (Recommended for complex network environments): In your `{product-very-short} dynamic-plugins-config.yaml`, add the following code:
50+
.. Use a proxy setup: In your `{product-very-short} dynamic-plugins-config.yaml`, add the following code:
5151
+
5252
[source,yaml]
5353
----
@@ -60,7 +60,7 @@ plugins:
6060
product: datacenter # Change to 'cloud' if using Jira Cloud
6161
----
6262

63-
.. In your `{product-very-short} app-config.yaml` file, add the following proxy settings:
63+
... In your `{product-very-short} app-config.yaml` file, add the following proxy settings:
6464
+
6565
[source,yaml]
6666
----
@@ -75,6 +75,7 @@ proxy:
7575
Authorization: ${JIRA_TOKEN} # Must be configured in your environment
7676
----
7777
where:
78+
7879
`Authorization`:: Set any of the following header value:
7980
* For *Cloud*: `Basic YourCreatedAboveToken`
8081
* For *Data Center*: `Bearer YourJiraToken`
@@ -102,6 +103,7 @@ spec:
102103
providesApis: [example-grpc-api]
103104
----
104105
where:
106+
105107
`jira/project-key`:: Required: Enter the Jira project key.
106108
`jira/component`:: Optional: Enter the Jira component name.
107109
`jira/label`:: Optional: Enter the Jira label.
@@ -140,6 +142,7 @@ scorecard:
140142
customFilter: priority in ("Critical", "Blocker")
141143
----
142144
where:
145+
143146
`mandatoryFilter`:: Optional: Replaces the default filter (`type = Bug and resolution = Unresolved`).
144147
`customFilter`:: Optional: Specifies a global custom filter. The entity annotation `jira/custom-filter` overrides this value.
145148

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ You must manually install and enable the plugin in your {product} instance.
1010
* You have provisioned your custom {installing-and-viewing-plugins-book-link}[dynamic plugins config map].
1111

1212
.Procedure
13+
1314
* Add the following configuration in your `{product} dynamic-plugin-config.yaml` file:
1415
+
1516
[source,yaml]
@@ -30,7 +31,7 @@ plugins:
3031
importName: EntityScorecardContent
3132
config:
3233
layout:
33-
gridColumn: 1 / -1
34+
gridColumn: 1 / -1
3435
if:
3536
allOf:
3637
- isKind: component
@@ -45,4 +46,8 @@ plugins:
4546
baseUrl: ${JIRA_BASE_URL}
4647
token: ${JIRA_TOKEN}
4748
product: datacenter
48-
----
49+
----
50+
where:
51+
52+
`baseUrl`:: Enter the Jira URL.
53+
`token`:: Enter the Jira token.

0 commit comments

Comments
 (0)