Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

AppSpec sección de «ganchos»

El contenido de la 'hooks' sección del AppSpec archivo varía en función de la plataforma informática de la implementación. La sección 'hooks' de una implementación de EC2/en las instalaciones contiene los mapeos que vinculan los enlaces de eventos del ciclo de vida de la implementación a uno o varios scripts. La sección 'hooks' de una implementación de Lambda o de Amazon ECS especifica las funciones de validación de Lambda que se ejecutan durante un evento del ciclo de vida de la implementación. Si un enlace de evento no está presente, no se ejecuta ninguna operación para ese evento. Esta sección solo es necesaria si ejecuta scripts o funciones de validación de Lambda como parte de la implementación.

AppSpec sección «ganchos» para una implementación de Amazon ECS

Lista de enlaces de eventos de ciclo de vida para una implementación de Amazon ECS

Un enlace de AWS Lambda es una función de Lambda especificada con una cadena en una línea nueva después del nombre del evento del ciclo de vida. Cada enlace se ejecuta una vez por implementación. A continuación, se muestran las descripciones de los eventos del ciclo de vida donde puede ejecutar un enlace durante una implementación de Amazon ECS.

Para obtener más información, consulte ¿Qué sucede durante una implementación de Amazon ECS? y Tutorial: Implementación de un servicio de Amazon ECS con una prueba de validación.

Ejecute el orden de los enlaces en una implementación de Amazon ECS.

En una implementación de Amazon ECS, los enlaces de eventos se ejecutan en el siguiente orden:

Estructura de la sección "hooks"

Los siguientes ejemplos muestran la estructura de la sección 'hooks'.

Mediante YAML:

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

Mediante JSON:

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

Ejemplo de función de “hooks” de Lambda

Utilice la 'hooks' sección para especificar una función de Lambda a la que CodeDeploy se pueda llamar para validar una implementación de Amazon ECS. Puede usar la misma función o una diferente para los eventos del BeforeInstall ciclo de vida de la AfterAllowTraffic implementación y AfterInstall AfterAllowTestTrafficBeforeAllowTraffic, Tras completar las pruebas de validación, la AfterAllowTraffic función Lambda vuelve a llamar CodeDeploy y entrega un resultado de Succeeded o. Failed

Antes de invocar una función de enlace de Lambda, el servidor debe recibir una notificación con el ID de implementación y el ID de ejecución del enlace de evento del ciclo de vida con el comando putLifecycleEventHookExecutionStatus.

A continuación, se muestra una función de enlace de Lambda de ejemplo escrita en Node.js.

'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');
        }
    });
};

AppSpec sección de «ganchos» para una implementación de AWS Lambda

Lista de enlaces de eventos del ciclo de vida para una implementación de AWS Lambda

Un enlace de AWS Lambda es una función de Lambda especificada con una cadena en una línea nueva después del nombre del evento del ciclo de vida. Cada enlace se ejecuta una vez por implementación. Estas son las descripciones de los ganchos disponibles para su AppSpec uso en el archivo.

Orden de ejecución de los enlaces en una implementación de versiones de funciones de Lambda

En una implementación de versiones de funciones de Lambda sin servidor, los enlaces de eventos se ejecutan en el siguiente orden:

Estructura de la sección "hooks"

Los siguientes ejemplos muestran la estructura de la sección "hooks".

Mediante YAML:

hooks:
   - BeforeAllowTraffic: BeforeAllowTrafficHookFunctionName
   - AfterAllowTraffic: AfterAllowTrafficHookFunctionName

Mediante JSON:

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

Ejemplo de función de “hooks” de Lambda

Utilice la sección «hooks» para especificar una función de Lambda a la que CodeDeploy se pueda llamar para validar una implementación de Lambda. Puede usar la misma función o una diferente para los eventos del ciclo de vida de la AfterAllowTraffic implementación BeforeAllowTraffic y para los eventos del ciclo de vida. Tras completar las pruebas de validación, la función de validación de Lambda vuelve a llamar CodeDeploy y entrega un resultado de Succeeded o. Failed

Antes de invocar una función de enlace de Lambda, el servidor debe recibir una notificación con el ID de implementación y el ID de ejecución del enlace de evento del ciclo de vida con el comando putLifecycleEventHookExecutionStatus.

A continuación, se muestra una función de enlace de Lambda de ejemplo escrita en Node.js.

'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');
        }
    });
};

AppSpec Sección de «enganches» para una implementación local de EC2/

Lista de enlaces de eventos del ciclo de vida

Un enlace de implementación de EC2/en las instalaciones se ejecuta una vez por cada implementación en una instancia. Puede especificar uno o varios scripts para ejecutar en un enlace. Cada enlace de un evento del ciclo de vida se especifica con una cadena en una línea independiente. Estas son las descripciones de los ganchos disponibles para su uso en el archivo. AppSpec

Para obtener información sobre los enlaces de eventos del ciclo de vida válidos para cada tipo de implementación y restauración, consulte Disponibilidad de los enlaces de eventos del ciclo de vida.

Disponibilidad de los enlaces de eventos del ciclo de vida

