yonahdissen/kor

Kor Docker镜像文档

镜像概述和主要用途

Kor是一款Kubernetes未使用资源发现工具，旨在帮助用户识别和清理集群中的冗余资源。通过扫描集群资源并分析其使用情况，Kor能够列出多种未被使用的Kubernetes资源，从而优化集群资源利用率，减少资源浪费。

核心功能和特性

• 支持识别多种未使用的Kubernetes资源，包括：
  • ConfigMaps
  • Secrets
  • Services
  • ServiceAccounts
  • Deployments
  • StatefulSets
  • Roles
  • ClusterRoles
  • HPAs（Horizontal Pod Autoscalers）
  • PVCs（Persistent Volume Claims）
  • Ingresses
  • PDBs（Pod Disruption Budgets）
  • CRDs（Custom Resource Definitions）
  • PVs（Persistent Volumes）
  • Pods
  • Jobs
  • ReplicaSets
  • DaemonSets
  • StorageClasses

使用场景和适用范围

• Kubernetes集群资源清理：定期检查并清理未使用的资源，释放集群空间
• 资源利用率优化：识别冗余资源，提高集群资源使用效率
• 集群审计与维护：作为日常集群维护的一部分，确保资源配置合理
• 成本控制：减少不必要的资源占用，降低集群运行成本
• 适用于Kubernetes管理员、DevOps工程师及负责集群维护的技术人员

使用方法和配置说明

Docker运行

通过Docker容器运行Kor，需挂载kubeconfig文件以访问Kubernetes集群：

sh
# 基本运行（使用默认配置）
docker run --rm -i yonahdissen/kor

# 挂载本地kubeconfig并检查所有未使用资源
docker run --rm -i -v "/path/to/.kube/config:/root/.kube/config" yonahdissen/kor all

Helm部署

Kor可通过Helm chart部署到Kubernetes集群中，支持两种部署模式：

1. 作为CronJob运行（支持Slack通知）

sh
helm upgrade -i kor \
    --namespace kor \
    --create-namespace \
    --set cronJob.enabled=true \
    ./charts/kor

2. 作为Deployment运行（暴露Prometheus指标）

sh
helm upgrade -i kor \
    --namespace kor \
    --create-namespace \
    ./charts/kor

子命令说明

Kor提供多种子命令用于识别不同类型的未使用资源，常用命令包括：

• all - 获取指定命名空间或所有命名空间的所有未使用资源
• configmap - 获取指定命名空间或所有命名空间的未使用ConfigMaps
• secret - 获取指定命名空间或所有命名空间的未使用Secrets
• services - 获取指定命名空间或所有命名空间的未使用Services
• serviceaccount - 获取指定命名空间或所有命名空间的未使用ServiceAccounts
• deployments - 获取指定命名空间或所有命名空间的未使用Deployments
• statefulsets - 获取指定命名空间或所有命名空间的未使用StatefulSets
• role - 获取指定命名空间或所有命名空间的未使用Roles
• clusterrole - 获取集群中未使用的ClusterRoles（命名空间参数指RoleBinding）
• hpa - 获取指定命名空间或所有命名空间的未使用HPAs
• pods - 获取指定命名空间或所有命名空间的未使用Pods
• pvc - 获取指定命名空间或所有命名空间的未使用PVCs
• pv - 获取集群中未使用的PVs（非命名空间资源）
• storageclasses - 获取集群中未使用的StorageClasses（非命名空间资源）
• ingress - 获取指定命名空间或所有命名空间的未使用Ingresses
• pdb - 获取指定命名空间或所有命名空间的未使用PDBs
• crd - 获取集群中未使用的CRDs（非命名空间资源）
• jobs - 获取指定命名空间或所有命名空间的未使用Jobs
• replicasets - 获取指定命名空间或所有命名空间的未使用ReplicaSets
• daemonsets - 获取指定命名空间或所有命名空间的未使用DaemonSets
• finalizers - 获取指定命名空间或所有命名空间中处于待删除状态的未使用资源
• exporter - 导出Prometheus指标
• version - 打印Kor版本信息

使用示例：

sh
# 检查指定命名空间"my-namespace"中的所有未使用资源
kor all --include-namespaces my-namespace

# 查看特定子命令的帮助信息
kor configmap --help

支持的标志

Kor提供多种标志用于自定义资源检查和输出：

更多信息

访问项目GitHub仓库获取完整文档：https://github.com/yonahd/kor