AWS CodeDeploy
用户指南 (API 版本 2014-10-06)
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

Amazon ECS 计算平台 上的部署

本主题提供了有关使用 Amazon ECS 计算平台的 CodeDeploy 部署的组件和工作流程的信息。

在开始 Amazon ECS 部署之前

在开始 Amazon ECS 应用程序部署之前,必须准备好以下事项。创建部署组时指定了一些要求,并且某些要求在 AppSpec file中指定。

要求 指定的位置
Amazon ECS 集群 部署组
Amazon ECS 服务 部署组
应用程序负载均衡器 或者 Network Load Balancer 部署组
生产侦听器 部署组
测试侦听器(可选) 部署组
两个目标组 部署组
Amazon ECS 任务定义 AppSpec file
容器名称 AppSpec file
容器端口 AppSpec file
Amazon ECS 集群

Amazon ECS 集群 是任务或服务的逻辑分组。在创建 CodeDeploy 应用程序的部署组时,需要指定包含 Amazon ECS 服务的 Amazon ECS 集群。有关更多信息,请参阅 Amazon Elastic Container Service 用户指南 中的 Amazon ECS 集群

Amazon ECS 服务

Amazon ECS 服务 维护并运行 Amazon ECS 集群中任务定义的指定实例。CodeDeploy 必须已启用 Amazon ECS 服务。默认情况下,Amazon ECS 部署已启用 Amazon ECS 服务。当您创建部署组时,您需要选择部署 Amazon ECS 集群中的 Amazon ECS 服务。有关更多信息,请参阅 Amazon Elastic Container Service 用户指南 中的 Amazon ECS 服务

应用程序负载均衡器 或者 Network Load Balancer

在要随 Amazon ECS 部署一起更新的 Amazon ECS 服务中,您必须使用 Elastic Load Balancing。您可以使用 应用程序负载均衡器 或 Network Load Balancer。我们建议使用 应用程序负载均衡器,以便您可以利用动态端口映射和基于路径的路由和优先级规则等功能。在创建 CodeDeploy 应用程序的部署组时,您需要指定负载均衡器。有关更多信息,请参阅 Amazon Elastic Container Service 用户指南 中的 为 CodeDeploy Amazon ECS 部署设置负载均衡器、目标组和侦听器创建负载均衡器

一个或两个侦听器

侦听器 由负载均衡器用于将流量定向到目标组。必须提供一个生产侦听器。您可以指定可选的第二个测试侦听器,在您运行验证测试时该侦听器可以将流量定向到替换任务集。在创建部署组时,您需要指定一个或两个侦听器。如果您使用 Amazon ECS 控制台创建 Amazon ECS 服务,系统会为您创建侦听器。有关更多信息,请参阅 Elastic Load Balancing 用户指南 中的 Application Load Balancer 的侦听器以及 Amazon Elastic Container Service 用户指南 中的创建服务

两个 Amazon ECS 目标组

目标组 用于将流量路由到一个注册目标。一个 Amazon ECS 部署需要两个目标组:一个用于 Amazon ECS 应用程序的原始任务集,另一个用于其替换任务集。在部署过程中,CodeDeploy 会创建替换任务集,并将流量从原始任务集重新路由到新的任务集。在创建 CodeDeploy 应用程序的部署组时,您需要指定目标组。

在部署期间,CodeDeploy 会确定哪个目标组与 Amazon ECS 服务中状态为 PRIMARY(这是原始任务集)的任务集关联,并将一个目标组与其关联,然后将另一个目标组与替换任务集关联。如果执行其他部署,则与当前部署的原始任务集关联的目标组将与下一个部署的替换任务集关联。有关更多信息,请参阅 Elastic Load Balancing 用户指南 中的您的 Application Load Balancer 的目标组

Amazon ECS 任务定义

运行包含 Amazon ECS 应用程序的 Docker 容器需要任务定义。您需要在 CodeDeploy 应用程序的 AppSpec file中指定任务定义的 ARN。有关更多信息,请参阅 Amazon Elastic Container Service 用户指南 中的 Amazon ECS 任务定义以及 用于 Amazon ECS 部署的 AppSpec 的“resources”部分

您的 Amazon ECS 应用程序的容器

