1. ECSタスク定義テンプレート作成 (task-def-handson-cli)¶

作業の目的 [why]¶

ECSタスク定義テンプレート"task-def-handson-cli"(ポートマッピングを利用)を作成します。

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

完了条件 [after]

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

完了条件1: ECSタスク定義テンプレートファイル"${HOME}/tmp/conf-ecs/task-def-handson-cli.json"が存在する。

事前条件 [before]

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

事前条件1: 設定ファイル用ディレクトリが存在する。
事前条件2: ECSタスク定義テンプレートファイル"${HOME}/tmp/conf-ecs/task-def-handson-cli.json"が存在しない。

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

作業対象 [what]¶

ローカル環境

標準時間¶

8分

前提条件¶

作業権限条件 [who]¶

本作業は、以下の作業権限を有する人が行います。

作業権限条件: 特になし

作業環境条件 [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)

開始条件¶

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

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

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

今回は"${HOME}/tmp/conf-ecs"を設定ファイル用ディレクトリとします。
```
ls -d ${HOME}/tmp/conf-ecs
```

結果(例:存在する場合):

${HOME}/tmp/conf-ecs

存在しない場合は作成します。
```
mkdir -p ${HOME}/tmp/conf-ecs
```

リソース2: ECSタスク定義テンプレート名

作成するECSタスク定義テンプレートの名称です。
今回は"task-def-handson-cli"とします。

リソース3: コンテナ名

作成するECSタスク定義テンプレートで利用するコンテナ名です。
今回は"nginx-handson-cli"とします。

リソース4: コンテナイメージ名

作成するECSタスク定義テンプレートで利用するコンテナイメージ名です。
今回は"nginx:latest"とします。

リソース5: コンテナのポート番号 (ポートマッピング)

作成するECSタスク定義のポートマッピングで指定する「コンテナのポート」番号です。
今回は"80"とします。

リソース6: ホストのポート番号 (ポートマッピング)

作成するECSタスク定義のポートマッピングで指定する「ホストのポート番号」です。
今回は"80"とします。

リソース7: プロトコル名 (ポートマッピング)

作成するECSタスク定義のポートマッピングで指定するプロトコル名です。
今回は"tcp"とします。

リソース8: ECSタスク定義テンプレートファイル名

作成するECSタスク定義テンプレートのファイル名です。
今回は"${HOME}/tmp/conf-ecs/task-def-handson-cli.json"とします。

作業開始 [when]¶

以下を全て満たしているとき、作業を開始します。

開始の指示があった場合。

タスクの実施¶

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. DIR_CONF:"${HOME}/tmp/conf-ecs"
         DIR_CONF="${DIR_CONF}"
  # 0.2. ECS_TASK_DEFINITION_NAME:"task-def-handson-cli"
         ECS_TASK_DEFINITION_NAME="${ECS_TASK_DEFINITION_NAME}"
  # 0.3. CONTAINER_NAME:"nginx-handson-cli"
         CONTAINER_NAME="${CONTAINER_NAME}"
  # 0.4. CONTAINER_IMAGE_NAME:"nginx:latest"
         CONTAINER_IMAGE_NAME="${CONTAINER_IMAGE_NAME}"
  # 0.5. CONTAINER_MEMORY_SIZE:"128"
         CONTAINER_MEMORY_SIZE="${CONTAINER_MEMORY_SIZE}"
  # 0.6. CONTAINER_PORT:"80"
         CONTAINER_PORT="${CONTAINER_PORT}"
  # 0.7. HOST_PORT:"80"
         HOST_PORT="${HOST_PORT}"
  # 0.8. PROTOCOL_NAME:"tcp"
         PROTOCOL_NAME="${PROTOCOL_NAME}"
  # 0.9. FILE_ECS_TASK_DEFINITION:"${HOME}/tmp/conf-ecs/task-def-handson-cli.json"
         FILE_ECS_TASK_DEFINITION="${FILE_ECS_TASK_DEFINITION}"

ETX

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

