9.4. EC2ユーザデータの作成 (handson-rds-userdata)

作業の目的 [why]

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

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

完了条件 [after]

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

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

事前条件 [before]

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

事前条件1
ユーザデータ用ディレクトリ"${HOME}/tmp/conf-handson-rds"が存在する。
事前条件2
EC2ユーザデータファイル"${HOME}/tmp/conf-handson-rds/handson-rds-userdata.bash"が存在しない。
事前条件3
SSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"が存在する。

作業対象 [what]

  • EC2サービス

標準時間(合計)

8分

パラメータ設定

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

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

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

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

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

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

コマンド:

ls -d ${HOME}/tmp/conf-handson-rds

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

${HOME}/tmp/conf-handson-rds

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

コマンド:

mkdir -p ${HOME}/tmp/conf-handson-rds

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

  • 作成するEC2ユーザデータのファイル名です。
  • 今回は"${HOME}/tmp/conf-handson-rds/handson-rds-userdata.bash"とします。

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

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

リソース4: SSMパラメータ名

  • 起動したEC2インスタンスに配置するPostgreSQL接続情報が格納されているSSMパラメータ名です。
  • 今回は"/handson-rds/connection/handson-rds-dbinstance/pgadmin"とします。

リソース5: ロググループ名プレフィクス

  • 起動したEC2インスタンスがログを書き込むロググループ名のプレフィクスです。
  • 今回は"handson-rds"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

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

変数の設定:

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

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

EC2ユーザデータ名の指定

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

変数の設定:

EC2_USERDATA_NAME='handson-rds-userdata'

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

EC2ユーザデータファイル名を指定します。

変数の設定:

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

結果(例):

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

0.3. SSHポート番号の指定

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

変数の設定:

PORT_SSHD='22322'

0.4. SSMパラメータ名の指定

SSMパラメータ名を指定します。

変数の設定:

SSM_PARAMETER_NAME='/handson-rds/connection/handson-rds-dbinstance/pgadmin'

0.5. ロググループ名のプレフィクス指定

ロググループ名のプレフィクスを指定します。

変数の設定:

LOGS_GROUP_PREFIX='handson-rds'

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-rds/2019-06-10-ec2-userdata-create-expand-env_maint_db-postgresql.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-rds"
         DIR_EC2_USERDATA="${DIR_EC2_USERDATA}"
  # 0.2. FILE_EC2_USERDATA:"${HOME}/tmp/conf-handson-rds/handson-rds-userdata.bash"
         FILE_EC2_USERDATA="${FILE_EC2_USERDATA}"
  # 0.3. PORT_SSHD:"22322"
         PORT_SSHD="${PORT_SSHD}"
  # 0.4. SSM_PARAMETER_NAME:"/handson-rds/connection/handson-rds-dbinstance/pgadmin"
         SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}"
  # 0.5. LOGS_GROUP_PREFIX:"handson-rds"
         LOGS_GROUP_PREFIX="${LOGS_GROUP_PREFIX}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

処理対象の状態確認

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

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

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

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

コマンド:

ls -d ${DIR_EC2_USERDATA}

結果(例):

${HOME}/tmp/conf-handson-rds

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

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

コマンド:

! ls ${FILE_EC2_USERDATA}

結果(例):

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

事前条件3: SSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"が存在する。

「SSMパラメータ"/handson-rds/connection/handson-rds-dbinstance/pgadmin"が存在する。」ことを確認します。

コマンド:

aws ssm describe-parameters \
  --filters "Key=Name,Values=${SSM_PARAMETER_NAME}" \
  --query 'Parameters[].Name' \
  --output text

結果(例):

/handson-rds/connection/handson-rds-dbinstance/pgadmin

2. 主処理

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

変数の確認:

cat << ETX

  # FILE_EC2_USERDATA:"${HOME}/tmp/conf-handson-rds/handson-rds-userdata.bash"
    FILE_EC2_USERDATA="${FILE_EC2_USERDATA}"
  # LOGS_GROUP_PREFIX:"handson-rds"
    LOGS_GROUP_PREFIX="${LOGS_GROUP_PREFIX}"
  # SSM_PARAMETER_NAME:"/handson-rds/connection/handson-rds-dbinstance/pgadmin"
    SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}"

ETX

コマンド:

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

REGION=\$( \\
  curl -s http://169.254.169.254/latest/meta-data/placement/availability-zone \\
    | sed -e 's/[a-z]$//' \\
)
export AWS_DEFAULT_REGION="\${REGION}"

# yum
yum update -y

# psql client
yum install postgresql96.x86_64 -y

# configure logs agent
yum install -y awslogs

