11. DBサブネットグループの作成 (handson-cli-dbsubnet)

作業の目的 [why]

DBサブネットグループ"handson-cli-dbsubnet"を作成します。

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

完了条件 [after]

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

完了条件1
リソースファイル"${HOME}/tmp/handson-cli-vpc-cfn/resources/RdsDbSubnet.txt"が存在する。

事前条件 [before]

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

事前条件1
リソースファイル用ディレクトリ"${HOME}/tmp/handson-cli-vpc-cfn/resources"が存在する。
事前条件2
リソースファイル"${HOME}/tmp/handson-cli-vpc-cfn/resources/RdsDbSubnet.txt"が存在しない。

作業対象 [what]

  • RDSサービス

標準時間(合計)

8分

パラメータ設定

パラメータ設定の標準時間:2分

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

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

リソース1: DBサブネットグループ名

  • 作成するDBサブネットグループの名称です。
  • 今回は"handson-cli-dbsubnet"とします。

リソース2: DBサブネットグループの説明

  • 作成するDBサブネットグループの説明です。
  • 今回は"for handson-cli"とします。

リソース3: リソース名

  • 作成するVPCのCloudFormationリソース名です。
  • 今回は"RdsDbSubnet"とします。

リソース4: サブネット1リソース名

  • DBサブネットグループに含めるサブネット1のリソース名称です。
  • 今回は"db-alpha-handson-cli-subnet"とします。

リソース5: サブネット2リソース名

  • DBサブネットグループに含めるサブネット2のリソース名称です。
  • 今回は"db-charlie-handson-cli-subnet"とします。

リソース6: リソースファイル用ディレクトリ

  • 今回は"${HOME}/tmp/handson-cli-vpc-cfn/resources"をCloudFormationリソース用ディレクトリとします。

ディレクトリが存在することを確認します。

コマンド:

ls -d ${HOME}/tmp/handson-cli-vpc-cfn/resources

結果(例:存在する場合):

${HOME}/tmp/handson-cli-vpc-cfn/resources

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

コマンド:

mkdir -p ${HOME}/tmp/handson-cli-vpc-cfn/resources

パラメータの指定

作業に必要なパラメータを変数に格納をします。

0.1. DBサブネットグループ名の指定

DBサブネットグループ名を指定します。

変数の設定:

RDS_SUBNET_GROUP_NAME='handson-cli-dbsubnet'

0.2. DBサブネットグループの説明の指定

DBサブネットグループの説明を指定します。

変数の設定:

RDS_SUBNET_GROUP_DESC='for handson-cli'

0.3. リソース名の指定

CloudFormationのリソース名を指定します。

変数の設定:

CFN_RESOURCE_NAME='RdsDbSubnet'

0.4. サブネット1の指定

サブネット1のリソース名を指定します。

変数の設定:

CFN_RESOURCE_NAME_SUBNET_1='SubnetDb0'

0.5. サブネット2の指定

サブネット2のリソース名を指定します。

変数の設定:

CFN_RESOURCE_NAME_SUBNET_2='SubnetDb1'

0.6. リソースファイル用ディレクトリの指定

変数の設定:

DIR_CFN_RESOURCE="${HOME}/tmp/handson-cli-vpc-cfn/resources"

パラメータの保存

設定されている変数の保存先となるファイル名を指定します。

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-rds-db_subnet_group-stack_cfn.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-rds-db_subnet_group-stack_cfn.env

各変数に正しいパラメータ値が格納されていることを確認しながら保存します。

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 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. CFN_RESOURCE_NAME:"RdsDbSubnet"
         CFN_RESOURCE_NAME="${CFN_RESOURCE_NAME}"
  # 0.4. CFN_RESOURCE_NAME_SUBNET_1:"SubnetDb0"
         CFN_RESOURCE_NAME_SUBNET_1="${CFN_RESOURCE_NAME_SUBNET_1}"
  # 0.5. CFN_RESOURCE_NAME_SUBNET_2:"SubnetDb1"
         CFN_RESOURCE_NAME_SUBNET_2="${CFN_RESOURCE_NAME_SUBNET_2}"
  # 0.6. DIR_CFN_RESOURCE:"${HOME}/tmp/handson-cli-vpc-cfn/resources"
         DIR_CFN_RESOURCE="${DIR_CFN_RESOURCE}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

