1.1. Route53 リソースレコードセットの削除 (Alias: ELB)

作業の目的 [why]

Route53ゾーン"<ドメイン名>"から、ロードバランサ"handson-cli-webapp-stateless-alb"へのエイリアスレコード"handson-cli-stateless.<ドメイン名>."を削除します。

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

完了条件 [after]

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

完了条件1
Route53ゾーン"<ドメイン名>"に、ロードバランサ"handson-cli-webapp-stateless-alb"へのエイリアスレコード"handson-cli-stateless.<ドメイン名>."が存在しない。

事前条件 [before]

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

事前条件1
リソースレコードセットファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli-webapp-stateless"が存在する。
事前条件2
ロードバランサ"handson-cli-webapp-stateless-alb"が存在する。
事前条件3
ドメイン(FQDN)名"<ドメイン名>."のRoute53ゾーンが存在する。
事前条件4
Route53ゾーン"<ドメイン名>"に、ロードバランサ"handson-cli-webapp-stateless-alb"へのエイリアスレコード"handson-cli-stateless.<ドメイン名>."が存在する。

作業対象 [what]

  • Route53リソースレコードセット

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: リソースレコードセットファイル用ディレクトリ

  • 今回は"${HOME}/tmp/conf-handson-cli-webapp-stateless"をリソースレコードセットファイル用ディレクトリとします。

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

コマンド:

ls -d ${HOME}/tmp/conf-handson-cli-webapp-stateless

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

${HOME}/tmp/conf-handson-cli-webapp-stateless

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

コマンド:

mkdir -p ${HOME}/tmp/conf-handson-cli-webapp-stateless

リソース2: Route53アクション名

  • レコードを登録するRoute53アクションの名称です。
  • 今回は"DELETE"とします。

リソース3: リソースレコードのTTL

  • 登録するリソースレコードのTTLです。
  • 今回は"300"とします。

リソース4: ドメイン名

  • レコードを登録するドメイン名です。
  • 今回は"<ドメイン名>"とします。

リソース5: ホスト名

  • 登録するAレコードのホスト名です。
  • "ホスト名" + "ドメイン名" + "."のうちの"ホスト名"部分です。
  • ここでは"handson-cli-stateless"とします。

リソース6: エイリアス先のロードバランサ名

  • エイリアスの対象となるロードバランサ名です。
  • 今回は"handson-cli-webapp-stateless-alb"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. リソースレコードセットファイルディレクトリの指定

変数の設定:

DIR_ROUTE53_RRSET_DOC="${HOME}/tmp/conf-handson-cli-webapp-stateless"

0.2. Route53アクションの指定

変数の設定:

ROUTE53_RRSET_ACTION='DELETE'

0.3. TTLの指定

TTLは必須項目になっています。

変数の設定:

ROUTE53_RRSET_TTL='300'

0.4. ドメイン名の指定

ドメイン名を指定します。

変数の設定:

DOMAIN_NAME='<ドメイン名>'

0.5. ホスト名の指定

ホスト名を指定します。

変数の設定:

HOST_NAME='handson-cli-stateless'

0.6. ロードバランサ名の指定

ロードバランサ名を指定します。

変数の設定:

ELBV2_LB_NAME='handson-cli-webapp-stateless-alb'

パラメータの保存

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-webapp-stateless"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-route53-resource_record_set-delete-expand-alias-elb.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli-webapp-stateless/2019-05-19-route53-resource_record_set-delete-expand-alias-elb.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. DIR_ROUTE53_RRSET_DOC:"${HOME}/tmp/conf-handson-cli-webapp-stateless"
         DIR_ROUTE53_RRSET_DOC="${DIR_ROUTE53_RRSET_DOC}"
  # 0.2. ROUTE53_RRSET_ACTION:"DELETE"
         ROUTE53_RRSET_ACTION="${ROUTE53_RRSET_ACTION}"
  # 0.3. ROUTE53_RRSET_TTL:"300"
         ROUTE53_RRSET_TTL="${ROUTE53_RRSET_TTL}"
  # 0.4. DOMAIN_NAME:"<ドメイン名>"
         DOMAIN_NAME="${DOMAIN_NAME}"
  # 0.5. HOST_NAME:"handson-cli-stateless"
         HOST_NAME="${HOST_NAME}"
  # 0.6. ELBV2_LB_NAME:"handson-cli-webapp-stateless-alb"
         ELBV2_LB_NAME="${ELBV2_LB_NAME}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

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

ドメイン名のFQDNへの変換

ドメイン名をFQDN形式に変換します。

変数の設定:

DOMAIN_NAME_FQDN="${DOMAIN_NAME}." \
  && echo ${DOMAIN_NAME_FQDN}

結果(例):

<ドメイン名>.

リソースレコード名への変換

ドメイン名を、"FQDN名"形式に変換します。

変数の設定:

ROUTE53_RRSET_NAME="${HOST_NAME}.${DOMAIN_NAME}." \
  && echo ${ROUTE53_RRSET_NAME}

結果(例):

