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

排查 EC2/本地 部署问题

注意

通过查看部署过程中创建的日志文件可以确定很多部署失败的原因。为简单起见,我们建议您使用 Amazon CloudWatch Logs 集中监控日志文件,而不是逐个实例查看这些文件。有关信息,请参阅在 CloudWatch Logs 控制台中查看 AWS CodeDeploy 日志

部署失败,显示消息“PKCS7 签名的消息验证失败”

此错误消息指示实例正在运行仅支持 SHA-1 哈希算法的 AWS CodeDeploy 代理版本。对 SHA-2 哈希算法的支持是在 AWS CodeDeploy 代理的 1.0.1.854 版(在 2015 年 11 月发布)中引入的。自 2016 年 10 月 17 起,如果安装了低于 1.0.1.854 版本的 AWS CodeDeploy 代理,部署将会失败。有关更多信息,请参阅 AWS 切换到 SSL 证书的 SHA256 哈希算法通知:停用低于 1.0.1.85 版本的 AWS CodeDeploy 主机代理更新 AWS CodeDeploy 代理

将相同的文件部署或重新部署到相同的实例位置失败,出现错误“The deployment failed because a specified file already exists at this location”

当 AWS CodeDeploy 尝试将文件部署到实例,但指定目标位置已存在同名文件时,针对该实例的部署可能会失败。您可能会收到错误消息“The deployment failed because a specified file already exists at this location: location-name.”这是因为,在每个部署期间,AWS CodeDeploy 会先删除上一部署中的所有文件 (清除日志文件中列出了这些文件)。如果目标安装文件夹中存在此清除文件中未列出的文件,则默认情况下,AWS CodeDeploy 代理会将其视为错误,并且部署将失败。

注意

在 Amazon Linux、RHEL 和 Ubuntu Server 实例上,清除文件位于 /opt/codedeploy-agent/deployment-root/deployment-instructions/ 中。在 Windows Server 实例上,此位置为 C:\ProgramData\Amazon\CodeDeploy\deployment-instructions\

避免此错误的最简单方式是,指定默认行为之外的选项以使部署失败。对于每个部署,您可以选择是使部署失败、覆盖清除文件中未列出的文件,还是保留实例上已有的文件。

覆盖选项在以下情况下很有用:您在上一个部署后手动将文件放置在实例上,然后将一个同名文件添加到下一个应用程序修订。

您可以为您在要成为下一部署的一部分的实例上放置的文件选择保留选项,而无需将这些文件添加到应用程序修订包。如果您的应用程序文件已在生产环境中,并且您首次需要使用 AWS CodeDeploy 进行部署,则保留选项也很有用。有关更多信息,请参阅 创建 EC2/本地 计算平台 部署 (控制台)回滚行为与现有内容

排查“The deployment failed because a specified file already exists at this location”部署错误

如果您选择不指定选项来覆盖或保留 AWS CodeDeploy 在目标部署位置检测到的内容 (或者,如果您不指定任何部署选项来处理编程命令中的现有内容),则可以选择纠正错误。

以下信息仅在您选择不保留或覆盖内容的情况下适用。

当您尝试重新部署具有相同的名称和位置的文件时,如果指定应用程序名称和具有之前使用的相同基础部署组 ID 的部署组,则重新部署获得成功的可能性会更大。AWS CodeDeploy 使用基础部署组 ID 标识要在重新部署前删除的文件。

将新文件部署到实例上的相同位置或将相同的文件重新部署到实例上的相同位置可能会因以下原因而失败:

  • 您为将相同修订重新部署到同一实例的操作指定不同的应用程序名称。重新部署将失败,因为即使部署组名称相同,使用其他应用程序名称意味着将使用不同的基础部署组 ID。

  • 您已删除并重新创建应用程序的部署组,然后尝试将同一修订重新部署到该部署组。重新部署将失败,因为即使部署组名称相同,AWS CodeDeploy 也将引用不同的基础部署组 ID。

  • 您在 AWS CodeDeploy 中删除了某个应用程序和部署组,然后创建了与已删除的应用程序和部署组同名的应用程序和部署组。之后,您尝试重新将已部署到上一个部署组的修订部署到同名的新部署组。重新部署将失败,因为即使应用程序和部署组的名称相同,AWS CodeDeploy 仍将引用已删除的部署组的 ID。

  • 您已将一个修订部署到一个部署组,然后将对另一个部署组的同一修订部署到相同的实例。第二次部署将失败,因为 AWS CodeDeploy 将引用不同的基础部署组 ID。

  • 您已将一个修订部署到一个部署组,然后将对另一个部署组的其他修订部署到相同的实例。至少有一个文件具有相同名称且位于第二个部署组尝试部署的相同位置。第二次部署将失败,因为在第二次部署开始之前,AWS CodeDeploy 将不会删除现有文件。两个部署都将引用不同的部署组 ID。

  • 您在 AWS CodeDeploy 中部署了一个修订,但至少有一个文件具有相同名称且位于相同位置。部署将失败,因为默认情况下,在部署开始之前,AWS CodeDeploy 将不会删除现有文件。