Docker 容器 是一套打包代码及其依赖项以便应用程序运行的软件。容器可以隔离您的应用程序,使其在不同的计算环境中运行。负载均衡器将流量定向到 Amazon ECS 应用程序任务集中的容器。您需要在 CodeDeploy 应用程序的 AppSpec file中指定容器的名称。AppSpec file中指定的容器必须是 Amazon ECS 任务定义中指定的容器之一。有关更多信息,请参阅 Amazon Elastic Container Service 用户指南 中的什么是 Amazon Elastic Container Service?以及 用于 Amazon ECS 部署的 AppSpec 的“resources”部分

您的替换任务集的端口

在 Amazon ECS 部署期间,负载均衡器会将流量定向到您 CodeDeploy 应用程序的 AppSpec file所指定容器上的端口。您需要在 CodeDeploy 应用程序的 AppSpec file中指定端口。有关更多信息,请参阅 用于 Amazon ECS 部署的 AppSpec 的“resources”部分

Amazon ECS 计算平台上的部署组件

下图显示了 Amazon ECS 计算平台上的 CodeDeploy 部署中的组件。

Amazon ECS 计算平台上的部署工作流(高级)

下图显示部署更新的 Amazon ECS 服务的主要步骤。

这些步骤包括:

  1. 通过指定一个唯一表示要部署的内容的名称,创建 AWS CodeDeploy 应用程序。要部署 Amazon ECS 应用程序,您可以在 AWS CodeDeploy 应用程序中选择 Amazon ECS 计算平台。CodeDeploy 在部署期间使用应用程序来引用正确的部署组件,例如部署组、目标组、侦听器、流量重新路由行为和应用程序修订。有关更多信息,请参阅 使用 CodeDeploy 创建应用程序

  2. 通过指定以下内容设置部署组:

    • 部署组名称。

    • 您的 Amazon ECS 集群和服务名称。Amazon ECS 服务的部署控制器必须设置为 CodeDeploy。

    • 生产侦听器、可选的测试侦听器以及在部署期间使用的目标组。

    • 部署设置,例如何时将生产流量重新路由到 Amazon ECS 服务中的替换 Amazon ECS 任务集以及何时终止 Amazon ECS 服务中的原始 Amazon ECS 任务集。

    • 可选设置,如触发器、警报和回滚行为。

  3. 指定一个application specification file (AppSpec file)。您可以将它上传到 Amazon S3,以 YAML 或 JSON 格式将它输入控制台,或者使用 AWS CLI 或开发工具包指定它。AppSpec file指定用于部署的 Amazon ECS 任务定义,用于路由流量的容器名称和端口映射,以及在部署生命周期挂钩之后运行的 Lambda 函数。容器名称必须是您的 Amazon ECS 任务定义中的容器。有关更多信息,请参阅使用 CodeDeploy 的应用程序修订

  4. 部署您的应用程序修订。AWS CodeDeploy 从 Amazon ECS 服务中任务集的原始版本将流量重新路由到新的替换任务集。部署组中指定的目标组用于处理传输到原始和替换任务集的流量。在部署完成后,会终止原始任务集。您可以指定一个可选的测试侦听器,以便在将流量重新路由到替换版本之前为其提供测试流量。有关更多信息,请参阅 使用 CodeDeploy 创建部署

  5. 检查部署结果。有关更多信息,请参阅 在 CodeDeploy 中监控部署

在 Amazon ECS 部署过程中发生的事件

在启动具有测试侦听器的 Amazon ECS 部署之前,您必须配置其组件。有关更多信息,请参阅 在开始 Amazon ECS 部署之前

下图显示了在准备好启动 Amazon ECS 部署时,这些组件之间的关系。

当部署启动时,开始一次执行一个部署生命周期事件。一些生命周期事件是挂钩,仅执行在 AppSpec file中指定的 Lambda 函数。下表中的部署生命周期事件按照执行的顺序列出。有关更多信息,请参阅用于 Amazon ECS 部署的 AppSpec 的“hooks”部分

生命周期事件 生命周期事件操作
BeforeInstall(Lambda 函数的挂钩) 运行 Lambda 函数。
安装 设置替换任务集。
AfterInstall(Lambda 函数的挂钩) 运行 Lambda 函数。
AllowTestTraffic 将流量从测试侦听器路由至目标组 2。
AfterAllowTestTraffic(Lambda 函数的挂钩) 运行 Lambda 函数。
BeforeAllowTraffic(Lambda 函数的挂钩) 运行 Lambda 函数。
AllowTraffic 将流量从生产侦听器路由至目标组 2。
AfterAllowTraffic 运行 Lambda 函数。

注意

