mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-14 21:14:23 +00:00
Updating new site with new docs content
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Contributing to Rancher
|
||||
weight: 27
|
||||
weight: 700
|
||||
---
|
||||
|
||||
This section explains the repositories used for Rancher, how to build the repositories, and what information to include when you file an issue.
|
||||
|
||||
@@ -1 +1,6 @@
|
||||
<!-- PLACEHOLDER -->
|
||||
---
|
||||
title: Explanations
|
||||
weight: 400
|
||||
---
|
||||
|
||||
**Explanatory docs** are concerned primarily with providing theoretical knowledge for the "why" behind a task or a topic. Explanations are "understanding-oriented" in nature and will clarify a topic in order to broaden the user's knowledge. In this section, users can find additional context and background, alternatives or even opinions on topics, and often historical reasons, constraints, and insights into why a process works the way that it does.
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: FAQ
|
||||
weight: 25
|
||||
weight: 500
|
||||
---
|
||||
|
||||
This FAQ is a work in progress designed to answers the questions our users most frequently ask about Rancher v2.x.
|
||||
|
||||
+11
-1
@@ -1 +1,11 @@
|
||||
<!-- PLACEHOLDER -->
|
||||
---
|
||||
title: Getting Started
|
||||
weight: 100
|
||||
---
|
||||
|
||||
To get up and running with Rancher quickly, we have included a **Getting Started** section.
|
||||
|
||||
The goal of this section is to be able to assist users in deploying Rancher and workloads and to install or upgrade Rancher quickly and effectively.
|
||||
|
||||
Please see the [introduction], [quick start guides], and the [installation and upgrade] sections for more.
|
||||
|
||||
|
||||
@@ -1 +1,6 @@
|
||||
<!-- PLACEHOLDER -->
|
||||
---
|
||||
title: How-to Guides
|
||||
weight: 200
|
||||
---
|
||||
|
||||
**How-to guides** serve to describe practical steps for users to accomplish some task. In Rancher, we break down how-to guides further into [new user guides] and [advanced user guides].
|
||||
+42
-1
@@ -1 +1,42 @@
|
||||
<!-- PLACEHOLDER -->
|
||||
---
|
||||
title: Configure Alerts for Periodic Scan on a Schedule
|
||||
weight: 8
|
||||
---
|
||||
|
||||
It is possible to run a ClusterScan on a schedule.
|
||||
|
||||
A scheduled scan can also specify if you should receive alerts when the scan completes.
|
||||
|
||||
Alerts are supported only for a scan that runs on a schedule.
|
||||
|
||||
The CIS Benchmark application supports two types of alerts:
|
||||
|
||||
- Alert on scan completion: This alert is sent out when the scan run finishes. The alert includes details including the ClusterScan’s name and the ClusterScanProfile name.
|
||||
|
||||
- Alert on scan failure: This alert is sent out if there are some test failures in the scan run or if the scan is in a Fail state.
|
||||
|
||||
:::note Prerequisite:
|
||||
|
||||
Before enabling alerts for `rancher-cis-benchmark`, make sure to install the `rancher-monitoring` application and configure the Receivers and Routes. For more information, see this [section](https://rancher.com/docs/rancher/v2.6/en/monitoring-alerting/configuration/).
|
||||
|
||||
While configuring the routes for `rancher-cis-benchmark` alerts, you can specify the matching using the key-value pair `job: rancher-cis-scan`. An example route configuration is [here](https://rancher.com/docs/rancher/v2.6/en/monitoring-alerting/configuration/receiver/#example-route-config-for-cis-scan-alerts).
|
||||
|
||||
:::
|
||||
|
||||
To configure alerts for a scan that runs on a schedule,
|
||||
|
||||
1. Please enable alerts on the `rancher-cis-benchmark` application (#enabling-alerting-for-rancher-cis-benchmark)
|
||||
1. In the upper left corner, click **☰ > Cluster Management**.
|
||||
1. On the **Clusters** page, go to the cluster where you want to run a CIS scan and click **Explore**.
|
||||
1. Click **CIS Benchmark > Scan**.
|
||||
1. Click **Create**.
|
||||
1. Choose a cluster scan profile. The profile determines which CIS Benchmark version will be used and which tests will be performed. If you choose the Default profile, then the CIS Operator will choose a profile applicable to the type of Kubernetes cluster it is installed on.
|
||||
1. Choose the option **Run scan on a schedule**.
|
||||
1. Enter a valid [cron schedule expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) in the field **Schedule**.
|
||||
1. Check the boxes next to the Alert types under **Alerting**.
|
||||
1. Optional: Choose a **Retention Count**, which indicates the number of reports maintained for this recurring scan. By default this count is 3. When this retention limit is reached, older reports will get purged.
|
||||
1. Click **Create**.
|
||||
|
||||
**Result:** The scan runs and reschedules to run according to the cron schedule provided. Alerts are sent out when the scan finishes if routes and receiver are configured under `rancher-monitoring` application.
|
||||
|
||||
A report is generated with the scan results every time the scan runs. To see the latest results, click the name of the scan that appears.
|
||||
+12
-1
@@ -1 +1,12 @@
|
||||
<!-- PLACEHOLDER -->
|
||||
---
|
||||
title: Install Rancher CIS Benchmark
|
||||
weight: 1
|
||||
---
|
||||
|
||||
1. In the upper left corner, click **☰ > Cluster Management**.
|
||||
1. On the **Clusters** page, go to the cluster where you want to install CIS Benchmark and click **Explore**.
|
||||
1. In the left navigation bar, click **Apps & Marketplace > Charts**.
|
||||
1. Click **CIS Benchmark**.
|
||||
1. Click **Install**.
|
||||
|
||||
**Result:** The CIS scan application is deployed on the Kubernetes cluster.
|
||||
@@ -1 +1,23 @@
|
||||
<!-- PLACEHOLDER -->
|
||||
---
|
||||
title: Run a Scan
|
||||
weight: 3
|
||||
---
|
||||
|
||||
When a ClusterScan custom resource is created, it launches a new CIS scan on the cluster for the chosen ClusterScanProfile.
|
||||
|
||||
:::note
|
||||
|
||||
There is currently a limitation of running only one CIS scan at a time for a cluster. If you create multiple ClusterScan custom resources, they will be run one after the other by the operator, and until one scan finishes, the rest of the ClusterScan custom resources will be in the “Pending” state.
|
||||
|
||||
:::
|
||||
|
||||
To run a scan,
|
||||
|
||||
1. In the upper left corner, click **☰ > Cluster Management**.
|
||||
1. On the **Clusters** page, go to the cluster where you want to run a CIS scan and click **Explore**.
|
||||
1. Click **CIS Benchmark > Scan**.
|
||||
1. Click **Create**.
|
||||
1. Choose a cluster scan profile. The profile determines which CIS Benchmark version will be used and which tests will be performed. If you choose the Default profile, then the CIS Operator will choose a profile applicable to the type of Kubernetes cluster it is installed on.
|
||||
1. Click **Create**.
|
||||
|
||||
**Result:** A report is generated with the scan results. To see the results, click the name of the scan that appears.
|
||||
+12
-1
@@ -1 +1,12 @@
|
||||
<!-- PLACEHOLDER -->
|
||||
---
|
||||
title: Uninstall Rancher CIS Benchmark
|
||||
weight: 2
|
||||
---
|
||||
|
||||
1. From the **Cluster Dashboard**, go to the left navigation bar and click **Apps & Marketplace > Installed Apps**.
|
||||
|
||||
1. Go to the **cis-operator-system** namespace and check the boxes next to **rancher-cis-benchmark-crd** and **rancher-cis-benchmark**.
|
||||
|
||||
1. Click **Delete** and confirm **Delete**.
|
||||
|
||||
**Result:** The `rancher-cis-benchmark` application is uninstalled.
|
||||
@@ -1 +1,12 @@
|
||||
<!-- PLACEHOLDER -->
|
||||
---
|
||||
title: Reference Guides
|
||||
weight: 300
|
||||
---
|
||||
|
||||
**Reference guides** are technical descriptions of processes or products that users can study. Reference guides are designed to be "information-oriented" and their primary function is to describe.
|
||||
|
||||
These docs may also include some usage steps in the course of description; however, their purpose is not to explain concepts nor to outline steps to achieve tasks.
|
||||
|
||||
The users who utilize reference guides are knowledgeable with the Rancher product as well as how to use it. They will benefit from detailed descriptions of something to be used when needing to refer to specifics of usage.
|
||||
|
||||
Good examples of Rancher reference guides would be the [Rancher Manager architecture] and [cluster configuration guides].
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Troubleshooting
|
||||
weight: 26
|
||||
weight: 600
|
||||
---
|
||||
|
||||
This section contains information to help you troubleshoot issues when using Rancher.
|
||||
|
||||
Reference in New Issue
Block a user