11. DBサブネットグループの作成 (handson-cli-dbsubnet)¶
作業の目的 [why]¶
DBサブネットグループ"handson-cli-dbsubnet"を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- DBサブネットグループ"handson-cli-dbsubnet"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- DBサブネットグループ"handson-cli-dbsubnet"が存在しない。
- 事前条件2
- VPC"handson-cli-vpc"が存在する。
- 事前条件3
- VPC"handson-cli-vpc"にサブネット"db-alpha-handson-cli-subnet"が存在する。
- 事前条件4
- VPC"handson-cli-vpc"にサブネット"db-charlie-handson-cli-subnet"が存在する。
前提と異なることが判明した場合、直ちに処理を中止します。
作業対象 [what]¶
- RDSサービス
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: DBサブネットグループ名
- 作成するDBサブネットグループの名称です。
- 今回は"handson-cli-dbsubnet"とします。
リソース2: DBサブネットグループの説明
- 作成するDBサブネットグループの説明です。
- 今回は"for handson-cli"とします。
リソース3: VPC名
- DBサブネットグループを作成するVPCの名称です。
- 今回は"handson-cli-vpc"とします。
リソース4: サブネット1名
- DBサブネットグループに含めるサブネット1の名称です。
- 今回は"db-alpha-handson-cli-subnet"とします。
リソース5: サブネット2名
- DBサブネットグループに含めるサブネット2の名称です。
- 今回は"db-charlie-handson-cli-subnet"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-rds-db_subnet_group-create.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-rds-db_subnet_group-create.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"us-west-2" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. RDS_SUBNET_GROUP_NAME:"handson-cli-dbsubnet" RDS_SUBNET_GROUP_NAME="${RDS_SUBNET_GROUP_NAME}" # 0.2. RDS_SUBNET_GROUP_DESC:"for handson-cli" RDS_SUBNET_GROUP_DESC="${RDS_SUBNET_GROUP_DESC}" # 0.3. VPC_TAG_NAME:"handson-cli-vpc" VPC_TAG_NAME="${VPC_TAG_NAME}" # 0.4. VPC_SUBNET_TAG_NAME_1:"db-alpha-handson-cli-subnet" VPC_SUBNET_TAG_NAME_1="${VPC_SUBNET_TAG_NAME_1}" # 0.5. VPC_SUBNET_TAG_NAME_2:"db-charlie-handson-cli-subnet" VPC_SUBNET_TAG_NAME_2="${VPC_SUBNET_TAG_NAME_2}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: DBサブネットグループ"handson-cli-dbsubnet"が存在しない。
「DBサブネットグループ"handson-cli-dbsubnet"が存在しない。」ことを確認します。
コマンド:
aws rds describe-db-subnet-groups \ --query "DBSubnetGroups[?DBSubnetGroupName == \`${RDS_SUBNET_GROUP_NAME}\`].DBSubnetGroupName" \ --output text
結果(例):
(出力なし)
事前条件2: VPC"handson-cli-vpc"が存在する。
「VPC"handson-cli-vpc"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-vpcs \ --filters Name=tag:Name,Values=${VPC_TAG_NAME} \ --query 'Vpcs[].Tags[?Key == `Name`].Value' \ --output text
結果(例):
handson-cli-vpc
VPC IDを取得します。
コマンド:
VPC_ID=$( \ aws ec2 describe-vpcs \ --filters Name=tag:Name,Values=${VPC_TAG_NAME} \ --query 'Vpcs[].VpcId' \ --output text \ ) \ && echo ${VPC_ID}
結果(例):
vpc-xxxxxxxxxxxxxxxxx
事前条件3: VPC"handson-cli-vpc"にサブネット"db-alpha-handson-cli-subnet"が存在する。
「VPC"handson-cli-vpc"にサブネット"db-alpha-handson-cli-subnet"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-subnets \ --filters Name=vpc-id,Values=${VPC_ID} \ Name=tag:Name,Values=${VPC_SUBNET_TAG_NAME_1} \ --query 'Subnets[].Tags[?Key == `Name`].Value' \ --output text
結果(例):
db-alpha-handson-cli-subnet
事前条件4: VPC"handson-cli-vpc"にサブネット"db-charlie-handson-cli-subnet"が存在する。
「VPC"handson-cli-vpc"にサブネット"db-charlie-handson-cli-subnet"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-subnets \ --filters Name=vpc-id,Values=${VPC_ID} \ Name=tag:Name,Values=${VPC_SUBNET_TAG_NAME_2} \ --query 'Subnets[].Tags[?Key == `Name`].Value' \ --output text
結果(例):
db-charlie-handson-cli-subnet
1.2. 主処理に必要な情報の取得¶
サブネット1のサブネットID取得
コマンド:
VPC_SUBNET_ID_1=$( \ aws ec2 describe-subnets \ --filters Name=vpc-id,Values=${VPC_ID} \ --filters Name=tag:Name,Values=${VPC_SUBNET_TAG_NAME_1} \ --query "Subnets[].SubnetId" \ --output text \ ) \ && echo ${VPC_SUBNET_ID_1}
結果(例):
subnet-xxxxxxxxxxxxxxxxx
サブネット2のサブネットID取得
コマンド:
VPC_SUBNET_ID_2=$( \ aws ec2 describe-subnets \ --filters Name=vpc-id,Values=${VPC_ID} \ --filters Name=tag:Name,Values=${VPC_SUBNET_TAG_NAME_2} \ --query "Subnets[].SubnetId" \ --output text \ ) \ && echo ${VPC_SUBNET_ID_2}
結果(例):
subnet-yyyyyyyyyyyyyyyyy
サブネットIDの配列化
変数の設定:
ARRAY_VPC_SUBNET_IDS="${VPC_SUBNET_ID_1} ${VPC_SUBNET_ID_2}" \ && echo ${ARRAY_VPC_SUBNET_IDS}
結果(例):
subnet-xxxxxxxxxxxxxxxxx subnet-yyyyyyyyyyyyyyyyy
2. 主処理¶
DBサブネットグループの作成¶
変数の確認:
cat << ETX # RDS_SUBNET_GROUP_NAME:"handson-cli-dbsubnet" RDS_SUBNET_GROUP_NAME="${RDS_SUBNET_GROUP_NAME}" # RDS_SUBNET_GROUP_DESC:"for handson-cli" RDS_SUBNET_GROUP_DESC="${RDS_SUBNET_GROUP_DESC}" # ARRAY_VPC_SUBNET_IDS:"subnet-xxxxxxxxxxxxxxxxx subnet-yyyyyyyyyyyyyyyyy" 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": "us-west-2a" } }, { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-xxxxxxxx", "SubnetAvailabilityZone": { "Name": "us-west-2c" } } ], "VpcId": "vpc-8228f8e6", "DBSubnetGroupDescription": "for handson-cli ", "SubnetGroupStatus": "Complete", "DBSubnetGroupArn": "arn:aws:rds:us-west-2:XXXXXXXXXXXX:subgrp:handson-cli-dbsubnet", "DBSubnetGroupName": "handson-cli-dbsubnet" } }
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: DBサブネットグループ"handson-cli-dbsubnet"が存在する。
「DBサブネットグループ"handson-cli-dbsubnet"が存在する。」ことを確認します。
コマンド:
aws rds describe-db-subnet-groups \ --query "DBSubnetGroups[?DBSubnetGroupName == \`${RDS_SUBNET_GROUP_NAME}\`].DBSubnetGroupName" \ --output text
結果(例):
handson-cli-dbsubnet