使用和，在 Amazon ECS Anywhere 上为混合工作负载设置 CI/CD 管道 AWS CDK GitLab

由 Rahul Sharad Gaikwad 博士创作 () AWS

摘要

注意：AWS CodeCommit 不再向新客户开放。AWS CodeCommit 的现有客户可以继续正常使用该服务。了解更多。

Amazon ECS Anywhere 是亚马逊弹性容器服务（亚马逊ECS）的扩展。它支持将外部实例（例如本地服务器或虚拟机 (VM)）注册到您的 Amazon ECS 集群。其功能有助于降低成本并缓解复杂的本地容器编排和操作。您可以使用 ECS Anywhere 在本地和云环境中部署和运行容器应用程序。它使您的团队无需学习多个域和技能组合，也无需自行管理复杂的软件。

此模式描述了 step-by-step一种使用亚马逊网络服务 (AWS) Cloud Development Kit () 堆栈 () 为亚马逊ECS集群配置 Amazon ECS Anywhere 实例的方法。AWS CDK然后，您可以使用AWS CodePipeline 设置持续集成和持续部署 (CI/CD) 管道。然后，将您的 GitLab 代码存储库复制到 Amazon 集群，AWS CodeCommit 并将您的容器化应用程序部署到 Ama ECS zon 集群上。

此模式旨在帮助那些使用本地基础设施运行容器应用程序并 GitLab 用于管理应用程序代码库的用户。您可以使用AWS云服务管理这些工作负载，而不会干扰现有的本地基础架构。

先决条件和限制

先决条件

一个活动的 AWS 账户。
在本地基础设施上运行的容器应用程序。
用于管理应用程序代码 GitLab 库的存储库。有关更多信息，请参阅存储库 (GitLab)。
AWS已安装并配置命令行界面 (AWSCLI)。有关更多信息，请参阅安装或更新最新版本的 AWS CLI（AWSCLI文档）。
AWSCDK工具包，已在全球范围内安装和配置。有关更多信息，请参阅安装 AWS CDK（AWSCDK文档）。
npm，已安装并配置为AWSCDK中。 TypeScript有关更多信息，请参阅下载和安装 Node.js 和 npm（npm 文档）。

限制

有关限制和注意事项，请参阅亚马逊ECS文档中的外部实例（Amazon ECS Anywhere）。

产品版本

AWSCDK工具包版本 2.27.0 或更高版本
npm 版本 7.20.3 或更高版本
Node.js 版本 16.6.1 或更高版本

架构

目标技术堆栈

AWS CDK
AWS CloudFormation
AWS CodeBuild
AWS CodeCommit
AWS CodePipeline
亚马逊无ECS处不在
亚马逊弹性容器注册表（亚马逊ECR）
AWSIdentity and Access Management (IAM)
AWS系统经理
GitLab 存储库

目标架构

此图表示此模式中描述的两个主要工作流程，即配置 Amazon ECS 集群和设置CI/CD pipeline that sets up and deploys the CI/CD管道，如下所示：

配置 Amazon ECS 集群
1. 部署第一个AWSCDK堆栈时，它会在上面创建一个 CloudFormation 堆栈AWS。
2. 此 CloudFormation 堆栈预置 Amazon ECS 集群和相关AWS资源。
3. 要向亚马逊ECS集群注册外部实例，您必须在虚拟机上安装 S AWS ystems Manager 代SSM理（代理），并将该虚拟机注册为 S AWS ystems Manager 托管实例。
4. 您还必须在虚拟机上安装 Amazon ECS 容器代理和 Docker，才能将其注册为亚马逊ECS集群的外部实例。
5. 在 Amazon ECS 集群中注册和配置外部实例后，它可以在您的虚拟机上运行多个容器，该虚拟机已注册为外部实例。
6. Amazon ECS 集群处于活动状态，可以通过容器运行应用程序工作负载。Amazon ECS Anywhere 容器实例在本地环境中运行，但与云中的亚马逊ECS集群相关联。
设置和部署 CI/CD 管线
1. 部署第二个AWSCDK堆栈时，它会在上面创建另一个 CloudFormation 堆栈AWS。
2. 此 CloudFormation 堆栈提供管道 CodePipeline 和相关AWS资源。
3. 您可以将应用程序代码更改推送并合并到本地 GitLab 存储库。
4. GitLab 存储库会自动复制到 CodeCommit 存储库。
5. 对 CodeCommit 存储库的更新会自动开始 CodePipeline。
6. CodePipeline 从中复制代码 CodeCommit 并创建可部署的 CodeBuild内置应用程序。
7. CodePipeline 创建 CodeBuild 构建环境的 Docker 镜像并将其推送到亚马逊存储ECR库。
8. CodePipeline 启动从 Amazon ECR 存储库中提取容器映像的 CodeDeploy 操作。
9. CodePipeline 在 Amazon 集ECS群上部署容器映像。

