後始末2. Route53リソースレコードの削除 (NS: example.jp)

作業の目的 [why]

Route53ゾーン"example.jp"から、リソースタイプ"NS"、リソース名"handson-cli-lightsail.example.jp."のリソースレコードを削除します。

注釈

作業者によって作業対象のドメイン名が異なるため、本手順においてはドメイン名"example.jp"の部分を"<事前に用意した独自ドメイン>"に読み替えてください。

("コマンド"、"変数の設定"、"変数の確認"については読み替えの必要はありません。)

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

完了条件 [after]

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

完了条件1

Route53ゾーン"example.jp"に、リソースタイプ"NS"、リソース名"handson-cli-lightsail.example.jp."のリソースレコードが存在しない。

事前条件 [before]

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

事前条件1

Route53ゾーン"example.jp"が存在する。

事前条件2

Route53ゾーン"example.jp"に、リソースタイプ"NS"、リソース名"handson-cli-lightsail.example.jp."のリソースレコードが存在する。

事前条件3

リソースレコードセットファイル用ディレクトリ"${HOME}/environment/conf-handson-cli-lightsail"が存在する。

事前条件4

リソースレコードセットファイル"${HOME}/environment/conf-handson-cli-lightsail/2020-02-10-handson-cli-lightsail.example.jp.-NS-DELETE.json"が存在しない。

作業対象 [what]

  • Route53サービス

標準時間(合計)

8分

パラメータ設定

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

2分

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

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

リソース1: ドメイン名

  • レコードを削除するドメイン名です。

  • 今回は、事前に用意した独自ドメインを利用します。

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

  • レコードを削除するRoute53アクションの名称です。

  • 今回は"DELETE"とします。

リソース3: リソースレコードのタイプ

  • 削除するリソースレコードのタイプです。

  • 今回は"NS"とします。

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

  • 削除するリソースレコードのTTLです。

  • 今回は"300"とします。

リソース5: サブドメイン名

  • レコードを削除するサブドメイン名です。

  • 今回は"handson-cli-lightsail"とします。

リソース6: NSホスト名

  • NSレコードから削除するNSホスト名です。

  • 今回は"ns-XX.awsdns-XX.com ns-XXX.awsdns-XX.net ns-XXXX.awsdns-XX.org ns-XXXX.awsdns-XX.co.uk"とします。

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

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

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

コマンド:

ls -d ${HOME}/environment/conf-handson-cli-lightsail

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

${HOME}/environment/conf-handson-cli-lightsail

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

コマンド:

mkdir -p ${HOME}/environment/conf-handson-cli-lightsail

パラメータの指定

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

0.1. ドメイン名(FQDN形式)の指定

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

Route53ゾーン名を指定します。

変数の設定:

DIR_TMP="${HOME}/environment/tmp-handson-cli-lightsail"

変数の設定:

FILE_TMP="${DIR_TMP}/sub_domain.tmp" \
  && echo ${FILE_TMP}

結果(例):

${HOME}/environment/tmp-handson-cli-lightsail/sub_domain.tmp

コマンド:

source ${FILE_TMP}

変数の設定:

ROUTE53_ZONE_NAME="${DOMAIN_NAME}" \
  && echo ${ROUTE53_ZONE_NAME}

結果(例):

example.jp

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

変数の設定:

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

結果(例):

example.jp.

0.2. Route53アクションの指定

変数の設定:

ROUTE53_RRSET_ACTION='DELETE'

0.3. リソースタイプの指定

変数の設定:

ROUTE53_RRSET_TYPE='NS'

0.4. TTLの指定

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

変数の設定:

ROUTE53_RRSET_TTL='300'

0.5. リソースレコード名の指定

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

変数の設定:

ROUTE53_RRSET_SUBDOMAIN='handson-cli-lightsail'

変数の設定:

ROUTE53_RRSET_NAME="${ROUTE53_RRSET_SUBDOMAIN}.${DOMAIN_NAME_FQDN}" \
  && echo ${ROUTE53_RRSET_NAME}

結果(例):

handson-cli-lightsail.example.jp.

0.6. NSホストの指定

変数の設定:

LIGHTSAIL_DOMAIN_NAME="${DOMAIN_SUB_FULLNAME}" \
  && echo ${LIGHTSAIL_DOMAIN_NAME}

結果(例):

handson-cli-lightsail.example.jp

コマンド:

ARRAY_LIGHTSAIL_DOMAIN_NS=$( \
  aws lightsail get-domain \
    --region us-east-1 \
    --domain-name ${LIGHTSAIL_DOMAIN_NAME} \
    --query 'domain.domainEntries[?type == `NS`].target' \
    --output text \
  | tr '\t' ' ' \
) \
  && echo ${ARRAY_LIGHTSAIL_DOMAIN_NS}

結果(例):