0.a. プロファイルの指定¶

変数の設定:

export AWS_DEFAULT_PROFILE='<ECSのフル権限を許可されたプロファイル>'

0.b. リージョンの指定¶

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

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

変数の設定:

DIR_CONF="${HOME}/tmp/conf-ecs"

0.2. ECSタスク定義テンプレート名の指定¶

ECSタスク定義テンプレート名を指定します。

変数の設定:

ECS_TASK_DEFINITION_NAME='task-def-handson-cli'

0.3. コンテナ名の指定¶

コンテナ名を指定します。

変数の設定:

CONTAINER_NAME='nginx-handson-cli'

0.4. コンテナイメージ名の指定¶

コンテナイメージ名を指定します。

変数の設定:

CONTAINER_IMAGE_NAME='nginx:latest'

0.5. 割り当てメモリ量の指定¶

割り当てメモリ量を指定します。

変数の設定:

CONTAINER_MEMORY_SIZE='128'

0.6. ポートマッピング: コンテナのポート番号の指定¶

コンテナのポート番号を指定します。

変数の設定:

CONTAINER_PORT='80'

0.7. ポートマッピング: ホストのポート番号の指定¶

ホストのポート番号を指定します。

変数の設定:

HOST_PORT='80'

0.8. ポートマッピング: プロトコル名の指定¶

プロトコル名を指定します。

変数の設定:

PROTOCOL_NAME='tcp'

0.9. ECSタスク定義テンプレートファイル名の指定¶

ECSタスク定義テンプレートファイル名を指定します。

変数の設定:

FILE_ECS_TASK_DEFINITION="${HOME}/tmp/conf-ecs/task-def-handson-cli.json"

再確認¶

設定されている変数の内容を再確認します。

変数の確認:

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. DIR_CONF:"${HOME}/tmp/conf-ecs"
         DIR_CONF="${DIR_CONF}"
  # 0.2. ECS_TASK_DEFINITION_NAME:"task-def-handson-cli"
         ECS_TASK_DEFINITION_NAME="${ECS_TASK_DEFINITION_NAME}"
  # 0.3. CONTAINER_NAME:"nginx-handson-cli"
         CONTAINER_NAME="${CONTAINER_NAME}"
  # 0.4. CONTAINER_IMAGE_NAME:"nginx:latest"
         CONTAINER_IMAGE_NAME="${CONTAINER_IMAGE_NAME}"
  # 0.5. CONTAINER_MEMORY_SIZE:"128"
         CONTAINER_MEMORY_SIZE="${CONTAINER_MEMORY_SIZE}"
  # 0.6. CONTAINER_PORT:"80"
         CONTAINER_PORT="${CONTAINER_PORT}"
  # 0.7. HOST_PORT:"80"
         HOST_PORT="${HOST_PORT}"
  # 0.8. PROTOCOL_NAME:"tcp"
         PROTOCOL_NAME="${PROTOCOL_NAME}"
  # 0.9. FILE_ECS_TASK_DEFINITION:"${HOME}/tmp/conf-ecs/task-def-handson-cli.json"
         FILE_ECS_TASK_DEFINITION="${FILE_ECS_TASK_DEFINITION}"

ETX

1. 前処理¶

処理対象の状態確認¶

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

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

事前条件1: 設定ファイル用ディレクトリが存在する。

「設定ファイル用ディレクトリが存在する。」ことを確認します。

コマンド:

ls -d ${DIR_CONF}

結果(例):

${HOME}/tmp/conf-ecs

事前条件2: ECSタスク定義テンプレートファイル"${HOME}/tmp/conf-ecs/task-def-handson-cli.json"が存在しない。

「ECSタスク定義テンプレートファイル"${HOME}/tmp/conf-ecs/task-def-handson-cli.json"が存在しない。」ことを確認します。

コマンド:

ls ${FILE_ECS_TASK_DEFINITION}

結果(例):

ls: ${HOME}/tmp/conf-ecs/task-def-handson-cli.json No such file or directory

