Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

AppSpec Bagian 'kait'

Konten di 'hooks' bagian AppSpec file bervariasi, tergantung pada platform komputasi untuk penerapan Anda. 'hooks'Bagian untuk penerapan EC2/On-premise berisi pemetaan yang menghubungkan peristiwa siklus hidup penerapan terkait ke satu atau beberapa skrip. 'hooks'Bagian untuk Lambda atau penerapan Amazon ECS menentukan fungsi validasi Lambda untuk dijalankan selama peristiwa siklus hidup penerapan. Jika hook peristiwa tidak ada, tidak ada operasi yang dijalankan untuk acara itu. Bagian ini diperlukan hanya jika Anda menjalankan skrip atau fungsi validasi Lambda sebagai bagian dari penerapan.

AppSpec Bagian 'kait' untuk penerapan Amazon ECS

Daftar kait peristiwa siklus hidup untuk penerapan Amazon ECS

Hook AWS Lambda adalah salah satu fungsi Lambda yang ditentukan dengan string pada baris baru setelah nama peristiwa siklus hidup. Setiap hook dijalankan sekali per penerapan. Berikut ini adalah deskripsi peristiwa siklus hidup tempat Anda dapat menjalankan hook selama penerapan Amazon ECS.

Untuk informasi selengkapnya, lihat Apa yang terjadi selama penyebaran Amazon ECS dan Tutorial: Menyebarkan layanan Amazon ECS dengan uji validasi.

Jalankan urutan kait dalam penerapan Amazon ECS.

Dalam penerapan Amazon ECS, kait peristiwa berjalan dalam urutan berikut:

Struktur bagian 'kait'

Berikut ini adalah contoh struktur 'hooks' bagian.

Menggunakan YAMAL:

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

Menggunakan JSON:

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

Contoh fungsi 'kait' Lambda

Gunakan 'hooks' bagian untuk menentukan fungsi Lambda yang CodeDeploy dapat memanggil untuk memvalidasi penerapan Amazon ECS. Anda dapat menggunakan fungsi yang sama atau yang berbeda untuk peristiwa siklus hidup BeforeInstall AfterInstallAfterAllowTestTraffic,BeforeAllowTraffic,,, dan AfterAllowTraffic penerapan. Setelah menyelesaikan tes validasi, fungsi AfterAllowTraffic Lambda memanggil CodeDeploy kembali dan memberikan hasil dari atau. Succeeded Failed

Sebelum menjalankan fungsi hook Lambda, server harus diberi tahu tentang ID penerapan dan ID eksekusi kait peristiwa siklus hidup menggunakan perintah. putLifecycleEventHookExecutionStatus

Berikut ini adalah contoh fungsi hook Lambda ditulis dalam 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 Bagian 'kait' untuk penerapan AWS Lambda

Daftar kait peristiwa siklus hidup untuk penerapan Lambda AWS

Hook AWS Lambda adalah salah satu fungsi Lambda yang ditentukan dengan string pada baris baru setelah nama peristiwa siklus hidup. Setiap hook dijalankan sekali per penerapan. Berikut adalah deskripsi kait yang tersedia untuk digunakan dalam file Anda AppSpec .

Jalankan urutan kait dalam penerapan versi fungsi Lambda

Dalam penerapan versi fungsi Lambda tanpa server, kait peristiwa berjalan dalam urutan berikut:

Struktur bagian 'kait'

Berikut ini adalah contoh struktur bagian 'kait'.

Menggunakan YAMAL:

hooks:
   - BeforeAllowTraffic: BeforeAllowTrafficHookFunctionName
   - AfterAllowTraffic: AfterAllowTrafficHookFunctionName

Menggunakan JSON:

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

Contoh fungsi 'kait' Lambda

Gunakan bagian 'kait' untuk menentukan fungsi Lambda CodeDeploy yang dapat memanggil untuk memvalidasi penerapan Lambda. Anda dapat menggunakan fungsi yang sama atau yang berbeda untuk peristiwa siklus hidup BeforeAllowTraffic dan AfterAllowTraffic penerapan. Setelah menyelesaikan tes validasi, fungsi validasi Lambda memanggil CodeDeploy kembali dan memberikan hasil dari atau. Succeeded Failed

Sebelum menjalankan fungsi hook Lambda, server harus diberi tahu tentang ID penerapan dan ID eksekusi kait peristiwa siklus hidup menggunakan perintah. putLifecycleEventHookExecutionStatus

Berikut ini adalah contoh fungsi hook Lambda ditulis dalam 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 Bagian 'kait' untuk penerapan EC2/On-premise

Daftar kait acara siklus hidup

Pengait penerapan EC2/On-premise dijalankan satu kali per penerapan ke sebuah instance. Anda dapat menentukan satu atau beberapa skrip untuk dijalankan di hook. Setiap hook untuk acara siklus hidup ditentukan dengan string pada baris terpisah. Berikut adalah deskripsi kait yang tersedia untuk digunakan dalam file Anda AppSpec .

Untuk informasi tentang kait peristiwa siklus hidup mana yang valid untuk jenis penerapan dan rollback, lihat. Ketersediaan kait acara siklus hidup

Ketersediaan kait acara siklus hidup

Tabel berikut mencantumkan kait peristiwa siklus hidup yang tersedia untuk setiap skenario penerapan dan rollback.

