1. ECSコンテナ定義の作成 (handson-cli-container-definition)¶

作業の目的 [why]¶

ECSコンテナ定義"handson-cli-container-definition"を作成します。

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

完了条件 [after]

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

完了条件1: ECSコンテナ定義"handson-cli-container-definition"が存在する。

事前条件 [before]

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

事前条件1: 設定ファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。
事前条件2: ECSコンテナ定義"handson-cli-container-definition"が存在しない。

作業対象 [what]¶

ECSサービス

標準時間(合計)¶

8分

パラメータ設定¶

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

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

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

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

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

ディレクトリが存在することを確認します。

コマンド:

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

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

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

存在しない場合は作成します。

コマンド:

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

リソース2: ECSコンテナ定義名

作成するECSコンテナ定義の名称です。
今回は"handson-cli-container-definition"とします。

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

作成するECSコンテナ定義のファイル名です。
今回は"${HOME}/tmp/conf-handson-cli/handson-cli-container-definition.json"とします。

リソース4: コンテナ名

作成するECSコンテナ定義で利用するコンテナ名です。
今回は"handson-cli"とします。

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

作成するECSコンテナ定義で利用するコンテナイメージ名です。
今回は"httpd:2.4"とします。

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

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

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

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

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

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

リソース9: ロググループ名

作成するECSコンテナ定義が利用するロググループ名です。
今回は"handson-cli"とします。

リソース10: ログストリーム名プレフィクス

作成するECSコンテナ定義が利用するログストリームのプレフィクスです。
今回は"handson-cli"とします。

パラメータの指定¶

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

0.0. リージョンの指定¶

変数の設定

export AWS_DEFAULT_REGION='us-west-2'

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

変数の設定:

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

0.2. ECSコンテナ定義名の指定¶

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

変数の設定:

ECS_CONTAINER_DEFINITION_NAME='handson-cli-container-definition'

0.3. ECSコンテナ定義ファイル名の指定¶

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

変数の設定:

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.4. コンテナ名の指定¶

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

変数の設定:

CONTAINER_NAME='handson-cli'

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

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

変数の設定:

CONTAINER_IMAGE_NAME='httpd:2.4'

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

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

変数の設定:

CONTAINER_PORT='80'

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

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

変数の設定:

HOST_PORT='80'

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

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

変数の設定:

PROTOCOL_NAME='tcp'

0.9. ロググループ名の指定¶

ロググループ名を指定します。

変数の設定:

LOGS_GROUP_NAME='handson-cli'

0.10. ログストリーム名の指定¶

ログストリーム名を指定します。

変数の設定:

LOGS_STREAM_PREFIX='handson-cli'

パラメータの保存¶

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ecs-container_definition_doc-create-case-sample-aws-php.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-ecs-container_definition_doc-create-case-sample-aws-php.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"us-west-2"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. DIR_CONF:"${HOME}/tmp/conf-handson-cli"
         DIR_CONF="${DIR_CONF}"
  # 0.2. ECS_CONTAINER_DEFINITION_NAME:"handson-cli-container-definition"
         ECS_CONTAINER_DEFINITION_NAME="${ECS_CONTAINER_DEFINITION_NAME}"
  # 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. CONTAINER_NAME:"handson-cli"
         CONTAINER_NAME="${CONTAINER_NAME}"
  # 0.5. CONTAINER_IMAGE_NAME:"httpd:2.4"
         CONTAINER_IMAGE_NAME="${CONTAINER_IMAGE_NAME}"
  # 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. LOGS_GROUP_NAME:"handson-cli"
         LOGS_GROUP_NAME="${LOGS_GROUP_NAME}"
  # 0.10. LOGS_STREAM_PREFIX:"handson-cli"
          LOGS_STREAM_PREFIX="${LOGS_STREAM_PREFIX}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施¶

課題

(未検証)

タスク標準時間:	6分

1. 前処理¶

処理対象の状態確認¶

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

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

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

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

コマンド:

ls -d ${DIR_CONF}

結果(例):

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

事前条件2: ECSコンテナ定義"handson-cli-container-definition"が存在しない。

「ECSコンテナ定義"handson-cli-container-definition"が存在しない。」ことを確認します。

コマンド:

! ls ${FILE_ECS_CONTAINER_DEFINITION}

結果(例):

ls: ${HOME}/tmp/conf-handson-cli/handson-cli-container-definition.json No such file or directory

2. 主処理¶

ECSコンテナ定義の作成¶

変数の確認:

