Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

AppSpec sezione 'hooks'

Il contenuto nella 'hooks' sezione del AppSpec file varia a seconda della piattaforma di elaborazione utilizzata per la distribuzione. La 'hooks' sezione relativa alla distribuzione EC2 /On-Premises contiene mappature che collegano gli hook degli eventi del ciclo di vita della distribuzione a uno o più script. La 'hooks' sezione relativa a una ECS distribuzione Lambda o Amazon specifica le funzioni di convalida Lambda da eseguire durante un evento del ciclo di vita della distribuzione. Se l'hook di un evento non è presente, non viene eseguita alcuna operazione per quell'evento. Questa sezione è obbligatoria solo se esegui script o funzioni di convalida Lambda come parte della distribuzione.

AppSpec sezione 'hooks' per una distribuzione Amazon ECS

Elenco degli hook relativi agli eventi del ciclo di vita per una distribuzione Amazon ECS

Un hook AWS Lambda è una funzione Lambda specificata con una stringa su una nuova riga dopo il nome dell'evento del ciclo di vita. Ogni hook viene eseguito una volta per distribuzione. Di seguito sono riportate le descrizioni degli eventi del ciclo di vita in cui è possibile eseguire un hook durante una distribuzione AmazonECS.

Per ulteriori informazioni, consulta Cosa succede durante una ECS distribuzione Amazon e Tutorial: distribuisci un ECS servizio Amazon con un test di convalida.

Esegui l'ordine degli hook in una ECS distribuzione Amazon.

In una ECS distribuzione Amazon, gli event hook vengono eseguiti nel seguente ordine:

Struttura della sezione «ganci»

Di seguito sono riportati alcuni esempi della struttura della sezione 'hooks'.

UsandoYAML:

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

UsandoJSON:

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

Esempio di funzione «ganci» Lambda

Utilizza la 'hooks' sezione per specificare una funzione Lambda che CodeDeploy può chiamare per convalidare una distribuzione Amazon. ECS Puoi utilizzare la stessa funzione o una diversa per gli eventi del ciclo di vita BeforeInstallAfterInstall, AfterAllowTestTrafficBeforeAllowTraffic, e della AfterAllowTraffic distribuzione. Dopo il completamento dei test di convalida, la funzione AfterAllowTraffic Lambda CodeDeploy richiama e fornisce il risultato Succeeded di o. Failed

Prima di richiamare una funzione Lambda hook, il server deve ricevere una notifica dell'ID di distribuzione e dell'ID di esecuzione dell'hook dell'evento lifecycle utilizzando il comando. putLifecycleEventHookExecutionStatus

Di seguito è riportato un esempio di funzione hook Lambda scritta in 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 sezione 'hooks' per una distribuzione AWS Lambda

Elenco degli hook relativi agli eventi del ciclo di vita per un'implementazione Lambda AWS

Un hook AWS Lambda è una funzione Lambda specificata con una stringa su una nuova riga dopo il nome dell'evento del ciclo di vita. Ogni hook viene eseguito una volta per distribuzione. Di seguito sono riportate le descrizioni degli hook disponibili per l'uso nel file. AppSpec

Esegui l'ordine degli hook in una distribuzione della versione della funzione Lambda

In una versione di una funzione Lambda senza server, gli event hook vengono eseguiti nel seguente ordine:

Struttura della sezione «ganci»

Di seguito sono riportati alcuni esempi della struttura della sezione "hooks".

UsandoYAML:

hooks:
   - BeforeAllowTraffic: BeforeAllowTrafficHookFunctionName
   - AfterAllowTraffic: AfterAllowTrafficHookFunctionName

UsandoJSON:

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

Esempio di funzione «ganci» Lambda

Usa la sezione 'hooks' per specificare una funzione Lambda CodeDeploy che può chiamare per convalidare una distribuzione Lambda. È possibile utilizzare la stessa funzione o una diversa per gli eventi del ciclo di vita della distribuzioneBeforeAllowTraffic. AfterAllowTraffic Dopo il completamento dei test di convalida, la funzione di convalida Lambda CodeDeploy richiama e fornisce il risultato di o. Succeeded Failed

Prima di richiamare una funzione Lambda hook, il server deve ricevere una notifica dell'ID di distribuzione e dell'ID di esecuzione dell'hook dell'evento lifecycle utilizzando il comando. putLifecycleEventHookExecutionStatus

Di seguito è riportato un esempio di funzione hook Lambda scritta in 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 sezione 'hooks' per una EC2 distribuzione /On-Premises

Elenco degli hook relativi agli eventi del ciclo di vita

Un hook di distribuzione EC2 /On-Premises viene eseguito una volta per distribuzione su un'istanza. Puoi specificare uno o più script da eseguire in un hook. Ogni hook per un evento del ciclo di vita viene specificato con una stringa su una riga separata. Di seguito sono riportate le descrizioni degli hook disponibili per l'uso nel file. AppSpec

Per informazioni sugli hook degli eventi del ciclo di vita validi per i vari tipi di rollback e di distribuzione, consulta Disponibilità di Lifecycle Event Hook.

Disponibilità di Lifecycle Event Hook