自动化和扩缩

此模式使用AWSCDK作为基础设施即代码 (IaC) 工具来配置和部署此架构。 AWSCDK帮助您协调AWS资源并设置 Amazon ECS Anywhere 和 CI/CD 管道。

工具

AWS 服务

AWSCloud Development Kit (AWSCDK) 是一个软件开发框架，可帮助您在代码中定义和配置AWS云基础架构。
AWS CodeCommit是一项版本控制服务，可帮助您私下存储和管理 Git 存储库，而无需管理自己的源代码控制系统。
AWS CodePipeline帮助您快速建模和配置软件发布的不同阶段，并自动执行持续发布软件更改所需的步骤。
AWSCommand Line Interface (AWSCLI) 是一个开源工具，可帮助您通过命令行外壳中的命令与AWS服务进行交互。
Amazon Elastic Container Registry (AmazonECR) 是一项安全、可扩展且可靠的托管容器镜像注册服务。
Amazon 弹性容器服务 (AmazonECS) 是一项快速且可扩展的容器管理服务，可帮助您在集群上运行、停止和管理容器。这种模式还使用 Amazon ECS Anywh ere，它支持将本地服务器或虚拟机注册到您的 Amazon ECS 集群。

其他工具

Node.js 是一个事件驱动的 JavaScript 运行时环境，专为构建可扩展的网络应用程序而设计。
npm 是在 Node.js 环境中运行的软件注册表，用于共享或借用软件包以及管理私有软件包的部署。
Vagrant 是一个开源实用程序，用于构建和维护便携式虚拟软件开发环境。出于演示目的，此模式使用 Vagrant 创建本地虚拟机。

代码存储库

此模式的代码可使用AWSCDK存储库在 Amazon ECS Anywhere 的 GitHub CI/CD 管道中找到。

最佳实践

部署此模式时，请考虑以下最佳实践：

开发和部署云基础架构的最佳实践 AWS CDK
使用开发云应用程序的最佳实践 AWS CDK（AWS博客文章）

操作说明

任务描述所需技能

任务	描述	所需技能
验证AWSCDK版本。	输入以下命令验证AWSCDK工具包的版本。 `cdk --version` 此模式需要版本 2.27.0 或更高版本。如果您使用的是早期版本，请按照AWSCDK文档中的说明进行更新。	DevOps 工程师
验证 npm 版本。	通过输入以下命令验证 npm 的版本。 `npm --version` 此模式需要版本 7.20.3 或更高版本。如果您拥有早期版本，请按照 npm 文档中的说明对其进行更新。	DevOps 工程师
设置AWS凭据。	通过输入`aws configure`命令并按照提示设置AWS凭据。 `$aws configure AWS Access Key ID [None]: <your-access-key-ID> AWS Secret Access Key [None]: <your-secret-access-key> Default region name [None]: <your-Region-name> Default output format [None]:`	DevOps 工程师

验证AWSCDK版本。

输入以下命令验证AWSCDK工具包的版本。


cdk --version

此模式需要版本 2.27.0 或更高版本。如果您使用的是早期版本，请按照AWSCDK文档中的说明进行更新。

DevOps 工程师

验证 npm 版本。

通过输入以下命令验证 npm 的版本。


npm --version

此模式需要版本 7.20.3 或更高版本。如果您拥有早期版本，请按照 npm 文档中的说明对其进行更新。

DevOps 工程师

设置AWS凭据。

通过输入aws configure命令并按照提示设置AWS凭据。


$aws configure
AWS Access Key ID [None]: <your-access-key-ID>
AWS Secret Access Key [None]: <your-secret-access-key>
Default region name [None]: <your-Region-name>
Default output format [None]:

DevOps 工程师

任务描述所需技能