Jalankan urutan kait dalam penerapan

Penerapan peluncuran Auto Scaling

Selama penerapan peluncuran Auto Scaling, CodeDeploy jalankan event hook dalam urutan berikut.

Untuk informasi selengkapnya tentang penerapan peluncuran Auto Scaling, lihat. Cara Kerja Auto Scaling Amazon EC2 CodeDeploy

Penerapan penghentian Auto Scaling

Selama penerapan penghentian Auto Scaling, CodeDeploy jalankan event hook dalam urutan berikut.

Untuk informasi selengkapnya tentang penerapan penghentian Auto Scaling, lihat. Mengaktifkan penerapan penghentian selama peristiwa penskalaan Auto Scaling

Penerapan di tempat

Dalam penerapan di tempat, termasuk rollback penerapan di tempat, kait peristiwa dijalankan dalam urutan berikut:

Penerapan biru/hijau

Dalam penerapan biru/hijau, kait acara dijalankan dengan urutan sebagai berikut:

Struktur bagian 'kait'

'hooks'Bagian ini memiliki struktur sebagai berikut:

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

Anda dapat menyertakan elemen-elemen berikut dalam entri hook setelah nama peristiwa siklus hidup penerapan:

Mereferensikan file dalam skrip hook Anda

Jika Anda menghubungkan skrip ke peristiwa CodeDeploy siklus hidup seperti yang dijelaskan dalamAppSpec Bagian 'kait', dan Anda ingin mereferensikan file (misalnya,helper.sh) dalam skrip Anda, maka Anda harus menentukan menggunakan: helper.sh

Menggunakan jalur absolut

Untuk mereferensikan file menggunakan jalur absolutnya, Anda dapat:

Lokasi arsip penyebaran

Selama peristiwa DownloadBundlesiklus hidup, CodeDeploy agen mengekstrak revisi untuk penerapan ke direktori yang memiliki format berikut:

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

Bagian direktori root dari jalur selalu diatur ke default yang ditampilkan dalam tabel berikut, atau dikendalikan oleh :root_dir pengaturan konfigurasi. Untuk informasi selengkapnya tentang pengaturan konfigurasi, lihatCodeDeploy referensi konfigurasi agen.

Dari skrip hook Anda, Anda dapat mengakses arsip penyebaran saat ini menggunakan jalur direktori root dan variabel DEPLOYMENT_ID dan DEPLOYMENT_GROUP_ID lingkungan. Untuk informasi lebih lanjut tentang variabel yang dapat Anda gunakan, lihatKetersediaan variabel lingkungan untuk kait.

Misalnya, berikut adalah bagaimana Anda dapat mengakses data.json file yang berada di root revisi Anda di 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)

Sebagai contoh lain, berikut adalah bagaimana Anda dapat mengakses data.json file yang berada di root revisi Anda menggunakan Powershell di 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)

Menggunakan jalur relatif

Untuk mereferensikan file menggunakan jalur relatifnya, Anda harus mengetahui direktori kerja CodeDeploy agen. Jalur file relatif terhadap direktori ini.

Tabel berikut menunjukkan direktori kerja untuk setiap platform CodeDeploy agen yang didukung.

Ketersediaan variabel lingkungan untuk kait

Selama setiap peristiwa siklus hidup penerapan, skrip hook dapat mengakses variabel lingkungan berikut:

Variabel lingkungan ini bersifat lokal untuk setiap peristiwa siklus hidup penerapan.

Ada variabel lingkungan tambahan yang tersedia untuk mengaitkan skrip tergantung pada sumber bundel penerapan:

Bundel dari Amazon S3

Bundel dari GitHub

Skrip berikut mengubah port mendengarkan pada server HTTP Apache menjadi 9090, bukan 80 jika nilai DEPLOYMENT_GROUP_NAME sama dengan. Staging Skrip ini harus dipanggil selama peristiwa siklus hidup BeforeInstall penerapan:

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

Contoh skrip berikut mengubah tingkat verbositas pesan yang direkam dalam log kesalahannya dari peringatan menjadi debug jika nilai variabel lingkungan DEPLOYMENT_GROUP_NAME sama dengan. Staging Skrip ini harus dipanggil selama peristiwa siklus hidup BeforeInstall penerapan:

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

Contoh skrip berikut menggantikan teks di halaman web yang ditentukan dengan teks yang menampilkan nilai variabel lingkungan ini. Skrip ini harus dipanggil selama peristiwa siklus hidup AfterInstall penerapan:

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

Contoh kait

Berikut adalah contoh entri kait yang menentukan dua kait untuk acara siklus hidup: AfterInstall

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

Scripts/RunResourceTests.shSkrip berjalan selama AfterInstall tahap proses penyebaran. Penerapan tidak berhasil jika skrip membutuhkan waktu lebih dari 180 detik (3 menit) untuk dijalankan.

Lokasi skrip yang Anda tentukan di bagian 'kait' relatif terhadap root bundel revisi aplikasi. Dalam contoh sebelumnya, sebuah file bernama RunResourceTests.sh dalam direktori bernama. Scripts ScriptsDirektori berada di tingkat root bundel. Untuk informasi selengkapnya, lihat Rencanakan revisi untuk CodeDeploy.