3.1. EBSボリュームの作成 (handson-cli-instance-stateful-ssh-data-volume)

作業の目的 [why]

EBSリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"を作成します。

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

完了条件 [after]

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

完了条件1

EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"が存在する。

事前条件 [before]

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

事前条件1

AZ"ap-northeast-1a"が存在する。

事前条件2

EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"が存在しない。

作業対象 [what]

  • EC2サービス

標準時間(合計)

8分

パラメータ設定

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

2分

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

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

リソース1: EBSボリューム配置AZ名

  • 作成するEBSボリュームを配置するAZ名です。

  • 今回は"handson-cli-instance-stateful-ssh-data-volume"とします。

リソース2: EBSボリュームサイズ

  • 作成するEBSボリュームのサイズです。

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

リソース3: EBSボリュームタイプ

  • 作成するEBSボリュームのタイプです。

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

リソース4: EBSボリュームタグ名

  • 作成するEBSボリュームのタグ名です。

  • 今回は"handson-cli-instance-stateful-ssh-data-volume"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. EBSボリューム配置AZ名の指定

EBSボリュームを配置するAZ名を指定します。

変数の設定:

EC2_AZ_NAME="ap-northeast-1a"

0.2. EBSボリュームサイズの指定

EBSボリュームのサイズを指定します。

変数の設定:

EC2_VOLUME_SIZE='8'

0.3. EBSボリュームタイプの指定

EBSボリュームのタイプを指定します。

変数の設定:

EC2_VOLUME_TYPE='gp2'

0.4. EBSボリュームのタグ名の指定

EBSボリュームのタグ名を指定します。

変数の設定:

EC2_VOLUME_TAG_NAME='handson-cli-instance-stateful-ssh-data-volume'

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli-instance-stateful-ssh/2019-09-16-ec2-volume-create.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. EC2_AZ_NAME:"ap-northeast-1a"
         EC2_AZ_NAME="${EC2_AZ_NAME}"
  # 0.2. EC2_VOLUME_SIZE:"8"
         EC2_VOLUME_SIZE="${EC2_VOLUME_SIZE}"
  # 0.3. EC2_VOLUME_TYPE:"gp2"
         EC2_VOLUME_TYPE="${EC2_VOLUME_TYPE}"
  # 0.4. EC2_VOLUME_TAG_NAME:"handson-cli-instance-stateful-ssh-data-volume"
         EC2_VOLUME_TAG_NAME="${EC2_VOLUME_TAG_NAME}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間

6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: AZ"ap-northeast-1a"が存在する。

「AZ"ap-northeast-1a"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-availability-zones \
  --filters Name=region-name,Values=${AWS_DEFAULT_REGION} \
            Name=zone-name,Values=${EC2_AZ_NAME} \
  --query 'AvailabilityZones[].ZoneName' \
  --output text

結果(例):

ap-northeast-1a

事前条件2: EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"が存在しない。

「EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"が存在しない。」ことを確認します。

コマンド:

aws ec2 describe-volumes \
  --filters Name=tag-key,Values=Name \
            Name=tag-value,Values=${EC2_VOLUME_TAG_NAME} \
  --query 'Volumes[?Tags.Key == Name].Tags[].Value' \
  --output text

結果(例):

(出力なし)

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

タグ設定文字列の生成

変数の設定:

EC2_TAG_KEY='Name'

変数の設定:

STRING_TAG_CONF="ResourceType=volume,Tags=[{Key=${EC2_TAG_KEY},Value=${EC2_VOLUME_TAG_NAME}}]" \
  && echo ${STRING_TAG_CONF}

結果(例):

ResourceType=volume,Tags=[{Key=Name,Value=handson-cli-instance-stateful-ssh-data-volume}]

2. 主処理

EBSボリュームの作成

変数の確認:

cat << ETX

  # EC2_AZ_NAME:"ap-northeast-1a"
    EC2_AZ_NAME="${EC2_AZ_NAME}"
  # EC2_VOLUME_SIZE:"8"
    EC2_VOLUME_SIZE="${EC2_VOLUME_SIZE}"
  # EC2_VOLUME_TYPE:"gp2"
    EC2_VOLUME_TYPE="${EC2_VOLUME_TYPE}"
  # STRING_TAG_CONF:"ResourceType=volume,Tags=[{Key=Name,Value=handson-cli-instance-stateful-ssh-data-volume}]"
    STRING_TAG_CONF="${STRING_TAG_CONF}"

ETX

コマンド:

aws ec2 create-volume \
  --availability-zone ${EC2_AZ_NAME} \
  --size ${EC2_VOLUME_SIZE} \
  --volume-type ${EC2_VOLUME_TYPE} \
  --tag-specifications "${STRING_TAG_CONF}"

結果(例):

{
  "AvailabilityZone": "ap-northeast-1a",
  "CreateTime": "2019-09-16T01:23:45.000Z",
  "Encrypted": false,
  "Size": 8,
  "SnapshotId": "",
  "State": "creating",
  "VolumeId": "vol-xxxxxxxxxxxxxxxxx",
  "Iops": 100,
  "Tags": [
    {
        "Key": "Name",
        "Value": "handson-cli-instance-stateful-ssh-data-volume"
    }
  ],
  "VolumeType": "gp2"
}

3. 後処理

完了条件の確認

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

完了条件1: EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"が存在する。

「EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-volumes \
  --filters Name=tag-key,Values=Name \
            Name=tag-value,Values=${EC2_VOLUME_TAG_NAME} \
  --query 'Volumes[?Tags.Key == Name].Tags[].Value' \
  --output text

結果(例):

handson-cli-instance-stateful-ssh-data-volume

完了