任务	描述	所需技能
克隆AWSCDK代码存储库。	输入以下命令，使用此模式的AWSCDK存储库克隆 Amazon ECS Anywhere 的 CI/CD 管道。 `git clone https://github.com/aws-samples/amazon-ecs-anywhere-cicd-pipeline-cdk-sample.git` 通过输入以下命令导航到克隆的目录。 `cd amazon-ecs-anywhere-cicd-pipeline-cdk-sample`	DevOps 工程师
引导环境。	输入以下命令，将 CloudFormation 模板部署到要使用的账户和AWS区域。 `cdk bootstrap <account-number>/<Region>` 有关更多信息，请参阅文档中的引导。AWS CDK	DevOps 工程师

克隆AWSCDK代码存储库。

输入以下命令，使用此模式的AWSCDK存储库克隆 Amazon ECS Anywhere 的 CI/CD 管道。
```
git clone https://github.com/aws-samples/amazon-ecs-anywhere-cicd-pipeline-cdk-sample.git
```
通过输入以下命令导航到克隆的目录。
```
cd amazon-ecs-anywhere-cicd-pipeline-cdk-sample
```

DevOps 工程师

引导环境。

输入以下命令，将 CloudFormation 模板部署到要使用的账户和AWS区域。


cdk bootstrap <account-number>/<Region>

有关更多信息，请参阅文档中的引导。AWS CDK

DevOps 工程师

任务	描述	所需技能
安装软件包依赖关系并编译 TypeScript 文件。	通过输入以下命令安装软件包依赖关系并编译 TypeScript 文件。 `$cd EcsAnywhereCdk $npm install $npm fund` 这些命令安装示例存储库内的所有软件包。有关更多信息，请参阅 npm 文档中的 npm ci 和 npm 安装。如果在输入这些命令时出现任何关于丢失程序包的错误，请参阅此模式的故障排除部分。	DevOps 工程师
构建项目。	要构建项目代码，请输入以下命令。 `npm run build` 有关构建和部署项目的更多信息，请参阅AWSCDK文档中的您的第一个AWSCDK应用程序。	DevOps 工程师
部署 Amazon ECS Anywhere 基础设施堆栈。	通过输入以下命令列出堆栈。 `$cdk list` 确认输出是否返回了 `EcsAnywhereInfraStack` 和 `ECSAnywherePipelineStack` 堆栈。通过输入以下命令部署 `EcsAnywhereInfraStack` 堆栈。 `$cdk deploy EcsAnywhereInfraStack`	DevOps 工程师
验证堆栈创建和输出。	登录AWS管理控制台并在上打开 CloudFormation 控制台https://console.aws.amazon.com/cloudformation/。在堆栈页面，选择 `EcsAnywhereInfraStack` 堆栈。确认堆栈状态为 `CREATE_IN_PROGRESS` 或 `CREATE_COMPLETE`。设置 Amazon ECS 集群可能需要一些时间。在堆栈创建完成前，请勿继续。	DevOps 工程师

任务描述所需技能

任务	描述	所需技能
设置您的虚拟机。	通过从 Vagrantfile 所在的根目录中输入 `vagrant up` 命令来创建 Vagrant 虚拟机。有关更多信息，请参阅 Vagrant 文档。	DevOps 工程师
将您的虚拟机注册为外部实例。	使用 `vagrant ssh` 命令登录 Vagrant 虚拟机。有关更多信息，请参阅 Vagrant 文档。按照AWSCLI安装AWSCLI说明并输入以下命令在虚拟机上安装。 `$ curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" \ > -o "awscliv2.zip" $sudo apt install unzip $unzip awscliv2.zip $sudo ./aws/install $aws configure AWS Access Key ID [None]: <your-access-key-ID> AWS Secret Access Key [None]: <your-secret-access-key> Default region name [None]: <your-Region-name> Default output format [None]:` 创建激活码和 ID，用于向 S AWS ystems Manager 注册虚拟机并激活外部实例。此命令输出包括激活 ID 和激活码值。 `aws ssm create-activation \ > --iam-role EcsAnywhereInstanceRole \ > \| tee ssm-activation.json` 如果您在运行此命令时收到错误，请参阅故障排除部分。导出激活 ID 与代码值。 `export ACTIVATION_ID=<activation-ID> export ACTIVATION_CODE=<activation-code>` 下载安装脚本至虚拟机。 `curl --proto "https" -o "ecs-anywhere-install.sh" \ > "https://amazon-ecs-agent.s3.amazonaws.com/ecs-anywhere-install-latest.sh"` 在您的虚拟机上运行安装脚本。 `sudo bash ecs-anywhere-install.sh \ --cluster EcsAnywhereCluster \ --activation-id $ACTIVATION_ID \ --activation-code $ACTIVATION_CODE \ --region <region-name>` 这会将您的虚拟机设置为 Amazon ECS Anywhere 外部实例，并在亚马逊ECS集群中注册该实例。有关更多信息，请参阅 Amazon ECS 文档中的向集群注册外部实例。如果您遇到任何问题，请参阅故障排除部分。	DevOps 工程师
验证 Amazon ECS Anywhere 和外部虚拟机的状态。	要验证您的虚拟机是否已连接到 Amazon ECS 控制平面并正在运行，请使用以下命令。 `$aws ssm describe-instance-information $aws ecs list-container-instances --cluster $CLUSTER_NAME`	DevOps 工程师

