AppSpec 的“hooks”部分

AppSpec 文件的 'hooks' 部分内容会随着部署的计算平台而改变。EC2/本地部署的 'hooks' 部分包含将部署生命周期事件挂钩链接到一个或多个脚本的映射。Lambda 或 Amazon ECS 部署的 'hooks' 部分指定在部署生命周期事件期间运行的 Lambda 验证函数。如果某个事件的挂钩不存在，则不会对该事件执行任何操作。仅当您将在部署过程中运行脚本或 Lambda 验证函数时，才需要此部分。

用于 Amazon ECS 部署的 AppSpec 的“hooks”部分

用于 Amazon ECS 部署的生命周期事件挂钩的列表

AWS Lambda 挂钩是一个 Lambda 函数，该函数在生命周期事件名称之后的新行中使用字符串指定。对于每次部署，每个挂钩将执行一次。以下是在 Amazon ECS 部署期间可以运行挂钩的生命周期事件的描述。

有关更多信息，请参阅在 Amazon ECS 部署过程中发生的事件和教程：部署具有验证测试的 Amazon ECS 服务。

钩子在 Amazon ECS 部署中的运行顺序。

在 Amazon ECS 部署中，事件挂钩按以下顺序运行：

“hooks”部分的结构

以下示例说明了 'hooks' 部分的结构。

使用 YAML：

Hooks:
  - BeforeInstall: "BeforeInstallHookFunctionName"
  - AfterInstall: "AfterInstallHookFunctionName"
  - AfterAllowTestTraffic: "AfterAllowTestTrafficHookFunctionName"
  - BeforeAllowTraffic: "BeforeAllowTrafficHookFunctionName"
  - AfterAllowTraffic: "AfterAllowTrafficHookFunctionName"

使用 JSON：

"Hooks": [
		{
			"BeforeInstall": "BeforeInstallHookFunctionName"
		},
		{
			"AfterInstall": "AfterInstallHookFunctionName"
		},
		{
			"AfterAllowTestTraffic": "AfterAllowTestTrafficHookFunctionName"
		},
		{
			"BeforeAllowTraffic": "BeforeAllowTrafficHookFunctionName"
		},
		{
			"AfterAllowTraffic": "AfterAllowTrafficHookFunctionName"
		}
	]
}

Lambda“hooks”函数示例

使用 'hooks' 部分可以指定 CodeDeploy 可调用以验证 Amazon ECS 部署的 Lambda 函数。对于 BeforeInstall、AfterInstall、AfterAllowTestTraffic、BeforeAllowTraffic 和 AfterAllowTraffic 部署生命周期事件，您可以使用相同函数或不同的函数。验证测试完成后，Lambda AfterAllowTraffic 函数会回调 CodeDeploy 并提供 Succeeded 或 Failed 结果。

在调用 Lambda 挂钩函数之前，必须使用 putLifecycleEventHookExecutionStatus 命令向服务器通知部署 ID 和生命周期事件挂钩执行 ID。

下面是一个使用 Node.js 编写的 Lambda 挂钩函数示例。

'use strict';

const aws = require('aws-sdk');
const codedeploy = new aws.CodeDeploy({apiVersion: '2014-10-06'});

exports.handler = (event, context, callback) => {
    //Read the DeploymentId from the event payload.
    var deploymentId = event.DeploymentId;

    //Read the LifecycleEventHookExecutionId from the event payload
    var lifecycleEventHookExecutionId = event.LifecycleEventHookExecutionId;

    /*
     Enter validation tests here.
    */

    // Prepare the validation test results with the deploymentId and
    // the lifecycleEventHookExecutionId for CodeDeploy.
    var params = {
        deploymentId: deploymentId,
        lifecycleEventHookExecutionId: lifecycleEventHookExecutionId,
        status: 'Succeeded' // status can be 'Succeeded' or 'Failed'
    };
    
    // Pass CodeDeploy the prepared validation test results.
    codedeploy.putLifecycleEventHookExecutionStatus(params, function(err, data) {
        if (err) {
            // Validation failed.
            callback('Validation test failed');
        } else {
            // Validation succeeded.
            callback(null, 'Validation test succeeded');
        }
    });
};

用于 AWS Lambda 部署的 AppSpec 的“hooks”部分

用于 AWS Lambda 部署的生命周期事件挂钩的列表

AWS Lambda 挂钩是一个 Lambda 函数，该函数在生命周期事件名称之后的新行中使用字符串指定。对于每次部署，每个挂钩将执行一次。以下是对可用于您的 AppSpec 文件中的挂钩的描述。