handson-cli-stateless.<ドメイン名>.

1.2. 処理対象の状態確認

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

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

事前条件1: リソースレコードセットファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli-webapp-stateless"が存在する。

「リソースレコードセットファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli-webapp-stateless"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_ROUTE53_RRSET_DOC}

結果(例):

${HOME}/tmp/conf-handson-cli-webapp-stateless

事前条件2: ロードバランサ"handson-cli-webapp-stateless-alb"が存在する。

「ロードバランサ"handson-cli-webapp-stateless-alb"が存在する。」ことを確認します。

コマンド:

aws elbv2 describe-load-balancers \
  --name ${ELBV2_LB_NAME} \
  --query 'LoadBalancers[].LoadBalancerName' \
  --output text

結果(例):

handson-cli-webapp-stateless-alb

事前条件3: ドメイン(FQDN)名"<ドメイン名>."のRoute53ゾーンが存在する。

「ドメイン(FQDN)名"<ドメイン名>."のRoute53ゾーンが存在する。」ことを確認します。

コマンド:

aws route53 list-hosted-zones-by-name \
  --dns-name ${DOMAIN_NAME_FQDN} \
  --query "HostedZones[?Name == \`${DOMAIN_NAME_FQDN}\`].Name" \
  --output text

結果(例):

<ドメイン名>.

ゾーンIDを取得します。

コマンド:

ROUTE53_ZONE_ID=$( \
  aws route53 list-hosted-zones-by-name \
    --dns-name ${DOMAIN_NAME_FQDN} \
    --query "HostedZones[?Name == \`${DOMAIN_NAME_FQDN}\`].Id" \
    --output text \
  | sed 's/\/hostedzone\///' \
) \
  && echo ${ROUTE53_ZONE_ID}

結果(例):

ZXXXXXXXXXXXXX

事前条件4: Route53ゾーン"<ドメイン名>"に、ロードバランサ"handson-cli-webapp-stateless-alb"へのエイリアスレコード"handson-cli-stateless.<ドメイン名>."が存在する。

「Route53ゾーン"<ドメイン名>"に、ロードバランサ"handson-cli-webapp-stateless-alb"へのエイリアスレコード"handson-cli-stateless.<ドメイン名>."が存在する。」ことを確認します。

コマンド:

aws route53 list-resource-record-sets \
  --hosted-zone-id /hostedzone/${ROUTE53_ZONE_ID} \
  --query "ResourceRecordSets[?Type == \`A\` \
    && Name == \`${ROUTE53_RRSET_NAME}\`].Name" \
  --output text

結果(例):

handson-cli-stateless.<ドメイン名>.

1.3. 主処理に必要な情報の取得

ロードバランサのDNS名の取得

コマンド:

ELBV2_LB_DNS_NAME=$( \
  aws elbv2 describe-load-balancers \
    --name ${ELBV2_LB_NAME} \
    --query 'LoadBalancers[].DNSName' \
    --output text \
) \
  && echo ${ELBV2_LB_DNS_NAME}

結果(例):

handson-cli-webapp-stateless-alb-xxxxxxxxxxxxxxxx.ap-northeast-1.elb.amazonaws.com

ロードバランサのホストゾーンID取得

ALBのHosted Zone IDを取得します。

コマンド:

ELBV2_LB_ZONE_ID=$( \
  aws elbv2 describe-load-balancers \
    --name ${ELBV2_LB_NAME} \
    --query 'LoadBalancers[].CanonicalHostedZoneId' \
    --output text \
) \
  && echo ${ELBV2_LB_ZONE_ID}

結果(例):

Z14GRHDCWA56QT

リソースレコードセット設定ファイルの作成

変数の設定:

FILE_ROUTE53_RRSET_DOC="${DIR_ROUTE53_RRSET_DOC}/$(date +%Y-%m-%d)-${ROUTE53_RRSET_NAME}-alias_elb-${ROUTE53_RRSET_ACTION}.json" \
  && echo ${FILE_ROUTE53_RRSET_DOC}

結果(例):

${HOME}/tmp/conf-handson-cli-webapp-stateless/2019-05-19-handson-cli-stateless.<ドメイン名>.-alias_elb-DELETE.json

変数の確認:

cat << ETX

  # FILE_ROUTE53_RRSET_DOC:"${HOME}/tmp/conf-handson-cli-webapp-stateless/2019-05-19-handson-cli-stateless.<ドメイン名>.-alias_elb-DELETE.json"
    FILE_ROUTE53_RRSET_DOC="${FILE_ROUTE53_RRSET_DOC}"
  # ROUTE53_RRSET_ACTION:"DELETE"
    ROUTE53_RRSET_ACTION="${ROUTE53_RRSET_ACTION}"
  # ROUTE53_RRSET_NAME:"handson-cli-stateless.<ドメイン名>."
    ROUTE53_RRSET_NAME="${ROUTE53_RRSET_NAME}"
  # ELBV2_LB_DNS_NAME:"handson-cli-webapp-stateless-alb-xxxxxxxxx.ap-northeast-1.elb.amazonaws.com"
    ELBV2_LB_DNS_NAME="${ELBV2_LB_DNS_NAME}"
  # ELBV2_LB_ZONE_ID:"Z14GRHDCWA56QT"
    ELBV2_LB_ZONE_ID="${ELBV2_LB_ZONE_ID}"