ns-XX.awsdns-XX.com ns-XXX.awsdns-XX.net ns-XXXX.awsdns-XX.org ns-XXXX.awsdns-XX.co.uk

変数の設定:

ARRAY_NS_HOSTS="${ARRAY_LIGHTSAIL_DOMAIN_NS}" \
  && echo ${ARRAY_NS_HOSTS}

結果(例):

ns-XX.awsdns-XX.com ns-XXX.awsdns-XX.net ns-XXXX.awsdns-XX.org ns-XXXX.awsdns-XX.co.uk

0.7. リソースレコードセットファイル名の指定

変数の設定:

DIR_ROUTE53_RRSET_DOC="${HOME}/environment/conf-handson-cli-lightsail"

変数の設定:

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

結果(例):

${HOME}/environment/conf-handson-cli-lightsail/2020-02-10-handson-cli-lightsail.example.jp.-NS-DELETE.json

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli-lightsail/2020-02-10-route53-resource_record_set-delete-expand-ns-lightsail.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.1. DOMAIN_NAME_FQDN:"example.jp."
         DOMAIN_NAME_FQDN="${DOMAIN_NAME_FQDN}"
  # 0.2. ROUTE53_RRSET_ACTION:"DELETE"
         ROUTE53_RRSET_ACTION="${ROUTE53_RRSET_ACTION}"
  # 0.3. ROUTE53_RRSET_TYPE:"NS"
         ROUTE53_RRSET_TYPE="${ROUTE53_RRSET_TYPE}"
  # 0.4. ROUTE53_RRSET_TTL:"300"
         ROUTE53_RRSET_TTL="${ROUTE53_RRSET_TTL}"
  # 0.5. ROUTE53_RRSET_NAME:"handson-cli-lightsail.example.jp."
         ROUTE53_RRSET_NAME="${ROUTE53_RRSET_NAME}"
  # 0.6. ARRAY_NS_HOSTS:"ns-XX.awsdns-XX.com ns-XXX.awsdns-XX.net ns-XXXX.awsdns-XX.org ns-XXXX.awsdns-XX.co.uk"
         ARRAY_NS_HOSTS="${ARRAY_NS_HOSTS}"
  # 0.7. FILE_ROUTE53_RRSET_DOC:"${HOME}/environment/conf-handson-cli-lightsail/2020-02-10-handson-cli-lightsail.example.jp.-NS-DELETE.json"
         FILE_ROUTE53_RRSET_DOC="${FILE_ROUTE53_RRSET_DOC}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間

6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: Route53ゾーン"example.jp"が存在する。

「Route53ゾーン"example.jp"が存在する。」ことを確認します。

コマンド:

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

結果(例):

example.jp.

ゾーン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

事前条件2: Route53ゾーン"example.jp"に、リソースタイプ"NS"、リソース名"handson-cli-lightsail.example.jp."のリソースレコードが存在する。

「Route53ゾーン"example.jp"に、リソースタイプ"NS"、リソース名"handson-cli-lightsail.example.jp."のリソースレコードが存在する。」ことを確認します。

コマンド:

ROUTE53_RRSET_VALUE=$( \
  echo ${ARRAY_NS_HOSTS} \
  | cut -d ' ' -f 1 \
) \
  && echo ${ROUTE53_RRSET_VALUE}

コマンド:

aws route53 list-resource-record-sets \
  --hosted-zone-id /hostedzone/${ROUTE53_ZONE_ID} \
  --query "ResourceRecordSets[?Type == \`${ROUTE53_RRSET_TYPE}\` \
    && Name == \`${ROUTE53_RRSET_NAME}\` \
    && contains(ResourceRecords[].Value, \`${ROUTE53_RRSET_VALUE}\`)].Name" \
  --output text

結果(例):

handson-cli-lightsail.example.jp.

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

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

コマンド:

ls -d ${DIR_ROUTE53_RRSET_DOC}

結果(例):

${HOME}/environment/conf-handson-cli-lightsail

事前条件4: リソースレコードセットファイル"${HOME}/environment/conf-handson-cli-lightsail/2020-02-10-handson-cli-lightsail.example.jp.-NS-DELETE.json"が存在しない。

「リソースレコードセットファイル"${HOME}/environment/conf-handson-cli-lightsail/2020-02-10-handson-cli-lightsail.example.jp.-NS-DELETE.json"が存在しない。」ことを確認します。

コマンド:

! ls ${FILE_ROUTE53_RRSET_DOC}

結果(例):

ls: cannot access ${HOME}/environment/conf-handson-cli-lightsail/2020-02-10-handson-cli-lightsail.example.jp.-NS-DELETE.json : No such file or directory

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

変数の確認:

