Skip to content
kix docs
Search limited to the v0.1 version. Switch to the latest version for up-to-date results.

Disable scorecard rules

This content is for the v0.1 version. Switch to the latest version for up-to-date documentation.

Disable an individual rule through scorecard.ruleOverrides.byRule. This keeps the rest of its built-in or custom category active.

This guide assumes the rule is in the active set. The built-in rules are, by default; a custom rule must be present under scorecard.rules.

Add the override

Section titled “Add the override”

Use the rule’s full <category>.<rule> name and set enabled = false:

cluster.nix
scorecard.ruleOverrides.byRule."reliability.hasProbes".enabled = false;

Kix excludes the rule before evaluating it, so it produces no findings. Other reliability rules continue to run.

Check the result

Section titled “Check the result”

Run the cluster checks:

Run in kix-examples/ 
❱ kix check 19-scorecards
 TOOL         RESULT  DETAILS                                                       
 eval         pass    23 manifests evaluated                                        
 kubeconform  pass    skipped (this validation tool is not yet integrated with Kix) 
 pluto        pass    skipped (this validation tool is not yet integrated with Kix) 
 kyverno      pass    skipped (this validation tool is not yet integrated with Kix) 
 scorecard    pass    0 errors, 6 warnings, 4 info

Confirm that the disabled rule no longer appears in the findings. If it still appears, check that the override includes the category and matches the rule name exactly.

To restore the rule, remove the override. Prefer removing it over setting enabled = true, so the cluster inherits future changes to the surrounding configuration without an unnecessary exception.