2. DB接続情報ファイルの作成 (dbinstance-handson-cli)¶
作業の目的 [why]¶
DBインスタンス"dbinstance-handson-cli"への接続情報ファイルを作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- DB接続情報"${HOME}/tmp/conf-rds/.pgpass"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- 設定ファイル用ディレクトリが存在する。
- 事前条件2
- DB接続情報"${HOME}/tmp/conf-rds/.pgpass"が存在しない。
- 事前条件3
- DBインスタンス"dbinstance-handson-cli"が存在する。
前提と異なることが判明した場合、直ちに処理を中止します。
作業対象 [what]¶
- RDSサービス
標準時間¶
8分
前提条件¶
作業環境条件 [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.24
コマンド:
aws --version
結果(例):
aws-cli/1.14.28 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.8.32
バージョンが古い場合は最新版に更新しましょう。
コマンド:
sudo -H pip install -U awscli
開始条件¶
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: 設定ファイル用ディレクトリ
今回は"${HOME}/tmp/conf-rds"を設定ファイル用ディレクトリとします。
ls -d ${HOME}/tmp/conf-rds
結果(例:存在する場合):
${HOME}/tmp/conf-rds
存在しない場合は作成します。
mkdir -p ${HOME}/tmp/conf-rds
リソース2: DBインスタンス名
- 接続するDBインスタンスの名称です。
- 今回は"dbinstance-handson-cli"とします。
リソース3: DBインスタンスの接続ポート番号
- 接続するDBインスタンスの接続ポート番号です。
- 今回は"5432"とします。
リソース4: データベース名
- 接続するデータベースの名称です。
- 今回は"handsonCLI"とします。
- データベース名には、英数字のみが利用できます。
リソース5: マスタユーザ名
- 接続するデータベースで利用するユーザ名です。
- 今回は"pgadmin"とします。
リソース6: マスタパスワード
- 接続するデータベースで利用するユーザのパスワードです。
- 今回は"#dbPass123"とします。
リソース7: DB接続情報ファイル名
- 作成するDB接続情報ファイルのファイル名です。
- 今回は"${HOME}/tmp/conf-rds/.pgpass"とします。
タスクの実施¶
0. パラメータの指定¶
まず変数の確認をします。
変数の確認:
cat << ETX # 0.a. AWS_DEFAULT_PROFILE:"<RDSのフル権限を許可されたプロファイル>" AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}" # 0.b. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. DIR_CONF:"${HOME}/tmp/conf-rds" DIR_CONF="${DIR_CONF}" # 0.2. RDS_INSTANCE_IDENT:"dbinstance-handson-cli" RDS_INSTANCE_IDENT="${RDS_INSTANCE_IDENT}" # 0.3. VPC_SG_PORT:"5432" VPC_SG_PORT="${VPC_SG_PORT}" # 0.4. RDS_DB_NAME:"handsonCLI" RDS_DB_NAME="${RDS_DB_NAME}" # 0.5. RDS_USER_NAME:"pgadmin" RDS_USER_NAME="${RDS_USER_NAME}" # 0.6. RDS_USER_PASS:"#dbPass123" RDS_USER_PASS="${RDS_USER_PASS}" # 0.7. FILE_INPUT:"${HOME}/tmp/conf-rds/.pgpass" FILE_INPUT="${FILE_INPUT}" ETX
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号について作業を行います。
0.a. プロファイルの指定¶
プロファイルの一覧を確認します。
コマンド:
cat ~/.aws/credentials \ | grep '\[' \ | sed 's/\[//g' | sed 's/\]//g'
結果(例):
iamFull-prjz-mbpr13 <RDSのフル権限を許可されたプロファイル>
変数の設定:
export AWS_DEFAULT_PROFILE='<RDSのフル権限を許可されたプロファイル>'
再確認¶
設定されている変数の内容を再確認します。
変数の確認:
cat << ETX # 0.a. AWS_DEFAULT_PROFILE:"<RDSのフル権限を許可されたプロファイル>" AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}" # 0.b. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. DIR_CONF:"${HOME}/tmp/conf-rds" DIR_CONF="${DIR_CONF}" # 0.2. RDS_INSTANCE_IDENT:"dbinstance-handson-cli" RDS_INSTANCE_IDENT="${RDS_INSTANCE_IDENT}" # 0.3. VPC_SG_PORT:"5432" VPC_SG_PORT="${VPC_SG_PORT}" # 0.4. RDS_DB_NAME:"handsonCLI" RDS_DB_NAME="${RDS_DB_NAME}" # 0.5. RDS_USER_NAME:"pgadmin" RDS_USER_NAME="${RDS_USER_NAME}" # 0.6. RDS_USER_PASS:"#dbPass123" RDS_USER_PASS="${RDS_USER_PASS}" # 0.7. FILE_INPUT:"${HOME}/tmp/conf-rds/.pgpass" FILE_INPUT="${FILE_INPUT}" ETX
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: 設定ファイル用ディレクトリが存在する。
「設定ファイル用ディレクトリが存在する。」ことを確認します。
コマンド:
ls -d ${DIR_CONF}
結果(例):
${HOME}/tmp/conf-rds
事前条件2: DB接続情報"${HOME}/tmp/conf-rds/.pgpass"が存在しない。
「DB接続情報"${HOME}/tmp/conf-rds/.pgpass"が存在しない。」ことを確認します。
コマンド:
ls ${FILE_INPUT}
結果(例):
ls: ${HOME}/tmp/conf-rds/.pgpass No such file or directory
事前条件3: DBインスタンス"dbinstance-handson-cli"が存在する。
「DBインスタンス"dbinstance-handson-cli"が存在する。」ことを確認します。
コマンド:
aws rds describe-db-instances \ --query "DBInstances[?DBInstanceIdentifier == \`${RDS_INSTANCE_IDENT}\`].DBInstanceIdentifier"
結果(例):
[ "dbinstance-handson-cli" ]
1.2. 主処理に必要な情報の取得¶
エンドポイントの確認
コマンド:
RDS_INSTANCE_ENDPOINT=$( \ aws rds describe-db-instances \ --db-instance-identifier ${RDS_INSTANCE_IDENT} \ --query 'DBInstances[].Endpoint.Address' \ --output text \ ) \ && echo ${RDS_INSTANCE_ENDPOINT}
結果(例):
dbinstance-handson-cli-ap-northeast-1.xxxxxxxxxxxx.ap-northeast-1rds.amazonaws.com
2. 主処理¶
DB接続情報ファイルの作成¶
変数の確認:
cat << ETX # RDS_INSTANCE_ENDPOINT:"dbinstance-handson-cli.xxxxxxxxxxxx.ap-northeast-1.rds.amazonaws.com" RDS_INSTANCE_ENDPOINT="${RDS_INSTANCE_ENDPOINT}" # VPC_SG_PORT:"5432" VPC_SG_PORT="${VPC_SG_PORT}" # RDS_DB_NAME:"handsonCLI" RDS_DB_NAME="${RDS_DB_NAME}" # RDS_USER_NAME:"pgadmin" RDS_USER_NAME="${RDS_USER_NAME}" # RDS_USER_PASS:"#dbPass123" RDS_USER_PASS="${RDS_USER_PASS}" ETX
コマンド:
echo "${RDS_INSTANCE_ENDPOINT}:${VPC_SG_PORT}:${RDS_DB_NAME}:${RDS_USER_NAME}:${RDS_USER_PASS}" > ${FILE_INPUT} \ && chmod 600 ${FILE_INPUT} \ && cat ${FILE_INPUT}
結果(例):
dbinstance-handson-cli-ap-northeast-1.xxxxxxxxxxxx.ap-northeast-1rds.amazonaws.com:5432:handsonCLI:pgadmin:#dbPass123