事前作業3. UserDataの作成 (PostgreSQL: postgresql)

作業の目的 [why]

EC2ユーザデータ"postgresql"を作成します。

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

完了条件 [after]

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

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

事前条件 [before]

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

事前条件1
設定ファイル用ディレクトリが存在する。
事前条件2
EC2ユーザデータファイル"${HOME}/tmp/conf-ec2/postgresql.bash"が存在しない。
事前条件3
S3バケット"conf-<AWS_ID>"が存在する。
事前条件4
S3バケット"conf-<AWS_ID>"のパス"conf-rds-dbinstance-handson-cli"に設定ファイルが存在する。
事前条件5
S3バケット"log-<AWS_ID>"が存在する。

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

作業対象 [what]

  • EC2サービス

標準時間

8分

前提条件

作業権限条件 [who]

本作業は、以下の作業権限を有する人が行います。

作業権限条件: EC2への権限

EC2に対してフル権限があること。

作業環境条件 [where]

本作業は、以下の作業環境で行います。

作業環境条件1: OSとバージョン

Amazon Linuxの以下のバージョンで動作確認済

コマンド:

cat /etc/issue | head -1

結果(例):

Amazon Linux AMI release 2016.09

作業環境条件2: シェルとバージョン

bashの以下のバージョンで動作確認済

コマンド:

bash --version -v | head -1

結果(例):

GNU bash, バージョン 4.2.46(1)-release (x86_64-redhat-linux-gnu)

作業環境条件3: AWS CLIのバージョン

以下のバージョンで動作確認済

  • AWS CLI 1.14.18

コマンド:

aws --version

結果(例):

aws-cli/1.14.19 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.8.23

バージョンが古い場合は最新版に更新しましょう。

コマンド:

sudo -H pip install -U awscli

開始条件

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

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

リソース1: 設定ファイル用ディレクトリ

  • 今回は"${HOME}/tmp/conf-ec2"を設定ファイル用ディレクトリとします。

    ls ${HOME}/tmp/conf-ec2

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

    mkdir -p ${HOME}/tmp/conf-ec2

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

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

リソース3: 設定ファイル用S3バケット

  • 設定ファイル用S3バケット名です。
  • 今回は"conf-<AWS_ID>"とします。

リソース4: 設定ファイル用S3バケットのパス名

  • 設定ファイル用S3バケットのパス名です。
  • 今回は"conf-rds-dbinstance-handson-cli"とします。

作業開始 [when]

以下を全て満たしているとき、作業を開始します。

  • 開始の指示があった場合。

タスクの実施

0. パラメータの指定

まず変数の確認をします。

変数の確認:

cat << ETX

  # 0.1. DIR_CONF: ${HOME}/tmp/conf-ec2
         DIR_CONF="${DIR_CONF}"
  # 0.2. EC2_USERDATA_NAME: postgresql
         EC2_USERDATA_NAME="${EC2_USERDATA_NAME}"
  # 0.3. S3_BUCKET_NAME: conf-<AWS_ID>
         S3_BUCKET_NAME="${S3_BUCKET_NAME}"
  # 0.4. S3_BUCKET_PATH: conf-rds-dbinstance-handson-cli
         S3_BUCKET_PATH="${S3_BUCKET_PATH}"
  # 0.5. S3_BUCKET_LOG: log-<AWS_ID>
         S3_BUCKET_LOG="${S3_BUCKET_LOG}"

ETX

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

0.1. 設定ファイルディレクトリの指定

変数の設定:

DIR_CONF="${HOME}/tmp/conf-ec2"

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

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

変数の設定:

EC2_USERDATA_NAME='postgresql'

0.3. 設定ファイル用S3バケット名の指定

設定ファイル用S3バケット名を指定します。

変数の設定:

S3_BUCKET_NAME='conf-<AWS_ID>'

0.4. 設定ファイル用S3バケットのパス名の指定

設定ファイル用S3バケットのパス名を指定します。

変数の設定:

S3_BUCKET_PATH='conf-rds-dbinstance-handson-cli'

0.5. ログ用S3バケット名の指定

設定ファイル用S3バケット名を指定します。

変数の設定:

S3_BUCKET_LOG='log-<AWS_ID>'

再確認

設定されている変数の内容を再確認します。

変数の確認:

