coorpacademy/codebuild

Coorpacademy Infra Docker镜像

Coorpacademy AWS基础设施系统

概述

本Docker镜像为Coorpacademy的AWS基础设施系统提供支持，包含用于生成CloudFormation模板的配置、相关程序及参数，同时提供CLI工具用于与AWS基础设施交互。该镜像主要用于Amazon CodeBuild构建项目，是管理AWS基础设施的核心工具。

核心功能与特性

CLI工具功能

• config：与生成CloudFormation模板的定义相关的子命令
• ssm：与AWS参数存储（Parameter Store）相关的子命令，用于管理环境变量
• stacks：用于操作stacks-configs的子命令
• clusters：用于查看ECS集群状态的子命令
• dns（已禁用）：用于AWS或Heroku DNS路由操作的子命令

其他特性

• 支持交互模式和非交互模式运行CLI命令
• 提供Stack Definition管理，用于描述服务参数并生成对应CloudFormation模板
• 集成AWS服务（如CloudFormation、ECS、SSM等）的管理能力

使用场景与适用范围

适用于需要通过Amazon CodeBuild构建项目，并对AWS基础设施进行管理的开发和运维场景，包括：

• 生成和管理CloudFormation模板
• 操作AWS参数存储中的环境变量
• 管理CloudFormation栈配置
• 监控ECS集群状态

使用方法与配置说明

CLI使用

子命令详情

各分类下的子命令可通过以下方式查看详细信息：

bash
help 子分类  # 或 子分类 help

交互与非交互模式

• 交互模式：直接启动CLI，通过命令行交互操作
• 非交互模式：指定具体命令直接执行，例如：

  bash
  npm start config generate-all
  

安装

本地安装CLI

从项目目录执行以下命令进行本地安装：

bash
npm link

安装后可使用coorpinfra命令调用CLI。

自动补全配置

• Zsh：在.zshrc中添加

  bash
  . <(coorpinfra --completion)
  

• Bash：在.bashrc中添加（需先安装bash-completion）

  bash
  eval "$(coorpinfra --completion)"
  

  若使用brew安装bash-completion，需在~/.bash_profile中添加：

  bash
  source $(brew --prefix)/etc/bash_completion
  

项目结构

镜像包含以下主要目录结构：

• archive：早期CloudFormation模板，作为生成器的参考模型
• codebuild-image：包含Dockerfile及脚本，用于CodeBuild构建项目
• config：项目配置文件（原始配置和生成配置）
  • stack-definitions：栈定义及全局配置（如common.yml）
  • cf-cluster：集群相关CloudFormation配置（ECS集群、VPC、ASG、ALB等）
  • cf-gen-services：生成的服务和CodePipeline相关CloudFormation配置
  • 栈配置文件（如stacks-config-staging.yml）：包含创建CloudFormation栈所需的参数
• lib：CLI代码、工具及生成器（含Handlebars模板）
• test：测试文件

Stack Definition结构

Stack Definition用于描述服务参数，示例如下（以API I18n为例）：

yaml
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: 测试变量
    value: TEST

可通过config generate-all命令从Stack Definition生成CloudFormation模板。

Docker部署说明

该镜像主要用于Amazon CodeBuild项目构建，在AWS CodeBuild配置中引用此镜像即可用于项目构建流程，具体配置需结合AWS CodeBuild项目设置完成。