課題

(未検証)

タスク標準時間:6分

1. 前処理

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

リソースファイル名の指定

変数の設定:

FILE_CFN_RESOURCE="${DIR_CFN_RESOURCE}/${CFN_RESOURCE_NAME}.txt" \
  && echo ${FILE_CFN_RESOURCE}

結果(例):

${HOME}/tmp/handson-cli-vpc-cfn/resources/RdsDbSubnet.txt

1.2. 処理対象の状態確認

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

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

事前条件1: リソースファイル用ディレクトリ"${HOME}/tmp/handson-cli-vpc-cfn/resources"が存在する。

「リソースファイル用ディレクトリ"${HOME}/tmp/handson-cli-vpc-cfn/resources"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_CFN_RESOURCE}

結果(例):

${HOME}/tmp/handson-cli-vpc-cfn/resources

事前条件2: リソースファイル"${HOME}/tmp/handson-cli-vpc-cfn/resources/RdsDbSubnet.txt"が存在しない。

「リソースファイル"${HOME}/tmp/handson-cli-vpc-cfn/resources/RdsDbSubnet.txt"が存在しない。」ことを確認します。

コマンド:

! ls ${FILE_CFN_RESOURCE}

結果(例):

ls: ${HOME}/tmp/handson-cli-vpc-cfn/resources/RdsDbSubnet.txt No such file or directory

2. 主処理

DBサブネットグループの作成

変数の確認:

cat << ETX

  # FILE_CFN_RESOURCE:"${HOME}/tmp/handson-cli-vpc-cfn/resources/RdsDbSubnet.txt"
    FILE_CFN_RESOURCE="${FILE_CFN_RESOURCE}"
  # CFN_RESOURCE_NAME:"RdsDbSubnet"
    CFN_RESOURCE_NAME="${CFN_RESOURCE_NAME}"
  # 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}"
  # CFN_RESOURCE_NAME_SUBNET_1:"SubnetDb0"
    CFN_RESOURCE_NAME_SUBNET_1="${CFN_RESOURCE_NAME_SUBNET_1}"
  # CFN_RESOURCE_NAME_SUBNET_2:"SubnetDb1"
    CFN_RESOURCE_NAME_SUBNET_2="${CFN_RESOURCE_NAME_SUBNET_2}"

ETX

コマンド:

cat << EOF > ${FILE_CFN_RESOURCE}
  ${CFN_RESOURCE_NAME}:
    Type: "AWS::RDS::DBSubnetGroup"
    Properties: 
      DBSubnetGroupName: ${RDS_SUBNET_GROUP_NAME}
      DBSubnetGroupDescription: ${RDS_SUBNET_GROUP_DESC}
      SubnetIds:
        - !Ref ${CFN_RESOURCE_NAME_SUBNET_1}
        - !Ref ${CFN_RESOURCE_NAME_SUBNET_2}

EOF
cat ${FILE_CFN_RESOURCE}

結果(例):

RdsDbSubnet:
  Type: "AWS::RDS::DBSubnetGroup"
  Properties:
    DBSubnetGroupName: handson-cli-dbsubnet
    DBSubnetGroupDescription: for handson-cli
    SubnetIds:
      - !Ref SubnetDb0
      - !Ref SubnetDb1

3. 後処理

完了条件の確認

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

完了条件1: リソースファイル"${HOME}/tmp/handson-cli-vpc-cfn/resources/RdsDbSubnet.txt"が存在する。

「リソースファイル"${HOME}/tmp/handson-cli-vpc-cfn/resources/RdsDbSubnet.txt"が存在する。」ことを確認します。

コマンド:

ls ${FILE_CFN_RESOURCE}

結果(例):

${HOME}/tmp/handson-cli-vpc-cfn/resources/RdsDbSubnet.txt

完了