2. CodeDeployデプロイメントの作成¶
作業の目的 [why]¶
CodeDeployアプリケーション名"handson-cli-deploy-app"のデプロイメントグループ"handson-cli-deploy-dg"にデプロイメントを作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- CodeDeployデプロイメントのステータスが"Succeeded"である。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- CodeDeployアプリケーション名"handson-cli-deploy-app"が存在する。
- 事前条件2
- CodeDeployアプリケーション名"handson-cli-deploy-app"にCodeDeployデプロイメントグループ名"handson-cli-deploy-dg"が存在する。
- 事前条件3
- S3バケット"handson-cli-artifacts-XXXXXXXXXXXX"が存在する。
- 事前条件4
- S3バケット"handson-cli-artifacts-XXXXXXXXXXXX"にオブジェクト"handson-cli-codebuild-project.zip"が存在する。
- 事前条件5
- 一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。
作業対象 [what]¶
- CodeDeployデプロイメントグループ
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: CodeDeployアプリケーション名
- デプロイメントを実行するCodeDeployアプリケーションの名称です。
- 今回は"handson-cli-deploy-app"とします。
リソース2: CodeDeployデプロイメントグループ名
- デプロイメントを実行するCodeDeployデプロイメントグループの名称です。
- 今回は"handson-cli-deploy-dg"とします。
リソース3: S3バケット名
- デプロイメントの対象となるアーティファクトが配置されているS3バケット名です。
- 今回は"handson-cli-artifacts-XXXXXXXXXXXX"とします。
リソース4: S3オブジェクトキー名
- デプロイメントの対象となるアーティファクトが配置されているディレクトリ(S3オブジェクトキー)名です。
- 今回は"handson-cli-codebuild-project.zip"とします。
リソース5: 一時ファイル用ディレクトリ
- 今回は"${HOME}/tmp"を一時ファイル用ディレクトリとします。
ディレクトリが存在することを確認します。
コマンド:
ls -d ${HOME}/tmp
結果(例:存在する場合):
${HOME}/tmp
ディレクトリが存在しない場合は作成します。
コマンド:
mkdir -p ${HOME}/tmp
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.1. CodeDeployアプリケーション名の指定¶
CodeDeployアプリケーション名を指定します。
変数の設定:
CODED_APP_NAME='handson-cli-deploy-app'
0.2. CodeDeployデプロイメントグループ名の指定¶
CodeDeployデプロイメントグループ名を指定します。
変数の設定:
CODED_DEPLOY_GROUP_NAME='handson-cli-deploy-dg'
0.3. S3バケット名の指定¶
S3バケット名を指定します。
変数の設定:
S3_BUCKET_PREFIX='handson-cli-artifacts'
コマンド:
AWS_ID=$( \ aws sts get-caller-identity \ --query 'Account' \ --output text \ ) \ && echo ${AWS_ID}
結果(例):
XXXXXXXXXXXX
変数の設定:
S3_BUCKET_NAME="${S3_BUCKET_PREFIX}-${AWS_ID}" \ && echo ${S3_BUCKET_NAME}
結果(例):
handson-cli-artifacts-XXXXXXXXXXXX
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-deploy-deployment-create.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-deploy-deployment-create.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. CODED_APP_NAME:"handson-cli-deploy-app" CODED_APP_NAME="${CODED_APP_NAME}" # 0.2. CODED_DEPLOY_GROUP_NAME:"handson-cli-deploy-dg" CODED_DEPLOY_GROUP_NAME="${CODED_DEPLOY_GROUP_NAME}" # 0.3. S3_BUCKET_NAME:"handson-cli-artifacts-XXXXXXXXXXXX" S3_BUCKET_NAME="${S3_BUCKET_NAME}" # 0.4. S3_OBJECT_NAME:"handson-cli-codebuild-project.zip" S3_OBJECT_NAME="${S3_OBJECT_NAME}" # 0.5. DIR_TMP:"${HOME}/tmp" DIR_TMP="${DIR_TMP}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: CodeDeployアプリケーション名"handson-cli-deploy-app"が存在する。
「CodeDeployアプリケーション名"handson-cli-deploy-app"が存在する。」ことを確認します。
コマンド:
aws deploy get-application \ --application-name ${CODED_APP_NAME} \ --query 'application.applicationName' \ --output text
結果(例):
handson-cli-deploy-app
事前条件2: CodeDeployアプリケーション名"handson-cli-deploy-app"にCodeDeployデプロイメントグループ名"handson-cli-deploy-dg"が存在する。
「CodeDeployアプリケーション名"handson-cli-deploy-app"にCodeDeployデプロイメントグループ名"handson-cli-deploy-dg"が存在する。」ことを確認します。
コマンド:
aws deploy get-deployment-group \ --application-name ${CODED_APP_NAME} \ --deployment-group-name ${CODED_DEPLOY_GROUP_NAME} \ --query 'deploymentGroupInfo.deploymentGroupName' \ --output text
結果(例):
handson-cli-deploy-dg
事前条件3: S3バケット"handson-cli-artifacts-XXXXXXXXXXXX"が存在する。
「S3バケット"handson-cli-artifacts-XXXXXXXXXXXX"が存在する。」ことを確認します。
コマンド:
aws s3api list-buckets \ --query "Buckets[?Name == \`${S3_BUCKET_NAME}\`].Name" \ --output text
結果(例):
handson-cli-artifacts-XXXXXXXXXXXX
事前条件4: S3バケット"handson-cli-artifacts-XXXXXXXXXXXX"にオブジェクト"handson-cli-codebuild-project.zip"が存在する。
「S3バケット"handson-cli-artifacts-XXXXXXXXXXXX"にオブジェクト"handson-cli-codebuild-project.zip"が存在する。」ことを確認します。
コマンド:
aws s3 ls s3://${S3_BUCKET_NAME}/${S3_OBJECT_NAME}
結果(例):
2019-04-30 01:23:45 xxxxxxxx handson-cli-artifacts-XXXXXXXXXXXX/handson-cli-codebuild-project.zip
事前条件5: 一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。
「一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_TMP}
結果(例):
${HOME}/tmp
1.2. 主処理に必要な情報の取得¶
S3ロケーション文字列の生成
変数の設定:
STRING_S3_LOCATION="bucket=${S3_BUCKET_NAME},bundleType=zip,key=${S3_OBJECT_NAME}" \ && echo ${STRING_S3_LOCATION}
結果(例):
bucket=handson-cli-artifacts-XXXXXXXXXXXX,bundleType=zip,key=handson-cli-codebuild-project.zip
ファイル名の指定
変数の設定:
FILE_OUTPUT="${DIR_TMP}/$(date +%Y-%m-%d)-deploy-${CODED_APP_NAME}-${CODED_DEPLOY_GROUP_NAME}-${AWS_DEFAULT_REGION}.json" \ && echo ${FILE_OUTPUT}
結果(例):
${HOME}/tmp/2019-04-30-deploy-handson-cli-deploy-app-handson-cli-deploy-dg-ap-northeast-1.json
2. 主処理¶
CodeDeployデプロイメントの作成¶
変数の確認:
cat << ETX # CODED_APP_NAME:"handson-cli-deploy-app" CODED_APP_NAME="${CODED_APP_NAME}" # CODED_DEPLOY_GROUP_NAME:"handson-cli-deploy-dg" CODED_DEPLOY_GROUP_NAME="${CODED_DEPLOY_GROUP_NAME}" # STRING_S3_LOCATION:"bucket=handson-cli-artifacts-XXXXXXXXXXXX,bundleType=zip,key=handson-cli-codebuild-project.zip" STRING_S3_LOCATION="${STRING_S3_LOCATION}" # FILE_OUTPUT:"${HOME}/tmp/2019-04-30-deploy-handson-cli-deploy-app-handson-cli-deploy-dg-ap-northeast-1.json" FILE_OUTPUT="${FILE_OUTPUT}" ETX
コマンド:
aws deploy create-deployment \ --application-name ${CODED_APP_NAME} \ --deployment-group-name ${CODED_DEPLOY_GROUP_NAME} \ --s3-location ${STRING_S3_LOCATION} \ > ${FILE_OUTPUT} cat ${FILE_OUTPUT}
結果(例):
{ "deploymentId": "d-xxxxxxxxx" }
3. 後処理¶
3.1. 状態確認に必要な情報の取得¶
デプロイメントIDの取得
コマンド:
CODED_DEPLOYMENT_ID=$( \ cat ${FILE_OUTPUT} \ | jp.py "deploymentId" \ | sed 's/\"//g' \ ) \ && echo ${CODED_DEPLOYMENT_ID}
結果(例):
d-xxxxxxxxx
3.2. 完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: CodeDeployデプロイメントのステータスが"Succeeded"である。
「CodeDeployデプロイメントのステータスが"Succeeded"である。」ことを確認します。
コマンド:
CODED_DEPLOYMENT_STATUS=$( aws deploy get-deployment \ --deployment-id ${CODED_DEPLOYMENT_ID} \ --query "deploymentInfo.status" \ --output text \ ) \ && echo ${CODED_DEPLOYMENT_STATUS}
結果(例):
Succeeded