9. セキュリティグループの作成 (webapp-handson-cli-sg)

作業の目的 [why]

VPC"handson-cli-vpc"にセキュリティグループ"webapp-handson-cli-sg"のテンプレートを作成します。

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

完了条件 [after]

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

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

事前条件 [before]

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

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

作業対象 [what]

  • EC2サービス

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: セキュリティグループ名

  • 作成するセキュリティグループの名称です。
  • 今回は"webapp-handson-cli-sg"とします。

リソース2: セキュリティグループの説明

  • 作成するセキュリティグループの説明です。
  • 今回は"for webapp server"とします。

リソース3: リソース名

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

リソース4: VPCのリソース名

  • 作成するセキュリティグループが属するVPCのリソース名称です。
  • 今回は"Vpc"とします。

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

  • 今回は"${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. セキュリティグループ名の指定

セキュリティグループ名を指定します。

変数の設定:

VPC_SG_NAME='webapp-handson-cli-sg'

0.2. セキュリティグループの説明の指定

セキュリティグループの説明を指定します。

変数の設定:

VPC_SG_DESC='for webapp server'

0.3. リソース名の指定

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

変数の設定:

CFN_RESOURCE_NAME='SecurityGroupWebapp'

0.4. VPCのリソース名の指定

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

変数の設定:

CFN_RESOURCE_NAME_VPC='Vpc'

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

変数の設定:

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)-ec2-security_group-stack_cfn.env" \
  && echo ${FILE_PARAMETER}

結果(例):

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

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.1. VPC_SG_NAME:"webapp-handson-cli-sg"
         VPC_SG_NAME="${VPC_SG_NAME}"
  # 0.2. VPC_SG_DESC:"for webapp server"
         VPC_SG_DESC="${VPC_SG_DESC}"
  # 0.3. CFN_RESOURCE_NAME:"SecurityGroupWebapp"
         CFN_RESOURCE_NAME="${CFN_RESOURCE_NAME}"
  # 0.4. CFN_RESOURCE_NAME_VPC:"Vpc"
         CFN_RESOURCE_NAME_VPC="${CFN_RESOURCE_NAME_VPC}"
  # 0.5. 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/SecurityGroupWebapp.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/SecurityGroupWebapp.txt"が存在しない。

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

コマンド:

! ls ${FILE_CFN_RESOURCE}

結果(例):

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

2. 主処理

テンプレートの作成

変数の確認:

cat << ETX

  # FILE_CFN_RESOURCE:"${HOME}/tmp/handson-cli-vpc-cfn/resources/SecurityGroupWebapp.txt"
    FILE_CFN_RESOURCE="${FILE_CFN_RESOURCE}"
  # CFN_RESOURCE_NAME:"SecurityGroupWebapp"
    CFN_RESOURCE_NAME="${CFN_RESOURCE_NAME}"
  # VPC_SG_NAME:"webapp-handson-cli-sg"
    VPC_SG_NAME="${VPC_SG_NAME}"
  # VPC_SG_DESC:"for webapp server"
    VPC_SG_DESC="${VPC_SG_DESC}"
  # CFN_RESOURCE_NAME_VPC:"Vpc"
    CFN_RESOURCE_NAME_VPC="${CFN_RESOURCE_NAME_VPC}"

ETX

コマンド:

cat << EOF > ${FILE_CFN_RESOURCE}
  ${CFN_RESOURCE_NAME}:
    Type: "AWS::EC2::SecurityGroup"
    Properties:
      GroupName: ${VPC_SG_NAME}
      GroupDescription: ${VPC_SG_DESC}
      VpcId: !Ref ${CFN_RESOURCE_NAME_VPC}

EOF

cat ${FILE_CFN_RESOURCE}

結果(例):

SecurityGroupWebapp:
  Type: "AWS::EC2::SecurityGroup"
  Properties:
    GroupName: webapp-handson-cli-sg
    GroupDescription: for webapp server
    VpcId: !Ref Vpc

3. 後処理

完了条件の確認

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

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

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

コマンド:

ls ${FILE_CFN_RESOURCE}

結果(例):

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

完了