Kube-Capacity 使用教程

1. 项目目录结构及介绍

Kube-Capacity 是一个用于查看 Kubernetes 集群资源使用情况的命令行工具。它的目录结构如下：

kube-capacity/
├── go.mod
├── go.sum
├── krew.yaml
├── LICENSE
├── README.md
├── goreleaser.yml
├── gitignore
├── golangci.yml
├── main.go
└── pkg/

• go.mod 和 go.sum：Go 项目的依赖管理文件。
• krew.yaml：Krew 插件的配置文件，用于将 Kube-Capacity 打包成 Kubectl 插件。
• LICENSE：项目使用的 Apache-2.0 许可证文件。
• README.md：项目的说明文件。
• goreleaser.yml：Goreleaser 的配置文件，用于自动化发布。
• gitignore：Git 忽略文件。
• golangci.yml：GolangCI 的配置文件，用于代码风格和错误检查。
• main.go：项目的入口文件。
• pkg/：包含项目的核心逻辑。

2. 项目的启动文件介绍

项目的启动文件是 main.go。以下是 main.go 的主要部分：

package main

import (
    "fmt"
    "os"

    "github.com/robscott/kube-capacity/pkg/kubecap"
)

func main() {
    if len(os.Args) < 2 {
        fmt.Println("Usage of kube-capacity:")
        fmt.Println("kube-capacity [flags]")
        os.Exit(1)
    }

    // 初始化命令行参数解析
    parser := kubecap.NewArgumentParser()
    args, err := parser.ParseFlags(os.Args[1:])
    if err != nil {
        fmt.Println("Error parsing flags:", err)
        os.Exit(1)
    }

    // 运行命令
    if err := kubecap.Run(args); err != nil {
        fmt.Println("Error running kube-capacity:", err)
        os.Exit(1)
    }
}

main.go 文件负责解析命令行参数并启动 Kube-Capacity。

3. 项目的配置文件介绍

Kube-Capacity 的配置主要通过命令行参数进行。目前没有独立的配置文件。在 main.go 中，通过 NewArgumentParser 函数创建一个命令行参数解析器，然后通过 ParseFlags 函数解析命令行参数。

例如，以下是如何使用命令行参数运行 Kube-Capacity 并显示资源使用情况：

kube-capacity --util

这个命令将显示 Kubernetes 集群中每个节点的资源请求、限制和使用情况。可以通过其他命令行参数来调整输出内容，例如 --pods 会包含每个 Pod 的详细信息。

Kube-Capacity 的配置主要通过命令行参数进行，目前没有提供通过外部配置文件进行配置的选项。