public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-12 12:07:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: remove 'Skip Tests' section and related references from compliance scan guides

Browse Source
This commit is contained in:
Krunal Hingu
2025-07-24 10:47:05 +05:30
committed by swastik959
parent e8d3c04c6a
commit 28511bb76b
7 changed files with 0 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/how-to-guides/advanced-user-guides/compliance-scan-guides/compliance-scan-guides.md
-1
View File
@@ -10,7 +10,6 @@ title: Compliance Scan Guides
- [Uninstall rancher-compliance](uninstall-rancher-compliance.md)
- [Run a Scan](run-a-scan.md)
- [Run a Scan Periodically on a Schedule](run-a-scan-periodically-on-a-schedule.md)
- [Skip Tests](skip-tests.md)
- [View Reports](view-reports.md)
- [Enable Alerting for rancher-compliance](enable-alerting-for-rancher-compliance.md)
- [Configure Alerts for Periodic Scan on a Schedule](configure-alerts-for-periodic-scan-on-a-schedule.md)
docs/how-to-guides/advanced-user-guides/compliance-scan-guides/skip-tests.md
-38
View File
@@ -1,38 +0,0 @@
---
title: Skip Tests
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/compliance-scan-guides/skip-tests"/>
</head>
Compliance scans can be run using test profiles with user-defined skips.
To skip tests, you will create a custom Compliance scan profile. A profile contains the configuration for the Compliance scan, which includes the benchmark versions to use and any specific tests to skip in that benchmark.
1. In the upper left corner, click **☰ > Cluster Management**.
1. the **Clusters** page, go to the cluster where you want to run a Compliance scan and click **Explore**.
1. Click **Compliance > Profile**.
1. From here, you can create a profile in multiple ways. To make a new profile, click **Create** and fill out the form in the UI. To make a new profile based on an existing profile, go to the existing profile and click **⋮ Clone**. If you are filling out the form, add the tests to skip using the test IDs, using the relevant Compliance as a reference. If you are creating the new test profile as YAML, you will add the IDs of the tests to skip in the `skipTests` directive. You will also give the profile a name:
```yaml
apiVersion: compliance.cattle.io/v1
kind: ClusterScanProfile
metadata:
annotations:
meta.helm.sh/release-name: clusterscan-operator
meta.helm.sh/release-namespace: compliance-operator-system
labels:
app.kubernetes.io/managed-by: Helm
name: "<example-profile>"
spec:
benchmarkVersion: rke2-cis-1.7
skipTests:
- "1.1.20"
- "1.1.21"
```
1. Click **Create**.
**Result:** A new compliance profile is created.
When you [run a scan](./run-a-scan.md) that uses this profile, the defined tests will be skipped during the scan. The skipped tests will be marked in the generated report as `Skip`.
docusaurus.config.js
-4
View File
@@ -1587,10 +1587,6 @@ module.exports = {
from: "/how-to-guides/advanced-user-guides/cis-scan-guides/run-a-scan-periodically-on-a-schedule",
to: "/how-to-guides/advanced-user-guides/compliance-scan-guides/run-a-scan-periodically-on-a-schedule",
},
{
from: "/how-to-guides/advanced-user-guides/cis-scan-guides/skip-tests",
to: "/how-to-guides/advanced-user-guides/compliance-scan-guides/skip-tests",
},
{
from: "/how-to-guides/advanced-user-guides/cis-scan-guides/view-reports",
to: "/how-to-guides/advanced-user-guides/compliance-scan-guides/view-reports",
sidebars.js
-1
View File
@@ -772,7 +772,6 @@ const sidebars = {
"how-to-guides/advanced-user-guides/compliance-scan-guides/uninstall-rancher-compliance",
"how-to-guides/advanced-user-guides/compliance-scan-guides/run-a-scan",
"how-to-guides/advanced-user-guides/compliance-scan-guides/run-a-scan-periodically-on-a-schedule",
"how-to-guides/advanced-user-guides/compliance-scan-guides/skip-tests",
"how-to-guides/advanced-user-guides/compliance-scan-guides/view-reports",
"how-to-guides/advanced-user-guides/compliance-scan-guides/enable-alerting-for-rancher-compliance",
"how-to-guides/advanced-user-guides/compliance-scan-guides/configure-alerts-for-periodic-scan-on-a-schedule",
versioned_docs/version-2.12/how-to-guides/advanced-user-guides/compliance-scan-guides/compliance-scan-guides.md
-1
View File
@@ -10,7 +10,6 @@ title: Compliance Scan Guides
- [Uninstall rancher-compliance](uninstall-rancher-compliance.md)
- [Run a Scan](run-a-scan.md)
- [Run a Scan Periodically on a Schedule](run-a-scan-periodically-on-a-schedule.md)
- [Skip Tests](skip-tests.md)
- [View Reports](view-reports.md)
- [Enable Alerting for rancher-compliance](enable-alerting-for-rancher-compliance.md)
- [Configure Alerts for Periodic Scan on a Schedule](configure-alerts-for-periodic-scan-on-a-schedule.md)
versioned_docs/version-2.12/how-to-guides/advanced-user-guides/compliance-scan-guides/skip-tests.md
-38
View File
@@ -1,38 +0,0 @@
---
title: Skip Tests
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/compliance-scan-guides/skip-tests"/>
</head>
Compliance scans can be run using test profiles with user-defined skips.
To skip tests, you will create a custom Compliance scan profile. A profile contains the configuration for the Compliance scan, which includes the benchmark versions to use and any specific tests to skip in that benchmark.
1. In the upper left corner, click **☰ > Cluster Management**.
1. the **Clusters** page, go to the cluster where you want to run a Compliance scan and click **Explore**.
1. Click **Compliance > Profile**.
1. From here, you can create a profile in multiple ways. To make a new profile, click **Create** and fill out the form in the UI. To make a new profile based on an existing profile, go to the existing profile and click **⋮ Clone**. If you are filling out the form, add the tests to skip using the test IDs, using the relevant Compliance as a reference. If you are creating the new test profile as YAML, you will add the IDs of the tests to skip in the `skipTests` directive. You will also give the profile a name:
```yaml
apiVersion: compliance.cattle.io/v1
kind: ClusterScanProfile
metadata:
annotations:
meta.helm.sh/release-name: clusterscan-operator
meta.helm.sh/release-namespace: compliance-operator-system
labels:
app.kubernetes.io/managed-by: Helm
name: "<example-profile>"
spec:
benchmarkVersion: rke2-cis-1.7
skipTests:
- "1.1.20"
- "1.1.21"
```
1. Click **Create**.
**Result:** A new compliance profile is created.
When you [run a scan](./run-a-scan.md) that uses this profile, the defined tests will be skipped during the scan. The skipped tests will be marked in the generated report as `Skip`.
versioned_sidebars/version-2.12-sidebars.json
-1
View File
@@ -736,7 +736,6 @@
"how-to-guides/advanced-user-guides/compliance-scan-guides/uninstall-rancher-compliance",
"how-to-guides/advanced-user-guides/compliance-scan-guides/run-a-scan",
"how-to-guides/advanced-user-guides/compliance-scan-guides/run-a-scan-periodically-on-a-schedule",
"how-to-guides/advanced-user-guides/compliance-scan-guides/skip-tests",
"how-to-guides/advanced-user-guides/compliance-scan-guides/view-reports",
"how-to-guides/advanced-user-guides/compliance-scan-guides/enable-alerting-for-rancher-compliance",
"how-to-guides/advanced-user-guides/compliance-scan-guides/configure-alerts-for-periodic-scan-on-a-schedule",