pahud/cdk-remote

cdk-remote Docker镜像文档

概述

cdk-remote 是一个Docker镜像，旨在帮助用户部署AWS CDK应用，无需在本地安装aws-cdk CLI，甚至无需安装npm或node。通过该镜像，用户可以直接从远程GitHub仓库部署CDK应用，极大简化了AWS CDK的部署流程。

核心功能和特性

• 无本地依赖：无需在本地安装aws-cdk CLI、npm或node环境
• 远程部署支持：直接部署托管在GitHub上的CDK应用
• AWS凭证集成：通过挂载本地AWS凭证文件实现身份验证
• 灵活参数传递：支持传递CDK命令参数（如diff、deploy）、堆栈名称及上下文参数

使用场景和适用范围

• 开发者需要快速部署AWS CDK应用，不想在本地配置完整的CDK开发环境
• CI/CD流程中集成CDK部署步骤，避免环境依赖冲突
• 临时或多环境下的CDK应用部署测试
• 需要统一CDK部署环境版本的团队协作场景

使用方法和配置说明

镜像信息

Docker镜像名称：pahud/cdk-remote:latest

准备工作

1. 创建一个cdk-remote shell脚本并添加到系统$PATH中：

sh
#!/bin/bash

docker run -ti \
  -e AWS_DEFAULT_REGION=${AWS_DEFAULT_REGION-us-east-1} \
  -e AWS_REGION=${AWS_REGION-${AWS_DEFAULT_REGION}} \
  -v ${HOME}/.aws:/root/.aws pahud/cdk-remote $@

2. 为脚本添加执行权限：

sh
chmod +x /path/to/cdk-remote

基本使用示例

部署GitHub上的CDK应用

以部署仓库https://github.com/pahud/aws-cdk-serverless-sample为例：

bash
# 部署前查看变更
$ cdk-remote github.com/pahud/aws-cdk-serverless-sample diff

# 部署应用
$ cdk-remote github.com/pahud/aws-cdk-serverless-sample deploy

指定堆栈名称和上下文参数

部署https://github.com/pahud/cdk-samples/typescript中的EksStack堆栈：

bash
# 查看变更
$ cdk-remote github.com/pahud/cdk-samples/typescript diff EksStack -c enable_stack=EksStack -c use_default_vpc=1

# 部署堆栈
$ cdk-remote github.com/pahud/cdk-samples/typescript deploy EksStack -c enable_stack=EksStack -c use_default_vpc=1

部署Bottlerocket堆栈（带Amazon EKS集群）

bash
# 查看变更
$ cdk-remote github.com/pahud/cdk-samples/typescript diff Bottlerocket -c enable_stack=Bottlerocket

# 部署堆栈
$ cdk-remote github.com/pahud/cdk-samples/typescript deploy Bottlerocket -c enable_stack=Bottlerocket

环境变量说明

• AWS_DEFAULT_REGION：默认AWS区域，未指定时默认为us-east-1
• AWS_REGION：AWS区域，未指定时使用AWS_DEFAULT_REGION的值

安全注意事项

cdk-remote通过docker -v将本地AWS凭证目录（~/.aws）挂载到容器中，以代表用户向AWS环境部署远程CDK应用。请确保在部署前信任该远程应用，避免部署不受信任的代码导致安全风险。