挂钩中的 Lambda 函数是可选的。

  1. 执行在 AppSpec file 的 BeforeInstall 挂钩中指定的任意 Lambda 函数。

  2. Install 生命周期事件期间:

    1. 在您的 Amazon ECS 服务中创建替换任务集。

    2. 更新后的容器化应用程序安装到替换任务集中。

    3. 第二个目标组与替换任务集关联。

    此图显示具有新替换任务集的部署组件。容器化应用程序位于此任务集的内部。任务集包含三个任务。(应用程序可以具有任意数量的任务。) 第二个目标组现与替换任务集关联。

  3. 执行在 AppSpec file的 AfterInstall 挂钩中指定的任意 Lambda 函数。

  4. 调用了 AllowTestTraffic 事件。在此生命周期事件中,测试侦听器将流量路由到更新后的容器化应用程序中。

  5. 执行在 AppSpec file的 AfterAllowTestTraffic 挂钩中指定的任意 Lambda 函数。Lambda 函数可以使用测试流量验证部署。例如,Lambda 函数可以向测试侦听器提供流量,并跟踪替换任务集的指标。如果配置了回滚,则您可以配置 CloudWatch 警报,在 Lambda 函数中的验证测试失败时触发回滚。

    验证测试完成后,将会发生以下情况之一:

    • 如果验证失败并配置了回滚,则部署状态标记为 Failed,组件返回其开始部署时的状态。

    • 如果验证失败但未配置回滚,则部署状态标记为 Failed,并且组件保持其当前状态。

    • 如果验证成功,则部署将继续到 BeforeAllowTraffic 挂钩。

    有关更多信息,请参阅在 CodeDeploy 中使用 CloudWatch 警报监控部署自动回滚为部署组配置高级选项

  6. 执行在 AppSpec file的 BeforeAllowTraffic 挂钩中指定的任意 Lambda 函数。

  7. 调用了 AllowTraffic 事件。生产流量从原始任务集重新路由到替换任务集。下图显示了接收生产流量的替换任务集。

  8. 执行在 AppSpec file的 AfterAllowTraffic 挂钩中指定的任意 Lambda 函数。

  9. 所有事件成功后,部署状态设置为 Succeeded 并删除原始任务集。

上传应用程序修订

将 AppSpec file放入 Amazon S3 中或将其直接输入到控制台或 AWS CLI 中。有关更多信息,请参阅 应用程序规范文件

创建应用程序和部署组

Amazon ECS 计算平台上的 CodeDeploy 部署组可以标识侦听器,以便处理传输到更新的 Amazon ECS 应用程序和部署期间使用的两个目标组的流量。部署组还定义一组配置选项,例如警报和回滚配置。

部署应用程序修订

现在,您已准备好部署在部署组中指定的更新的 Amazon ECS 服务。可以使用 CodeDeploy 控制台或 create-deployment 命令。可以指定一些参数(包括修订和部署组)来控制部署。

更新应用程序

您可以更新应用程序,然后使用 CodeDeploy 控制台或调用 create-deployment 命令推送修订。

停止和失败的部署

您可以使用 CodeDeploy 控制台或 stop-deployment 命令停止部署。当您尝试停止部署时,将发生下面三种情况之一:

  • 部署将停止,并且操作将返回成功状态。在这种情况下,没有更多的部署生命周期事件将在已停止部署的部署组上运行。

  • 部署将不会立即停止,并且操作将返回挂起状态。在这种情况下,一些部署生命周期事件可能仍在部署组上运行。在挂起的操作完成后,停止部署的后续调用将返回成功状态。

  • 部署无法停止,并且操作将返回错误。有关更多信息,请参阅 AWS CodeDeploy API Reference 中的错误信息常见错误

重新部署和部署回滚

CodeDeploy 通过将流量从替换任务集重新路由到原始任务集来实现回滚。

您可以对部署组进行配置,使之在满足特定条件(例如部署失败或达到警报监控阈值)时自动回滚部署。您还可以在单个部署中覆盖为部署组指定的回滚设置。

另外,也可以选择通过手动重新部署以前部署的版本回滚失败的部署。

在所有情况下,新的或回滚的部署都分配有自己的部署 ID。CodeDeploy 控制台显示列出自动部署结果的部署列表。

如果进行重新部署,则与当前部署的原始任务集关联的目标组将与重新部署的替换任务集关联。

有关更多信息,请参阅使用 CodeDeploy 重新部署和回滚部署