ETX

コマンド:

cat << EOF > ${FILE_ROUTE53_RRSET_DOC}
{
  "Changes": [
    {
      "Action": "${ROUTE53_RRSET_ACTION}",
      "ResourceRecordSet": {
        "Name": "${ROUTE53_RRSET_NAME}",
        "Type": "A",
        "AliasTarget": {
          "HostedZoneId": "${ELBV2_LB_ZONE_ID}",
          "DNSName": "${ELBV2_LB_DNS_NAME}",
          "EvaluateTargetHealth": false
        }
      }
    }
  ]
}
EOF

cat ${FILE_ROUTE53_RRSET_DOC}

JSONファイルを作成したら、フォーマットが壊れてないか必ず確認します。

エラーが出力されなければOKです。

コマンド:

jsonlint -q ${FILE_ROUTE53_RRSET_DOC}

結果(例):

(出力なし)

出力ファイル名の指定

変数の設定:

FILE_ROUTE53_RRSET_OUTPUT="${DIR_ROUTE53_RRSET_DOC}/$(date +%Y-%m-%d)-${ROUTE53_RRSET_NAME}-alias_s3-${ROUTE53_RRSET_ACTION}-output.json" \
  && echo ${FILE_ROUTE53_RRSET_OUTPUT}

結果(例):

${HOME}/tmp/conf-handson-cli-webapp-stateless/2019-05-19-handson-cli-stateless.<ドメイン名>.-alias_elb-DELETE-output.json

2. 主処理

リソースレコードセットの変更

変数の確認:

cat << ETX

  # ROUTE53_ZONE_ID:"ZXXXXXXXXXXXXX"
    ROUTE53_ZONE_ID="${ROUTE53_ZONE_ID}"
  # FILE_ROUTE53_RRSET_DOC:"${HOME}/tmp/conf-handson-cli-webapp-stateless/2019-05-19-handson-cli-stateless.<ドメイン名>.-alias_elb-DELETE.json"
    FILE_ROUTE53_RRSET_DOC="${FILE_ROUTE53_RRSET_DOC}"
  # FILE_ROUTE53_RRSET_OUTPUT:"${HOME}/tmp/conf-handson-cli-webapp-stateless/2019-05-19-handson-cli-stateless.<ドメイン名>.-alias_elb-DELETE-output.json"
    FILE_ROUTE53_RRSET_OUTPUT="${FILE_ROUTE53_RRSET_OUTPUT}"

ETX

コマンド:

aws route53 change-resource-record-sets \
  --hosted-zone-id ${ROUTE53_ZONE_ID} \
  --change-batch file://${FILE_ROUTE53_RRSET_DOC} \
  > ${FILE_ROUTE53_RRSET_OUTPUT} \
    && cat ${FILE_ROUTE53_RRSET_OUTPUT}

結果(例):

{
  "ChangeInfo": {
    "Status": "PENDING",
    "SubmittedAt": "2019-05-19T01:23:45.678Z",
    "Id": "/change/C1LBXXXXXXXXXX"
  }
}

3. 後処理

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

Change IDの取得

Change IDを取得します。

コマンド:

ROUTE53_CHANGE_ID=$( \
  cat ${FILE_ROUTE53_RRSET_OUTPUT} \
    | jp.py 'ChangeInfo.Id' \
    | sed 's/\"//g' \
) \
  && echo ${ROUTE53_CHANGE_ID}

結果(例):

/change/C1LBXXXXXXXXXX

ステータスの確認

ステータスを確認します。

コマンド:

ROUTE53_CHANGE_STATUS=$( \
  aws route53 get-change \
    --id ${ROUTE53_CHANGE_ID} \
    --query 'ChangeInfo.Status' \
    --output text \
) \
  && echo ${ROUTE53_CHANGE_STATUS}

結果(例):

INSYNC

ステータスがINSYNCになれば設定変更が完了しています。 (1分程度かかります。)

3.2. 完了条件の確認

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

完了条件1: Route53ゾーン"<ドメイン名>"に、ロードバランサ"handson-cli-webapp-stateless-alb"へのエイリアスレコード"handson-cli-stateless.<ドメイン名>."が存在しない。

「Route53ゾーン"<ドメイン名>"に、ロードバランサ"handson-cli-webapp-stateless-alb"へのエイリアスレコード"handson-cli-stateless.<ドメイン名>."が存在しない。」ことを確認します。

コマンド:

aws route53 list-resource-record-sets \
  --hosted-zone-id /hostedzone/${ROUTE53_ZONE_ID} \
  --query "ResourceRecordSets[?Type == \`A\` \
    && Name == \`${ROUTE53_RRSET_NAME}\`].Name" \
  --output text

結果(例):

(出力なし)

完了