Skip to content

Commit 7aaa0d5

Browse files
committed
RHIDP-12601: updated YAML example based on dev comments
1 parent f6d5ab7 commit 7aaa0d5

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

modules/observability_evaluate-project-health-using-scorecards/proc-configure-custom-severity-levels-and-colors-for-scorecard.adoc

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66
[role="_abstract"]
77
Customizing severity thresholds and color mappings in your Scorecard configuration allows you to visualize platform metrics using your organization's custom operational terminology.
88

9+
[NOTE]
10+
====
11+
You must explicitly configure a corresponding icon component layout key for each custom severity color level you declare. Custom severity metrics will not render properly in the dashboard overview if the icon parameter is missing or invalid.
12+
====
13+
914
.Prerequisites
1015
* You have administrative access to the {product} configuration files.
1116
* An existing default Scorecard plugin configuration is deployed.
@@ -15,7 +20,7 @@ Customizing severity thresholds and color mappings in your Scorecard configurati
1520

1621
2. Navigate to the `scorecard` backend plugin configuration section.
1722

18-
3. Add your custom severity keys and user-defined hex color values under the threshold color mapping block.
23+
3. Define your custom severity threshold keys by adding hex color parameters to the `colors` mapping object and valid UI icon names to the `icons` mapping object.
1924
+
2025
--
2126
[source,yaml]
@@ -28,12 +33,18 @@ scorecard:
2833
error: '#C9190B'
2934
critical: '#A30000'
3035
info: '#0066CC'
36+
icons:
37+
success: check
38+
warning: warning
39+
error: error
40+
critical: dangerous
41+
info: info
3142
----
3243
--
3344
4. Save the changes to the configuration file.
3445

35-
5. Restart your {product} instance to apply the new thresholds.
46+
5. Restart your {product} instance to apply the new threshold rules.
3647

3748
.Verification
3849

39-
* Open the {product} UI, navigate to the Scorecard component, and verify that the custom severity levels display with their specified colors.
50+
* Open the {product} UI, navigate to the Scorecard component, and verify that the custom severity levels display with the colors and icons you specified.

0 commit comments

Comments
 (0)