3. ECSサービスの作成 (service-handson-cli)¶
作業の目的 [why]¶
ECSサービス"service-handson-cli"を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- ECSサービス"service-handson-cli"が存在する。
- 完了条件2
- ECSサービス"service-handson-cli"の稼動コンテナ数が"1"である。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- ECSクラスタ"cluster-handson-cli"が存在する。
- 事前条件2
- ECSタスク定義"task-def-family-handson-cli"のリビジョン"1"が存在する。
- 事前条件3
- ECSクラスタ"cluster-handson-cli"にECSサービス"service-handson-cli"が存在しない。
前提と異なることが判明した場合、直ちに処理を中止します。
作業対象 [what]¶
- ECSサービス
標準時間¶
8分
前提条件¶
作業環境条件 [where]¶
本作業は、以下の作業環境で行います。
作業環境条件1: OSとバージョン
Amazon Linuxの以下のバージョンで動作確認済
コマンド:
cat /etc/issue | head -1
結果(例):
Amazon Linux AMI release 2016.09
作業環境条件2: シェルとバージョン
bashの以下のバージョンで動作確認済
コマンド:
bash --version -v | head -1
結果(例):
GNU bash, バージョン 4.2.46(1)-release (x86_64-redhat-linux-gnu)
作業環境条件3: AWS CLIのバージョン
以下のバージョンで動作確認済
- AWS CLI 1.14.24
コマンド:
aws --version
結果(例):
aws-cli/1.14.31 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.8.35
バージョンが古い場合は最新版に更新しましょう。
コマンド:
sudo -H pip install -U awscli
開始条件¶
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: ECSクラスタ名
- 作成するECSクラスタの名称です。
- 今回は"cluster-handson-cli"とします。
リソース1: ECSタスク定義ファミリ名
- 作成するECSサービスが利用するECSタスク定義ファミリの名称です。
- 今回は"task-def-family-handson-cli"とします。
リソース3: ECSタスク定義リビジョン
- 作成するECSサービスが利用するECSタスク定義のリビジョンです。
- 今回は"1"とします。
リソース4: ECSサービス名
- 作成するECSサービスの名称です。
- 今回は"service-handson-cli"とします。
リソース5: ECSタスク定義の実行数
- ECSタスク定義のインスタンスをクラスタに配置して実行状態に保つ数です。
- 今回は"1"とします。
タスクの実施¶
0. パラメータの指定¶
まず変数の確認をします。
変数の確認:
cat << ETX # 0.a. AWS_DEFAULT_PROFILE:"<ECSのフル権限を許可されたプロファイル>" AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}" # 0.b. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. ECS_CLUSTER_NAME:"cluster-handson-cli" ECS_CLUSTER_NAME="${ECS_CLUSTER_NAME}" # 0.2. ECS_TASK_DEFINITION_FAMILY:"task-def-family-handson-cli" 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:"service-handson-cli" ECS_SERVICE_NAME="${ECS_SERVICE_NAME}" # 0.5. ECS_SERVICE_DESIERD_COUNT:"1" ECS_SERVICE_DESIERD_COUNT="${ECS_SERVICE_DESIERD_COUNT}" ETX
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号について作業を行います。
0.2. ECSタスク定義ファミリ名の指定¶
ECSタスク定義ファミリ名を指定します。
変数の設定:
ECS_TASK_DEFINITION_FAMILY='task-def-family-handson-cli'
再確認¶
設定されている変数の内容を再確認します。
変数の確認:
cat << ETX # 0.a. AWS_DEFAULT_PROFILE:"<ECSのフル権限を許可されたプロファイル>" AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}" # 0.b. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. ECS_CLUSTER_NAME:"cluster-handson-cli" ECS_CLUSTER_NAME="${ECS_CLUSTER_NAME}" # 0.2. ECS_TASK_DEFINITION_FAMILY:"task-def-family-handson-cli" 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:"service-handson-cli" ECS_SERVICE_NAME="${ECS_SERVICE_NAME}" # 0.5. ECS_SERVICE_DESIERD_COUNT:"1" ECS_SERVICE_DESIERD_COUNT="${ECS_SERVICE_DESIERD_COUNT}" ETX
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: ECSクラスタ"cluster-handson-cli"が存在する。
「ECSクラスタ"cluster-handson-cli"が存在する。」ことを確認します。
コマンド:
aws ecs list-clusters \ --query "clusterArns[?contains(@,\`${ECS_CLUSTER_NAME}\`)]"
結果(例):
[ "arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:cluster/cluster-handson-cli" ]
事前条件2: ECSタスク定義"task-def-family-handson-cli"のリビジョン"1"が存在する。
「ECSタスク定義"task-def-family-handson-cli"のリビジョン"1"が存在する。」ことを確認します。
コマンド:
aws ecs list-task-definitions \ --family-prefix ${ECS_TASK_DEFINITION_FAMILY} \ --query "taskDefinitionArns[?contains(@,\`${ECS_TASK_DEFINITION_FAMILY}:${ECS_TASK_DEFINITION_REVISION}\`)]"
結果(例):
[ "arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:task-definition/task-def-family-handson-cli:1" ]
事前条件3: ECSクラスタ"cluster-handson-cli"にECSサービス"service-handson-cli"が存在しない。
「ECSクラスタ"cluster-handson-cli"にECSサービス"service-handson-cli"が存在しない。」ことを確認します。
コマンド:
aws ecs list-services \ --cluster ${ECS_CLUSTER_NAME} \ --query "serviceArns[?contains(@,\`${ECS_SERVICE_NAME}\`)]"
結果(例):
[]
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/task-def-family-handson-cli:1" ]
2. 主処理¶
ECSサービスの作成¶
変数の確認:
cat << ETX # ECS_CLUSTER_NAME:"cluster-handson-cli" ECS_CLUSTER_NAME="${ECS_CLUSTER_NAME}" # ECS_SERVICE_NAME:"service-handson-cli" ECS_SERVICE_NAME="${ECS_SERVICE_NAME}" # ECS_TASK_DEFINISION_ARN:"arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:task-definition/task-def-family-handson-cli: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/service-handson-cli", "serviceName": "service-handson-cli", "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/task-def-family-handson-cli:1", "deploymentConfiguration": { "maximumPercent": 200, "minimumHealthyPercent": 100 }, "deployments": [ { "id": "ecs-svc/xxxxxxxxxxxxxxxxxxx", "status": "PRIMARY", "taskDefinition": "arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:task-definition/task-def-family-handson-cli:11", "desiredCount": 1, "pendingCount": 0, "runningCount": 0, "createdAt": 15xxxxxxxx.123, "updatedAt": 15xxxxxxxx.123, "launchType": "EC2" } ], "events": [], "createdAt": 15xxxxxxxx.123, "placementConstraints": [], "placementStrategy": [] } }
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: ECSサービス"service-handson-cli"が存在する。
「ECSサービス"service-handson-cli"が存在する。」ことを確認します。
コマンド:
aws ecs list-services \ --cluster ${ECS_CLUSTER_NAME} \ --query "serviceArns[?contains(@,\`${ECS_SERVICE_NAME}\`)]"
結果(例):
[ "arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:service/service-handson-cli" ]
完了条件2: ECSサービス"service-handson-cli"の稼動コンテナ数が"1"である。
「ECSサービス"service-handson-cli"の稼動コンテナ数が"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/service-handson-cli
稼動コンテナ数の取得
コマンド:
aws ecs describe-services \ --cluster ${ECS_CLUSTER_NAME} \ --services ${ECS_SERVICE_ARN} \ --query 'services[].runningCount'
結果(例):
[ 1 ]
3.3. 後処理に必要な作業¶
完了条件を充たしていない場合は、イベントを確認します。
コマンド:
aws ecs describe-services \ --cluster ${ECS_CLUSTER_NAME} \ --services ${ECS_SERVICE_ARN} \ --query 'services[].events'
結果(例):
(省略)