要处理这些情况,请执行下列操作之一:

  • 从文件之前部署到的位置和实例中删除文件,然后尝试重新部署。

  • 在修订的 AppSpec file中,在 ApplicationStopBeforeInstall 部署生命周期事件中,指定一个自定义脚本以删除与您的修订即将安装的文件匹配的任何位置的文件。

  • 将文件部署或重新部署到不属于之前的部署的位置或实例。

  • 在您删除应用程序或部署组之前,部署一个包含未指定要复制到实例的文件的 AppSpec file的修订。对于该部署,指定使用您即将删除的基础应用程序和部署组的 ID 的应用程序名称和部署组名称。(您可以使用 get-deployment-group 命令检索部署组 ID。)AWS CodeDeploy 将使用该基础部署组 ID 和 AppSpec file来删除它在上一个成功部署中安装的所有文件。

排查 AllowTraffic 生命周期事件失败,但部署日志中未报错的问题

在某些情况下,在 AllowTraffic 生命周期事件的过程中,蓝/绿部署会失败,但部署日志中没有指明失败原因。

发生这种失败通常是由于 Elastic Load Balancing 中对于 传统负载均衡器、应用程序负载均衡器 或 Network Load Balancer (用于管理部署组的流量) 的运行状况检查配置不正确。

要解决这一问题,请检查并更正负载均衡器的运行状况检查配置中的错误。

对于 传统负载均衡器,请参阅 传统负载均衡器 用户指南中的配置运行状况检查,以及 Elastic Load Balancing API Reference version 2012-06-01中的 ConfigureHealthCheck

对于 应用程序负载均衡器,请参阅 应用程序负载均衡器 用户指南中的目标组的运行状况检查

对于 Network Load Balancer,请参阅 Network Load Balancer 用户指南 中的目标组的运行状况检查

对失败的 ApplicationStop、BeforeBlockTraffic 和 AfterBlockTraffic 部署生命周期事件进行故障排除

在部署期间,AWS CodeDeploy 代理运行上一个 成功部署中的 AppSpec 文件中为 ApplicationStop、BeforeBlockTraffic 和 AfterBlockTraffic 指定的脚本。(在当前部署中,所有其他脚本从 AppSpec 文件运行。)如果这些脚本之一包含错误且未成功运行,则部署可能失败。

这些失败的可能原因包括:

  • AWS CodeDeploy 代理在正确位置找到了 deployment-group-id_last_successful_install 文件,但 deployment-group-id_last_successful_install 文件中列出的位置不存在。

    在 Amazon Linux、Ubuntu Server 和 RHEL 实例上,此文件必须存在于 /opt/codedeploy-agent/deployment-root/deployment-instructions 中。

    在 Windows Server 实例上,此文件必须存储在 C:\ProgramData\Amazon\CodeDeploy\deployment-instructions 文件夹中。

  • deployment-group-id_last_successful_install 文件中列出的位置上,AppSpec file无效或脚本无法成功运行。

  • 这一脚本中包含无法更正的错误,所以永远无法成功运行。

使用 AWS CodeDeploy 控制台调查部署在这些事件中的任一事件期间失败的可能原因。在部署的详细信息页上,选择 View events。在实例的详细信息页上,在 ApplicationStopBeforeBlockTrafficAfterBlockTraffic 行中,选择 View logs。或者,使用 AWS CLI 调用 get-deployment-instance 命令。

如果失败的原因是上一个成功部署中从未成功运行的脚本,请创建一个新的部署,并指定应忽略 ApplicationStopBeforeBlockTrafficAfterBlockTraffic 失败。您可以通过两种方式执行此操作:

  • 使用 AWS CodeDeploy 控制台创建部署。在 Create deployment 页上的 ApplicationStop lifecycle event failure 下,选择 Don't fail the deployment to an instance if this lifecycle event on the instance fails

  • 使用 AWS CLI 调用 create-deployment 命令并包含 --ignore-application-stop-failures 选项。

当您重新部署应用程序修订时,部署将继续,即使这三个生命周期事件中的任一事件失败也是如此。如果新的修订已包含这些生命周期事件的修复脚本,则将来部署会成功,而无需应用此修复。

排查失败的 DownloadBundle 部署生命周期事件的问题,错误为“UnknownError: not opened for reading”

如果您正在尝试从 Amazon S3 部署应用程序修订,并且部署在 DownloadBundle 部署生命周期事件期间失败,错误为“UnknownError: not opened for reading”:

  • 发生内部 Amazon S3 服务错误。请重新部署应用程序修订。

  • Amazon EC2 实例上的 IAM 实例配置文件无权访问 Amazon S3 中的应用程序修订。有关 Amazon S3 存储桶策略的信息,请参阅将 AWS CodeDeploy 的修订推送到 Amazon S3部署先决条件

  • 您将部署到的实例与一个区域(例如,美国西部(俄勒冈))关联,而包含应用程序修订的 Amazon S3 存储桶与另一个区域(例如,美国东部(弗吉尼亚北部))关联。请确保 Amazon S3 存储桶中的应用程序修订与实例所在的区域关联。