cat << ETX

  # FILE_ROUTE53_RRSET_DOC:"${HOME}/environment/conf-handson-cli-lightsail/2020-02-10-handson-cli-lightsail.example.jp.-NS-DELETE.json"
    FILE_ROUTE53_RRSET_DOC="${FILE_ROUTE53_RRSET_DOC}"
  # ROUTE53_RRSET_ACTION:"DELETE"
    ROUTE53_RRSET_ACTION="${ROUTE53_RRSET_ACTION}"
  # ROUTE53_RRSET_TYPE:"NS"
    ROUTE53_RRSET_TYPE="${ROUTE53_RRSET_TYPE}"
  # ROUTE53_RRSET_TTL:"300"
    ROUTE53_RRSET_TTL="${ROUTE53_RRSET_TTL}"
  # ROUTE53_RRSET_NAME:"handson-cli-lightsail.example.jp."
    ROUTE53_RRSET_NAME="${ROUTE53_RRSET_NAME}"
  # ARRAY_NS_HOSTS:"ns-XX.awsdns-XX.com ns-XXX.awsdns-XX.net ns-XXXX.awsdns-XX.org ns-XXXX.awsdns-XX.co.uk"
    ARRAY_NS_HOSTS="${ARRAY_NS_HOSTS}"

ETX

コマンド:

count=$( \
  echo ${ARRAY_NS_HOSTS} \
    | wc -w  \
)

last=$( \
  echo ${ARRAY_NS_HOSTS} \
    | cut -d ' ' -f ${count} \
)

not_last=$( \
  echo ${ARRAY_NS_HOSTS} \
    | sed "s/ ${last}//" \
)

cat << EOF > ${FILE_ROUTE53_RRSET_DOC}
{
  "Changes": [
    {
      "Action": "${ROUTE53_RRSET_ACTION}",
      "ResourceRecordSet": {
        "Name": "${ROUTE53_RRSET_NAME}",
        "Type": "${ROUTE53_RRSET_TYPE}",
        "TTL":  ${ROUTE53_RRSET_TTL},
        "ResourceRecords": [
EOF

for i in $( echo ${not_last} ); do
   echo "          { \"Value\": \"${i}\" }," >> ${FILE_ROUTE53_RRSET_DOC}
done
echo "          { \"Value\": \"${last}\" }" >> ${FILE_ROUTE53_RRSET_DOC}

cat << EOF >> ${FILE_ROUTE53_RRSET_DOC}
        ]
      }
    }
  ]
}
EOF

cat ${FILE_ROUTE53_RRSET_DOC}

結果(例):

{
  "Changes": [
    {
      "Action": "DELETE",
      "ResourceRecordSet": {
        "Name": "handson-cli-lightsail.example.jp.",
        "Type": "NS",
        "TTL":  300,
        "ResourceRecords": [
          { "Value": "ns-XX.awsdns-XX.com" },
          { "Value": "ns-XXX.awsdns-XX.net" },
          { "Value": "ns-XXXX.awsdns-XX.org" },
          { "Value": "ns-XXXX.awsdns-XX.co.uk" }
        ]
      }
    }
  ]
}

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

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

コマンド:

jsonlint -q ${FILE_ROUTE53_RRSET_DOC}

結果(例):

(出力なし)

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

出力ファイル名の指定

変数の設定:

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

結果(例):

${HOME}/environment/conf-handson-cli-lightsail/2020-02-10-handson-cli-lightsail.example.jp.-NS-DELETE-output.json

2. 主処理

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

変数の確認:

cat << ETX

  # ROUTE53_ZONE_ID:"Zxxxxxxxxxxxxx"
    ROUTE53_ZONE_ID="${ROUTE53_ZONE_ID}"
  # FILE_ROUTE53_RRSET_DOC:"${HOME}/environment/conf-handson-cli-lightsail/2020-02-10-handson-cli-lightsail.example.jp.-NS-DELETE.json"
    FILE_ROUTE53_RRSET_DOC="${FILE_ROUTE53_RRSET_DOC}"
  # FILE_ROUTE53_RRSET_OUTPUT:"${HOME}/environment/conf-handson-cli-lightsail/2020-02-10-handson-cli-lightsail.example.jp.-NS-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": "2020-02-10T01: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ゾーン"example.jp"に、リソースタイプ"NS"、リソース名"handson-cli-lightsail.example.jp."のリソースレコードが存在しない。

「Route53ゾーン"example.jp"に、リソースタイプ"NS"、リソース名"handson-cli-lightsail.example.jp."のリソースレコードが存在しない。」ことを確認します。

コマンド:

aws route53 list-resource-record-sets \
  --hosted-zone-id /hostedzone/${ROUTE53_ZONE_ID} \
  --query "ResourceRecordSets[?Type == \`${ROUTE53_RRSET_TYPE}\` \
    && Name == \`${ROUTE53_RRSET_NAME}\` \
    && contains(ResourceRecords[].Value, \`${ROUTE53_RRSET_VALUE}\`)].Name" \
  --output text

結果(例):

(出力なし)

完了