En la siguiente tabla se indican los enlaces de eventos del ciclo de vida disponibles para cada escenario de implementación y restauración.

Orden de ejecución de los enlaces en una implementación

Implementaciones de lanzamiento de Auto Scaling

Durante una implementación de lanzamiento de Auto Scaling, CodeDeploy ejecuta los enlaces de eventos en el siguiente orden.

Para obtener más información sobre implementaciones de lanzamiento Auto Scaling, consulte Cómo funciona Amazon EC2 Auto Scaling con CodeDeploy.

Implementaciones de terminación de Auto Scaling

Durante un despliegue de terminación de Auto Scaling, CodeDeploy ejecuta los enlaces de eventos en el siguiente orden.

Para obtener más información sobre implementaciones de terminación de Auto Scaling, consulte Habilitación de implementaciones de terminación durante los eventos de reducción horizontal de Auto Scaling.

Implementaciones in situ

En una implementación in situ, incluida la restauración de una implementación in situ, los enlaces de eventos se ejecutan en el orden siguiente:

Implementaciones blue/green

En una implementación blue/green, los enlaces de eventos se ejecutan en el siguiente orden:

Estructura de la sección "hooks"

La sección 'hooks' tiene la siguiente estructura:

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

Puede incluir los siguientes elementos en una entrada hook detrás del nombre de evento del ciclo de vida de la implementación:

Hacer referencia a los archivos en los scripts de enlaces

Si va a conectar un script a un evento CodeDeploy del ciclo de vida, tal y como se describe enAppSpec sección de «ganchos», y desea hacer referencia a un archivo (por ejemplohelper.sh) del script, tendrá que especificarlo mediante: helper.sh

Uso de rutas absolutas

Para hacer referencia a un archivo mediante su ruta absoluta, puede hacer lo siguiente:

Ubicación del archivo de implementación

Durante el evento DownloadBundledel ciclo de vida, el CodeDeploy agente extrae la revisión para el despliegue en un directorio que tiene el siguiente formato:

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

La parte del directorio raíz de la ruta siempre se establece en el valor predeterminado que se muestra en la siguiente tabla o se controla mediante el ajuste de configuración :root_dir. Para obtener más información acerca de los ajustes de configuración, consulte CodeDeploy referencia de configuración del agente.

Desde sus scripts de enlace, puede acceder al archivo de implementación actual utilizando la ruta del directorio raíz y las variables de entorno DEPLOYMENT_ID y DEPLOYMENT_GROUP_ID. Para obtener más información acerca de las que puede usar, consulte Disponibilidad de las variables de entorno para los enlaces.

Por ejemplo, así es como puede acceder a un archivo data.json que se encuentra en la raíz de su revisión en Linux:

#!/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)

Otro ejemplo: así es como puede acceder a un archivo data.json que se encuentra en la raíz de la revisión con Powershell en Windows:

$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)

Uso de rutas relativas

Para hacer referencia a un archivo mediante su ruta relativa, necesitará conocer el directorio de trabajo del CodeDeploy agente. Las rutas de los archivos son relativas a este directorio.

La siguiente tabla muestra el directorio de trabajo de cada plataforma compatible del CodeDeploy agente.

Disponibilidad de las variables de entorno para los enlaces

Durante cada evento del ciclo de vida de la implementación, los scripts de enlace pueden tener acceso a las siguientes variables de entorno:

Estas variables de entorno son locales con respecto a cada evento del ciclo de vida de la implementación.

Hay variables de entorno adicionales disponibles para conectar scripts de enlace en función del origen del paquete de implementación:

Paquete de Amazon S3

Paquete de GitHub

El script siguiente cambia el puerto de escucha de un servidor HTTP Apache a 9090 en lugar de a 80 si el valor de DEPLOYMENT_GROUP_NAME es igual a Staging. Este script debe invocarse durante el evento del ciclo de vida de implementación BeforeInstall:

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

El script de ejemplo siguiente cambia el nivel de detalle de los mensajes registrados en su log de errores de advertencia a depurar si el valor de la variable de entorno DEPLOYMENT_GROUP_NAME es igual a Staging. Este script debe invocarse durante el evento del ciclo de vida de implementación BeforeInstall:

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

El script de ejemplo siguiente sustituye el texto de la página web especificada por el texto que muestra el valor de estas variables de entorno. Este script debe invocarse durante el evento del ciclo de vida de implementación 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()

Ejemplo de enlaces

A continuación se muestra un ejemplo de una entrada hooks (enlaces) que especifica dos enlaces para el evento de ciclo de vida AfterInstall.

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

El script Scripts/RunResourceTests.sh se ejecuta durante la fase AfterInstall del proceso de implementación. La implementación no tendrá éxito si el script tarda más de 180 segundos (3 minutos) en ejecutarse.

La ubicación de los scripts que especifica en la sección "hooks" es relativa a la raíz del paquete de revisión de la aplicación. En el ejemplo anterior, un archivo denominado RunResourceTests.sh está en un directorio denominado Scripts. El directorio Scripts está en la raíz del paquete. Para obtener más información, consulte Planifique una revisión para CodeDeploy.