1. ECSタスク定義の作成 (Fargate role: handson-cli-task-definition)¶

作業の目的 [why]¶

ECSタスク定義"handson-cli-task-definition"を作成します。

完了条件/事前条件 [設計者用情報]

完了条件 [after]

主処理は、以下を満たしたときに成功したものとします。

完了条件1: ECSタスク定義"handson-cli-task-definition"が存在する。

事前条件 [before]

主処理の実施は、以下の状態であることを前提とします。

事前条件1: 設定ファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。
事前条件2: ECSコンテナ定義ファイル"${HOME}/tmp/conf-handson-cli/handson-cli-container-definition.json"が存在する。
事前条件3: ECSタスク定義"handson-cli-task-definition"が存在しない。
事前条件4: 実行用IAMロール"handson-cli-ecs-execution-role"が存在する。
事前条件5: タスク用IAMロール"handson-cli-ecs-task-role"が存在する。

作業対象 [what]¶

ECSサービス

標準時間(合計)¶

8分

パラメータ設定¶

パタメータ設定の標準時間:	2分

作業に必要なモノ・情報 [resource]¶

作業開始には、以下が全て揃っていることが必要です。

リソース1: ECSタスク定義ファミリ名

作成するECSタスク定義ファミリの名称です。
今回は"handson-cli-task-definition"とします。

リソース2: 設定ファイル用ディレクトリ

設定ファイルが存在するディレクトリ"${HOME}/tmp/conf-handson-cli"です。

リソース3: コンテナ定義ファイル

今回は"${HOME}/tmp/conf-handson-cli/handson-cli-container-definition.json"を設定ファイルとします。

リソース4: 起動タイプ

作成するECSタスク定義ファミリの起動タイプです。
今回は"FARGATE"とします。

リソース5: CPU数

作成するECSタスク定義ファミリが利用するCPU数です。
今回は"256"とします。

リソース6: メモリサイズ

作成するECSタスク定義ファミリが利用するメモリサイズです。
今回は"512"とします。

リソース7: 実行用IAMロール名

タスクの実行時に利用するIAMロールの名称です。
今回は"handson-cli-ecs-execution-role"とします。

リソース8: タスク用IAMロール名

タスクが利用するIAMロールの名称です。
今回は"handson-cli-ecs-task-role"とします。

パラメータの指定¶

作業に必要なパラメータを変数に格納をします。

0.0. リージョンの指定¶

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. ECSタスク定義ファミリ名の指定¶

ECSタスク定義ファミリ名を指定します。

変数の設定:

ECS_TASK_DEFINITION_FAMILY='handson-cli-task-definition'

0.2. 設定ファイルディレクトリの指定¶

設定ファイルディレクトリを指定します。

変数の設定:

DIR_CONF="${HOME}/tmp/conf-handson-cli"

0.3. 起動タイプの指定¶

起動タイプを指定します。

変数の設定:

ARRAY_ECS_DEFINITION_COMPATIBILITIES='FARGATE'

0.4. コンテナ定義ファイルの指定¶

コンテナ定義ファイルを指定します。

変数の設定:

ECS_CONTAINER_DEFINITION_NAME='handson-cli-container-definition'

変数の設定:

FILE_ECS_CONTAINER_DEFINITION="${DIR_CONF}/${ECS_CONTAINER_DEFINITION_NAME}.json" \
  && echo ${FILE_ECS_CONTAINER_DEFINITION}

結果(例):

${HOME}/tmp/conf-handson-cli/handson-cli-container-definition.json

0.5. CPU数の指定¶

CPU数(1CPU = 1024)を指定します。

変数の設定:

ECS_TASK_DEFINITION_CPU='256'

0.6. メモリサイズの指定¶

メモリサイズ(MB)を指定します。 (CPU数によって選択できるメモリサイズは決まっています。)

変数の設定:

ECS_TASK_DEFINITION_MEMORY='512'

0.7. 実行用IAMロール名の指定¶

実行用IAMロール名を指定します。

変数の設定:

IAM_ROLE_NAME_EXECUTION='handson-cli-ecs-execution-role'

0.8. タスク用IAMロール名の指定¶

タスク用IAMロール名を指定します。

変数の設定:

IAM_ROLE_NAME_TASK='handson-cli-ecs-task-role'

パラメータの保存¶

設定されている変数の保存先となるファイル名を指定します。

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ecs-task_definition_fargate-create-expand-task_role.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-ecs-task_definition_fargate-create-expand-task_role.env

