1. ECSサービスの作成 (handson-cli-service)¶
作業の目的 [why]¶
ECSサービス"handson-cli-service"を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- ECSサービス"handson-cli-service"が存在する。
- 完了条件2
- ECSサービス"handson-cli-service"の稼動コンテナ数が"1"である。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- ECSクラスタ"handson-cli-cluster"が存在する。
- 事前条件2
- ECSタスク定義"handson-cli-task-definition"のリビジョン"1"が存在する。
- 事前条件3
- ECSクラスタ"handson-cli-cluster"にECSサービス"handson-cli-service"が存在しない。
前提と異なることが判明した場合、直ちに処理を中止します。
作業対象 [what]¶
- ECSサービス
標準時間(合計)¶
8分
パラメータ設定¶
パタメータ設定の標準時間: | 2分 |
---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: ECSクラスタ名
- 作成するECSクラスタの名称です。
- 今回は"handson-cli-cluster"とします。
リソース1: ECSタスク定義ファミリ名
- 作成するECSサービスが利用するECSタスク定義ファミリの名称です。
- 今回は"handson-cli-task-definition"とします。
リソース3: ECSタスク定義リビジョン
- 作成するECSサービスが利用するECSタスク定義のリビジョンです。
- 今回は"1"とします。
リソース4: ECSサービス名
- 作成するECSサービスの名称です。
- 今回は"handson-cli-service"とします。
リソース5: ECSタスク定義の実行数
- ECSタスク定義のインスタンスをクラスタに配置して実行状態に保つ数です。
- 今回は"1"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.2. ECSタスク定義ファミリ名の指定¶
ECSタスク定義ファミリ名を指定します。
変数の設定:
ECS_TASK_DEFINITION_FAMILY='handson-cli-task-definition'
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ecs-service-create.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-ecs-service-create.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. ECS_CLUSTER_NAME:"handson-cli-cluster" ECS_CLUSTER_NAME="${ECS_CLUSTER_NAME}" # 0.2. ECS_TASK_DEFINITION_FAMILY:"handson-cli-task-definition" ECS_TASK_DEFINITION_FAMILY="${ECS_TASK_DEFINITION_FAMILY}" # 0.3. ECS_TASK_DEFINITION_REVISION:"1" ECS_TASK_DEFINITION_REVISION="${ECS_TASK_DEFINITION_REVISION}" # 0.4. ECS_SERVICE_NAME:"handson-cli-service" ECS_SERVICE_NAME="${ECS_SERVICE_NAME}" # 0.5. ECS_SERVICE_DESIERD_COUNT:"1" ECS_SERVICE_DESIERD_COUNT="${ECS_SERVICE_DESIERD_COUNT}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
タスク標準時間: | 6分 |
---|
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: 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
事前条件2: 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
事前条件3: 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. 主処理に必要な情報の取得¶
ECSタスク定義の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
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:"1" ECS_SERVICE_DESIERD_COUNT="${ECS_SERVICE_DESIERD_COUNT}" 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}
結果(例):
{ "service": { "serviceArn": "arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:service/handson-cli-service", "serviceName": "handson-cli-service", "clusterArn": "arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:cluster/cluster-cli-handson", "loadBalancers": [], "status": "ACTIVE", "desiredCount": 1, "runningCount": 0, "pendingCount": 0, "launchType": "EC2", "taskDefinition": "arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:task-definition/handson-cli-task-definition:1", "deploymentConfiguration": { "maximumPercent": 200, "minimumHealthyPercent": 100 }, "deployments": [ { "id": "ecs-svc/xxxxxxxxxxxxxxxxxxx", "status": "PRIMARY", "taskDefinition": "arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:task-definition/handson-cli-task-definition:11", "desiredCount": 1, "pendingCount": 0, "runningCount": 0, "createdAt": 15xxxxxxxx.123, "updatedAt": 15xxxxxxxx.123, "launchType": "EC2" } ], "events": [], "createdAt": 15xxxxxxxx.123, "placementConstraints": [], "placementStrategy": [] } }
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"の稼動コンテナ数が"1"である。
「ECSサービス"handson-cli-service"の稼動コンテナ数が"1"である。」ことを確認します。
サービス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
結果(例):
1