自定义指标API服务器(Custom-Metrics-ApiServer)安装与使用指南

自定义指标API服务器(Custom-Metrics-ApiServer)安装与使用指南

1. 项目目录结构及介绍

在https://github.com/kubernetes-incubator/custom-metrics-apiserver仓库中，主要的目录结构如下：

1. cmd: 包含主命令入口文件，用于启动自定义指标API服务器。
2. pkg: 存放核心业务逻辑和库，包括提供者接口（如provider），API资源定义（如apis），以及服务器实现（如apiserver）等。
3. examples: 提供示例配置和用法说明。
4. vendor: 第三方依赖库。
5. docs: 文档相关资料。
6. .gitlab-ci.yml: GitLab持续集成配置文件。
7. .travis.yml: Travis CI构建配置文件。

该项目的核心是实现了一个框架，使得开发者能够轻松地添加和管理自定义的度量指标API。

2. 项目的启动文件介绍

主要的启动文件位于cmd目录下，例如adapter/main.go。这个文件包含了启动自定义指标API服务器的主要逻辑，它使用AdapterBase初始化必要的标志并设置API服务器，然后传入已实现的提供者接口。

当你运行go run cmd/adapter/main.go时，程序将会解析命令行参数，加载配置，然后启动自定义指标API服务器。

3. 项目的配置文件介绍

项目的配置通常通过环境变量或命令行参数传递。一些关键的配置项包括：

• ADAPTER_LISTEN_PORT: 自定义API服务器监听的端口。
• ADAPTER_SECURE_PORT: 安全连接下API服务器监听的端口。
• PROVIDERS: 配置自定义指标提供者的参数，如URL、密钥等。
• SERVICEACCOUNT_NAME: 用于API服务器的服务账户名。
• SERVICEACCOUNT_MOUNT_PATH: 服务账户Token挂载路径。

在examples目录下可能能找到配置文件示例，例如config.yaml，这些示例文件可以作为启动API服务器时的参考模板。

请注意，实际的配置可能会因不同的用例和需求而变化，你需要根据实际情况调整配置项和提供者接口实现。

为了正确运行和测试，还需要确保集群内的RBAC规则已经配置好，允许API服务器访问所需的资源和执行操作。这通常涉及到创建ServiceAccount、Role、RoleBinding等对象。

在examples/rbac.yaml中，你可以找到相关的RBAC配置示例，比如为API服务器服务账户授予权限的ClusterRoleBinding和Role。

在部署之前，务必阅读官方文档或示例，以确保了解所有必要的配置选项和步骤。