QuickStart

This topic walks you through the process of enabling KubeSphere Inspector, inspecting clusters, and viewing the inspection reports.

Prerequisites

You have imported an existing cluster or created a lite cluster, and the cluster in the Ready state.

Enabling the cluster inspection component

1. Log in to the KubeSphere Cloud platform with your account.

2. In the upper-right corner, hover your cursor over the username area and click Console from the drop-down list.

3. In the navigation pane on the left, click Cluster Inspection.

4. On the Inspection List page, locate Clusters to Inspect, and click On in the target cluster area.

   common:NOTE

   You can also enable KubeSphere Inspector cluster on the Overview and Resource Management pages.

5. On the Install Cluster Inspection Component dialog box, click Confirm. The system automatically installs the cluster inspection component.

   common:WARNING

   If the version of your inspection component is low, the system will prompt you to upgrade the inspection component. You can not cancel or roll back the upgrade. After the upgrade is completed, the previous inspection reports will not be saved. If you need to keep a record of the inspection results, please make a backup before upgrading.

Inspect clusters

Both manual and scheduled inspection are supported.

If you want to manually inspect clusters, you can click Inspect Clusters in the Inspected Clusters area after cluster inspection component has been installed. If you want to set up scheduled inspections, follow these steps:

1. In the Inspected Clusters area of the Inspection List page, click the target cluster to go to the details page.

2. In the Cluster Info area on the right of the page, click Scheduled.

3. In the Enable Scheduled Inspection dialog box, set the time zone, inspection frequency, and inspection time, and then click OK.

   In the Cluster Info area, you can view the Scheduled Policy and Next Inspection Time.

4. If you want to disable the scheduled inspection, click the button next to Scheduled.

View the inspection result

1. After the inspection is completed, in the Inspected Clusters area of the Inspection List page, click the target cluster to go to the details page.

2. In the Overview area, select the inspection time period to view the health check items and health score. The severity of clusters is highlighted and classified into Normal, Warning, Risky, and Ignore.

3. Click Health Trend to view the health trend of the cluster.

4. In the lower part, you can view the following information.

   Parameter	Description
   Inspection Name	System-generated name of the inspection task.
   Start Time	Time when the inspection starts.
   End Time	Time when the inspection ends.
   Health Score	Health score of clusters.
   Check Item	You can click the inspection name to expand its details page, where you can search for alerts of the target resources, or you can filter the alerts. Inspection items include the following: Resource Name: name of the inspected resource. Resource Name: resource type, such as deployment and node. Cluster Resources: whether it belongs to cluster resources. Namespace: namespace where the alert is reported. Alerts: after you click the alert, alert description, solution, reference, and sample will be displayed on the right of the page.
   Status	Status of the inspection task.

View inspection reports

After inspection reports are generated, you can either export the reports to the local or set an email for receiving the reports.

Export inspection reports

1. In the Overview area of the details page, click Export Report.

2. In the Export Cluster Inspection Report dialog box, set the time range for the inspection report, and click Export.

3. Open the exported report, and you can view the following information.

   Parameter	Description
   Namespace	Namespace where the alert is reported.
   Resource Type	Type of inspection resources.
   Inspection Info	Name of the inspection item.
   Severity	Severity of an alert.
   Best Practice	Solutions for reference.

   common:NOTE

   For more information about alerts and solutions of inspected clusters, refer to View inspection items and solutions.

   Please note that the solutions mentioned in the Best Practices tab page are for reference only. Please handle them based on your actual situation.

Set an email for receiving reports

1. In the Cluster info area on the right, click the button next to Email Report to set an email.

2. In the confirmation dialog box, click Yes to go to the Account Settings page.

3. In the Work email area, set an email for receiving the reports. You can view the email address in the Cluster info area after the email has been set successfully.