6.2. Route53 リソースレコードセットの登録 (CNAME for ACM)

作業の目的 [why]

Route53ゾーン"<ドメイン名>"に、ACM証明書"<タグ名>"の承認用CNAMEレコードを登録します。

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

完了条件 [after]

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

完了条件1
Route53ゾーン"<ドメイン名>"に、ACM証明書"handson-cli-website-https"の承認用CNAMEレコードが存在する。
完了条件2
リソースタイプ"CNAME"のリソースレコード"_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.handson-cli.<ドメイン名>."が名前解決できる。

事前条件 [before]

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

事前条件1
ドメイン(FQDN)名"<ドメイン名>."のRoute53ゾーンが存在する。
事前条件2
ACM証明書"handson-cli-website-https"が存在する。
事前条件3
Route53ゾーン"<ドメイン名>"に、ACM証明書"handson-cli-website-https"の承認用CNAMEレコードが存在しない。
事前条件4
リソースレコードセットファイル用ディレクトリ"${HOME}/conf/handson-cli-website-https-conf"が存在する。

作業対象 [what]

  • Route53ホストゾーン

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: ドメイン名(FQDN形式)

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

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

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

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

  • レコードを登録するリソースレコードタイプです。
  • 今回は"CNAME"とします。

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

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

リソース5: ACM上のドメイン名

  • ACM証明書のドメイン名(<ホスト>.<ドメイン>形式)です。
  • ここでは"handson-cli.<ドメイン名>"とします。

リソース6: ACM証明書名

  • ACM証明書のタグ名です。
  • 今回は"handson-cli-website-https"とします。

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

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

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

コマンド:

ls -d ${HOME}/conf/handson-cli-website-https-conf

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

${HOME}/conf/handson-cli-website-https-conf

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

コマンド:

mkdir -p ${HOME}/conf/handson-cli-website-https-conf

パラメータの指定

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

0.0. リージョンの指定

コマンド:

export AWS_DEFAULT_REGION='us-east-1'

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

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

変数の設定:

DOMAIN_NAME='<ドメイン名>'

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

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

変数の設定:

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

結果(例):

<ドメイン名>.

0.2. Route53アクションの指定

変数の設定:

ROUTE53_RRSET_ACTION='CREATE'

0.3. レコードタイプの指定

変数の設定:

ROUTE53_RRSET_TYPE='CNAME'

0.4. TTLの指定

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

変数の設定:

ROUTE53_RRSET_TTL='300'

0.5. ACM上のドメイン名の指定

ホスト名を指定します。

変数の設定:

HOST_NAME='handson-cli'

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

SSL証明書上のドメイン名を指定します。

コマンド:

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

結果(例):

handson-cli.<ドメイン名>

0.6. ACM証明書名の指定

ACM証明書のタグ名を指定します。

変数の設定:

ACM_CERT_TAG_NAME='handson-cli-website-https'

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

変数の設定:

DIR_ROUTE53_RRSET_DOC="${HOME}/conf/handson-cli-website-https-conf"

パラメータの保存

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-website-https"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-route53-resource_record_set-create-expand-cname-acm.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli-website-https/2019-07-14-route53-resource_record_set-create-expand-cname-acm.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"us-east-1"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. DOMAIN_NAME_FQDN:"<ドメイン名>."
         DOMAIN_NAME_FQDN="${DOMAIN_NAME_FQDN}"
  # 0.2. ROUTE53_RRSET_ACTION:"CREATE"
         ROUTE53_RRSET_ACTION="${ROUTE53_RRSET_ACTION}"
  # 0.3. ROUTE53_RRSET_TYPE:"CNAME"
         ROUTE53_RRSET_TYPE="${ROUTE53_RRSET_TYPE}"
  # 0.4. ROUTE53_RRSET_TTL:"300"
         ROUTE53_RRSET_TTL="${ROUTE53_RRSET_TTL}"
  # 0.5. ACM_DOMAIN_NAME:"handson-cli.<ドメイン名>"
         ACM_DOMAIN_NAME="${ACM_DOMAIN_NAME}"
  # 0.6. ACM_CERT_TAG_NAME:"handson-cli-website-https"
         ACM_CERT_TAG_NAME="${ACM_CERT_TAG_NAME}"
  # 0.7. DIR_ROUTE53_RRSET_DOC:"${HOME}/conf/handson-cli-website-https-conf"
         DIR_ROUTE53_RRSET_DOC="${DIR_ROUTE53_RRSET_DOC}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: ドメイン(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}

結果(例):

<ゾーンID>

事前条件2: ACM証明書"handson-cli-website-https"が存在する。

「ACM証明書"handson-cli-website-https"が存在する。」ことを確認します。

コマンド:

aws acm list-certificates \
  --query "CertificateSummaryList[?DomainName == \`${ACM_DOMAIN_NAME}\`].DomainName" \
  --output text

結果(例):

handson-cli.<ドメイン名>

ACM証明書のARNを取得します。

コマンド:

for i in $( 
  aws acm list-certificates \
    --query "CertificateSummaryList[].CertificateArn" \
    --output text \
); do
  j=$( \
    aws acm list-tags-for-certificate \
      --certificate-arn ${i} \
      --query "Tags[?Key == \`Name\` && Value == \`${ACM_CERT_TAG_NAME}\`].Value" \
      --output text \
  )
  if [ "${j}" == "${ACM_CERT_TAG_NAME}" ]; then \
    ACM_CERT_ARN=$( \
      aws acm list-certificates \
        --query "CertificateSummaryList[?CertificateArn == \`${i}\`].CertificateArn" \
        --output text \
    ) \
      && echo "${ACM_CERT_ARN}"
  fi
done

結果(例):