挂钩在 Lambda 函数版本部署中的运行顺序

在无服务器 Lambda 函数版本部署中，事件挂钩按以下顺序运行：

“hooks”部分的结构

以下示例说明了“hooks”部分的结构。

使用 YAML：

hooks:
   - BeforeAllowTraffic: BeforeAllowTrafficHookFunctionName
   - AfterAllowTraffic: AfterAllowTrafficHookFunctionName

使用 JSON：

"hooks": [{
    "BeforeAllowTraffic": "BeforeAllowTrafficHookFunctionName"
    },
    {
    "AfterAllowTraffic": "AfterAllowTrafficHookFunctionName"
}]

Lambda“hooks”函数示例

使用“hooks”部分可以指定 CodeDeploy 可调用以验证 Lambda 部署的 Lambda 函数。对于 BeforeAllowTraffic 和 AfterAllowTraffic 部署生命周期事件，您可以使用相同函数或不同的函数。验证测试完成后，Lambda 验证函数会回调 CodeDeploy 并提供 Succeeded 或 Failed 结果。

在调用 Lambda 挂钩函数之前，必须使用 putLifecycleEventHookExecutionStatus 命令向服务器通知部署 ID 和生命周期事件挂钩执行 ID。

下面是一个使用 Node.js 编写的 Lambda 挂钩函数示例。

'use strict';

const aws = require('aws-sdk');
const codedeploy = new aws.CodeDeploy({apiVersion: '2014-10-06'});

exports.handler = (event, context, callback) => {
    //Read the DeploymentId from the event payload.
    var deploymentId = event.DeploymentId;

    //Read the LifecycleEventHookExecutionId from the event payload
    var lifecycleEventHookExecutionId = event.LifecycleEventHookExecutionId;

    /*
     Enter validation tests here.
    */

    // Prepare the validation test results with the deploymentId and
    // the lifecycleEventHookExecutionId for CodeDeploy.
    var params = {
        deploymentId: deploymentId,
        lifecycleEventHookExecutionId: lifecycleEventHookExecutionId,
        status: 'Succeeded' // status can be 'Succeeded' or 'Failed'
    };
    
    // Pass CodeDeploy the prepared validation test results.
    codedeploy.putLifecycleEventHookExecutionStatus(params, function(err, data) {
        if (err) {
            // Validation failed.
            callback('Validation test failed');
        } else {
            // Validation succeeded.
            callback(null, 'Validation test succeeded');
        }
    });
};

用于 EC2/本地部署的 AppSpec 的“hooks”部分

生命周期事件挂钩的列表

对于实例的每次部署，EC2/本地部署挂钩执行一次。在一个挂钩中，可以指定运行一个或多个脚本。生命周期事件的每个挂钩在单独的行中使用字符串指定。以下是对可用于您的 AppSpec 文件中的挂钩的描述。

有关哪些生命周期事件挂钩对哪些部署和回滚类型有效的信息，请参阅生命周期事件挂钩可用性。

生命周期事件挂钩可用性

下表列出了适用于每个部署和回滚方案的生命周期事件挂钩。

挂钩在部署中的运行顺序

Auto Scaling 启动部署

在 Auto Scaling 启动部署期间，CodeDeploy 按以下顺序运行事件挂钩。

有关 Auto Scaling 启动部署的更多信息，请参阅 Amazon EC2 Auto Scaling 如何与 CodeDeploy 结合使用。

Auto Scaling 终止部署

在 Auto Scaling 终止部署期间，CodeDeploy 按以下顺序运行事件挂钩。

有关 Auto Scaling 终止部署的更多信息，请参阅 在 Auto Scaling 横向缩减事件期间启用终止部署。

就地部署

在就地部署中（包括就地部署的回滚），事件挂钩按以下顺序运行：

蓝绿部署

在蓝/绿部署中，事件挂钩按以下顺序运行：

“hooks”部分的结构

'hooks' 部分具有以下结构：

hooks:
   deployment-lifecycle-event-name:
     - location: script-location
       timeout: timeout-in-seconds
       runas: user-name

可以在 hook 条目中的部署生命周期事件名称后包括以下元素：

在挂钩脚本中引用文件

如果您要按 AppSpec 的“hooks”部分 中所述，将脚本挂接到 CodeDeploy 生命周期事件，并且想要在脚本中引用文件（如 helper.sh），则需要使用以下内容指定 helper.sh：

使用绝对路径

要使用文件的绝对路径来引用文件，可以执行以下任一操作：

部署存档位置

在 DownloadBundle 生命周期事件期间，CodeDeploy 代理会将部署修订提取到以下格式的目录中：

