Skip to content

Commit baa2261

Browse files
authored
Merge pull request #95033 from agantony/ROX29774-rhacs-docs-main
[RHACS][Docs] ROX-29774: Additional updates to Compliance docs
2 parents 104f47d + d063322 commit baa2261

8 files changed

+39
-31
lines changed

_topic_maps/_topic_map.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -206,10 +206,10 @@ Topics:
206206
Topics:
207207
- Name: Compliance feature overview
208208
File: compliance-feature-overview
209-
- Name: Monitoring workload and cluster compliance
210-
File: monitoring-workload-and-cluster-compliance
211-
- Name: Scheduling compliance scans and assessing profile compliance
212-
File: scheduling-compliance-scans-and-assessing-profile-compliance
209+
- Name: Using the compliance dashboard (deprecated)
210+
File: using-the-compliance-dashboard
211+
- Name: Using OpenShift compliance
212+
File: using-openshift-compliance
213213
- Name: Evaluating security risks
214214
File: evaluate-security-risks
215215
- Name: Using admission controller enforcement

modules/assessing-the-profile-compliance-across-clusters.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ For more information about how to create a compliance scan schedule, see "Custom
2727
2828
.Procedure
2929

30-
* In the {product-title-short} portal, click *Compliance -> Coverage*.
30+
* In the {product-title-short} portal, click *Compliance -> OpenShift Coverage*.

modules/customizing-and-automating-your-compliance-scans.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ By creating a compliance scan schedule, you can customize and automate your comp
1313
You can only have one schedule that scans the same profile on the same cluster. This means that you cannot create multiple scan schedules for the same profile on a single cluster.
1414
====
1515

16-
1716
.Prerequisites
1817

1918
* You have installed the Compliance Operator version 1.6.0 or later.
@@ -24,7 +23,7 @@ For more information about how to install the Compliance Operator, see "Using th
2423
====
2524
** Currently, the compliance feature and the Compliance Operator evaluate only infrastructure and platform compliance.
2625
27-
** The compliance feature requires the Compliance Operator to be running and does _not_ support Amazon Elastic Kubernetes Service (EKS).
26+
** To use the compliance feature, you must run the Compliance Operator on a {osp} cluster.
2827
====
2928

3029
.Procedure

operating/compliance-operator-rhacs.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ include::modules/compliance-operator-install.adoc[leveloffset=+1]
3535
3636
[role="_additional-resources"]
3737
.Additional resources
38-
* xref:../operating/manage-compliance/scheduling-compliance-scans-and-assessing-profile-compliance.adoc#customizing-and-automating-your-compliance-scans_scheduling-scans-and-assessing-profile-compliance[Customizing and automating your compliance scans]
38+
* xref:../operating/manage-compliance/using-openshift-compliance.adoc#customizing-and-automating-your-compliance-scans_using-openshift-compliance[Customizing and automating your compliance scans]
3939
4040
//Configuring the ScanSettingBinding object
4141
include::modules/compliance-operator-configure-scanning.adoc[leveloffset=+1]
@@ -47,6 +47,6 @@ include::modules/compliance-operator-configure-scanning.adoc[leveloffset=+1]
4747

4848
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-latest-version}/html/security_and_compliance/compliance-operator#understanding-compliance-operator[Understanding the Compliance Operator]
4949
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-latest-version}/html/security_and_compliance/compliance-operator#compliance-operator-scans[Compliance Operator scans]
50-
* xref:../operating/manage-compliance/monitoring-workload-and-cluster-compliance.adoc#checking-the-compliance-status-of-your-infrastructure_monitoring-workload-and-cluster-compliance[Checking the compliance status of your infrastructure]
51-
* xref:../operating/manage-compliance/monitoring-workload-and-cluster-compliance.adoc#viewing-the-compliance-standards-across-your-environment_monitoring-workload-and-cluster-compliance[Viewing the compliance standards across your environment]
52-
* xref:../operating/manage-compliance/scheduling-compliance-scans-and-assessing-profile-compliance.adoc#assessing-the-profile-compliance-across-clusters_scheduling-scans-and-assessing-profile-compliance[Assessing the profile compliance across clusters]
50+
* xref:../operating/manage-compliance/using-the-compliance-dashboard.adoc#checking-the-compliance-status-of-your-infrastructure_using-the-compliance-dashboard[Checking the compliance status of your infrastructure]
51+
* xref:../operating/manage-compliance/using-the-compliance-dashboard.adoc#viewing-the-compliance-standards-across-your-environment_using-the-compliance-dashboard[Viewing the compliance standards across your environment]
52+
* xref:../operating/manage-compliance/using-openshift-compliance.adoc#assessing-the-profile-compliance-across-clusters_using-openshift-compliance[Assessing the profile compliance across clusters]

