2.1. DBインスタンスの作成 (PostgreSQL: handson-rds-dbinstance)¶
作業の目的 [why]¶
DBインスタンス"handson-rds-dbinstance"を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- DBインスタンス"handson-rds-dbinstance"が存在する。
- 完了条件2
- DBインスタンス"handson-rds-dbinstance"がSingleAZで動作している。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- DBインスタンス"handson-rds-dbinstance"が存在しない。
- 事前条件2
- DBサブネットグループ"handson-rds-dbsubnet"が存在する。
- 事前条件3
- VPC"handson-rds-vpc"が存在する。
- 事前条件4
- VPC"handson-rds-vpc"にセキュリティグループ"handson-rds-db-sg"が存在する。
作業対象 [what]¶
- RDSサービス
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: DBインスタンス名
- 作成するDBインスタンスの名称です。
- 今回は"handson-rds-dbinstance"とします。
リソース2: VPC名
- DBサブネットグループに属するサブネット、セキュリティグループの存在するVPCの名称です。
- 今回は"handson-rds-vpc"とします。
リソース3: DBサブネットグループ名
- 作成するDBサブネットグループの名称です。
- 今回は"handson-rds-dbsubnet"とします。
リソース4: セキュリティーグループ名
- 作成するDBインスタンスが利用するセキュリティーグループの名称です。
- 今回は"handson-rds-db-sg"とします。
リソース5: DBエンジンの決定
- 作成するDBインスタンスが利用するの名称です。
- 今回は"postgres"とします。
リソース6: DBインスタンスクラス
- 作成するインスタンスが利用するインスタンスのクラス名です。
- 今回は"db.t2.micro"とします。
リソース7: ストレージサイズ
- 作成するDBインスタンスが利用するストレージのサイズです。
- 今回は"5"とします。
リソース8: マスタユーザ名
- インスタンスに作成するマスタユーザの名称です。
- 今回は"pgadmin"とします。
リソース9: マスタパスワード
- インスタンスに作成するマスタユーザのパスワードです。
- 今回は"#dbPass123"とします。
リソース10: データベース名
- インスタンスに作成するデフォルトデータベースの名称です。
- 今回は"handsonCLI"とします。
- データベース名には、英数字のみが利用できます。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-rds" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-rds-db_instance_postgresql-create.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-rds/2019-06-10-rds-db_instance_postgresql-create.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. RDS_INSTANCE_IDENT:"handson-rds-dbinstance" RDS_INSTANCE_IDENT="${RDS_INSTANCE_IDENT}" # 0.2. VPC_TAG_NAME:"handson-rds-vpc" VPC_TAG_NAME="${VPC_TAG_NAME}" # 0.3. RDS_SUBNET_GROUP_NAME:"handson-rds-dbsubnet" RDS_SUBNET_GROUP_NAME="${RDS_SUBNET_GROUP_NAME}" # 0.4. VPC_SG_NAME:"handson-rds-db-sg" VPC_SG_NAME="${VPC_SG_NAME}" # 0.5. RDS_ENGINE_NAME:"postgres" RDS_ENGINE_NAME="${RDS_ENGINE_NAME}" # 0.6. RDS_INSTANCE_CLASS:"db.t2.micro" RDS_INSTANCE_CLASS="${RDS_INSTANCE_CLASS}" # 0.7. RDS_STORAGE_SIZE:"5" RDS_STORAGE_SIZE="${RDS_STORAGE_SIZE}" # 0.8. RDS_USER_NAME:"pgadmin" RDS_USER_NAME="${RDS_USER_NAME}" # 0.9. RDS_USER_PASS:"#dbPass123" RDS_USER_PASS="${RDS_USER_PASS}" # 0.10. RDS_DB_NAME:"handsonCLI" RDS_DB_NAME="${RDS_DB_NAME}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: DBインスタンス"handson-rds-dbinstance"が存在しない。
「DBインスタンス"handson-rds-dbinstance"が存在しない。」ことを確認します。
コマンド:
aws rds describe-db-instances \ --query "DBInstances[?DBInstanceIdentifier == \`${RDS_INSTANCE_IDENT}\`].DBInstanceIdentifier" \ --output text
結果(例):
(出力なし)
事前条件2: DBサブネットグループ"handson-rds-dbsubnet"が存在する。
「DBサブネットグループ"handson-rds-dbsubnet"が存在する。」ことを確認します。
コマンド:
aws rds describe-db-subnet-groups \ --query "DBSubnetGroups[?DBSubnetGroupName == \`${RDS_SUBNET_GROUP_NAME}\`].DBSubnetGroupName" \ --output text
結果(例):
handson-rds-dbsubnet
事前条件3: VPC"handson-rds-vpc"が存在する。
「VPC"handson-rds-vpc"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-vpcs \ --filters Name=tag:Name,Values=${VPC_TAG_NAME} \ --query 'Vpcs[].Tags[?Key == `Name`].Value' \ --output text
結果(例):
handson-rds-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
事前条件4: VPC"handson-rds-vpc"にセキュリティグループ"handson-rds-db-sg"が存在する。
「VPC"handson-rds-vpc"にセキュリティグループ"handson-rds-db-sg"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-security-groups \ --filter Name=vpc-id,Values=${VPC_ID} \ Name=group-name,Values=${VPC_SG_NAME} \ --query 'SecurityGroups[].GroupName' \ --output text
結果(例):
handson-rds-db-sg
1.2. 主処理に必要な情報の取得¶
セキュリティグループIDの取得
セキュリティグループIDを取得します。
コマンド:
VPC_SG_ID=$( \ aws ec2 describe-security-groups \ --filter Name=vpc-id,Values=${VPC_ID} \ Name=group-name,Values=${VPC_SG_NAME} \ --query "SecurityGroups[].GroupId" \ --output text \ ) \ && echo ${VPC_SG_ID}
結果(例):
sg-xxxxxxxxxxxxxxxxx
セキュリティグループの配列への追加
変数の設定:
ARRAY_VPC_SG_IDS="${VPC_SG_ID}" \ && echo ${ARRAY_VPC_SG_IDS}
結果(例):
sg-xxxxxxxxxxxxxxxxx
2. 主処理¶
DBインスタンスの作成¶
変数の確認:
cat << ETX # RDS_INSTANCE_IDENT:"handson-rds-dbinstance" RDS_INSTANCE_IDENT="${RDS_INSTANCE_IDENT}" # RDS_INSTANCE_CLASS:"db.t2.micro" RDS_INSTANCE_CLASS="${RDS_INSTANCE_CLASS}" # RDS_ENGINE_NAME:"postgres" RDS_ENGINE_NAME="${RDS_ENGINE_NAME}" # RDS_DB_NAME:"handsonCLI" RDS_DB_NAME="${RDS_DB_NAME}" # RDS_STORAGE_SIZE:"5" RDS_STORAGE_SIZE="${RDS_STORAGE_SIZE}" # RDS_USER_NAME:"pgadmin" RDS_USER_NAME="${RDS_USER_NAME}" # RDS_USER_PASS:"#dbPass123" RDS_USER_PASS="${RDS_USER_PASS}" # RDS_SUBNET_GROUP_NAME:"handson-rds-dbsubnet" RDS_SUBNET_GROUP_NAME="${RDS_SUBNET_GROUP_NAME}" # ARRAY_VPC_SG_IDS:"sg-xxxxxxxxxxxxxxxxx" ARRAY_VPC_SG_IDS="${ARRAY_VPC_SG_IDS}" ETX
コマンド:
aws rds create-db-instance \ --db-instance-identifier ${RDS_INSTANCE_IDENT} \ --db-instance-class ${RDS_INSTANCE_CLASS} \ --engine ${RDS_ENGINE_NAME} \ --db-name ${RDS_DB_NAME} \ --allocated-storage ${RDS_STORAGE_SIZE} \ --master-username ${RDS_USER_NAME} \ --master-user-password ${RDS_USER_PASS} \ --db-subnet-group-name ${RDS_SUBNET_GROUP_NAME} \ --vpc-security-group-ids ${ARRAY_VPC_SG_IDS}
結果(例):
{ "DBInstance": { "PubliclyAccessible": false, "MasterUsername": "pgadmin", "MonitoringInterval": 0, "LicenseModel": "postgresql-license", "VpcSecurityGroups": [ { "Status": "active", "VpcSecurityGroupId": "sg-xxxxxxxx" } ], "CopyTagsToSnapshot": false, "OptionGroupMemberships": [ { "Status": "in-sync", "OptionGroupName": "default:postgres-9-5" } ], "PendingModifiedValues": { "MasterUserPassword": "****" }, "Engine": "postgres", "MultiAZ": false, "DBSecurityGroups": [], "DBParameterGroups": [ { "DBParameterGroupName": "default.postgres9.5", "ParameterApplyStatus": "in-sync" } ], "AutoMinorVersionUpgrade": true, "PreferredBackupWindow": "19:06-19:36", "DBSubnetGroup": { "Subnets": [ { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-xxxxxxxx", "SubnetAvailabilityZone": { "Name": "ap-northeast-1a" } }, { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-xxxxxxxx", "SubnetAvailabilityZone": { "Name": "ap-northeast-1c" } } ], "DBSubnetGroupName": "handson-rds-dbsubnet", "VpcId": "vpc-xxxxxxxx", "DBSubnetGroupDescription": "PostgreSQL Redmine", "SubnetGroupStatus": "Complete" }, "ReadReplicaDBInstanceIdentifiers": [], "AllocatedStorage": 5, "DBInstanceArn": "arn:aws:rds:ap-northeast-1:XXXXXXXXXXXX:db:handson-rds-dbinstance", "BackupRetentionPeriod": 1, "DBName": "handsonCLI", "PreferredMaintenanceWindow": "tue:13:00-tue:13:30", "DBInstanceStatus": "creating", "EngineVersion": "9.5.4", "DomainMemberships": [], "StorageType": "standard", "DbiResourceId": "db-7ZOMGTEKHCZNLIFRXB3TOTR2XQ", "CACertificateIdentifier": "rds-ca-2015", "StorageEncrypted": false, "DBInstanceClass": "db.t2.micro", "DbInstancePort": 0, "DBInstanceIdentifier": "handson-rds-dbinstance" } }
3. 後処理¶
3.1. 状態確認に必要な情報の取得¶
DBインスタンスの状態確認
コマンド:
RDS_INSTANCE_STATUS=$( \ aws rds describe-db-instances \ --db-instance-identifier ${RDS_INSTANCE_IDENT} \ --query 'DBInstances[].DBInstanceStatus' \ --output text \ ) \ && echo ${RDS_INSTANCE_STATUS}
結果(例):
available
注釈
creating -> backing-up -> availableになるまで、db.t2.microで7分程度かかります。
3.2. 完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: DBインスタンス"handson-rds-dbinstance"が存在する。
「DBインスタンス"handson-rds-dbinstance"が存在する。」ことを確認します。
コマンド:
aws rds describe-db-instances \ --query "DBInstances[?DBInstanceIdentifier == \`${RDS_INSTANCE_IDENT}\`].DBInstanceIdentifier" \ --output text
結果(例):
handson-rds-dbinstance
完了条件2: DBインスタンス"handson-rds-dbinstance"がSingleAZで動作している。
「DBインスタンス"handson-rds-dbinstance"がSingleAZで動作している。」ことを確認します。
コマンド:
aws rds describe-db-instances \ --db-instance-identifier ${RDS_INSTANCE_IDENT} \ --query 'DBInstances[].MultiAZ' \ --output text
結果(例):
False