各変数に正しいパラメータ値が格納されていることを確認しながら保存します。

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. ECS_CONTAINER_DEFINITION_FAMILY:"handson-cli-task-definition"
         ECS_CONTAINER_DEFINITION_FAMILY="${ECS_TASK_DEFINITION_FAMILY}"
  # 0.2. DIR_CONF:"${HOME}/tmp/conf-handson-cli"
         DIR_CONF="${DIR_CONF}"
  # 0.3. FILE_ECS_CONTAINER_DEFINITION:"${HOME}/tmp/conf-handson-cli/handson-cli-container-definition.json"
         FILE_ECS_CONTAINER_DEFINITION="${FILE_ECS_CONTAINER_DEFINITION}"
  # 0.4. ARRAY_ECS_DEFINITION_COMPATIBILITIES:"FARGATE"
         ARRAY_ECS_DEFINITION_COMPATIBILITIES="${ARRAY_ECS_DEFINITION_COMPATIBILITIES}"
  # 0.5. ECS_TASK_DEFINITION_CPU:"256"
         ECS_TASK_DEFINITION_CPU="${ECS_TASK_DEFINITION_CPU}"
  # 0.6. ECS_TASK_DEFINITION_MEMORY:"512"
         ECS_TASK_DEFINITION_MEMORY="${ECS_TASK_DEFINITION_MEMORY}"
  # 0.7. IAM_ROLE_NAME_EXECUTION:"handson-cli-ecs-execution-role"
         IAM_ROLE_NAME_EXECUTION='${IAM_ROLE_NAME_EXECUTION}"
  # 0.8. IAM_ROLE_NAME_TASK:"handson-cli-ecs-task-role"
         IAM_ROLE_NAME_TASK='${IAM_ROLE_NAME_TASK}"

EOF

cat ${FILE_PARAMETER}

下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。

タスクの実施¶

タスク標準時間:	6分

1. 前処理¶

1.1. 処理対象の状態確認¶

主処理の実施は、以下の状態であることを前提とします。

前提と異なることが判明した場合、直ちに処理を中止します。

事前条件1: 設定ファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。

「設定ファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_CONF}

結果(例):

${HOME}/tmp/conf-handson-cli

事前条件2: ECSコンテナ定義ファイル"${HOME}/tmp/conf-handson-cli/handson-cli-container-definition.json"が存在する。

「ECSコンテナ定義ファイル"${HOME}/tmp/conf-handson-cli/handson-cli-container-definition.json"が存在する。」ことを確認します。

コマンド:

ls ${FILE_ECS_CONTAINER_DEFINITION}

結果(例):

${HOME}/tmp/conf-handson-cli/handson-cli-container-definition.json

事前条件3: ECSタスク定義"handson-cli-task-definition"が存在しない。

「ECSタスク定義"handson-cli-task-definition"が存在しない。」ことを確認します。

コマンド:

aws ecs list-task-definitions \
  --family-prefix ${ECS_TASK_DEFINITION_FAMILY} \
  --query "taskDefinitionArns[?contains(@,\`${ECS_TASK_DEFINITION_FAMILY}\`)]" \
  --output text

結果(例):

(出力なし)

事前条件4: 実行用IAMロール"handson-cli-ecs-execution-role"が存在する。

「実行用IAMロール"handson-cli-ecs-execution-role"が存在する。」ことを確認します。

コマンド:

aws iam get-role \
   --role-name ${IAM_ROLE_NAME_EXECUTION} \
   --query 'Role.RoleName' \
   --output text

結果(例):

handson-cli-ecs-execution-role

事前条件5: タスク用IAMロール"handson-cli-ecs-task-role"が存在する。

「タスク用IAMロール"handson-cli-ecs-task-role"が存在する。」ことを確認します。

コマンド:

aws iam get-role \
   --role-name ${IAM_ROLE_NAME_TASK} \
   --query 'Role.RoleName' \
   --output text

結果(例):

handson-cli-ecs-task-role

1.2. 主処理に必要な情報の取得¶

実行用IAMロールのARN取得

コマンド:

IAM_ROLE_ARN_EXECUTION=$( \
  aws iam get-role \
    --role-name ${IAM_ROLE_NAME_EXECUTION} \
    --query 'Role.Arn' \
    --output text \
) \
  && echo ${IAM_ROLE_ARN_EXECUTION}

結果(例):

arn:aws:iam::XXXXXXXXXXXX:role/handson-cli-ecs-execution-role

タスク用IAMロールのARN取得

コマンド:

IAM_ROLE_ARN_TASK=$( \
  aws iam get-role \
    --role-name ${IAM_ROLE_NAME_TASK} \
    --query 'Role.Arn' \
    --output text \
) \
  && echo ${IAM_ROLE_ARN_TASK}

結果(例):

arn:aws:iam::XXXXXXXXXXXX:role/handson-cli-ecs-task-role

2. 主処理¶

ECSタスク定義の作成¶

変数の確認:

