开源项目指南：CDK Bill Bot 使用手册

葛瀚纲Deirdre

于 2024-09-16 07:09:49 发布

阅读量811

点赞数 19

本文链接：https://blog.csdn.net/gitblog_00108/article/details/142292987

版权

开源项目指南：CDK Bill Bot 使用手册

cdk-bill-bot The serverless cost optimization bot 项目地址: https://gitcode.com/gh_mirrors/cd/cdk-bill-bot

项目概述

CDK Bill Bot 是一个无服务器的成本优化机器人，由 cremich 在 GitHub 上维护。这个项目提供了一套构建 AWS 成本和使用报告的 L2 和 L3 构建块，利用 AWS Cloud Development Kit (CDK) 进行资源搭建。Bill 的主要目标是帮助 AWS 用户主动监控基础设施成本，防止意外的支出，并实施基本的成本优化策略。

1. 目录结构及介绍

CDK Bill Bot 的项目结构设计是为了便于管理和扩展：

├── docs               # 文档资料，包括API说明和其他指导
├── src                # 核心源代码，包含CDK定义的构建块
├── test               # 测试用例和脚本
├── czrc               # Commitizen配置文件
├── eslintrc.json      # ESLint的配置文件
├── gitattributes      # Git属性文件，可能用于指定文件如何处理
├── gitignore          # 忽略特定文件的Git配置
├── lintstagedrc       # Git钩子相关，控制提交前的代码检查
├── mergify.yml        # Mergify配置，自动化合并Pull Requests
├── npmignore          # 指定npm打包时忽略的文件
├── prettierignore     # Prettier格式化工具忽略的文件列表
├── prettierrc.json    # Prettier的配置文件
├── projenrc.js        # Projen配置文件，用于自动化项目设置
├── package-lock.json  # 依赖包锁定文件
├── package.json       # 包含项目元数据和依赖信息
├── README.md          # 主要的项目读我文件，包含项目介绍和快速入门指南
└── LICENSE            # 许可证文件，该项目遵循Apache-2.0许可证

每个模块都有其明确的职责，比如src包含了实现功能的核心代码，而docs则提供了技术文档。

2. 项目启动文件介绍

CDK Bill Bot并不直接有一个单一的“启动”文件，而是通过CDK命令来启动或部署。核心的交互点是在使用CDK CLI（命令行界面）时创建和管理堆栈，通常从你的主应用文件开始，这可能是如main.ts或在示例配置中指定的任何 TypeScript 文件。例如，如果你遵循教程创建了一个新的CDK应用，启动流程将涉及以下步骤：

入口点：你的应用程序的启动逻辑通常位于类似于app.ts或main.ts的文件中，它初始化CDK环境并定义应用中的所有堆栈。
执行命令：在命令行中运行cdk synth来预览云Formation模板，然后使用cdk deploy实际部署到AWS。

# 初始化CDK环境
cdk init --language typescript

# 编写或修改src目录下的堆栈定义，如main.ts

# 合成云Formation模板查看配置
cdk synth

# 部署至AWS
cdk deploy

3. 项目的配置文件介绍

主要配置文件

package.json: 定义了项目的名称、版本、依赖项、脚本等。这是Node.js项目的基本配置文件，也包含了CDK所需的依赖项。
projenrc.js: 如果项目使用Projen进行自动化项目设置，这个文件定义了项目的构建配置，包括开发工具、代码风格和构建流程等。

特殊配置

cdk.json: 这个文件虽然未在上述目录结构直接列出，但它在某些CDK项目中很常见，用来配置CDK的一些默认行为，如默认的环境变量或构建选项。
环境变量和外部配置: CDK Bill Bot在实际部署时可能会要求配置如Slack Webhook URL等，这些配置往往在环境变量或者作为参数传递给部署命令，而非直接存在于项目文件中。

为了具体配置CDK Bill Bot，用户需关注文档中的指引，特别是关于AWS账号设置、安装CDK以及设置必要的服务连接（如Slack集成）的步骤。在main.ts或相应的启动文件中，配置您的AWS环境和应用特有参数是关键步骤之一。

cdk-bill-bot The serverless cost optimization bot 项目地址: https://gitcode.com/gh_mirrors/cd/cdk-bill-bot