operating/manage-compliance/compliance-feature-overview.adoc

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,34 @@ The feature includes detailed reports and remediation guidance to help administr
1212

1313
The compliance feature summarizes information into the following sections:
1414

15-
Dashboard:: Formerly known as _Compliance 1.0_, summarizes the compliance information collected from all your clusters. It covers workload and infrastructure compliance.
16-
+
15+
* OpenShift infrastructure compliance
16+
* Dashboard (deprecated)
17+
18+
[id="openshift-infrastructure-compliance_{context}"]
19+
== OpenShift infrastructure compliance
20+
21+
Formerly known as _Compliance 2.0_, summarizes the compliance information in a single interface after the scheduled scans by using the Compliance Operator.
22+
1723
[IMPORTANT]
1824
====
19-
By running a compliance scan in {product-title-short}, you can monitor the entire Kubernetes infrastructure and workloads and ensure that they meet the required standards. You can use the compliance dashboard for filtering and detailed reporting.
25+
* If you have {osp} clusters with the Compliance Operator installed, you can create and manage compliance scan schedules directly in {product-title-short} on the schedules page. The coverage page shows you the scan results associated with a benchmark and profile in a single interface.
2026
21-
For more information, see xref:../../operating/manage-compliance/monitoring-workload-and-cluster-compliance.adoc#monitoring-workload-and-cluster-compliance[Monitoring workload and cluster compliance].
27+
* You can now use the new OpenShift infrastructure compliance feature to assess compliance across your entire OpenShift cluster fleet and ensure consistent adherence to the security policies of your organization. {product-title-short} now generates reports even if some clusters in a scheduled scan fail, so that you can maintain visibility into the compliance status of successfully scanned clusters without data gaps.
28+
+
29+
For more information, see xref:../../operating/manage-compliance/using-openshift-compliance.adoc#using-openshift-compliance[Using OpenShift compliance].
2230
====
2331

24-
OpenShift Schedules and OpenShift Coverage:: Formerly known as _Compliance 2.0_, summarizes the compliance information in a single interface after the scheduled scans by using the Compliance Operator.
25-
+
32+
[id="dashboard_{context}"]
33+
== Dashboard (deprecated)
34+
35+
Formerly known as _Compliance 1.0_, summarizes the compliance information collected from all your clusters. It covers workload and infrastructure compliance. The dashboard is deprecated in {product-title-short} 4.8 and will be removed in a future release.
36+
2637
[IMPORTANT]
2738
====
28-
* If you have {osp} clusters with the Compliance Operator installed, you can create and manage compliance scan schedules directly in {product-title-short} on the schedules page. The coverage page shows you the scan results associated with a benchmark and profile in a single interface.
39+
By running a compliance scan in {product-title-short}, you can monitor the entire Kubernetes infrastructure and workloads and ensure that they meet the required standards. You can use the compliance dashboard for filtering and detailed reporting.
2940
30-
* You can now use the new OpenShift Infrastructure Compliance feature to assess compliance across your entire OpenShift cluster fleet and ensure consistent adherence to the security policies of your organization. {product-title-short} now generates reports even if some clusters in a scheduled scan fail, so that you can maintain visibility into the compliance status of successfully scanned clusters without data gaps.
31-
+
32-
For more information, see xref:../../operating/manage-compliance/scheduling-compliance-scans-and-assessing-profile-compliance.adoc#scheduling-compliance-scans-and-assessing-profile-compliance[Scheduling compliance scans and assessing profile compliance].
41+
For more information, see xref:../../operating/manage-compliance/using-the-compliance-dashboard.adoc#using-the-compliance-dashboard[Using the compliance dashboard (deprecated)].
3342
====
3443

