coorpacademy/codebuild-serverless

Coorpacademy 基础设施

Coorpacademy AWS基础设施系统

概述

本项目包含所有用于基础设施的CloudFormation配置，以及用于生成这些配置的程序、配置和参数。用户入口（开发环境）为CLI，可通过node cli、npm start或安装后通过coorpinfra命令访问。

核心功能与特性

• 提供命令行界面（CLI）用于与基础设施的不同方面交互
• 支持CloudFormation模板的生成与管理
• 集成AWS Parameter Store（SSM）用于存储环境变量
• 管理ECS集群状态及堆栈配置
• 包含CodeBuild镜像及脚本，用于项目构建

使用场景与适用范围

适用于Coorpacademy内部团队管理AWS基础设施，包括：

• 生成和部署CloudFormation堆栈
• 管理环境变量和配置参数
• 监控ECS集群状态
• 自动化代码构建和部署流程（通过CodePipeline）

使用方法与配置说明

CLI使用

启动CLI后，可执行以下类别的命令：

• config：与生成CloudFormation模板相关的子命令
• ssm：与AWS Parameter Store（用于存储环境变量）相关的子命令
• stacks：用于操作堆栈配置的子命令
• clusters：用于查看ECS集群状态的子命令
• dns（已禁用）：用于在AWS或Heroku上执行DNS路由操作的子命令

要查看各子类别中的子命令详情，可执行help my-category或my-category help。

若只需执行单个命令而不进入交互模式，可在调用CLI时直接指定命令，例如：npm start config generate-all。

安装

可通过以下步骤在本地安装CLI：

1. 从项目目录执行npm link
2. coorpinfra工具将可用

自动补全配置

• Zsh：在.zshrc中添加. <(coorpinfra --completion)
• Bash：
  1. 确保已安装bash-completion（可通过brew安装）
  2. 在~/.bash_profile中添加source $(brew --prefix)/etc/bash_completion
  3. 在.bashrc中添加eval "$(coorpinfra --completion)"

项目详情

⚠️ 过时详情待更新

项目结构

项目顶层组织如下：

• archive：包含早期CloudFormation模板，作为生成器的模型
• codebuild-image：包含CodeBuild用于构建项目的Dockerfile和脚本
• config：项目配置（原始或生成的）
  • stack-definitions：堆栈定义集及common.yml中的全局配置
  • cf-cluster：集群配置的CloudFormation文件，包括：
    • ecs.yml：集群定义（目前唯一）
    • vpc.yml：VPC定义（目前唯一）
    • asg.yml：自动扩展组的嵌套模板
    • alb.yml：应用程序负载均衡器的嵌套模板
  • cf-gen-services：为服务和CodePipeline（构建）生成的CloudFormation文件
  • 其他全局配置文件：
    • coorp-dns-records.yml：DNS映射记录，包含当前和未来（AWS）目标
    • 堆栈配置文件（如stacks-config-staging.yml）：包含创建所需堆栈的CloudFormation模板调用参数
• lib：CLI、工具和生成器的代码
  • generator：从堆栈定义生成CloudFormation模板的程序，包含JavaScript逻辑和Handlebars模板
• test：测试用例
• package.json、yarn.lock等：标准项目文件

堆栈定义结构

堆栈定义用于描述要提供的服务参数。每个服务（如mooc、api progression、api platform等）都有一个堆栈定义。

以下是基于API I18n的虚构示例：

yml
name: api-i18n
githubUrl: https://github.com/CoorpAcademy/api-i18n

config:
  minCapacity: 2
  maxCapacity: 10
  port: 3010
  host: i18n${HostSuffix}.coorpacademy.com

buildVariables:
  - name: NpmToken
    variable: NPM_TOKEN
    description: NPM的身份验证令牌
    path: /credentials/global/npm-token

runtimeVariables:
  - name: Test
    variable: TEST2
    describe: TEST2
    value: TEST

此定义用于生成实时部署的堆栈以及用于测试和构建项目的CodePipeline。

注意：变量可以是明文（如Test），也可以存储在AWS Parameter Store中，此时通过path引用变量（如示例中的npm token）。

要从定义生成CloudFormation模板，执行config generate-all命令即可。