Skip to content

Commit e97fea4

Browse files
committed
OCPBUGS-25761: Clarified relationship between rules and profiles
1 parent 371e041 commit e97fea4

File tree

4 files changed

+32
-20
lines changed

4 files changed

+32
-20
lines changed

Diff for: modules/compliance-profile-types.adoc

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/compliance_operator/co-concepts/compliance-operator-understanding.adoc
4+
// * security/compliance_operator/co-scans/compliance-operator-supported-profiles.adoc
5+
6+
:_mod-docs-content-type: REFERENCE
7+
[id="compliance_profile_types_{context}"]
8+
= Compliance Operator profile types
9+
10+
Compliance Operator rules are organized into profiles. Profiles can target the {product-title} Platform or Nodes, and some standards include `rhcos4` Node profiles.
11+
12+
Platform:: Platform scans evaluate your {product-title} cluster components, checking once per scan to verify settings. For example, confirming APIServer configurations are using strong encryption cyphers is Platform-level rule.
13+
14+
Node:: Node scans target the nodes of the cluster, checking every Node in a cluster to verify OpenShift-specific settings. For example, confirming kubeconfig files have the correct permissions to meet a compliance standard is a Node-level rule.
15+
16+
`rhcos4` Node:: Node scans for {op-system-first} Nodes. Every {op-system} Node is checked in a cluster to verify underlying operating system settings. For example, confirming the SSHD service is configured to disable password logins is an {op-system}-level rule.
17+
18+
[IMPORTANT]
19+
====
20+
For compliance standards that have Node and Platform profiles, such as PCI-DSS, you must run both profiles in your {product-title} environment.
21+
22+
For compliance standards that have Node, Platform, and `rhcos4` Node profiles, such as FedRAMP High, you must run all three profiles in your {product-title} environment.
23+
====
24+
25+
[NOTE]
26+
====
27+
Both Node and `rhcos4` Node scans may take a long time to complete in a cluster with many Nodes.
28+
====

Diff for: modules/compliance-profiles.adoc

+1-15
Original file line numberDiff line numberDiff line change
@@ -214,18 +214,4 @@ title: Record Attempts to Alter Logon and Logout Events
214214
warning: Manual editing of these files may indicate nefarious activity, such as an
215215
attacker attempting to remove evidence of an intrusion.
216216
----
217-
====
218-
219-
[id="compliance_profile_types_{context}"]
220-
== Compliance Operator profile types
221-
222-
There are two types of compliance profiles available: Platform and Node.
223-
224-
Platform:: Platform scans target your {product-title} cluster.
225-
226-
Node:: Node scans target the nodes of the cluster.
227-
228-
[IMPORTANT]
229-
====
230-
For compliance profiles that have Node and Platform applications, such as `pci-dss` compliance profiles, you must run both in your {product-title} environment.
231-
====
217+
====

Diff for: security/compliance_operator/co-concepts/compliance-operator-understanding.adoc

+1-5
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,4 @@ The Compliance Operator is available for {op-system-first} deployments only.
1515

1616
include::modules/compliance-profiles.adoc[leveloffset=+1]
1717

18-
[id="additional-resources_compliance-operator-understanding"]
19-
[role="_additional-resources"]
20-
== Additional resources
21-
22-
* xref:../../../security/compliance_operator/co-scans/compliance-operator-supported-profiles.adoc#compliance-operator-supported-profiles[Supported compliance profiles]
18+
include::modules/compliance-profile-types.adoc[leveloffset=+2]

Diff for: security/compliance_operator/co-scans/compliance-operator-supported-profiles.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ The Compliance Operator might report incorrect results on some managed platforms
2727

2828
include::modules/compliance-supported-profiles.adoc[leveloffset=+1]
2929

30+
include::modules/compliance-profile-types.adoc[leveloffset=+2]
31+
3032
[id="additional-resources-compliance-operator-"]
3133
[role="_additional-resources"]
3234
== Additional resources

0 commit comments

Comments
 (0)