快速入门

本节介绍如何在 KubeSphere Cloud 云原生应用服务平台上启用集群巡检组件，执行巡检任务，并查看巡检结果。

前提条件

已导入已有集群或新建集群，且集群处于已就绪状态。

启用集群巡检组件

1. 使用您的账户登录 KubeSphere Cloud 云原生应用服务平台。

2. 将光标移动到页面顶栏右侧的用户名区域，在弹出菜单中点击管理控制台。

3. 在左侧导航栏，点击集群巡检服务展开右侧的巡检列表，列表下显示了已开启、已暂停、待开启巡检组件的集群。

4. 在巡检列表页面，点击待开启集群下的开启巡检组件。

   common:NOTE

   您也可以在服务概览页面点击集群巡检服务下的开启巡检。

5. 在弹出的确认开启集群巡检组件对话框，点击开启，系统会自动为您的集群安装巡检组件。

   common:WARNING

   如果您的巡检组件版本较低，系统会提示您升级巡检组件。升级期间不可取消、回退。升级完成后，之前的巡检报告将不被保存。若需记录巡检结果，请在升级前自行备份。

执行集群巡检

集群巡检支持手动巡检和定期巡检。

如果您需要进行手动巡检，等待集群组件安装成功后，在已开启集群区域，点击开始巡检即可。如果需要设置定期巡检，请参考以下步骤。

1. 在巡检列表的已开启集群区域，点击目标集群名进入巡检详情页面。

2. 在页面右侧的集群信息区域，开启定时巡检。

3. 在弹出的启用定时巡检对话框，设置系统时区，巡检频率以及巡检时间，点击确认。

   在集群信息区域，您可以查看定时策略和下次巡检时间。

4. 如果您需要关闭定时巡检，点击定时巡检后的按钮。

查看巡检结果

1. 等待巡检完成后，在已开启集群区域，点击已巡检的集群进入巡检详情页面。

2. 在巡检数据总览区域，选择巡检时间段，查看健康检查项和巡检分数。集群巡检会按照触发风险的程度分为正常项、警告项、危险项和可忽略项，并高亮显示。

3. 点击健康趋势，您可以查看集群的健康趋势图。

4. 在页面下侧区域，您可以查看以下信息。

   参数	描述
   巡检名称	系统自定义的巡检任务名称。
   巡检开始时间	巡检任务开始的时间。
   巡检结束时间	巡检任务结束的时间。
   健康分数	集群的健康分数。
   巡检项	点击可以展开巡检项详情。巡检项详情页面，您可以直接搜索资源名称查看告警，也可以点击筛选筛选特定的资源告警。巡检项包括以下： 资源名称：巡检资源的名称。 资源类型：资源的类型，如 deployment，node 等。 是否集群资源：是否属于集群的资源。 命名空间：所处的命名空间。 告警项：点击可展开详细的告警项。点击部分告警项，页面右侧会出现告警描述信息、解决方案、参考链接和示例。
   巡检执行状态	巡检任务的执行状态。

查看巡检报告

巡检报告生成后，您可以下载巡检报告至本地查看，也可以设置邮箱接收报告。

导出巡检报告至本地

1. 在巡检详情页面的巡检数据总览区域，点击导出巡检报告。

2. 在确认导出集群巡检报告对话框，设置巡检报告的时间范围，点击导出。

3. 点击特定日期的巡检任务页签，您可以查看以下信息。

   参数	描述
   命名空间	所处的命名空间。
   资源类型	巡检资源类型。
   巡检信息	巡检项名称。
   风险等级	检查项的风险等级。
   最佳实践	提供修复方案供参考。

   common:NOTE

   关于集群巡检的常见风险预警及修复方案的更多信息，请参阅查看集群巡检项及修复方案。

   最佳实践页签里面提到的修复方案仅供参考，请根据实际情况处理。

通过邮件接收巡检报告

1. 在巡检详情页面的集群信息区域，点击邮件报告后的开启按钮。

2. 在弹出的设置邮箱确认对话框，点击前往跳转到账号设置页面。

3. 在工作邮箱区域，设置工作邮箱，即巡检报告接收邮箱。

   邮箱设置成功后，您可以在集群信息区域查看报告接收邮箱信息。