Skip to content

Commit fa76b3a

Browse files
committed
OCPBUGS-25761: Clarified relationship between rules and profiles
1 parent ce898fb commit fa76b3a

File tree

4 files changed

+31
-20
lines changed

4 files changed

+31
-20
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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+
[id="compliance_profile_types_{context}"]
7+
= Compliance Operator profile types
8+
9+
There are three types of compliance profiles available: Platform, Node, and {op-system-first} profiles. These profile types contain rules that check both OpenShift and operating system settings, such as {op-system} configurations.
10+
11+
Platform:: Platform scans target your {product-title} cluster, checking once per scan to verify settings. For example, confirming APIServer configurations are using strong encryption cyphers is Platform-level rule.
12+
13+
Node:: Node scans target the nodes of the cluster, checking every Node in a cluster to verify settings. For example, confirming kubeconfig files have the correct permissions to meet a compliance standard is a Node-level rule.
14+
15+
{op-system}:: Node scans for {op-system} Nodes. Every {op-system} Node is checked in a cluster to verify settings. For example, confirming the SSHD service is configured to disable password logins is an {op-system}-level rule.
16+
17+
[NOTE]
18+
====
19+
Both Node and {op-system} scans may take a long time to complete in a cluster with many Nodes.
20+
====
21+
22+
[IMPORTANT]
23+
====
24+
For compliance profiles that have Node and Platform applications, such as `pci-dss` compliance profiles, you must run both in your {product-title} environment.
25+
26+
For compliance profiles that have Node, Platform, and {op-system} applications, such as FedRAMP High compliance profiles, you must run all three in your {product-title} environment.
27+
====

modules/compliance-profiles.adoc

Lines changed: 1 addition & 15 deletions
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+
====

security/compliance_operator/co-concepts/compliance-operator-understanding.adoc

Lines changed: 1 addition & 5 deletions
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]

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

Lines changed: 2 additions & 0 deletions
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)