在部署的事件详细信息页的 Download bundle 行中,选择 View logs。或者,使用 AWS CLI 调用 get-deployment-instance 命令。如果出现此错误,则输出中应有一个错误代码为“UnknownError”且错误消息为“not opened for reading”的错误。

要确定此错误的原因,请执行以下步骤:

  1. 对至少一个实例启用线路日志记录,然后重新部署应用程序修订。

  2. 查看线路日志记录文件以找到错误。此问题的常见错误消息包括短语“access denied”。

  3. 在查看日志文件后,建议您禁用线路日志记录以减小日志文件的大小并减少将来可能会在实例上的输出中以纯文本格式出现的敏感信息量。

要了解如何查找线路日志记录文件以及启用和禁用线路日志记录,请参阅 使用 AWS CodeDeploy 代理中的 :log_aws_wire:

默认情况下,Windows PowerShell 脚本无法使用 64 位版本的 Windows PowerShell

如果作为部署的一部分运行的某个 Windows PowerShell 脚本依赖 64 位功能(例如,因为它占用的内存多于 32 位应用程序允许的内存,或调用的库仅在 64 位版本中提供),则该脚本可能会崩溃或无法按预期运行。这是因为,默认情况下,AWS CodeDeploy 使用 32 位版本的 Windows PowerShell 运行作为应用程序修订的一部分的 Windows PowerShell 脚本。

将类似于以下内容的代码添加到任何必须使用 64 位版本的 Windows PowerShell 运行的脚本的开头:

# Are you running in 32-bit mode? # (\SysWOW64\ = 32-bit mode) if ($PSHOME -like "*SysWOW64*") { Write-Warning "Restarting this script under 64-bit Windows PowerShell." # Restart this script under 64-bit Windows PowerShell. # (\SysNative\ redirects to \System32\ for 64-bit mode) & (Join-Path ($PSHOME -replace "SysWOW64", "SysNative") powershell.exe) -File ` (Join-Path $PSScriptRoot $MyInvocation.MyCommand) @args # Exit 32-bit script. Exit $LastExitCode } # Was restart successful? Write-Warning "Hello from $PSHOME" Write-Warning " (\SysWOW64\ = 32-bit mode, \System32\ = 64-bit mode)" Write-Warning "Original arguments (if any): $args" # Your 64-bit script code follows here... # ...

尽管此代码中的文件路径信息可能似乎违反直觉,但 32 位 Windows PowerShell 使用与以下内容类似的路径:

c:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe

64 位 Windows PowerShell 使用与以下内容类似的路径:

c:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe

长时间运行的进程可能会导致部署失败

对于针对 Amazon Linux、Ubuntu Server 和 RHEL 实例的部署,如果您的部署脚本启动了长时间运行的进程,则 AWS CodeDeploy 可能会在部署生命周期事件中等待较长的时间,然后使部署失败。这是因为,在该进程运行的时间比该事件中的前台和后台进程预期的所需时间长的情况下,AWS CodeDeploy 将停止部署并使其失败,即使该进程仍按预期运行也是如此。

例如,应用程序修订在其根目录下包含两个文件:after-install.shsleep.sh。其 AppSpec file包含以下说明:

version: 0.0 os: linux files: - source: ./sleep.sh destination: /tmp hooks: AfterInstall: - location: after-install.sh timeout: 60

after-install.sh 文件在 AfterInstall 应用程序生命周期事件期间运行。以下是其内容:

#!/bin/bash /tmp/sleep.sh

sleep.sh 文件包含以下内容,它会使程序执行暂停 3 分钟(180 秒),并模拟某个长时间运行的进程:

#!/bin/bash sleep 180

after-install.sh 调用 sleep.sh 时,sleep.sh 将启动并保持运行状态 3 分钟 (180 秒),它比 AWS CodeDeploy 预期 sleep.sh (以及相关联的 after-install.sh) 停止运行的时间晚 2 分钟 (120 秒)。在超时 1 分钟(60 秒)后,AWS CodeDeploy 将在 AfterInstall 应用程序生命周期事件处停止部署并使其失败,即使 sleep.sh 继续按预期运行也是如此。将显示以下错误:

Script at specified location: after-install.sh failed to complete in 60 seconds

仅在 & 中添加 after-install.sh 符号无法在后台运行 sleep.sh

#!/bin/bash # Do not do this. /tmp/sleep.sh &

这样做可能使部署在长达 1 小时(默认值)的部署生命周期事件超时时段内保持挂起状态,随后 AWS CodeDeploy 将像之前一样在 AfterInstall 应用程序生命周期事件处停止部署并使其失败。

after-install.sh 中,调用 sleep.sh(如下所示),后者支持 AWS CodeDeploy 在进程开始运行后继续:

#!/bin/bash /tmp/sleep.sh > /dev/null 2> /dev/null < /dev/null &

在之前的调用中,sleep.sh 是要在后台开始运行的进程的名称,该进程将 stdout、stderr 和 stdin 重定向到 /dev/null