设置您的虚拟机。

通过从 Vagrantfile 所在的根目录中输入 vagrant up 命令来创建 Vagrant 虚拟机。有关更多信息，请参阅 Vagrant 文档。

DevOps 工程师

将您的虚拟机注册为外部实例。

使用 vagrant ssh 命令登录 Vagrant 虚拟机。有关更多信息，请参阅 Vagrant 文档。

按照AWSCLI安装AWSCLI说明并输入以下命令在虚拟机上安装。


$ curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" \
> -o "awscliv2.zip"
$sudo apt install unzip
$unzip awscliv2.zip
$sudo ./aws/install
$aws configure
AWS Access Key ID [None]: <your-access-key-ID>
AWS Secret Access Key [None]: <your-secret-access-key>
Default region name [None]: <your-Region-name>
Default output format [None]:

创建激活码和 ID，用于向 S AWS ystems Manager 注册虚拟机并激活外部实例。此命令输出包括激活 ID 和激活码值。
```
aws ssm create-activation \
> --iam-role EcsAnywhereInstanceRole \
> | tee ssm-activation.json
```
如果您在运行此命令时收到错误，请参阅故障排除部分。

导出激活 ID 与代码值。


export ACTIVATION_ID=<activation-ID>
export ACTIVATION_CODE=<activation-code>

下载安装脚本至虚拟机。


curl --proto "https" -o "ecs-anywhere-install.sh" \
> "https://amazon-ecs-agent.s3.amazonaws.com/ecs-anywhere-install-latest.sh"

在您的虚拟机上运行安装脚本。


sudo bash ecs-anywhere-install.sh \
--cluster EcsAnywhereCluster \
--activation-id $ACTIVATION_ID \
--activation-code $ACTIVATION_CODE \
--region <region-name>

这会将您的虚拟机设置为 Amazon ECS Anywhere 外部实例，并在亚马逊ECS集群中注册该实例。有关更多信息，请参阅 Amazon ECS 文档中的向集群注册外部实例。如果您遇到任何问题，请参阅故障排除部分。

DevOps 工程师

验证 Amazon ECS Anywhere 和外部虚拟机的状态。

要验证您的虚拟机是否已连接到 Amazon ECS 控制平面并正在运行，请使用以下命令。


$aws ssm describe-instance-information
$aws ecs list-container-instances --cluster $CLUSTER_NAME

DevOps 工程师