3544
//Compliance assessment and reporting by using {product-title-short}
36-
include::modules/compliance-assessment-and-reporting-by-using-rhacs.adoc[leveloffset=+1]
45+
include::modules/compliance-assessment-and-reporting-by-using-rhacs.adoc[leveloffset=+2]
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="scheduling-compliance-scans-and-assessing-profile-compliance"]
3-
= Scheduling compliance scans and assessing profile compliance
2+
[id="using-openshift-compliance"]
3+
= Using OpenShift compliance
44
include::modules/common-attributes.adoc[]
5-
:context: scheduling-scans-and-assessing-profile-compliance
5+
:context: using-openshift-compliance
66

77
toc::[]
88

@@ -24,7 +24,7 @@ include::modules/analyzing-compliance-scan-schedules.adoc[leveloffset=+2]
2424
[role="_additional-resources"]
2525
.Additional resources
2626

27-
* xref:../../operating/manage-compliance/scheduling-compliance-scans-and-assessing-profile-compliance.adoc#customizing-and-automating-your-compliance-scans_scheduling-scans-and-assessing-profile-compliance[Customizing and automating your compliance scans]
27+
* xref:../../operating/manage-compliance/using-openshift-compliance.adoc#customizing-and-automating-your-compliance-scans_using-openshift-compliance[Customizing and automating your compliance scans]
2828
2929
//OpenShift Schedules page overview
3030
include::modules/schedules-page-overview.adoc[leveloffset=+2]
@@ -42,7 +42,7 @@ include::modules/assessing-the-profile-compliance-across-clusters.adoc[leveloffs
4242
.Additional resources
4343

4444
* xref:../../operating/compliance-operator-rhacs.adoc#compliance-operator-rhacs[Using the Compliance Operator with {product-title}]
45-
* xref:../../operating/manage-compliance/scheduling-compliance-scans-and-assessing-profile-compliance.adoc#customizing-and-automating-your-compliance-scans_scheduling-scans-and-assessing-profile-compliance[Customizing and automating your compliance scans]
45+
* xref:../../operating/manage-compliance/using-openshift-compliance.adoc#customizing-and-automating-your-compliance-scans_using-openshift-compliance[Customizing and automating your compliance scans]
4646
4747
//OpenShift Coverage page overview
4848
include::modules/coverage-page-overview.adoc[leveloffset=+2]

operating/manage-compliance/monitoring-workload-and-cluster-compliance.adoc renamed to operating/manage-compliance/using-the-compliance-dashboard.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="monitoring-workload-and-cluster-compliance"]
3-
= Monitoring workload and cluster compliance
2+
[id="using-the-compliance-dashboard"]
3+
= Using the compliance dashboard (deprecated)
44
include::modules/common-attributes.adoc[]
5-
:context: monitoring-workload-and-cluster-compliance
5+
:context: using-the-compliance-dashboard
66

77
toc::[]
88

operating/view-dashboard.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,6 @@ You can use the *Compliance by standard* widget with the Dashboard filter to foc
112112
====
113113
The *Compliance* widget shows details only after you run a compliance scan.
114114
115-
For more information, see xref:../operating/manage-compliance/monitoring-workload-and-cluster-compliance.adoc#checking-the-compliance-status-of-your-infrastructure_monitoring-workload-and-cluster-compliance[Checking the compliance status of your infrastructure].
115+
For more information, see xref:../operating/manage-compliance/using-the-compliance-dashboard.adoc#checking-the-compliance-status-of-your-infrastructure_using-the-compliance-dashboard[Checking the compliance status of your infrastructure].
116116
====
117117
//TODO: Add link to compliance scan

0 commit comments

Comments
 (0)