2.3. EFSマウントターゲットの作成 (app-charlie-handson-cli-subnet)

作業の目的 [why]

EFSファイルシステム名"handson-cli-filesystem"のマウントターゲットをサブネット"app-charlie-handson-cli-subnet"に作成します。

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

完了条件 [after]

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

完了条件1
サブネット"app-charlie-handson-cli-subnet"にEFSファイルシステム"handson-cli-filesystem"のマウントターゲットが存在する。

事前条件 [before]

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

事前条件1
EFSファイルシステム名"handson-cli-filesystem"が存在する。
事前条件2
VPC"handson-cli-vpc"が存在する。
事前条件3
VPC"handson-cli-vpc"にサブネット"app-charlie-handson-cli-subnet"が存在する。
事前条件4
サブネット"app-charlie-handson-cli-subnet"にEFSファイルシステム"handson-cli-filesystem"のマウントターゲットが存在しない。
事前条件5
VPC"handson-cli-vpc"にセキュリティグループ"appefs-handson-cli-sg"が存在する。

作業対象 [what]

  • EFSサービス

標準時間(合計)

8分

パラメータ設定

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

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

リソース1: EFSファイルシステム名

  • 作成するEFSマウントターゲットの対象となるEFSファイルシステムの名称です。
  • 今回は"handson-cli-filesystem"とします。

リソース2: VPCのタグ名

  • EFSマウントターゲットを作成するサブネットが属しているVPCのタグ名称です。
  • 今回は"handson-cli-vpc"とします。

リソース3: サブネットのタグ名

  • EFSマウントターゲットを作成するサブネットのタグ名称です。
  • 今回は"app-charlie-handson-cli-subnet"とします。

リソース4: セキュリティグループ名

  • EFSマウントターゲットに付与するセキュリティグループの名称です。
  • 今回は"appefs-handson-cli-sg"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. EFSファイルシステム名の指定

EFSファイルシステム名を指定します。

変数の設定:

EFS_FILE_SYSTEM_TOKEN_NAME='handson-cli-filesystem'

0.2. VPCのタグ名の指定

VPCのタグ名を指定します。

変数の設定:

VPC_TAG_NAME='handson-cli-vpc'

0.3. サブネットのタグ名の指定

サブネットのタグ名を指定します。

変数の設定:

VPC_SUBNET_TAG_NAME='app-charlie-handson-cli-subnet'

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

セキュリティグループ名を指定します。

変数の設定:

VPC_SG_NAME='appefs-handson-cli-sg'

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-efs-mount_target-create.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. EFS_FILE_SYSTEM_TOKEN_NAME:"handson-cli-filesystem"
         EFS_FILE_SYSTEM_TOKEN_NAME="${EFS_FILE_SYSTEM_TOKEN_NAME}"
  # 0.2. VPC_TAG_NAME:"handson-cli-vpc"
         VPC_TAG_NAME="${VPC_TAG_NAME}"
  # 0.3. VPC_SUBNET_TAG_NAME:"app-charlie-handson-cli-subnet"
         VPC_SUBNET_TAG_NAME="${VPC_SUBNET_TAG_NAME}"
  # 0.4. VPC_SG_NAME:"appefs-handson-cli-sg"
         VPC_SG_NAME="${VPC_SG_NAME}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: EFSファイルシステム名"handson-cli-filesystem"が存在する。

「EFSファイルシステム名"handson-cli-filesystem"が存在する。」ことを確認します。

コマンド:

aws efs describe-file-systems \
  --creation-token ${EFS_FILE_SYSTEM_TOKEN_NAME} \
  --query "FileSystems[].CreationToken" \
  --output text

結果(例):

handson-cli-filesystem

EFSファイルシステムIDを取得します。

コマンド:

EFS_FILE_SYSTEM_ID=$( \
  aws efs describe-file-systems \
    --creation-token ${EFS_FILE_SYSTEM_TOKEN_NAME} \
    --query "FileSystems[].FileSystemId" \
    --output text \
) \
  && echo ${EFS_FILE_SYSTEM_ID}

結果(例):

fs-xxxxxxxx

事前条件2: VPC"handson-cli-vpc"が存在する。

「VPC"handson-cli-vpc"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-vpcs \
  --filters Name=tag:Name,Values=${VPC_TAG_NAME}  \
  --query 'Vpcs[].Tags[?Key == `Name`].Value' \
  --output text

結果(例):

handson-cli-vpc

VPC IDを取得します。

コマンド:

VPC_ID=$( \
  aws ec2 describe-vpcs \
    --filters Name=tag:Name,Values=${VPC_TAG_NAME}  \
    --query 'Vpcs[].VpcId' \
    --output text \
) \
  && echo ${VPC_ID}

