1. ECSサービスのセキュリティグループ確認 (handson-cli-service)

作業の目的 [why]

ECSサービス"handson-cli-service"が稼動しているECSクラスタ"handson-cli-cluster"に属するコンテナインスタンスに関連付いているセキュリティグループを確認します。

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

完了条件 [after]

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

完了条件1
ECSサービス"handson-cli-service"のセキュリティグループのセキュリティグループ名とVPC名を確認できている。

事前条件 [before]

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

事前条件1
ECSクラスタ"handson-cli-cluster"が存在する。
事前条件2
ECSサービス"handson-cli-service"がECSクラスタ"handson-cli-cluster"に属している。

作業対象 [what]

  • ECSサービス

標準時間(合計)

8分

パラメータ設定

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

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

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

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

  • 作成するECSクラスタの名称です。
  • 今回は"handson-cli-cluster"とします。

リソース2: ECSサービス名

  • 作成するECSサービスの名称です。
  • 今回は"handson-cli-service"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. ECSクラスタ名の指定

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

変数の設定:

ECS_CLUSTER_NAME='handson-cli-cluster'

0.2. ECSサービス名の指定

ECSサービス名を指定します。

変数の設定:

ECS_SERVICE_NAME='handson-cli-service'

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-ecs-service_security_group-read.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. ECS_CLUSTER_NAME:"handson-cli-cluster"
         ECS_CLUSTER_NAME="${ECS_CLUSTER_NAME}"
  # 0.2. ECS_SERVICE_NAME:"handson-cli-service"
         ECS_SERVICE_NAME="${ECS_SERVICE_NAME}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: 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: ECSサービス"handson-cli-service"がECSクラスタ"handson-cli-cluster"に属している。

「ECSサービス"handson-cli-service"がECSクラスタ"handson-cli-cluster"に属している。」ことを確認します。

コマンド:

aws ecs list-services \
  --cluster ${ECS_CLUSTER_NAME} \
  --query "serviceArns[?contains(@,\`${ECS_SERVICE_NAME}\`)]" \
  --output text

結果(例):

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

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

ECSクラスタに属するコンテナインスタンスのARN取得

コマンド:

ARRAY_ECS_INSTANCE_ARNS=$( \
  aws ecs list-container-instances \
    --cluster ${ECS_CLUSTER_NAME} \
    --query 'containerInstanceArns' \
    --output text \
) \
  && echo "${ARRAY_ECS_INSTANCE_ARNS}"

結果(例):

arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:container-instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

ECSクラスタに属するコンテナインスタンスのEC2インスタンスID取得

コマンド:

ARRAY_EC2_INSTANCE_IDS=$( \
  aws ecs describe-container-instances \
    --cluster ${ECS_CLUSTER_NAME} \
    --container-instances "${ARRAY_ECS_INSTANCE_ARNS}" \
    --query 'containerInstances[].ec2InstanceId' \
    --output text \
) \
  && echo ${ARRAY_EC2_INSTANCE_IDS}

結果(例):

i-xxxxxxxxxxxxxxxxx

変数の設定:

EC2_INSTANCE_ID=$( \
  echo ${ARRAY_EC2_INSTANCE_IDS} \
    | sed 's/ .*$//' \
) \
  && echo ${EC2_INSTANCE_ID}

結果(例):

i-xxxxxxxxxxxxxxxxx

2. 主処理

VPCタグ名の取得

ECSクラスタに属するインスタンスが属するVPCを確認します。

コマンド:

VPC_ID=$( \
  aws ec2 describe-instances \
    --instance-ids ${EC2_INSTANCE_ID} \
    --query 'Reservations[].Instances[].NetworkInterfaces[].VpcId' \
    --output text \
) \
  && echo ${VPC_ID}

結果(例):

vpc-xxxxxxxxxxxxxxxxx

コマンド:

VPC_TAG_NAME=$( \
  aws ec2 describe-vpcs \
    --filters Name=vpc-id,Values=${VPC_ID}  \
    --query 'Vpcs[].Tags[?Key == `Name`].Value' \
    --output text \
) \
  && echo ${VPC_TAG_NAME}

結果(例):

handson-cli-vpc

セキュリティグループの確認

ECSクラスタに属するインスタンスに関連付けられたセキュリティグループを確認します。

コマンド:

aws ec2 describe-instances \
  --instance-ids ${ARRAY_EC2_INSTANCE_IDS} \
  --query 'Reservations[].Instances[].SecurityGroups[].[join(``,[GroupId,`, `,GroupName])]' \
  --output text

結果(例):

sg-xxxxxxxxxxxxxxxxx, handson-cli-webapp-sg

セキュリティグループ名の指定

表示されたセキュリティグループから以下を指定します。

変数の設定:

VPC_SG_NAME='handson-cli-webapp-sg'

3. 後処理

完了条件の確認

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

完了条件1: ECSサービス"handson-cli-service"のセキュリティグループのセキュリティグループ名とVPC名を確認できている。

「ECSサービス"handson-cli-service"のセキュリティグループのセキュリティグループ名とVPC名を確認できている。」ことを確認します。

コマンド:

echo "${VPC_TAG_NAME}: ${VPC_SG_NAME}"

結果(例):

handson-cli-vpc: handson-cli-webapp-sg

完了