cimg/aws

CircleCI 便捷镜像 => AWS

一个专注于持续交付与部署的 Docker 镜像，专为在 CircleCI 上运行而构建。

![CircleCI 构建状态]([] ![CircleCI 社区]([]

镜像概述和主要用途

cimg/aws 是由 CircleCI 创建的 Docker 镜像，专为持续交付和部署流水线设计。它包含 AWS CLI、相关工具，并基于 https://github.com/CircleCI-Public/cimg-deploy 镜像构建。每个标签都是一个基于日期的快照，旨在为 CircleCI 用户提供稳定、预配置的环境以简化 AWS 相关部署流程。

核心功能和特性

定期更新

镜像每月发布一次，会将主要工具更新到最新可用版本，确保用户使用到最新的 AWS 工具链。

内置 Node.js

该镜像基于 deploy 镜像的 Node.js 变体构建，因此已预安装 Node.js，无需额外配置即可使用 Node.js 相关功能。

标签方案

镜像采用以下标签格式：

cimg/aws:YYYY.MM.I

其中，YYYY 为 4 位年份，MM 为 2 位月份，I 为当月的第 n 次发布。通常情况下，I 仅在需要为当月镜像打补丁时才会变化。

使用场景和适用范围

适用于需要在 CircleCI 环境中执行 AWS 相关操作的持续交付/部署流水线，例如：

• AWS 资源的创建、更新和管理
• 通过 AWS CLI 部署应用程序到 AWS 服务（如 S3、ECS、EKS 等）
• 结合 Node.js 脚本实现复杂的部署逻辑

使用方法和配置说明

快速开始

该镜像可与 CircleCI 的 docker 执行器配合使用。示例配置如下：

yaml
jobs:
  build:
    docker:
      - image: cimg/aws:2022.06.1
    steps:
      - checkout
      - run: echo "执行 AWS 相关操作"
      # 示例：查看 AWS CLI 版本
      - run: aws --version

在上述示例中，CircleCI 作业使用 cimg/aws:2022.06.1 作为主容器，其中 2022.06.1 表示 2022 年 6 月的第 1 次发布。作业中可直接使用镜像预装的 aws 命令等工具。

开发指南

本地构建和运行要求

• Linux（已测试 Ubuntu）或 macOS 本地机器
• 现代版本的 Bash（v4+）
• 现代版本的 Docker Engine（v20.10+）

克隆仓库

社区用户（无仓库写入权限）

1. 在 GitHub 上 Fork 本仓库
2. 使用以下命令克隆（包含子模块）：

   bash
   git clone --recurse-submodules <您的克隆 URL>
   

3. （若已克隆但未初始化子模块）运行：

   bash
   git submodule update --init
   

4. （可选）添加上游仓库：

   bash
   git remote add upstream https://github.com/CircleCI-Public/cimg-aws.git
   

维护者（有仓库写入权限）

使用以下命令克隆（包含子模块）：

bash
git clone --recurse-submodules git@github.com:CircleCI-Public/cimg-aws.git

生成 Dockerfile

通过 gen-dockerfiles.sh 脚本生成 Dockerfile，例如：

bash
./shared/gen-dockerfiles.sh 2022.06.1

生成的 Dockerfile 将位于 ./2022.04/Dockerfile。

本地构建和测试

生成 Dockerfile 后，可本地构建并运行镜像：

bash
cd 2022.04
docker build -t test/aws:2022.06.1 .
docker run -it test/aws:2022.06.1 bash

发布镜像（仅维护者）

使用 release.sh 脚本发布新版本，例如：

bash
./shared/release.sh 1991.04.2

该脚本会自动创建新 Git 分支、生成 Dockerfile、提交更改并推送到 GitHub。提交消息以 [release] 结尾，CircleCI 会据此将镜像推送到 Docker Hub。后续只需等待 CircleCI 构建通过、审核并合并 PR 即可完成发布。

变更整合

构建脚本变更

./shared 子模块的变更在其https://github.com/CircleCI-Public/cimg-shared%E4%B8%AD%E8%BF%9B%E8%A1%8C%E3%80%82%E8%A6%81%E5%B0%86%E8%BF%99%E4%BA%9B%E5%8F%98%E6%9B%B4%E5%BA%94%E7%94%A8%E5%88%B0%E6%9C%AC%E9%95%9C%E5%83%8F%EF%BC%8C%E9%9C%80%E6%9B%B4%E6%96%B0%E5%AD%90%E6%A8%A1%E5%9D%97%EF%BC%9A

bash
cd shared
git pull
cd ..
git add shared
git commit -m "更新子模块以支持某项功能"

父镜像变更

父镜像的变更不会影响现有 AWS 镜像（确保构建确定性），新的 AWS 镜像会自动包含父镜像的最新变更。

AWS 镜像特定变更

编辑仓库中的 Dockerfile.template 文件可修改 AWS 镜像。修改后需重新运行 gen-dockerfiles.sh 脚本以生成本地 Dockerfile。

贡献指南

我们欢迎针对本仓库的https://github.com/CircleCI-Public/cimg-aws/issues%E5%92%8Chttps://github.com/CircleCI-Public/cimg-aws/pulls%E3%80%82%E4%B8%BA%E8%8A%82%E7%9C%81%E6%82%A8%E7%9A%84%E6%97%B6%E9%97%B4%EF%BC%8C%E8%AF%B7%E6%B3%A8%E6%84%8F%E4%BB%A5%E4%B8%8B%E4%BA%8B%E9%A1%B9%EF%BC%9A

1. 并非所有工具都会被纳入镜像。只有被广泛使用且维护良好的工具才会被添加，以避免镜像体积过大。
2. 对于可能需要大量时间实现的 PR，建议先打开 issue 讨论，确保其符合项目方向。
3. issue 应用于报告 bug 或请求添加/移除工具。有关镜像使用帮助，请访问 CircleCI Discuss。

其他资源

• CircleCI 文档 - 官方 CircleCI 文档网站。
• CircleCI 配置参考 - 配置参考页面，列出了 .circleci/config.yml 支持的所有键和值。
• Docker 文档 - 深入学习 Docker 的资源。

许可证

本仓库采用 MIT 许可证，详情参见 https://raw.githubusercontent.com/CircleCI-Public/cimg-aws/main/LICENSE%E3%80%82