1.1. UserDataの作成 (ログイン検証 efs: handson-cli-efs-userdata)

作業の目的 [why]

EC2ユーザデータ"handson-cli-efs-userdata"を作成します。

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

完了条件 [after]

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

完了条件1
EC2ユーザデータ"${HOME}/tmp/conf-handson-cli-efs/handson-cli-efs-userdata.bash"が存在する。

事前条件 [before]

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

事前条件1
ユーザデータ用ディレクトリ"${HOME}/tmp/conf-handson-cli-efs"が存在する。
事前条件2
EC2ユーザデータファイル"${HOME}/tmp/conf-handson-cli-efs/handson-cli-efs-userdata.bash"が存在しない。
事前条件3
EFSファイルシステム名"handson-cli-filesystem"が存在する。

作業対象 [what]

  • EC2サービス

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: EC2ユーザデータ用ディレクトリ

  • 今回は"${HOME}/tmp/conf-handson-cli-efs"をEC2ユーザデータ用ディレクトリとします。

ディレクトリが存在することを確認します。

コマンド:

ls -d ${HOME}/tmp/conf-handson-cli-efs

結果(例:存在する場合):

${HOME}/tmp/conf-handson-cli-efs

存在しない場合は作成します。

コマンド:

mkdir -p ${HOME}/tmp/conf-handson-cli-efs

リソース2: EC2ユーザデータファイル名

  • 作成するEC2ユーザデータのファイル名です。
  • 今回は"handson-cli-efs-userdata"とします。

リソース3: SSHポート番号

  • 起動したEC2インスタンスのsshdが使用するTCPポート番号です。
  • デフォルトのままだと、恒常的にアタックが来るので変更します。
  • 今回は"22322"とします。

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

  • EC2インスタンスにマウントするEFSファイルシステムの名称です。
  • 今回は"handson-cli-filesystem"とします。

リソース5: マウントポイント

  • EFSファイルシステムをマウントするEC2上のディレクトリです。
  • 今回は"/mnt-efs"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. EC2ユーザデータ用ディレクトリの指定

変数の設定:

DIR_EC2_USERDATA="${HOME}/tmp/conf-handson-cli-efs"

0.2. EC2ユーザデータ名の指定

EC2ユーザデータの名称を指定します。

変数の設定:

EC2_USERDATA_NAME='handson-cli-efs-userdata'

0.3. SSHポート番号の指定

SSHポート番号を指定します。

変数の設定:

PORT_SSHD='22322'

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

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

変数の設定:

EFS_FILE_SYSTEM_TOKEN_NAME='handson-cli-filesystem'

0.5. マウントポイントの指定

マウントポイントを指定します。

変数の設定:

DIR_EFS_MOUNT_POINT='/mnt-efs'

パラメータの保存

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

変数の設定:

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

結果(例):

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

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. DIR_EC2_USERDATA:"${HOME}/tmp/conf-handson-cli-efs"
         DIR_EC2_USERDATA="${DIR_EC2_USERDATA}"
  # 0.2. EC2_USERDATA_NAME:"handson-cli-efs-userdata"
         EC2_USERDATA_NAME="${EC2_USERDATA_NAME}"
  # 0.3. PORT_SSHD:"22322"
         PORT_SSHD="${PORT_SSHD}"
  # 0.4. EFS_FILE_SYSTEM_TOKEN_NAME:"handson-cli-filesystem"
         EFS_FILE_SYSTEM_TOKEN_NAME="${EFS_FILE_SYSTEM_TOKEN_NAME}"
  # 0.5. DIR_EFS_MOUNT_POINT:"/mnt-efs"
         DIR_EFS_MOUNT_POINT="${DIR_EFS_MOUNT_POINT}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 状態確認に必要な情報の取得

EC2ユーザデータファイル名の指定

変数の設定:

FILE_EC2_USERDATA="${DIR_EC2_USERDATA}/${EC2_USERDATA_NAME}.bash" \
  && echo ${FILE_EC2_USERDATA}

結果(例):

${HOME}/tmp/conf-handson-cli-efs/handson-cli-efs-userdata.bash

1.2. 処理対象の状態確認

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

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

事前条件1: ユーザデータ用ディレクトリ"${HOME}/tmp/conf-handson-cli-efs"が存在する。

「ユーザデータ用ディレクトリ"${HOME}/tmp/conf-handson-cli-efs"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_EC2_USERDATA}

結果(例):

${HOME}/tmp/conf-handson-cli-efs

事前条件2: EC2ユーザデータファイル"${HOME}/tmp/conf-handson-cli-efs/handson-cli-efs-userdata.bash"が存在しない。

「EC2ユーザデータファイル"${HOME}/tmp/conf-handson-cli-efs/handson-cli-efs-userdata.bash"が存在しない。」ことを確認します。

コマンド:

! ls ${FILE_EC2_USERDATA}

結果(例):

ls: ${HOME}/tmp/conf-handson-cli-efs/handson-cli-efs-userdata.bash No such file or directory

事前条件3: 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

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

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. 主処理

EC2ユーザデータファイルの作成

変数の確認:

cat << ETX

  # FILE_EC2_USERDATA:"${HOME}/tmp/conf-handson-cli-efs/handson-cli-efs-userdata.bash"
    FILE_EC2_USERDATA="${FILE_EC2_USERDATA}"
  # PORT_SSHD:"22322"
    PORT_SSHD="${PORT_SSHD}"
  # EFS_FILE_SYSTEM_ID:"fs-xxxxxxxx"
    EFS_FILE_SYSTEM_ID="${EFS_FILE_SYSTEM_ID}"
  # DIR_EFS_MOUNT_POINT:"/mnt-efs"
    DIR_EFS_MOUNT_POINT="${DIR_EFS_MOUNT_POINT}"

ETX

コマンド:

cat << EOF1 > ${FILE_EC2_USERDATA}
#!/bin/bash

# configure sshd
cat << EOF >> /etc/ssh/sshd_config

Port ${PORT_SSHD}
EOF
service sshd restart


# yum
yum update -y


# configure efs agent
yum install -y amazon-efs-utils

mkdir -p ${DIR_EFS_MOUNT_POINT}
echo "${EFS_FILE_SYSTEM_ID}:/ ${DIR_EFS_MOUNT_POINT} efs tls,_netdev" \
  >> /etc/fstab
mount -a -t efs -o tls
if [ ! -d ${DIR_EFS_MOUNT_POINT}/ec2-user ]; then
  mkdir -p ${DIR_EFS_MOUNT_POINT}/ec2-user
  chown ec2-user:ec2-user ${DIR_EFS_MOUNT_POINT}/ec2-user
fi
EOF1

cat ${FILE_EC2_USERDATA}

結果(例):

#!/bin/bash

# configure sshd
cat << EOF >> /etc/ssh/sshd_config

Port 22322
EOF
service sshd restart


# yum
yum update -y

# configure efs agent
yum install -y amazon-efs-utils

mkdir -p /mnt-efs
echo "fs-xxxxxxxx:/ /mnt-efs efs tls,_netdev"   >> /etc/fstab
mount -a -t efs -o tls
chmod go+rw /mnt-efs

3. 後処理

完了条件の確認

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

完了条件1: EC2ユーザデータ"${HOME}/tmp/conf-handson-cli-efs/handson-cli-efs-userdata.bash"が存在する。

「EC2ユーザデータ"${HOME}/tmp/conf-handson-cli-efs/handson-cli-efs-userdata.bash"が存在する。」ことを確認します。

コマンド:

ls ${FILE_EC2_USERDATA}

結果(例):

${HOME}/tmp/conf-handson-cli-efs/handson-cli-efs-userdata.bash

完了