arn:aws:acm:us-east-1:XXXXXXXXXXXX:certificate/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

課題

list-certificatesコマンドがタグ表示できないため、同名の証明書が複数ある場合、全ての証明書をlist-tags-for-certificateコマンドでタグの有無をチェックするしか方法がない。

CNAME名を取得します。

コマンド:

ROUTE53_RRSET_NAME=$( \
  aws acm describe-certificate \
    --certificate-arn ${ACM_CERT_ARN} \
    --query 'Certificate.DomainValidationOptions[?ValidationMethod == `DNS`].ResourceRecord.Name' \
    --output text \
) \
  && echo ${ROUTE53_RRSET_NAME}

結果(例):

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

CNAMEの値を取得します。

コマンド:

ROUTE53_RRSET_VALUE=$( \
  aws acm describe-certificate \
    --certificate-arn ${ACM_CERT_ARN} \
    --query 'Certificate.DomainValidationOptions[?ValidationMethod == `DNS`].ResourceRecord.Value' \
    --output text \
) \
  && echo ${ROUTE53_RRSET_VALUE}

結果(例):

_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxx.acm-validations.aws.

事前条件3: Route53ゾーン"<ドメイン名>"に、ACM証明書"handson-cli-website-https"の承認用CNAMEレコードが存在しない。

「Route53ゾーン"<ドメイン名>"に、ACM証明書"handson-cli-website-https"の承認用CNAMEレコードが存在しない。」ことを確認します。

コマンド:

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

結果(例):

(出力なし)

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

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

コマンド:

ls -d ${DIR_ROUTE53_RRSET_DOC}

結果(例):

${HOME}/conf/handson-cli-website-https-conf

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

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

変数の設定:

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}/conf/handson-cli-website-https-conf/2019-07-14-_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.handson-cli.<ドメイン名>.-CNAME-CREATE.json

変数の確認:

cat << ETX

  # FILE_ROUTE53_RRSET_DOC:"${HOME}/conf/handson-cli-website-https-conf/2019-07-14-_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.handson-cli.<ドメイン名>.-CNAME-CREATE.json"
    FILE_ROUTE53_RRSET_DOC="${FILE_ROUTE53_RRSET_DOC}"
  # ROUTE53_RRSET_ACTION:"CREATE"
    ROUTE53_RRSET_ACTION="${ROUTE53_RRSET_ACTION}"
  # ROUTE53_RRSET_TYPE:"CNAME"
    ROUTE53_RRSET_TYPE="${ROUTE53_RRSET_TYPE}"
  # ROUTE53_RRSET_TTL:"300"
    ROUTE53_RRSET_TTL="${ROUTE53_RRSET_TTL}"
  # ROUTE53_RRSET_NAME:"_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.handson-cli.<ドメイン名>."
    ROUTE53_RRSET_NAME="${ROUTE53_RRSET_NAME}"
  # ROUTE53_RRSET_VALUE:"_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxx.acm-validations.aws."
    ROUTE53_RRSET_VALUE="${ROUTE53_RRSET_VALUE}"

ETX

コマンド:

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": [
          {
            "Value": "${ROUTE53_RRSET_VALUE}"
          }
        ]
      }
    }
  ]
}
EOF

cat ${FILE_ROUTE53_RRSET_DOC}

結果(例):

{
  "Changes": [
    {
      "Action": "CREATE",
      "ResourceRecordSet": {
        "Name": "_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.handson-cli.<ドメイン名>.",
        "Type": "CNAME",
        "TTL":  300,
        "ResourceRecords": [
          {
            "Value": "_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxx.acm-validations.aws."
          }
        ]
      }
    }
  ]
}

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}/conf/handson-cli-website-https-conf/2019-07-14-_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.handson-cli.<ドメイン名>.-CNAME-CREATE-output.json

2. 主処理

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

変数の確認:

cat << ETX

  # ROUTE53_ZONE_ID:"<ゾーンID>"
    ROUTE53_ZONE_ID="${ROUTE53_ZONE_ID}"
  # FILE_ROUTE53_RRSET_DOC:"${HOME}/conf/handson-cli-website-https-conf/2019-07-14-_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.handson-cli.<ドメイン名>.-CNAME-CREATE.json"
    FILE_ROUTE53_RRSET_DOC="${FILE_ROUTE53_RRSET_DOC}"
  # FILE_ROUTE53_RRSET_OUTPUT:"${HOME}/conf/handson-cli-website-https-conf/2019-07-14-_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.handson-cli.<ドメイン名>.-CNAME-CREATE-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-07-14T01: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ゾーン"<ドメイン名>"に、ACM証明書"handson-cli-website-https"の承認用CNAMEレコードが存在する。

「Route53ゾーン"<ドメイン名>"に、ACM証明書"handson-cli-website-https"の承認用CNAMEレコードが存在する。」ことを確認します。

コマンド:

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

結果(例):

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

完了条件2: リソースタイプ"CNAME"のリソースレコード"_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.handson-cli.<ドメイン名>."が名前解決できる。

「リソースタイプ"CNAME"のリソースレコード"_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.handson-cli.<ドメイン名>."が名前解決できる。」ことを確認します。

コマンド:

dig ${ROUTE53_RRSET_TYPE} ${ROUTE53_RRSET_NAME} \
  | grep ${ROUTE53_RRSET_TYPE} \
  | grep ${ROUTE53_RRSET_NAME} \
  | grep -v '^;'

結果(例):

_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.handson-cli.<ドメイン名>. 300 IN CNAME _xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxx.acm-validations.aws.

3.3. 後処理に必要な作業

ファイルの削除

コマンド:

rm ${FILE_ROUTE53_RRSET_OUTPUT}

完了