mv /etc/awslogs/awslogs.conf /etc/awslogs/awslogs.conf.orig
cat /etc/awslogs/awslogs.conf.orig \\
  | sed -e "\$(cat /etc/awslogs/awslogs.conf.orig \\
  | sed -n '/\[\/var\/log\/messages\]/='),\\\$d" \\
  | sed -e '/^#/d' | sed -e '/^$/d' \\
  > /etc/awslogs/awslogs.conf

mv /etc/awslogs/awscli.conf /etc/awslogs/awscli.conf.orig
cat /etc/awslogs/awscli.conf.orig \\
  | sed "s/us-east-1/\${REGION}/" \\
  > /etc/awslogs/awscli.conf
chmod 600 /etc/awslogs/awscli.conf

cat << EOF > /etc/awslogs/config/messages.conf
[/var/log/messages]
log_group_name = ${LOGS_GROUP_PREFIX}/var/log/messages
log_stream_name = {instance_id}
datetime_format = %b %d %H:%M:%S
file = /var/log/messages
buffer_duration = 5000
initial_position = start_of_file
EOF

cat << EOF > /etc/awslogs/config/secure.conf
[/var/log/secure]
log_group_name = ${LOGS_GROUP_PREFIX}/var/log/secure
log_stream_name = {instance_id}
datetime_format = %b %d %H:%M:%S
file = /var/log/secure
buffer_duration = 5000
initial_position = start_of_file
EOF
sudo service awslogs start

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

Port ${PORT_SSHD}
EOF

# restart sshd
service sshd restart

# pip
pip install -U awscli

# ec2-user
USER_NAME='ec2-user'
GROUP_NAME='ec2-user'

file_pgpass="/home/\${USER_NAME}/.pgpass"
aws ssm get-parameter \\
  --name "${SSM_PARAMETER_NAME}" \\
  --with-decryption \\
  --query 'Parameter.Value' \\
  --output text \\
  > \${file_pgpass} \\
&& chmod 400 \${file_pgpass} \\
&& chown \${USER_NAME}:\${GROUP_NAME} \${file_pgpass}

# end of ec2-user

EOF1

cat ${FILE_EC2_USERDATA}

結果(例):

#!/bin/bash

REGION=$(   curl -s http://169.254.169.254/latest/meta-data/placement/availability-zone     | sed -e 's/[a-z]$//' )
export AWS_DEFAULT_REGION="${REGION}"

# yum
yum update -y

# psql client
yum install postgresql96.x86_64 -y

# configure logs agent
yum install -y awslogs

mv /etc/awslogs/awslogs.conf /etc/awslogs/awslogs.conf.orig
cat /etc/awslogs/awslogs.conf.orig \
  | sed -e "$(cat /etc/awslogs/awslogs.conf.orig \
  | sed -n '/\[\/var\/log\/messages\]/='),\$d" \
  | sed -e '/^#/d' | sed -e '/^$/d' \
  > /etc/awslogs/awslogs.conf

mv /etc/awslogs/awscli.conf /etc/awslogs/awscli.conf.orig
cat /etc/awslogs/awscli.conf.orig \
  | sed "s/us-east-1/${REGION}/" \
  > /etc/awslogs/awscli.conf
chmod 600 /etc/awslogs/awscli.conf

cat << EOF > /etc/awslogs/config/messages.conf
[/var/log/messages]
log_group_name = handson-rds/var/log/messages
log_stream_name = {instance_id}
datetime_format = %b %d %H:%M:%S
file = /var/log/messages
buffer_duration = 5000
initial_position = start_of_file
EOF

cat << EOF > /etc/awslogs/config/secure.conf
[/var/log/secure]
log_group_name = handson-rds/var/log/secure
log_stream_name = {instance_id}
datetime_format = %b %d %H:%M:%S
file = /var/log/secure
buffer_duration = 5000
initial_position = start_of_file
EOF
sudo service awslogs start

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

Port 22322
EOF

# restart sshd
service sshd restart

# pip
pip install -U awscli

# ec2-user
USER_NAME='ec2-user'
GROUP_NAME='ec2-user'

# pgpass
file_pgpass="/home/${USER_NAME}/.pgpass"
aws ssm get-parameter \
  --name /handson-rds/connection/handson-rds-dbinstance/pgadmin \
  --with-decryption \
  --query 'Parameter.Value' \
  --output text \
  > ${file_pgpass} \
&& chmod 400 ${file_pgpass} \
&& chown ${USER_NAME}:${GROUP_NAME} ${file_pgpass}

# end of ec2-user

3. 後処理

3.2. 完了条件の確認

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

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

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

コマンド:

ls ${FILE_EC2_USERDATA}

結果(例):

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

完了