root-directory/deployment-group-id/deployment-id/deployment-archive

路径的 root-directory 部分始终设置为下表所示的默认值，或者由 :root_dir 配置设置控制。有关配置设置的更多信息，请参阅CodeDeploy 代理配置参考。

从挂钩脚本中，您可以使用根目录路径以及 DEPLOYMENT_ID 和 DEPLOYMENT_GROUP_ID 环境变量访问当前的部署存档。有关您能使用的变量的更多信息，请参阅挂钩的环境变量可用性。

下面的示例介绍了如何在 Linux 上访问位于修订根目录下的 data.json 文件：

#!/bin/bash

rootDirectory="/opt/codedeploy-agent/deployment-root" # note: this will be different if you
                                                      # customize the :root_dir configuration
dataFile="$rootDirectory/$DEPLOYMENT_GROUP_ID/$DEPLOYMENT_ID/deployment-archive/data.json"
data=$(cat dataFile)

再举一个例子，介绍了如何在 Windows 上使用 Powershell 访问位于修订根目录下的 data.json 文件：

$rootDirectory="$env:ProgramData\Amazon\CodeDeploy" # note: this will be different if you
                                                    # customize the :root_dir configuration
$dataFile="$rootDirectory\$env:DEPLOYMENT_GROUP_ID\$env:DEPLOYMENT_ID\deployment-archive\data.json"
$data=(Get-Content $dataFile)

使用相对路径

要使用文件的相对路径引用该文件，您需要知道 CodeDeploy 代理的工作目录。文件路径是相对于该目录的。

下表显示了 CodeDeploy 代理的每个受支持平台的工作目录。

挂钩的环境变量可用性

在每个部署生命周期事件期间，挂钩脚本可以访问以下环境变量：

这些是每个部署生命周期事件的本地环境变量。

根据部署包的来源，还有其他环境变量可用于挂接脚本：

来自 Amazon S3 的捆绑包

GitHub 上的捆绑包

如果 DEPLOYMENT_GROUP_NAME 的值等于 Staging，则以下脚本会将 Apache HTTP 服务器上的侦听端口更改为 9090 而非 80。必须在 BeforeInstall 部署生命周期事件期间调用此脚本：

if [ "$DEPLOYMENT_GROUP_NAME" == "Staging" ]
then
    sed -i -e 's/Listen 80/Listen 9090/g' /etc/httpd/conf/httpd.conf
fi

如果 DEPLOYMENT_GROUP_NAME 环境变量的值等于 Staging，则以下脚本示例会将其错误日志中记录的消息的详细级别从警告更改为调试。必须在 BeforeInstall 部署生命周期事件期间调用此脚本：

if [ "$DEPLOYMENT_GROUP_NAME" == "Staging" ]
then
    sed -i -e 's/LogLevel warn/LogLevel debug/g' /etc/httpd/conf/httpd.conf
fi

以下脚本示例将指定网页中的文本替换为显示这些环境变量值的文本。必须在 AfterInstall 部署生命周期事件期间调用此脚本：

#!/usr/bin/python

import os
 
strToSearch="<h2>This application was deployed using CodeDeploy.</h2>"
strToReplace="<h2>This page for "+os.environ['APPLICATION_NAME']+" application and "+os.environ['DEPLOYMENT_GROUP_NAME']+" deployment group with "+os.environ['DEPLOYMENT_GROUP_ID']+" deployment group ID was generated by a "+os.environ['LIFECYCLE_EVENT']+" script during "+os.environ['DEPLOYMENT_ID']+" deployment.</h2>"
 
fp=open("/var/www/html/index.html","r")
buffer=fp.read()
fp.close()
 
fp=open("/var/www/html/index.html","w")
fp.write(buffer.replace(strToSearch,strToReplace))
fp.close()

挂钩示例

以下是 hooks 条目的示例，该条目为 AfterInstall 生命周期事件指定两个挂钩：

hooks:
   AfterInstall:
     - location: Scripts/RunResourceTests.sh
       timeout: 180
     - location: Scripts/PostDeploy.sh
       timeout: 180

Scripts/RunResourceTests.sh 脚本在部署过程的 AfterInstall 阶段运行。如果该脚本的运行时间超过 180 秒（3 分钟），则部署将失败。

您在“hooks”部分中指定的脚本的位置是应用程序修订包根目录的相对路径。在上述示例中，名为 RunResourceTests.sh 的文件位于名为 Scripts 的目录中。该 Scripts 目录位于包的根级别。有关更多信息，请参阅 为 CodeDeploy 规划修订。