cat << ETX

  # AWS_DEFAULT_REGION:"us-west-2"
    AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"
  # FILE_ECS_CONTAINER_DEFINITION:"${HOME}/tmp/conf-handson-cli/handson-cli-container-definition.json"
    FILE_ECS_CONTAINER_DEFINITION="${FILE_ECS_CONTAINER_DEFINITION}"
  # ECS_CONTAINER_DEFINITION_NAME:"handson-cli-container-definition"
    ECS_CONTAINER_DEFINITION_NAME="${ECS_CONTAINER_DEFINITION_NAME}"
  # CONTAINER_NAME:"handson-cli"
    CONTAINER_NAME="${CONTAINER_NAME}"
  # CONTAINER_IMAGE_NAME:"httpd:2.4"
    CONTAINER_IMAGE_NAME="${CONTAINER_IMAGE_NAME}"
  # CONTAINER_PORT:"80"
    CONTAINER_PORT="${CONTAINER_PORT}"
  # HOST_PORT:"80"
    HOST_PORT="${HOST_PORT}"
  # PROTOCOL_NAME:"tcp"
    PROTOCOL_NAME="${PROTOCOL_NAME}"
  # LOGS_GROUP_NAME:"handson-cli"
    LOGS_GROUP_NAME="${LOGS_GROUP_NAME}"
  # LOGS_STREAM_PREFIX:"handson-cli"
    LOGS_STREAM_PREFIX="${LOGS_STREAM_PREFIX}"

ETX

コマンド:

cat << EOF > ${FILE_ECS_CONTAINER_DEFINITION}
[
  {
    "name": "${CONTAINER_NAME}",
    "image": "${CONTAINER_IMAGE_NAME}",
    "portMappings": [
      {
        "containerPort": ${CONTAINER_PORT},
        "hostPort": ${HOST_PORT},
        "protocol": "${PROTOCOL_NAME}"
      }
    ],
    "logConfiguration": {
        "logDriver": "awslogs",
        "options": {
            "awslogs-group": "${LOGS_GROUP_NAME}",
            "awslogs-region": "${AWS_DEFAULT_REGION}",
            "awslogs-stream-prefix": "${LOGS_STREAM_PREFIX}"
        }
    },
    "essential": true,
    "entryPoint": [
      "sh",
      "-c"
    ],
    "command": [
      "/bin/sh -c \"mkdir -p /usr/local/apache2/htdocs/${CONTAINER_NAME} && echo '<html> <head> <title>Amazon ECS Sample App</title> <style>body {margin-top: 40px; background-color: #333;} </style> </head><body> <div style=color:white;text-align:center> <h1>Amazon ECS Sample App</h1> <h2>Congratulations!</h2> <p>Your application is now running on a container in Amazon ECS.</p> </div></body></html>' >  /usr/local/apache2/htdocs/${CONTAINER_NAME}/index.html && httpd-foreground\""
    ]
  }
]
EOF

cat ${FILE_ECS_CONTAINER_DEFINITION}

結果(例):

[
  {
    "name": "handson-cli",
    "image": "httpd:2.4",
    "portMappings": [
      {
        "containerPort": 80,
        "hostPort": 80,
        "protocol": "tcp"
      }
    ],
    "logConfiguration": {
        "logDriver": "awslogs",
        "options": {
            "awslogs-group": "handson-cli",
            "awslogs-region": "us-west-2",
            "awslogs-stream-prefix": "handson-cli"
        }
    },
    "essential": true,
    "entryPoint": [
        "sh",
        "-c"
    ],
    "command": [
        "/bin/sh -c "mkdir -p /usr/local/apache2/htdocs/handson-cli && echo '<html> <head> <title>Amazon ECS Sample App</title> <style>body {margin-top: 40px; background-color: #333;} </style> </head><body> <div style=color:white;text-align:center> <h1>Amazon ECS Sample App</h1> <h2>Congratulations!</h2> <p>Your application is now running on a container in Amazon ECS.</p> </div></body></html>' >  /usr/local/apache2/htdocs/handson-cli/index.html && httpd-foreground""
    ]
  }
]

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

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

コマンド:

jsonlint -q ${FILE_ECS_CONTAINER_DEFINITION}

結果(例):

(出力なし)

3. 後処理¶

完了条件の確認¶

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

完了条件1: ECSコンテナ定義"handson-cli-container-definition"が存在する。

「ECSコンテナ定義"handson-cli-container-definition"が存在する。」ことを確認します。

コマンド:

ls ${FILE_ECS_CONTAINER_DEFINITION}

結果(例):

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

prototype.opslearn.jp

1. ECSコンテナ定義の作成 (handson-cli-container-definition)¶

作業の目的 [why]¶

作業対象 [what]¶

標準時間(合計)¶

パラメータ設定¶

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

パラメータの指定¶

0.0. リージョンの指定¶

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

0.2. ECSコンテナ定義名の指定¶

0.3. ECSコンテナ定義ファイル名の指定¶

0.4. コンテナ名の指定¶

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

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

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

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

0.9. ロググループ名の指定¶

0.10. ログストリーム名の指定¶

パラメータの保存¶

タスクの実施¶

1. 前処理¶

処理対象の状態確認¶

2. 主処理¶

ECSコンテナ定義の作成¶

3. 後処理¶

完了条件の確認¶

完了¶