cat << ETX

  # ECS_TASK_DEFINITION_FAMILY:"handson-cli-task-definition"
    ECS_TASK_DEFINITION_FAMILY="${ECS_TASK_DEFINITION_FAMILY}"
  # FILE_ECS_CONTAINER_DEFINITION:"${HOME}/tmp/conf-handson-cli/handson-cli-container-definition.json"
    FILE_ECS_CONTAINER_DEFINITION="${FILE_ECS_CONTAINER_DEFINITION}"
  # ARRAY_ECS_DEFINITION_COMPATIBILITIES:"FARGATE"
    ARRAY_ECS_DEFINITION_COMPATIBILITIES="${ARRAY_ECS_DEFINITION_COMPATIBILITIES}"
  # ECS_TASK_DEFINITION_CPU:"256"
    ECS_TASK_DEFINITION_CPU="${ECS_TASK_DEFINITION_CPU}"
  # ECS_TASK_DEFINITION_MEMORY:"512"
    ECS_TASK_DEFINITION_MEMORY="${ECS_TASK_DEFINITION_MEMORY}"
  # IAM_ROLE_ARN_EXECUTION:"arn:aws:iam::XXXXXXXXXXXX:role/handson-cli-ecs-execution-role"
    IAM_ROLE_ARN_EXECUTION="${IAM_ROLE_ARN_EXECUTION}"
  # IAM_ROLE_ARN_TASK:"arn:aws:iam::XXXXXXXXXXXX:role/handson-cli-ecs-task-role"
    IAM_ROLE_ARN_TASK="${IAM_ROLE_ARN_TASK}"

ETX

コマンド:

aws ecs register-task-definition \
  --family ${ECS_TASK_DEFINITION_FAMILY} \
  --container-definitions file://${FILE_ECS_CONTAINER_DEFINITION} \
  --requires-compatibilities "${ARRAY_ECS_DEFINITION_COMPATIBILITIES}" \
  --cpu ${ECS_TASK_DEFINITION_CPU} \
  --memory ${ECS_TASK_DEFINITION_MEMORY} \
  --network-mode awsvpc \
  --execution-role-arn ${IAM_ROLE_ARN_EXECUTION} \
  --task-role-arn ${IAM_ROLE_ARN_TASK}

結果(例):

{
  "taskDefinition": {
    "taskDefinitionArn": "arn:aws:ecs:us-west-2:247007617542:task-definition/handson-cli-fargate-task-definition:2",
    "containerDefinitions": [
       (タスク定義の内容)
    ],
    "family": "handson-cli-task-definition",
    "executionRoleArn": "arn:aws:iam::247007617542:role/handson-cli-ecs-fargate-app-role",
    "taskDefinitionArn": "arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:task-definition/handson-cli-task-definition:1",
    "networkMode": "awsvpc",
    "revision": 1
    "volumes": [],
    "status": "ACTIVE",
    "requiresAttributes": [
        {
            "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18"
        },
        {
            "name": "ecs.capability.task-eni"
        },
        {
            "name": "ecs.capability.execution-role-awslogs"
        },
        {
            "name": "com.amazonaws.ecs.capability.logging-driver.awslogs"
        },
        {
            "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19"
        }
    ],
    "placementConstraints": [],
    "compatibilities": [
        "EC2",
        "FARGATE"
    ],
    "requiresCompatibilities": [
        "FARGATE"
    ],
    "cpu": "256",
    "memory": "512"
  }
}

3. 後処理¶

完了条件の確認¶

主処理は、以下を満たしたときに成功したものとします。

完了条件1: ECSタスク定義"handson-cli-task-definition"が存在する。

「ECSタスク定義"handson-cli-task-definition"が存在する。」ことを確認します。

コマンド:

aws ecs list-task-definitions \
  --family-prefix ${ECS_TASK_DEFINITION_FAMILY} \
  --query "taskDefinitionArns[?contains(@,\`${ECS_TASK_DEFINITION_FAMILY}\`)]" \
  --output text

結果(例):

arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:task-definition/handson-cli-task-definition:1

prototype.opslearn.jp

1. ECSタスク定義の作成 (Fargate role: handson-cli-task-definition)¶

作業の目的 [why]¶

作業対象 [what]¶

標準時間(合計)¶

パラメータ設定¶

作業に必要なモノ・情報 [resource]¶

パラメータの指定¶

0.0. リージョンの指定¶

0.1. ECSタスク定義ファミリ名の指定¶

0.2. 設定ファイルディレクトリの指定¶

0.3. 起動タイプの指定¶

0.4. コンテナ定義ファイルの指定¶

0.5. CPU数の指定¶

0.6. メモリサイズの指定¶

0.7. 実行用IAMロール名の指定¶

0.8. タスク用IAMロール名の指定¶

パラメータの保存¶

タスクの実施¶

1. 前処理¶

1.1. 処理対象の状態確認¶

1.2. 主処理に必要な情報の取得¶

2. 主処理¶

ECSタスク定義の作成¶

3. 後処理¶

完了条件の確認¶

完了¶