5.2. ECSコンテナインスタンスの確認 (cluster-handson-cli)

作業の目的 [why]

ECSインスタンス"<ECSインスタンス名>"を確認します。

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

完了条件 [after]

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

完了条件1
ECSクラスタ"cluster-handson-cli"に存在するコンテナインスタンスの情報を確認できている。

事前条件 [before]

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

事前条件1
ECSクラスタ"cluster-handson-cli"が存在する。

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

作業対象 [what]

  • ECSコンテナインスタンス

標準時間

8分

前提条件

作業権限条件 [who]

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

作業権限条件: ECSへの権限

ECSに対して読み取り権限があること。

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

作業環境条件3: AWS CLIのバージョン

以下のバージョンで動作確認済

  • AWS CLI 1.14.24

コマンド:

aws --version

結果(例):

aws-cli/1.14.31 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.8.35

バージョンが古い場合は最新版に更新しましょう。

コマンド:

sudo -H pip install -U awscli

開始条件

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

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

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

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

作業開始 [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. ECS_CLUSTER_NAME:"cluster-handson-cli"
         ECS_CLUSTER_NAME="${ECS_CLUSTER_NAME}"

ETX

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

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

変数の設定:

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

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

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. ECSクラスタ名の指定

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

変数の設定:

ECS_CLUSTER_NAME='cluster-handson-cli'

再確認

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

変数の確認:

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. ECS_CLUSTER_NAME:"cluster-handson-cli"
         ECS_CLUSTER_NAME="${ECS_CLUSTER_NAME}"

ETX

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: ECSクラスタ"cluster-handson-cli"が存在する。

「ECSクラスタ"cluster-handson-cli"が存在する。」ことを確認します。

コマンド:

aws ecs list-clusters \
  --query "clusterArns[?contains(@,\`${ECS_CLUSTER_NAME}\`)]"

結果(例):

[
  "arn:aws:ecs:ap-northeast-1:XXXXXXXXXXXX:cluster/cluster-handson-cli"
]

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

コンテナインスタンスの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

2. 主処理

ECSコンテナインスタンスの情報取得

ステータスの取得

コマンド:

aws ecs describe-container-instances \
  --cluster ${ECS_CLUSTER_NAME} \
  --container-instances "${ARRAY_ECS_INSTANCE_ARNS}" \
  --query "containerInstances[].[join(\`\`,[ec2InstanceId,\`: \`,status]),agentConnected]" \
  --output text

結果(例):

i-xxxxxxxxxxxxxxxxx: ACTIVE True

バージョン情報の取得

コマンド:

aws ecs describe-container-instances \
  --cluster ${ECS_CLUSTER_NAME} \
  --container-instances "${ARRAY_ECS_INSTANCE_ARNS}" \
  --query "containerInstances[].[join(\`\`,[ec2InstanceId,\`: \`,versionInfo.agentVersion,\`: \`,versionInfo.dockerVersion])]" \
  --output text

結果(例):

i-xxxxxxxxxxxxxxxxx: 1.16.2: DockerVersion: DockerVersion: 17.06.2-ce

3. 後処理

完了条件の確認

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

完了条件1: ECSクラスタ"cluster-handson-cli"に存在するコンテナインスタンスの情報を確認できている。

「ECSクラスタ"cluster-handson-cli"に存在するコンテナインスタンスの情報を確認できている。」ことを確認します。

完了