1.1. RDS (create: DBサブネットグループ)¶
作業の目的 [why]¶
DBサブネットグループ"postgresql-2017-11-20"を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- DBサブネットグループ"postgresql-2017-11-20"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- DBサブネットグループ"postgresql-2017-11-20"が存在しない。
前提と異なることが判明した場合、直ちに処理を中止します。
課題
(未検証)
作業対象 [what]¶
- RDSサービス
標準時間¶
8分
前提条件¶
作業権限条件 [who]¶
本作業は、以下の作業権限を有する人が行います。
作業権限条件: RDSへの権限
RDSに対してフル権限があること。
作業権限条件: 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.11.117
コマンド:
aws --version
結果(例):
aws-cli/1.11.189 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.7.47
バージョンが古い場合は最新版に更新しましょう。
コマンド:
sudo -H pip install -U awscli
開始条件¶
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: DBサブネットグループ名
- 作成するDBサブネットグループの名称です。
- 今回は"postgresql-2017-11-20"とします。
リソース2: DBサブネットグループの説明
- 作成するDBサブネットグループの説明です。
- 今回は"PostgreSQL 2017-11-20"とします。
リソース3: VPC名
- DBサブネットグループを作成するVPCの名称です。
- 今回は"vpc-handson-2017-11-20"とします。
リソース4: サブネット1名
- DBサブネットグループに含めるサブネット1の名称です。
- 今回は"subnet1-handson-2017-11-20"とします。
リソース5: サブネット2名
- DBサブネットグループに含めるサブネット2の名称です。
- 今回は"subnet2-handson-2017-11-20"とします。
タスクの実施¶
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. RDS_SUBNET_GROUP_NAME:"postgresql-2017-11-20" RDS_SUBNET_GROUP_NAME="${RDS_SUBNET_GROUP_NAME}" # 0.2. RDS_SUBNET_GROUP_DESC:"PostgreSQL 2017-11-20" RDS_SUBNET_GROUP_DESC="${RDS_SUBNET_GROUP_DESC}" # 0.3. VPC_TAG_NAME:"vpc-handson-2017-11-20" VPC_TAG_NAME="${VPC_TAG_NAME}" # 0.4. VPC_SUBNET_TAG_NAME_1:"subnet1-handson-2017-11-20" VPC_SUBNET_TAG_NAME_1="${VPC_SUBNET_TAG_NAME_1}" # 0.5. VPC_SUBNET_TAG_NAME_2:"subnet2-handson-2017-11-20" VPC_SUBNET_TAG_NAME_2="${VPC_SUBNET_TAG_NAME_2}" 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. RDS_SUBNET_GROUP_NAME:"postgresql-2017-11-20" RDS_SUBNET_GROUP_NAME="${RDS_SUBNET_GROUP_NAME}" # 0.2. RDS_SUBNET_GROUP_DESC:"PostgreSQL 2017-11-20" RDS_SUBNET_GROUP_DESC="${RDS_SUBNET_GROUP_DESC}" # 0.3. VPC_TAG_NAME:"vpc-handson-2017-11-20" VPC_TAG_NAME="${VPC_TAG_NAME}" # 0.4. VPC_SUBNET_TAG_NAME_1:"subnet1-handson-2017-11-20" VPC_SUBNET_TAG_NAME_1="${VPC_SUBNET_TAG_NAME_1}" # 0.5. VPC_SUBNET_TAG_NAME_2:"subnet2-handson-2017-11-20" VPC_SUBNET_TAG_NAME_2="${VPC_SUBNET_TAG_NAME_2}" ETX
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: DBサブネットグループ"postgresql-2017-11-20"が存在しない。
「DBサブネットグループ"postgresql-2017-11-20"が存在しない。」ことを確認します。
コマンド:
aws rds describe-db-subnet-groups \ --query "DBSubnetGroups[?DBSubnetGroupName == \`${RDS_SUBNET_GROUP_NAME}\`].DBSubnetGroupName"
結果(例):
[]
1.2. 主処理に必要な情報の取得¶
変数の設定:
EC2_TAG_KEY='Name'
VPC IDの取得
VPC IDを取得します。
コマンド:
VPC_ID=$( \ aws ec2 describe-vpcs \ --filters Name=tag:${EC2_TAG_KEY},Values=${VPC_TAG_NAME} \ --query 'Vpcs[].VpcId' \ --output text \ ) \ && echo ${VPC_ID}
結果(例):
vpc-xxxxxxxx
サブネット1のサブネットID取得
コマンド:
VPC_SUBNET_ID_1=$( \ aws ec2 describe-subnets \ --filters Name=vpc-id,Values=${VPC_ID} \ --filters Name=tag:${EC2_TAG_KEY},Values=${VPC_SUBNET_TAG_NAME_1} \ --query "Subnets[].SubnetId" \ --output text \ ) \ && echo ${VPC_SUBNET_ID_1}
結果(例):
subnet-xxxxxxxx
サブネット2のサブネットID取得
コマンド:
VPC_SUBNET_ID_2=$( \ aws ec2 describe-subnets \ --filters Name=vpc-id,Values=${VPC_ID} \ --filters Name=tag:${EC2_TAG_KEY},Values=${VPC_SUBNET_TAG_NAME_2} \ --query "Subnets[].SubnetId" \ --output text \ ) \ && echo ${VPC_SUBNET_ID_2}
結果(例):
subnet-yyyyyyyy
サブネットIDの配列化
変数の設定:
ARRAY_VPC_SUBNET_IDS="${VPC_SUBNET_ID_1} ${VPC_SUBNET_ID_2}" \ && echo ${ARRAY_VPC_SUBNET_IDS}
結果(例):
subnet-xxxxxxxx subnet-yyyyyyyy
2. 主処理¶
DBサブネットグループの作成¶
変数の確認:
cat << ETX # RDS_SUBNET_GROUP_NAME:postgresql-2017-11-20 RDS_SUBNET_GROUP_NAME=${RDS_SUBNET_GROUP_NAME} # RDS_SUBNET_GROUP_DESC:"PostgreSQL 2017-11-20" RDS_SUBNET_GROUP_DESC="${RDS_SUBNET_GROUP_DESC}" # ARRAY_VPC_SUBNET_IDS:"subnet-xxxxxxxx subnet-yyyyyyyy" ARRAY_VPC_SUBNET_IDS="${ARRAY_VPC_SUBNET_IDS}" ETX
コマンド:
aws rds create-db-subnet-group \ --db-subnet-group-name ${RDS_SUBNET_GROUP_NAME} \ --db-subnet-group-description "${RDS_SUBNET_GROUP_DESC}" \ --subnet-ids ${ARRAY_VPC_SUBNET_IDS}
結果(例):
{ "DBSubnetGroup": { "Subnets": [ { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-xxxxxxxx", "SubnetAvailabilityZone": { "Name": "ap-northeast-1a" } }, { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-xxxxxxxx", "SubnetAvailabilityZone": { "Name": "ap-northeast-1c" } } ], "VpcId": "vpc-8228f8e6", "DBSubnetGroupDescription": "PostgreSQL 2017-11-20 ", "SubnetGroupStatus": "Complete", "DBSubnetGroupArn": "arn:aws:rds:ap-northeast-1:XXXXXXXXXXXX:subgrp:postgresql-2017-11-20", "DBSubnetGroupName": "postgresql-2017-11-20" } }
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: DBサブネットグループ"postgresql-2017-11-20"が存在する。
「DBサブネットグループ"postgresql-2017-11-20"が存在する。」ことを確認します。
コマンド:
aws rds describe-db-subnet-groups \ --query "DBSubnetGroups[?DBSubnetGroupName == \`${RDS_SUBNET_GROUP_NAME}\`].DBSubnetGroupName"
結果(例):
[ postgresql-2017-11-20 ]