Skip to content

Commit a4d5e9c

Browse files
authored
Merge pull request #43888 from sheriff-rh/bz2066952
BZ2066952 ComplianceCheckResult updates
2 parents 5fa60b3 + 548922a commit a4d5e9c

File tree

3 files changed

+29
-7
lines changed

3 files changed

+29
-7
lines changed

modules/compliance-filtering-failed-results.adoc renamed to modules/compliance-filtering-results.adoc

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
//
33
// * security/compliance_operator/compliance-operator-remediation.adoc
44

5-
[id="filtering-failed-compliance-check-results_{context}"]
6-
= Filters for failed compliance check results
5+
:_content-type: PROCEDURE
6+
[id="filtering-compliance-check-results_{context}"]
7+
= Filters for compliance check results
78

89
By default, the `ComplianceCheckResult` objects are labeled with several useful labels that allow you to query the checks and decide on the next steps after the results are generated.
910

@@ -38,3 +39,23 @@ $ oc get compliancecheckresults -l 'compliance.openshift.io/check-status=FAIL,!c
3839
----
3940

4041
The manual remediation steps are typically stored in the `description` attribute in the `ComplianceCheckResult` object.
42+
43+
.ComplianceCheckResult Status
44+
[cols="1,1",options="header"]
45+
|===
46+
| ComplianceCheckResult Status | Description
47+
| PASS
48+
| Compliance check ran to completion and passed.
49+
| FAIL
50+
| Compliance check ran to completion and failed.
51+
| INFO
52+
| Compliance check ran to completion and found something not severe enough to be considered an error.
53+
| MANUAL
54+
| Compliance check does not have a way to automatically assess the success or failure and must be checked manually.
55+
| INCONSISTENT
56+
| Compliance check reports different results from different sources, typically cluster nodes.
57+
| ERROR
58+
| Compliance check ran, but could not complete properly.
59+
| NOT-APPLICABLE
60+
| Compliance check did not run because it is not applicable or not selected.
61+
|===

modules/compliance-inconsistent.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
//
33
// * security/compliance_operator/compliance-operator-remediation.adoc
44

5+
:_content-type: PROCEDURE
56
[id="compliance-inconsistent_{context}"]
6-
= Inconsistent remediations
7+
= Inconsistent ComplianceScan
78
The `ScanSetting` object lists the node roles that the compliance scans generated from the `ScanSetting` or `ScanSettingBinding` objects would scan. Each node role usually maps to a machine config pool.
89

910
[IMPORTANT]

security/compliance_operator/compliance-operator-remediation.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
:_content-type: ASSEMBLY
22
[id="compliance-operator-remediation"]
3-
= Managing Compliance Operator remediation
3+
= Managing Compliance Operator result and remediation
44
include::_attributes/common-attributes.adoc[]
55
:context: compliance-remediation
66

77
toc::[]
88

99
Each `ComplianceCheckResult` represents a result of one compliance rule check. If the rule can be remediated automatically, a `ComplianceRemediation` object with the same name, owned by the `ComplianceCheckResult` is created. Unless requested, the remediations are not applied automatically, which gives an {product-title} administrator the opportunity to review what the remediation does and only apply a remediation once it has been verified.
1010

11+
include::modules/compliance-filtering-results.adoc[leveloffset=+1]
12+
1113
include::modules/compliance-review.adoc[leveloffset=+1]
1214

1315
include::modules/compliance-apply-remediation-for-customized-mcp.adoc[leveloffset=+1]
@@ -24,9 +26,7 @@ include::modules/compliance-removing-kubeletconfig.adoc[leveloffset=+1]
2426

2527
include::modules/compliance-inconsistent.adoc[leveloffset=+1]
2628

27-
include::modules/compliance-filtering-failed-results.adoc[leveloffset=+1]
28-
2929
[role="_additional-resources"]
3030
== Additional resources
3131

32-
* For more information about `KubeletConfig` objects, see xref:../../nodes/nodes/nodes-nodes-managing.adoc#nodes-nodes-managing-about_nodes-nodes-jobs[Modifying nodes].
32+
* xref:../../nodes/nodes/nodes-nodes-managing.adoc#nodes-nodes-managing-about_nodes-nodes-jobs[Modifying nodes].

0 commit comments

Comments
 (0)