4.3. AMIの作成 (handson-cli-instance-stateless-loadaverage-webhost-1)

作業の目的 [why]

EC2インスタンス"handson-cli-instance-stateless-loadaverage-admin-instance"からAMI"handson-cli-instance-stateless-loadaverage-webhost-1"を作成します。

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

完了条件 [after]

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

完了条件1

AMI"handson-cli-instance-stateless-loadaverage-webhost-1"が存在する。

完了条件2

AMI"handson-cli-instance-stateless-loadaverage-webhost-1"がavailableである。

事前条件 [before]

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

事前条件1

EC2インスタンス"handson-cli-instance-stateless-loadaverage-admin-instance"が存在する。

事前条件2

AMI"handson-cli-instance-stateless-loadaverage-webhost-1"が存在しない。

作業対象 [what]

  • EC2インスタンス

標準時間(合計)

8分

パラメータ設定

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

2分

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

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

リソース1: EC2インスタンス名

  • 作成するAMIの元となるEC2インスタンスの名称です。

  • 今回は"handson-cli-instance-stateless-loadaverage-admin-instance"とします。

リソース2: AMIプレフィックス名

  • 作成するAMIのプレフィックス名称です。

  • 今回は"handson-cli-instance-stateless-loadaverage-webhost"とします。

リソース3: AMIリビジョン名

  • 作成するAMIのリビジョンです。

  • 今回は"1"とします。

リソース4: AMIの説明

  • 作成するAMIの説明です。

  • 今回は"image of handson-cli-instance-stateless-loadaverage"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. EC2インスタンス名の指定

EC2インスタンスのタグ名を指定します。

変数の設定:

EC2_INSTANCE_TAG_NAME='handson-cli-instance-stateless-loadaverage-admin-instance'

0.2. AMIプレフィックス名の指定

作成するAMIのプレフィックスを指定します。

変数の設定:

EC2_MACHINE_IMAGE_PREFIX='handson-cli-instance-stateless-loadaverage-webhost'

作成するAMIのリビジョンを指定します。

変数の設定:

EC2_MACHINE_IMAGE_REVISION='1'

プレフィクスとリビジョンを組み合わせてAMIイメージ名を指定します。

変数の設定:

EC2_MACHINE_IMAGE_NAME="${EC2_MACHINE_IMAGE_PREFIX}-${EC2_MACHINE_IMAGE_REVISION}" \
  && echo ${EC2_MACHINE_IMAGE_NAME}

結果(例):

handson-cli-instance-stateless-loadaverage-webhost-1

0.3. AMIの説明の指定

AMIの説明を指定します。

変数の設定:

EC2_MACHINE_IMAGE_DESC='image of handson-cli-instance-stateless-loadaverage'

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli-instance-stateless-loadaverage/2020-01-13-ec2-image-create.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. EC2_INSTANCE_TAG_NAME:"handson-cli-instance-stateless-loadaverage-admin-instance"
         EC2_INSTANCE_TAG_NAME="${EC2_INSTANCE_TAG_NAME}"
  # 0.2. EC2_MACHINE_IMAGE_NAME:"handson-cli-instance-stateless-loadaverage-webhost-1"
         EC2_MACHINE_IMAGE_NAME="${EC2_MACHINE_IMAGE_NAME}"
  # 0.3. EC2_MACHINE_IMAGE_DESC:"image of handson-cli-instance-stateless-loadaverage"
         EC2_MACHINE_IMAGE_DESC="${EC2_MACHINE_IMAGE_DESC}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間

6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: EC2インスタンス"handson-cli-instance-stateless-loadaverage-admin-instance"が存在する。

「EC2インスタンス"handson-cli-instance-stateless-loadaverage-admin-instance"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-instances \
  --filters Name=tag-key,Values=Name \
            Name=tag-value,Values=${EC2_INSTANCE_TAG_NAME} \
            Name=instance-state-name,Values=running \
  --query Reservations[].Instances[].Tags[].Value \
  --output text

結果(例):

handson-cli-instance-stateless-loadaverage-admin-instance

事前条件2: AMI"handson-cli-instance-stateless-loadaverage-webhost-1"が存在しない。

「AMI"handson-cli-instance-stateless-loadaverage-webhost-1"が存在しない。」ことを確認します。

コマンド:

aws ec2 describe-images \
  --filter "Name=name, Values=${EC2_MACHINE_IMAGE_NAME}" \
  --query 'Images[].Name' \
  --output text

結果(例):

(出力なし)

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

インスタンスIDの取得

コマンド:

ARRAY_EC2_INSTANCE_IDS=$( \
  aws ec2 describe-instances \
    --filters Name=tag-key,Values=Name \
              Name=tag-value,Values=${EC2_INSTANCE_TAG_NAME} \
              Name=instance-state-name,Values=running \
    --query Reservations[].Instances[].InstanceId \
    --output text \
) \
  && echo ${ARRAY_EC2_INSTANCE_IDS}

結果(例):

i-xxxxxxxxxxxxxxxxx

注釈

本手順でインスタンスタグ名に対してインスタンスIDは1つしか出力されない前提ですが、念のため先頭のインスタンスIDのみを取得します。

変数の設定:

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

結果(例):

i-xxxxxxxxxxxxxxxxx

2. 主処理

AMIの作成

変数の確認:

cat << ETX

  # EC2_INSTANCE_ID:"i-xxxxxxxxxxxxxxxxx"
    EC2_INSTANCE_ID="${EC2_INSTANCE_ID}"
  # EC2_MACHINE_IMAGE_NAME:"handson-cli-instance-stateless-loadaverage-webhost-1"
    EC2_MACHINE_IMAGE_NAME="${EC2_MACHINE_IMAGE_NAME}"
  # EC2_MACHINE_IMAGE_DESC:"image of handson-cli-instance-stateless-loadaverage"
    EC2_MACHINE_IMAGE_DESC="${EC2_MACHINE_IMAGE_DESC}"

ETX

コマンド:

aws ec2 create-image \
  --instance-id ${EC2_INSTANCE_ID} \
  --name ${EC2_MACHINE_IMAGE_NAME} \
  --description "${EC2_MACHINE_IMAGE_DESC}"

結果(例):

{
  "ImageId": "ami-xxxxxxxx"
}

インスタンスがリブートを開始します。

3. 後処理

完了条件の確認

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

完了条件1: AMI"handson-cli-instance-stateless-loadaverage-webhost-1"が存在する。

「AMI"handson-cli-instance-stateless-loadaverage-webhost-1"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-images \
  --filter "Name=name, Values=${EC2_MACHINE_IMAGE_NAME}" \
  --query 'Images[].Name' \
  --output text

結果(例):

handson-cli-instance-stateless-loadaverage-webhost-1

イメージが表示されるまで数十秒以上かかります。

完了条件2: AMI"handson-cli-instance-stateless-loadaverage-webhost-1"がavailableである。

「AMI"handson-cli-instance-stateless-loadaverage-webhost-1"がavailableである。」ことを確認します。

コマンド:

EC2_MACHINE_IMAGE_STATE=$( \
  aws ec2 describe-images \
    --filters Name=name,Values="${EC2_MACHINE_IMAGE_NAME}" \
    --query "Images[?Name == \`${EC2_MACHINE_IMAGE_NAME}\`].State" \
    --output text \
) \
  && echo ${EC2_MACHINE_IMAGE_STATE}

結果(例):

available

availableになるまで数十秒以上かかります。 (マネジメントコンソールの方がAPIよりもavailableと表示されるのが早いようです。)

完了