任务	描述	所需技能
在 CodeCommit 存储库中创建一个分支。	通过为存储库创建第一个提交，创建一个`main`在 CodeCommit repo 中命名的分支。你可以按照AWS文档中的创建提交 CodeCommit。以下命令是一个示例。 `aws codecommit put-file \ --repository-name EcsAnywhereRepo \ --branch-name main \ --file-path README.md \ --file-content "Test" \ --name "Dev Ops" \ --email "devops@example.com" \ --commit-message "Adding README."`	DevOps 工程师
设置存储库镜像。	您可以将 GitLab 存储库镜像到外部源或从外部源镜像。您可选择哪个存储库作为源。分支、标签和提交自动同步。在托管应用程序的 GitLab 存储库和存储 CodeCommit 库之间设置推送镜像。有关说明，请参阅设置从 GitLab 到的推送镜像 CodeCommit（GitLab 文档）。注意默认情况下，镜像会自动同步存储库。如果要手动更新存储库，请参阅更新镜像（GitLab 文档）。	DevOps 工程师
部署 CI/CD 管线堆栈。	通过输入以下命令部署 `EcsAnywherePipelineStack` 堆栈。 `$cdk deploy EcsAnywherePipelineStack`	DevOps 工程师
测试 CI/CD 管线。	更改应用程序代码并将其推送到源本地 GitLab 存储库。有关更多信息，请参阅推送选项（GitLab 文档）。例如，编辑 `../application/index.html` 文件以更新应用程序版本值。当代码复制到 CodeCommit 存储库时，这会启动 CI/CD 管道。请执行以下操作之一：如果您使用自动镜像将 GitLab 存储库与存储库同步，请继续下一步。 CodeCommit 如果您使用的是手动镜像，请按照更新镜像（GitLab 文档）中的说明将应用程序代码更改推送到 CodeCommit 存储库。在您的本地计算机上，在 Web 浏览器中输入 http://localhost:80。这将打开NGINX网页，因为端口 80 被转发到 Vagrantfile 中的本地主机。确认您可查看更新的应用程序版本值。验证管线和映像部署。（可选）如果要在AWS管理控制台中验证部署，请执行以下操作：打开亚马逊ECS控制台，网址为https://console.aws.amazon.com/ecs/。从导航栏中，选择要使用的区域。在导航窗格中，选择集群。在集群页面上，选择集EcsAnywhereCluster群。选择任务定义。确认容器正在运行。	DevOps 工程师

任务描述所需技能

任务	描述	所需技能
清理和删除资源。	完成此模式后，应移除您创建的 proof-of-concept资源。要进行清理，请输入以下命令。 `$cdk destroy EcsAnywherePipelineStack $cdk destroy EcsAnywhereInfraStack`	DevOps 工程师

清理和删除资源。

完成此模式后，应移除您创建的 proof-of-concept资源。要进行清理，请输入以下命令。


$cdk destroy EcsAnywherePipelineStack
$cdk destroy EcsAnywhereInfraStack

DevOps 工程师

故障排除

事务解决方案

事务	解决方案
安装程序包依赖项时，出现缺少程序包的错误。	输入下列命令之一，解决程序包缺失问题。 `$npm ci` 或 `$npm install -g @aws-cdk/<package_name>`
在虚拟机上运行 `aws ssm create-activation` 命令时，您将收到以下错误。 `An error occurred (ValidationException) when calling the CreateActivation operation: Nonexistent role or missing ssm service principal in trust policy: arn:aws:iam::000000000000:role/EcsAnywhereInstanceRole`	`EcsAnywhereInfraStack`堆栈尚未完全部署，运行此命令所需的IAM角色也尚未创建。在 CloudFormation 控制台中检查堆栈状态。状态变为 `CREATE_COMPLETE` 后重试该命令。
亚马逊ECS运行状况检查返回`UNHEALTHY`，您在亚马逊ECS控制台集群的 “服务” 部分中看到以下错误。 `service EcsAnywhereService was unable to place a task because no container instance met all of its requirements. Reason: No Container Instances were found in your cluster.`	输入以下命令，在你的Vagrant虚拟机上重启亚马逊ECS代理。 `$vagrant ssh $sudo systemctl restart ecs $sudo systemctl status ecs`

安装程序包依赖项时，出现缺少程序包的错误。

输入下列命令之一，解决程序包缺失问题。


$npm ci

或


$npm install -g @aws-cdk/<package_name>

在虚拟机上运行 aws ssm create-activation 命令时，您将收到以下错误。

An error occurred (ValidationException) when calling the CreateActivation operation: Nonexistent role or missing ssm service principal in trust policy: arn:aws:iam::000000000000:role/EcsAnywhereInstanceRole

EcsAnywhereInfraStack堆栈尚未完全部署，运行此命令所需的IAM角色也尚未创建。在 CloudFormation 控制台中检查堆栈状态。状态变为 CREATE_COMPLETE 后重试该命令。

亚马逊ECS运行状况检查返回UNHEALTHY，您在亚马逊ECS控制台集群的 “服务” 部分中看到以下错误。

service EcsAnywhereService was unable to place a task because no container instance met all of its requirements. Reason: No Container Instances were found in your cluster.

输入以下命令，在你的Vagrant虚拟机上重启亚马逊ECS代理。


$vagrant ssh
$sudo systemctl restart ecs
$sudo systemctl status ecs

使用和，在 Amazon ECS Anywhere 上为混合工作负载设置 CI/CD 管道 AWS CDK GitLab

摘要

先决条件和限制

架构

工具

最佳实践

操作说明

注意

故障排除

相关资源