La tabella seguente elenca gli hook degli eventi del ciclo di vita disponibili per ogni scenario di distribuzione e rollback.

Esegui l'ordine degli hook in una distribuzione

Implementazioni di lancio di Auto Scaling

Durante una distribuzione con avvio di Auto Scaling, CodeDeploy esegue gli event hook nell'ordine seguente.

Per ulteriori informazioni sulle implementazioni di avvio di Auto Scaling, vedere. Come funziona Amazon EC2 Auto Scaling con CodeDeploy

Implementazioni di terminazione con Auto Scaling

Durante una distribuzione con terminazione di Auto Scaling, CodeDeploy esegue gli event hook nell'ordine seguente.

Per ulteriori informazioni sulle implementazioni di terminazione con Auto Scaling, vedere. Abilitazione delle implementazioni di terminazione durante gli eventi scale-in di Auto Scaling

Distribuzioni locali

In una distribuzione in loco, incluso il rollback di una distribuzione in loco, gli hook degli eventi vengono eseguiti nel seguente ordine:

Distribuzioni blu/verde

In una distribuzione blu/verde, gli hook degli eventi vengono eseguiti nell'ordine seguente:

Struttura della sezione «ganci»

La sezione 'hooks' ha la seguente struttura:

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

Puoi includere i seguenti elementi in una voce hook dopo il nome dell'evento del ciclo di vita della distribuzione:

Riferimento ai file negli script hook

Se stai collegando uno script a un evento CodeDeploy del ciclo di vita come descritto in AppSpec sezione 'hooks' e desideri fare riferimento a un file (ad esempio,helper.sh) nello script, dovrai specificare utilizzando: helper.sh

Utilizzo di percorsi assoluti

Per fare riferimento a un file usando il suo percorso assoluto, puoi:

Posizione dell'archivio di distribuzione

Durante l'evento del DownloadBundleciclo di vita, l' CodeDeploy agente estrae la revisione per la distribuzione in una directory con il seguente formato:

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

Il root-directory parte del percorso è sempre impostata sul valore predefinito mostrato nella tabella seguente o è controllata dall'impostazione di configurazione. :root_dir Per ulteriori informazioni sulle impostazioni di configurazione, vedereCodeDeploy riferimento alla configurazione dell'agente.

Dai tuoi script hook, puoi accedere all'archivio di distribuzione corrente utilizzando il percorso della directory principale e le variabili di ambiente DEPLOYMENT_ID andDEPLOYMENT_GROUP_ID. Per ulteriori informazioni sulle variabili che è possibile utilizzare, vedereDisponibilità delle variabili di ambiente per gli hook.

Ad esempio, ecco come è possibile accedere a un data.json file che si trova nella radice della revisione su 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)

Come altro esempio, ecco come è possibile accedere a un data.json file che si trova alla radice della revisione utilizzando Powershell su 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)

Utilizzo di percorsi relativi

Per fare riferimento a un file utilizzando il relativo percorso, è necessario conoscere la directory di lavoro dell' CodeDeploy agente. I percorsi dei file sono relativi a questa directory.

La tabella seguente mostra la directory di lavoro per ogni piattaforma supportata dall' CodeDeploy agente.

Disponibilità delle variabili di ambiente per gli hook

Durante ogni evento del ciclo di vita della distribuzione, gli script di hook possono accedere alle seguenti variabili di ambiente:

Queste variabili di ambiente sono locali per ciascun evento del ciclo di vita della distribuzione.

Sono disponibili variabili di ambiente aggiuntive per agganciare gli script a seconda dell'origine del pacchetto di distribuzione:

Pacchetto da Amazon S3

Bundle da GitHub

Lo script seguente modifica la porta di ascolto su un HTTP server Apache su 9090 anziché 80 se il valore di DEPLOYMENT_ GROUP _ NAME è uguale a. Staging Questo script devono essere richiamato durante l'evento del ciclo di vita della distribuzione BeforeInstall:

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

Il seguente esempio di script modifica il livello di dettaglio dei messaggi registrati nel relativo registro degli errori da avviso a debug se il valore della variabile di NAME ambiente DEPLOYMENT_ GROUP _ è uguale a. Staging Questo script devono essere richiamato durante l'evento del ciclo di vita della distribuzione BeforeInstall:

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

Il seguente esempio di script sostituisce il testo nella pagina Web specificata con il testo che visualizza il valore di queste variabili di ambiente. Questo script devono essere richiamato durante l'evento del ciclo di vita della distribuzione 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()

Esempio di Hooks

Ecco un esempio della voce hooks che specifica due hook per l'evento del ciclo di vita AfterInstall:

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

Lo script Scripts/RunResourceTests.sh viene eseguito durante la fase AfterInstall del processo di distribuzione. La distribuzione non ha esito positivo se lo script impiega più di 180 secondi (3 minuti) per l'esecuzione.

La posizione degli script specificati nella sezione "hooks" è relativa alla radice del bundle di revisione dell'applicazione. Nel precedente esempio, un file denominato RunResourceTests.sh si trova in una directory denominata Scripts. La directory Scripts si trova al livello di radice del bundle. Per ulteriori informazioni, consulta Pianifica una revisione per CodeDeploy.