Kubernetes 清理器(k8s-cleaner)安装与使用指南

---

1. 项目目录结构及介绍

k8s-cleaner 是一个旨在保持 Kubernetes 集群整洁高效的控制器。其GitHub仓库遵循标准的Go项目布局，主要关注点在于核心的清理逻辑。以下是基于描述的简化目录结构概述：

• main: 包含主入口点代码，负责初始化和运行清理逻辑。
• cmd: 存放用于部署或管理应用的具体命令行工具。
• pkg: 包括核心业务逻辑，如资源选择器的实现、清理策略等。
• config: 可能存放默认配置或者示例配置文件，虽然在提供的信息中没有具体列出这个路径，但它在同类项目中很常见。
• docs: 用户文档或API文档可能存放于此，帮助理解如何使用和集成项目。
• examples: 提供实例配置文件，展示如何创建Cleaner实例来定义资源清理规则。
• charts, manifest: 通常包含Helm图表或Kubernetes资源清单，用于部署k8s-cleaner到集群。

---

2. 项目启动文件介绍

k8s-cleaner作为Kubernetes的一个控制器，它本身不直接通过传统意义上的“启动文件”来运行，而是需要通过Kubernetes的资源管理和部署机制进行部署。主要依赖于一个Kubernetes资源清单（YAML文件）来部署至集群。根据项目说明，可以通过以下命令快速安装：

kubectl apply -f https://raw.githubusercontent.com/gianlucam76/k8s-cleaner/main/manifest/manifest.yaml

这里的manifest.yaml就是部署k8s-cleaner的关键文件，包含了控制器的服务账号、CRD定义以及其他必要的Kubernetes资源，使得k8s-cleaner能够在你的集群中运作起来。

---

3. 项目的配置文件介绍

k8s-cleaner的配置并不直接体现在单一的“配置文件”中，而是通过创建Cleaner实例资源来进行定制。这意味着，用户需要编写Kubernetes的CustomResourceDefinition (CRD)，具体来说，比如创建一个具有特定清理规则的Cleaner对象。以下是一个Cleaner配置的例子：

apiVersion: apps.projectsveltos.io/v1alpha1
kind: Cleaner
metadata:
  name: cleaner-with-slack-notifications
spec:
  schedule: "0 * * * *" # 定时任务设置
  action: Delete    # 行动指令：删除匹配的资源
  resourcePolicySet:
    resourceSelectors:
      - namespace: test   # 指定命名空间
        kind: Deployment  # 资源类型
        group: "apps"
        version: v1
  notifications:
    - name: slack       # 通知方式：Slack
      type: Slack
      notificationRef:
        apiVersion: v1
        kind: Secret
        name: slack
        namespace: default

在这个例子中，我们看到Cleaner CRD允许用户灵活地设定清理的计划、所操作的动作（如删除）、资源的选择条件以及通知方式，确保了k8s-cleaner的高度可定制性，以适应不同的集群管理需求。

---

总结而言，k8s-cleaner通过提供CRDs让管理员能够根据需要定义清理规则和策略，结合定时任务和通知系统，自动化维护Kubernetes集群的健康状态，减少资源浪费，提升整体效率。