2. ECSサービスの作成 (Fargate & ALB: handson-cli-service)¶
作業の目的 [why]¶
ECSサービス"handson-cli-service"を作成します。 サービスはALBのターゲットグループに関連付けます。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- ECSサービス"handson-cli-service"が存在する。
- 完了条件2
- ECSサービス"handson-cli-service"の稼動コンテナ数が"2"である。
- 完了条件3
- ECSサービス"handson-cli-service"にターゲットグループ"handson-cli-container-tg"が関連付けられていること。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- VPC"handson-cli-vpc"が存在する。
- 事前条件2
- VPC"handson-cli-vpc"にサブネット"handson-cli-app-alpha-subnet"が存在する。
- 事前条件3
- VPC"handson-cli-vpc"にサブネット"handson-cli-app-charlie-subnet"が存在する。
- 事前条件4
- VPC"handson-cli-vpc"にセキュリティグループ"handson-cli-webapp-sg"が存在する。
- 事前条件5
- ターゲットグループ"handson-cli-container-tg"が存在する。
- 事前条件6
- ECSクラスタ"handson-cli-cluster"が存在する。
- 事前条件7
- ECSタスク定義"handson-cli-task-definition"のリビジョン"1"が存在する。
- 事前条件8
- ECSタスク定義"handson-cli-task-definition"のリビジョン"1"にコンテナ"handson-cli-container"が存在する。
- 事前条件9
- ECSクラスタ"handson-cli-cluster"にECSサービス"handson-cli-service"が存在しない。
作業対象 [what]¶
- ECSサービス
標準時間(合計)¶
8分
パラメータ設定¶
| パタメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: VPCのタグ名
- 作成するECSサービスを配置するVPCのタグ名称です。
- 今回は"handson-cli-vpc"とします。
リソース2: サブネット1のタグ名
- 作成するECSサービスを配置するサブネットのタグ名称です。
- 今回は"handson-cli-app-alpha-subnet"とします。
リソース3: サブネット2のタグ名
- 作成するECSサービスを配置するサブネットのタグ名称です。
- 今回は"handson-cli-app-charlie-subnet"とします。
リソース4: セキュリティグループ名
- 作成するECSサービスが利用するセキュリティグループの名称です。
- 今回は"handson-cli-webapp-sg"とします。
リソース5: ターゲットグループ名
- 作成するECSサービスが利用するターゲットグループの名称です。
- 今回は"handson-cli-container-tg"とします。
リソース6: ECSクラスタ名
- 作成するECSクラスタの名称です。
- 今回は"handson-cli-cluster"とします。
リソース7: ECSタスク定義ファミリ名
- 作成するECSサービスが利用するECSタスク定義ファミリの名称です。
- 今回は"handson-cli-task-definition"とします。
リソース8: ECSタスク定義リビジョン
- 作成するECSサービスが利用するECSタスク定義のリビジョンです。
- 今回は"1"とします。
リソース9: コンテナ名
- 作成するECSサービスが利用するECSタスク定義に存在し、ターゲットグループに登録するコンテナ名です。
- 今回は"handson-cli-container"とします。
リソース10: ECSサービス名
- 作成するECSサービスの名称です。
- 今回は"handson-cli-service"とします。
リソース11: ECSタスク定義の実行数
- ECSタスク定義をクラスタに配置して実行状態に保つ数です。
- 今回は"2"とします。
リソース12: デプロイメントコントローラ
- 作成するECSサービスが利用するデプロイメントコントローラの名称です。
- 今回は"CODE_DEPLOY"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.7. ECSタスク定義ファミリ名の指定¶
ECSタスク定義ファミリ名を指定します。
変数の設定:
ECS_TASK_DEFINITION_FAMILY='handson-cli-task-definition'
0.12. デプロイメントコントローラ名の指定¶
ECSサービスのデプロイメントコントローラ名を指定します。
変数の設定:
ECS_SERVICE_DEPLOY_CONTROLLER='CODE_DEPLOY'
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ecs-service_fargate_alb-create.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-ecs-service_fargate_alb-create.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. VPC_TAG_NAME:"handson-cli-vpc" VPC_TAG_NAME="${VPC_TAG_NAME}" # 0.2. VPC_SUBNET_TAG_NAME_1:"handson-cli-app-alpha-subnet" VPC_SUBNET_TAG_NAME_1="${VPC_SUBNET_TAG_NAME_1}" # 0.3. VPC_SUBNET_TAG_NAME_2:"handson-cli-app-charlie-subnet" VPC_SUBNET_TAG_NAME_2="${VPC_SUBNET_TAG_NAME_2}" # 0.4. VPC_SG_NAME:"handson-cli-webapp-sg" VPC_SG_NAME="${VPC_SG_NAME}" # 0.5. ELBV2_TARGET_GROUP_NAME:"handson-cli-container-tg" ELBV2_TARGET_GROUP_NAME="${ELBV2_TARGET_GROUP_NAME}" # 0.6. ECS_CLUSTER_NAME:"handson-cli-cluster" ECS_CLUSTER_NAME="${ECS_CLUSTER_NAME}" # 0.7. ECS_TASK_DEFINITION_FAMILY:"handson-cli-task-definition" ECS_TASK_DEFINITION_FAMILY="${ECS_TASK_DEFINITION_FAMILY}" # 0.8. ECS_TASK_DEFINITION_REVISION:"1" ECS_TASK_DEFINITION_REVISION="${ECS_TASK_DEFINITION_REVISION}" # 0.9. CONTAINER_NAME:"handson-cli-container" CONTAINER_NAME="${CONTAINER_NAME}" # 0.10. ECS_SERVICE_NAME:"handson-cli-service" ECS_SERVICE_NAME="${ECS_SERVICE_NAME}" # 0.11. ECS_SERVICE_DESIERD_COUNT:"2" ECS_SERVICE_DESIERD_COUNT="${ECS_SERVICE_DESIERD_COUNT}" # 0.12. ECS_SERVICE_DEPLOY_CONTROLLER:"CODE_DEPLOY" ECS_SERVICE_DEPLOY_CONTROLLER="${ECS_SERVICE_DEPLOY_CONTROLLER}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: VPC"handson-cli-vpc"が存在する。
「VPC"handson-cli-vpc"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-vpcs \ --filters Name=tag:Name,Values=${VPC_TAG_NAME} \ --query 'Vpcs[].Tags[?Key == `Name`].Value' \ --output text
結果(例):
handson-cli-vpc
VPC IDを取得します。
コマンド:
VPC_ID=$( \ aws ec2 describe-vpcs \ --filters Name=tag:Name,Values=${VPC_TAG_NAME} \ --query 'Vpcs[].VpcId' \ --output text \ ) \ && echo ${VPC_ID}
結果(例):
vpc-xxxxxxxxxxxxxxxxx
事前条件2: VPC"handson-cli-vpc"にサブネット"handson-cli-app-alpha-subnet"が存在する。
「VPC"handson-cli-vpc"にサブネット"handson-cli-app-alpha-subnet"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-subnets \ --filters Name=vpc-id,Values=${VPC_ID} \ Name=tag:Name,Values=${VPC_SUBNET_TAG_NAME_1} \ --query 'Subnets[].Tags[?Key == `Name`].Value' \ --output text
結果(例):
handson-cli-app-alpha-subnet
事前条件3: VPC"handson-cli-vpc"にサブネット"handson-cli-app-charlie-subnet"が存在する。
「VPC"handson-cli-vpc"にサブネット"handson-cli-app-charlie-subnet"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-subnets \ --filters Name=vpc-id,Values=${VPC_ID} \ Name=tag:Name,Values=${VPC_SUBNET_TAG_NAME_2} \ --query 'Subnets[].Tags[?Key == `Name`].Value' \ --output text
結果(例):
handson-cli-app-charlie-subnet
事前条件4: VPC"handson-cli-vpc"にセキュリティグループ"handson-cli-webapp-sg"が存在する。
「VPC"handson-cli-vpc"にセキュリティグループ"handson-cli-webapp-sg"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-security-groups \ --filter Name=vpc-id,Values=${VPC_ID} \ Name=group-name,Values=${VPC_SG_NAME} \ --query 'SecurityGroups[].GroupName' \ --output text
結果(例):
handson-cli-webapp-sg
事前条件5: ターゲットグループ"handson-cli-container-tg"が存在する。
「ターゲットグループ"handson-cli-container-tg"が存在する。」ことを確認します。
コマンド:
aws elbv2 describe-target-groups \ --names ${ELBV2_TARGET_GROUP_NAME} \ --query 'TargetGroups[].TargetGroupName' \ --output text
結果(例):
handson-cli-container-tg
事前条件6: ECSクラスタ"handson-cli-cluster"が存在する。
「ECSクラスタ"handson-cli-cluster"が存在する。」ことを確認します。
コマンド:
aws ecs list-clusters \ --query "clusterArns[?contains(@,\`${ECS_CLUSTER_NAME}\`)]" \ --output text
結果(例):
arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:cluster/handson-cli-cluster
事前条件7: ECSタスク定義"handson-cli-task-definition"のリビジョン"1"が存在する。
「ECSタスク定義"handson-cli-task-definition"のリビジョン"1"が存在する。」ことを確認します。
コマンド:
aws ecs list-task-definitions \ --family-prefix ${ECS_TASK_DEFINITION_FAMILY} \ --query "taskDefinitionArns[?contains(@,\`${ECS_TASK_DEFINITION_FAMILY}:${ECS_TASK_DEFINITION_REVISION}\`)]" \ --output text
結果(例):
arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:task-definition/handson-cli-task-definition:1
タスク定義のARNを取得します。
コマンド:
ECS_TASK_DEFINISION_ARN=$( \ aws ecs list-task-definitions \ --family-prefix ${ECS_TASK_DEFINITION_FAMILY} \ --query "taskDefinitionArns[?contains(@,\`${ECS_TASK_DEFINITION_FAMILY}:${ECS_TASK_DEFINITION_REVISION}\`)]" \ --output text \ ) \ && echo ${ECS_TASK_DEFINISION_ARN}
結果(例):
arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:task-definition/handson-cli-task-definition:1
事前条件8: ECSタスク定義"handson-cli-task-definition"のリビジョン"1"にコンテナ"handson-cli-container"が存在する。
「ECSタスク定義"handson-cli-task-definition"のリビジョン"1"にコンテナ"handson-cli-container"が存在する。」ことを確認します。
コマンド:
aws ecs describe-task-definition \ --task-definition ${ECS_TASK_DEFINISION_ARN} \ --query "taskDefinition.containerDefinitions[?name == \`${CONTAINER_NAME}\`].name" \ --output text
結果(例):
handson-cli-container
事前条件9: ECSクラスタ"handson-cli-cluster"にECSサービス"handson-cli-service"が存在しない。
「ECSクラスタ"handson-cli-cluster"にECSサービス"handson-cli-service"が存在しない。」ことを確認します。
コマンド:
aws ecs list-services \ --cluster ${ECS_CLUSTER_NAME} \ --query "serviceArns[?contains(@,\`${ECS_SERVICE_NAME}\`)]" \ --output text
結果(例):
(出力なし)
1.2. 主処理に必要な情報の取得¶
サブネットIDの取得と配列化
サブネット1のサブネットIDを取得します。
コマンド:
VPC_SUBNET_ID_1=$( \ aws ec2 describe-subnets \ --filters Name=vpc-id,Values=${VPC_ID} \ --filters Name=tag:Name,Values=${VPC_SUBNET_TAG_NAME_1} \ --query "Subnets[].SubnetId" \ --output text \ ) \ && echo ${VPC_SUBNET_ID_1}
結果(例):
subnet-xxxxxxxxxxxxxxxxx
サブネット2のサブネットIDを取得します。
コマンド:
VPC_SUBNET_ID_2=$( \ aws ec2 describe-subnets \ --filters Name=vpc-id,Values=${VPC_ID} \ --filters Name=tag:Name,Values=${VPC_SUBNET_TAG_NAME_2} \ --query "Subnets[].SubnetId" \ --output text \ ) \ && echo ${VPC_SUBNET_ID_2}
結果(例):
subnet-xxxxxxxxxxxxxxxxx
サブネットIDを配列に格納します。
変数の設定:
ARRAY_VPC_SUBNET_IDS="${VPC_SUBNET_ID_1},${VPC_SUBNET_ID_2}" \ && echo ${ARRAY_VPC_SUBNET_IDS}
結果(例):
subnet-xxxxxxxxxxxxxxxxx,subnet-xxxxxxxxxxxxxxxxx
セキュリティグループIDの取得
コマンド:
VPC_SG_ID=$( \ aws ec2 describe-security-groups \ --filter Name=vpc-id,Values=${VPC_ID} \ Name=group-name,Values=${VPC_SG_NAME} \ --query "SecurityGroups[].GroupId" \ --output text \ ) \ && echo ${VPC_SG_ID}
結果(例):
sg-xxxxxxxxxxxxxxxxx
セキュリティグループID配列の生成
変数の設定:
ARRAY_VPC_SG_IDS="${VPC_SG_ID}" \ && echo ${ARRAY_VPC_SG_IDS}
結果(例):
sg-xxxxxxxxxxxxxxxxx
ネットワーク設定文字列の生成
変数の設定:
STRING_ECS_SERVICE_NETWORK_CONFIGURATION="awsvpcConfiguration={subnets=[${ARRAY_VPC_SUBNET_IDS}],securityGroups=[${ARRAY_VPC_SG_IDS}],assignPublicIp=ENABLED}" \ && echo ${STRING_ECS_SERVICE_NETWORK_CONFIGURATION}
結果(例):
awsvpcConfiguration={subnets=[subnet-xxxxxxxxxxxxxxxxx,subnet-xxxxxxxxxxxxxxxxx],securityGroups=[sg-xxxxxxxxxxxxxxxxx],assignPublicIp=ENABLED}
ターゲットグループARNの取得
ターゲットグループのARNを取得します。
コマンド:
ELBV2_TARGET_GROUP_ARN=$( \ aws elbv2 describe-target-groups \ --names ${ELBV2_TARGET_GROUP_NAME} \ --query 'TargetGroups[].TargetGroupArn' \ --output text \ ) \ && echo ${ELBV2_TARGET_GROUP_ARN}
結果(例):
arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-container-tg/xxxxxxxxxxxxxxxx
コンテナのポート番号取得
コンテナのポート番号を取得します。
コマンド:
CONTAINER_PORT=$( \ aws ecs describe-task-definition \ --task-definition ${ECS_TASK_DEFINISION_ARN} \ --query "taskDefinition.containerDefinitions[?name == \`${CONTAINER_NAME}\`].portMappings[].containerPort" \ --output text \ ) \ && echo ${CONTAINER_PORT}
結果(例):
80
ロードバランサ設定文字列の生成
変数の設定:
STRING_ECS_SERVICE_LOAD_BALANCERS="targetGroupArn=${ELBV2_TARGET_GROUP_ARN},containerName=${CONTAINER_NAME},containerPort=${CONTAINER_PORT}" \ && echo ${STRING_ECS_SERVICE_LOAD_BALANCERS}
結果(例):
targetGroupArn=arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-container-tg/xxxxxxxxxxxxxxxx,containerName=handson-cli-container,containerPort=80
デプロイメントコントローラ設定文字列の生成
変数の設定:
STRING_ECS_SERVICE_DEPLOY_CONTROLLER="type=${ECS_SERVICE_DEPLOY_CONTROLLER}" \ && echo ${STRING_ECS_SERVICE_DEPLOY_CONTROLLER}
結果(例):
type=CODE_DEPLOY
2. 主処理¶
ECSサービスの作成¶
変数の確認:
cat << ETX # ECS_CLUSTER_NAME:"handson-cli-cluster" ECS_CLUSTER_NAME="${ECS_CLUSTER_NAME}" # ECS_SERVICE_NAME:"handson-cli-service" ECS_SERVICE_NAME="${ECS_SERVICE_NAME}" # ECS_TASK_DEFINISION_ARN:"arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:task-definition/handson-cli-task-definition:1" ECS_TASK_DEFINISION_ARN="${ECS_TASK_DEFINISION_ARN}" # ECS_SERVICE_DESIERD_COUNT:"2" ECS_SERVICE_DESIERD_COUNT="${ECS_SERVICE_DESIERD_COUNT}" # STRING_ECS_SERVICE_NETWORK_CONFIGURATION:"awsvpcConfiguration={subnets=[subnet-xxxxxxxxxxxxxxxxx,subnet-xxxxxxxxxxxxxxxxx],securityGroups=[sg-xxxxxxxxxxxxxxxxx],assignPublicIp=ENABLED}" STRING_ECS_SERVICE_NETWORK_CONFIGURATION="${STRING_ECS_SERVICE_NETWORK_CONFIGURATION}" # STRING_ECS_SERVICE_LOAD_BALANCERS:"targetGroupArn=arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-container-tg/xxxxxxxxxxxxxxxx,containerName=handson-cli-container,containerPort=80" STRING_ECS_SERVICE_LOAD_BALANCERS="${STRING_ECS_SERVICE_LOAD_BALANCERS}" # STRING_ECS_SERVICE_DEPLOY_CONTROLLER:"type=CODE_DEPLOY" STRING_ECS_SERVICE_DEPLOY_CONTROLLER="${STRING_ECS_SERVICE_DEPLOY_CONTROLLER}" ETX
コマンド:
aws ecs create-service \ --cluster ${ECS_CLUSTER_NAME} \ --service-name ${ECS_SERVICE_NAME} \ --task-definition "${ECS_TASK_DEFINISION_ARN}" \ --desired-count ${ECS_SERVICE_DESIERD_COUNT} \ --launch-type "FARGATE" \ --network-configuration "${STRING_ECS_SERVICE_NETWORK_CONFIGURATION}" \ --load-balancers "${STRING_ECS_SERVICE_LOAD_BALANCERS}" \ --deployment-controller "${STRING_ECS_SERVICE_DEPLOY_CONTROLLER}"
結果(例):
{ "service": { "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "handson-cli-app-alpha-subnet", "handson-cli-app-charlie-subnet" ], "securityGroups": [ "handson-cli-webapp-sg" ], "assignPublicIp": "ENABLED" } }, "launchType": "FARGATE", "loadBalancers": [ { "containerName": "handson-cli-container", "targetGroupArn": "arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-container-tg/xxxxxxxxxxxxxxxx", "containerPort": 80 } ], "desiredCount": 2, "clusterArn": "arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:cluster/cluster-cli-handson", "serviceArn": "arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:service/handson-cli-service", "deploymentConfiguration": { "maximumPercent": 200, "minimumHealthyPercent": 100 }, "createdAt": 15xxxxxxxx.123, "healthCheckGracePeriodSeconds": 0, "schedulingStrategy": "REPLICA", "placementConstraints": [], "deployments": [ { "status": "PRIMARY", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "handson-cli-app-alpha-subnet", "handson-cli-app-charlie-subnet" ], "securityGroups": [ "handson-cli-webapp-sg" ], "assignPublicIp": "ENABLED" } }, "pendingCount": 0, "launchType": "FARGATE", "createdAt": 15xxxxxxxx.123, "desiredCount": 2, "taskDefinition": "arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:task-definition/handson-cli-task-definition:11", "updatedAt": 15xxxxxxxx.123, "platformVersion": "1.1.0", "id": "ecs-svc/xxxxxxxxxxxxxxxxxxx", "runningCount": 0 } ], "serviceName": "handson-cli-service", "events": [], "runningCount": 0, "status": "ACTIVE", "serviceRegistries": [], "pendingCount": 0, "platformVersion": "LATEST", "placementStrategy": [], "roleArn": "arn:aws:iam::XXXXXXXXXXXX:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", "taskDefinition": "arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:task-definition/handson-cli-task-definition:1" } }
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: ECSサービス"handson-cli-service"が存在する。
「ECSサービス"handson-cli-service"が存在する。」ことを確認します。
コマンド:
aws ecs list-services \ --cluster ${ECS_CLUSTER_NAME} \ --query "serviceArns[?contains(@,\`${ECS_SERVICE_NAME}\`)]" \ --output text
結果(例):
arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:service/handson-cli-service
完了条件2: ECSサービス"handson-cli-service"の稼動コンテナ数が"2"である。
「ECSサービス"handson-cli-service"の稼動コンテナ数が"2"である。」ことを確認します。
サービスARNを取得します。
コマンド:
ECS_SERVICE_ARN=$( \ aws ecs list-services \ --cluster ${ECS_CLUSTER_NAME} \ --query "serviceArns[?contains(@,\`${ECS_SERVICE_NAME}\`)]" \ --output text \ ) \ && echo ${ECS_SERVICE_ARN}
結果(例):
arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:service/handson-cli-service
稼動コンテナ数を取得します。
コマンド:
aws ecs describe-services \ --cluster ${ECS_CLUSTER_NAME} \ --services ${ECS_SERVICE_ARN} \ --query 'services[].runningCount' \ --output text
結果(例):
2
完了条件3: ECSサービス"handson-cli-service"にターゲットグループ"handson-cli-container-tg"が関連付けられていること。
「ECSサービス"handson-cli-service"にターゲットグループ"handson-cli-container-tg"が関連付けられていること。」ことを確認します。