2. 主処理¶

ECSタスク定義テンプレートの作成¶

変数の確認:

cat << ETX

  # FILE_ECS_TASK_DEFINITION:"${HOME}/tmp/conf-ecs/task-def-handson-cli.json"
    FILE_ECS_TASK_DEFINITION="${FILE_ECS_TASK_DEFINITION}"
  # ECS_TASK_DEFINITION_NAME:"task-def-handson-cli"
    ECS_TASK_DEFINITION_NAME="${ECS_TASK_DEFINITION_NAME}"
  # CONTAINER_NAME:"nginx-handson-cli"
    CONTAINER_NAME="${CONTAINER_NAME}"
  # CONTAINER_IMAGE_NAME:"nginx:latest"
    CONTAINER_IMAGE_NAME="${CONTAINER_IMAGE_NAME}"
  # CONTAINER_MEMORY_SIZE:"128"
    CONTAINER_MEMORY_SIZE="${CONTAINER_MEMORY_SIZE}"
  # CONTAINER_PORT:"80"
    CONTAINER_PORT="${CONTAINER_PORT}"
  # HOST_PORT:"80"
    HOST_PORT="${HOST_PORT}"
  # PROTOCOL_NAME:"tcp"
    PROTOCOL_NAME="${PROTOCOL_NAME}"

ETX

コマンド:

cat << EOF > ${FILE_ECS_TASK_DEFINITION}
[
  {
    "name": "${CONTAINER_NAME}",
    "image": "${CONTAINER_IMAGE_NAME}",
    "memory": ${CONTAINER_MEMORY_SIZE},
    "portMappings": [
      {
        "containerPort": ${CONTAINER_PORT},
        "hostPort": ${HOST_PORT},
        "protocol": "${PROTOCOL_NAME}"
      }
    ]
  }
]
EOF

cat ${FILE_ECS_TASK_DEFINITION}

結果(例):

[
  {
    "name": "nginx-handson-cli",
    "image": "nginx:latest",
    "memory": "128",
    "portMappings": [
      {
        "containerPort": 80,
        "hostPort": 80,
        "protocol": "tcp"
      }
    ]
  }
]

JSONファイルを作成したら、フォーマットが壊れてないか必ず確認します。

コマンド:

jsonlint -q ${FILE_ECS_TASK_DEFINITION}

エラーが出力されなければOKです。

3. 後処理¶

完了条件の確認¶

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

完了条件1: ECSタスク定義テンプレートファイル"${HOME}/tmp/conf-ecs/task-def-handson-cli.json"が存在する。

「ECSタスク定義テンプレートファイル"${HOME}/tmp/conf-ecs/task-def-handson-cli.json"が存在する。」ことを確認します。

コマンド:

ls ${FILE_ECS_TASK_DEFINITION}

結果(例):

${HOME}/tmp/conf-ecs/task-def-handson-cli.json

handson: CDP (create: Container Service)

1. ECSタスク定義テンプレート作成 (task-def-handson-cli)¶

作業の目的 [why]¶

作業対象 [what]¶

標準時間¶

前提条件¶

作業権限条件 [who]¶

作業環境条件 [where]¶

開始条件¶

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

作業開始 [when]¶

タスクの実施¶

0. パラメータの指定¶

0.a. プロファイルの指定¶

0.b. リージョンの指定¶

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

0.2. ECSタスク定義テンプレート名の指定¶

0.3. コンテナ名の指定¶

0.4. コンテナイメージ名の指定¶

0.5. 割り当てメモリ量の指定¶

0.6. ポートマッピング: コンテナのポート番号の指定¶

0.7. ポートマッピング: ホストのポート番号の指定¶

0.8. ポートマッピング: プロトコル名の指定¶

0.9. ECSタスク定義テンプレートファイル名の指定¶

再確認¶

1. 前処理¶

処理対象の状態確認¶

2. 主処理¶

ECSタスク定義テンプレートの作成¶

3. 後処理¶

完了条件の確認¶

完了¶