2. UserDataの作成 (ecsクラスタ: handson-cli-ecs-cluster)

作業の目的 [why]

EC2ユーザデータ"handson-cli-ecs-cluster"を作成します。

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

完了条件 [after]

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

完了条件1
EC2ユーザデータ"${HOME}/tmp/conf-handson-cli/handson-cli-ecs-cluster.bash"が存在する。

事前条件 [before]

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

事前条件1
ユーザデータ用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。
事前条件2
EC2ユーザデータファイル"${HOME}/tmp/conf-handson-cli/handson-cli-ecs-cluster.bash"が存在しない。

作業対象 [what]

  • ローカルホスト

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: EC2ユーザデータ用ディレクトリ

  • 今回は"${HOME}/tmp/conf-handson-cli"をEC2ユーザデータ用ディレクトリとします。

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

コマンド:

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

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

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

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

コマンド:

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

リソース2: EC2ユーザデータファイル名

  • 作成するEC2ユーザデータのファイル名です。
  • 今回は"handson-cli-ecs-cluster"とします。

リソース3: ECSクラスタ名

  • 作成するEC2ユーザデータから起動するEC2インスタンスが属すECSクラスタの名称です。
  • 今回は"handson-cli-cluster"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. EC2ユーザデータ用ディレクトリの指定

変数の設定:

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

0.2. EC2ユーザデータ名の指定

EC2ユーザデータの名称を指定します。

変数の設定:

EC2_USERDATA_NAME='handson-cli-ecs-cluster'

0.3. ECSクラスタ名の指定

ECSクラスタ名を指定します。

変数の設定:

ECS_CLUSTER_NAME="handson-cli-cluster"

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-ec2-userdata-create-expand-ecs_cluster.env

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

変数の確認:

cat << ETX

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

  # 0.1. DIR_EC2_USERDATA:"${HOME}/tmp/conf-handson-cli"
         DIR_EC2_USERDATA="${DIR_EC2_USERDATA}"
  # 0.2. EC2_USERDATA_NAME:"handson-cli-ecs-cluster"
         EC2_USERDATA_NAME="${EC2_USERDATA_NAME}"
  # 0.3. ECS_CLUSTER_NAME:"handson-cli-cluster"
         ECS_CLUSTER_NAME="${ECS_CLUSTER_NAME}"

ETX

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 状態確認に必要な情報の取得

EC2ユーザデータファイル名の指定

変数の設定:

FILE_EC2_USERDATA="${DIR_EC2_USERDATA}/${EC2_USERDATA_NAME}.bash" \
  && echo ${FILE_EC2_USERDATA}

結果(例):

${HOME}/tmp/conf-handson-cli/handson-cli-ecs-cluster.bash

1.2. 処理対象の状態確認

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

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

事前条件1: ユーザデータ用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。

「ユーザデータ用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_EC2_USERDATA}

結果(例):

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

事前条件2: EC2ユーザデータファイル"${HOME}/tmp/conf-handson-cli/handson-cli-ecs-cluster.bash"が存在しない。

「EC2ユーザデータファイル"${HOME}/tmp/conf-handson-cli/handson-cli-ecs-cluster.bash"が存在しない。」ことを確認します。

コマンド:

! ls ${FILE_EC2_USERDATA}

結果(例):

ls: ${HOME}/tmp/conf-handson-cli/handson-cli-ecs-cluster.bash No such file or directory

事前条件3: 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. 主処理

EC2ユーザデータファイルの作成

変数の確認:

cat << ETX

  # FILE_EC2_USERDATA:"${HOME}/tmp/conf-handson-cli/handson-cli-ecs-cluster.bash"
    FILE_EC2_USERDATA="${FILE_EC2_USERDATA}"
  # EC2_USERDATA_NAME:"handson-cli-ecs-cluster"
    EC2_USERDATA_NAME="${EC2_USERDATA_NAME}"
  # ECS_CLUSTER_NAME:"handson-cli-cluster"
    ECS_CLUSTER_NAME="${ECS_CLUSTER_NAME}"

ETX

コマンド:

cat << EOF0 > ${FILE_EC2_USERDATA}
#!/bin/bash
sudo yum update -y ecs-init

cat << EOF1 > /etc/ecs/ecs.config
ECS_CLUSTER=${ECS_CLUSTER_NAME}
#ECS_ENGINE_AUTH_TYPE=docker
#ECS_ENGINE_AUTH_DATA={"https://index.docker.io/v1/":{"username":"my_name","password":"my_password","email":"email@example.com"}}
#ECS_LOGLEVEL=debug
EOF1


sudo yum install -y awslogs

REGION=\$( \\
  curl -s http://169.254.169.254/latest/meta-data/placement/availability-zone \\
    | sed -e 's/[a-z]$//' \\
)

mv /etc/awslogs/awscli.conf /etc/awslogs/awscli.conf.orig
cat /etc/awslogs/awscli.conf.orig \\
  | sed "s/us-east-1/\${REGION}/" \\
  > /etc/awslogs/awscli.conf
chmod 600 /etc/awslogs/awscli.conf


EC2_INSTANCE_ID=\$(curl -s http://169.254.169.254/latest/meta-data/instance-id)

cat > /etc/awslogs/awslogs.conf <<- EOF2
[general]
state_file = /var/lib/awslogs/agent-state        
 
[/var/log/dmesg]
file = /var/log/dmesg
log_group_name = /var/log/dmesg
log_stream_name = ${ECS_CLUSTER_NAME}/${EC2_INSTANCE_ID}

[/var/log/messages]
file = /var/log/messages
log_group_name = /var/log/messages
log_stream_name = ${ECS_CLUSTER_NAME}/${EC2_INSTANCE_ID}
datetime_format = %b %d %H:%M:%S

[/var/log/docker]
file = /var/log/docker
log_group_name = /var/log/docker
log_stream_name = ${ECS_CLUSTER_NAME}/${EC2_INSTANCE_ID}
datetime_format = %Y-%m-%dT%H:%M:%S.%f

[/var/log/ecs/ecs-init.log]
file = /var/log/ecs/ecs-init.log
log_group_name = /var/log/ecs/ecs-init.log
log_stream_name = ${ECS_CLUSTER_NAME}/${EC2_INSTANCE_ID}
datetime_format = %Y-%m-%dT%H:%M:%SZ

[/var/log/ecs/ecs-agent.log]
file = /var/log/ecs/ecs-agent.log.*
log_group_name = /var/log/ecs/ecs-agent.log
log_stream_name = ${ECS_CLUSTER_NAME}/${EC2_INSTANCE_ID}
datetime_format = %Y-%m-%dT%H:%M:%SZ

[/var/log/ecs/audit.log]
file = /var/log/ecs/audit.log.*
log_group_name = /var/log/ecs/audit.log
log_stream_name = ${ECS_CLUSTER_NAME}/${EC2_INSTANCE_ID}
datetime_format = %Y-%m-%dT%H:%M:%SZ

EOF2

sudo service awslogs start
chkconfig awslogs on

EOF0

cat ${FILE_EC2_USERDATA}

3. 後処理

完了条件の確認

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

完了条件1: EC2ユーザデータ"${HOME}/tmp/conf-handson-cli/handson-cli-ecs-cluster.bash"が存在する。

「EC2ユーザデータ"${HOME}/tmp/conf-handson-cli/handson-cli-ecs-cluster.bash"が存在する。」ことを確認します。

コマンド:

ls ${FILE_EC2_USERDATA}

結果(例):

${HOME}/tmp/conf-handson-cli/handson-cli-ecs-cluster.bash

完了