結果(例):

vpc-xxxxxxxxxxxxxxxxx

事前条件3: VPC"handson-cli-vpc"にサブネット"app-charlie-handson-cli-subnet"が存在する。

「VPC"handson-cli-vpc"にサブネット"app-charlie-handson-cli-subnet"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-subnets \
  --filters Name=vpc-id,Values=${VPC_ID} \
            Name=tag:Name,Values=${VPC_SUBNET_TAG_NAME}  \
  --query 'Subnets[].Tags[?Key == `Name`].Value' \
  --output text

結果(例):

app-charlie-handson-cli-subnet

サブネットIDを取得します。

コマンド:

VPC_SUBNET_ID=$( \
  aws ec2 describe-subnets \
    --filters Name=vpc-id,Values=${VPC_ID} \
              Name=tag:Name,Values=${VPC_SUBNET_TAG_NAME}  \
    --query "Subnets[].SubnetId" \
    --output text \
) \
  && echo ${VPC_SUBNET_ID}

結果(例):

subnet-xxxxxxxxxxxxxxxxx

事前条件4: サブネット"app-charlie-handson-cli-subnet"にEFSファイルシステム"handson-cli-filesystem"のマウントターゲットが存在しない。

「サブネット"app-charlie-handson-cli-subnet"にEFSファイルシステム"handson-cli-filesystem"のマウントターゲットが存在しない。」ことを確認します。

コマンド:

aws efs describe-mount-targets \
  --file-system-id ${EFS_FILE_SYSTEM_ID} \
  --query "MountTargets[?SubnetId == \`${VPC_SUBNET_ID}\`].SubnetId" \
  --output text

結果(例):

(出力なし)

事前条件5: VPC"handson-cli-vpc"にセキュリティグループ"appefs-handson-cli-sg"が存在する。

「VPC"handson-cli-vpc"にセキュリティグループ"appefs-handson-cli-sg"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-security-groups \
  --filter Name=vpc-id,Values=${VPC_ID} \
    Name=group-name,Values=${VPC_SG_NAME} \
  --query 'SecurityGroups[].GroupName' \
  --output text

結果(例):

appefs-handson-cli-sg

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

セキュリティグループIDの取得

コマンド:

VPC_SG_ID=$( \
  aws ec2 describe-security-groups \
    --filter Name=vpc-id,Values=${VPC_ID} \
      Name=group-name,Values=${VPC_SG_NAME} \
    --query "SecurityGroups[].GroupId" \
    --output text \
) \
  && echo ${VPC_SG_ID}

結果(例):

sg-xxxxxxxxxxxxxxxxx

2. 主処理

EFSマウントターゲットの作成

パラメータの確認:

cat << ETX

  # EFS_FILE_SYSTEM_ID:"fs-xxxxxxxx"
    EFS_FILE_SYSTEM_ID="${EFS_FILE_SYSTEM_ID}"
  # VPC_SUBNET_ID:"subnet-xxxxxxxxxxxxxxxxx"
    VPC_SUBNET_ID="${VPC_SUBNET_ID}"
  # VPC_SG_ID:"sg-xxxxxxxxxxxxxxxxx"
    VPC_SG_ID="${VPC_SG_ID}"

ETX

コマンド:

aws efs create-mount-target \
  --file-system-id ${EFS_FILE_SYSTEM_ID} \
  --subnet-id ${VPC_SUBNET_ID} \
  --security-group ${VPC_SG_ID}

結果(例):

{
  "OwnerId": "XXXXXXXXXXXX",
  "MountTargetId": "fsmt-yyyyyyyy",
  "FileSystemId": "fs-xxxxxxxx",
  "SubnetId": "subnet-xxxxxxxxxxxxxxxxx",
  "LifeCycleState": "creating",
  "IpAddress": "yyy.yyy.yyy.yyy",
  "NetworkInterfaceId": "eni-yyyyyyyy"
}

3. 後処理

完了条件の確認

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

完了条件1: サブネット"app-charlie-handson-cli-subnet"にEFSファイルシステム"handson-cli-filesystem"のマウントターゲットが存在する。

「サブネット"app-charlie-handson-cli-subnet"にEFSファイルシステム"handson-cli-filesystem"のマウントターゲットが存在する。」ことを確認します。

コマンド:

aws efs describe-mount-targets \
  --file-system-id ${EFS_FILE_SYSTEM_ID} \
  --query "MountTargets[?SubnetId == \`${VPC_SUBNET_ID}\`].SubnetId" \
  --output text

結果(例):

subnet-xxxxxxxxxxxxxxxxx

完了