cat << ETX

  # 0.1. DIR_CONF: ${HOME}/tmp/conf-ec2
         DIR_CONF="${DIR_CONF}"
  # 0.2. EC2_USERDATA_NAME: postgresql
         EC2_USERDATA_NAME="${EC2_USERDATA_NAME}"
  # 0.3. S3_BUCKET_NAME: conf-<AWS_ID>
         S3_BUCKET_NAME="${S3_BUCKET_NAME}"
  # 0.4. S3_BUCKET_PATH: conf-rds-dbinstance-handson-cli
         S3_BUCKET_PATH="${S3_BUCKET_PATH}"
  # 0.5. S3_BUCKET_LOG: log-<AWS_ID>
         S3_BUCKET_LOG="${S3_BUCKET_LOG}"

ETX

1. 前処理

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

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

変数の設定:

FILE_INPUT="${DIR_CONF}/${EC2_USERDATA_NAME}.bash" \
  && echo ${FILE_INPUT}

結果(例):

${HOME}/tmp/conf-ec2/postgresql.bash

1.2. 処理対象の状態確認

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

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

事前条件1: 設定ファイル用ディレクトリが存在する。

「設定ファイル用ディレクトリが存在する。」ことを確認します。

コマンド:

ls -d ${DIR_CONF}

結果(例):

${HOME}/tmp/conf-ec2

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

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

コマンド:

ls ${FILE_INPUT}

結果(例):

ls: ${HOME}/tmp/conf-ec2/postgresql.bash No such file or directory

事前条件3: S3バケット"conf-<AWS_ID>"が存在する。

「S3バケット"conf-<AWS_ID>"が存在する。」ことを確認します。

コマンド:

aws s3 ls s3://${S3_BUCKET_NAME}/

結果(例):

20180108 01:23:45        290 <ファイル名>

事前条件4: S3バケット"conf-<AWS_ID>"のパス"conf-rds-dbinstance-handson-cli"に設定ファイルが存在する。

「S3バケット"conf-<AWS_ID>"のパス"conf-rds-dbinstance-handson-cli"に設定ファイルが存在する。」ことを確認します。

コマンド:

aws s3 ls s3://${S3_BUCKET_NAME}/${S3_BUCKET_PATH}/

結果(例):

20180108 01:23:45        290 <ファイル名>

事前条件5: S3バケット"log-<AWS_ID>"が存在する。

「S3バケット"log-<AWS_ID>"が存在する。」ことを確認します。

コマンド:

aws s3 ls s3://${S3_BUCKET_LOG}/

結果(例):

20180108 01:23:45        290 <ファイル名>

ファイルが存在しない場合は、出力はありません。

2. 主処理

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

変数の確認:

cat << ETX

  # FILE_INPUT:"${HOME}/tmp/conf-ec2/postgresql.bash"
    FILE_INPUT="${FILE_INPUT}"
  # EC2_USERDATA_NAME:"postgresql"
    EC2_USERDATA_NAME="${EC2_USERDATA_NAME}"
  # S3_BUCKET_NAME:"conf-<AWS_ID>"
    S3_BUCKET_NAME="${S3_BUCKET_NAME}"
  # S3_BUCKET_PATH:"conf-rds-dbinstance-handson-cli"
    S3_BUCKET_PATH="${S3_BUCKET_PATH}"
  # S3_BUCKET_LOG:"log-<AWS_ID>"
    S3_BUCKET_LOG="${S3_BUCKET_LOG}"

ETX

コマンド:

cat << EOF > ${FILE_INPUT}
#!/bin/bash
sudo yum -y update

# install packages
sudo yum install postgresql96.x86_64 -y

# sync conf
aws s3 sync s3://${S3_BUCKET_NAME}/${S3_BUCKET_PATH} /tmp/${S3_BUCKET_PATH}

# setup
mv /tmp/${S3_BUCKET_PATH}/.pgpass /home/ec2-user/
chown ec2-user:ec2-user /home/ec2-user/.pgpass 
chmod 400 /home/ec2-user/.pgpass 

# sync log
cd /var/log/
aws s3 cp cloud-init-output.log s3://${S3_BUCKET_LOG}/${EC2_USERDATA_NAME}-output-$(date +%Y%m%d-%H%M%S)

EOF

cat ${FILE_INPUT}

3. 後処理

完了条件の確認

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

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

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

コマンド:

ls ${FILE_INPUT}

結果(例):

${HOME}/tmp/conf-ec2/postgresql.bash

完了