6.4. Route53エイリアスレコードの作成 (CloudFront: <ドメイン名>)¶

作業の目的 [why]¶

Route53ゾーン"<ドメイン名>"に、CloudFrontへのエイリアスレコードを作成します。

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

完了条件 [after]

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

完了条件1: Route53ゾーン"<ドメイン名>"に、CloudFrontドメイン名 "<CloudFrontドメイン名>"のエイリアスレコードが存在する。

事前条件 [before]

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

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

作業対象 [what]¶

Route53サービス

標準時間(合計)¶

8分

パラメータ設定¶

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

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

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

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

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

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

コマンド:

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

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

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

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

コマンド:

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

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

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

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

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

リソース4: ドメイン名

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

リソース5: ホスト名

レコードを登録するホスト名です。
今回は"handson-cli"とします。

リソース6: ACM証明書名

エイリアスの対象となるCloudFrontディストリビューションで利用しているACM証明書のタグ名です。
今回は"handson-cli-website"とします。

パラメータの指定¶

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

0.0. ACM証明書のリージョンの指定¶

コマンド:

export AWS_DEFAULT_REGION='us-east-1'

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

変数の設定:

DIR_R53_RRSET_DOC="${HOME}/tmp/conf-handson-cli"

0.2. Route53アクションの指定¶

変数の設定:

R53_RRSET_ACTION='UPSERT'

0.3. TTLの指定¶

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

変数の設定:

R53_RRSET_TTL='300'

0.4. ドメイン名の指定¶

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

変数の設定:

DOMAIN_NAME='<ドメイン名>'

0.5. ホスト名の指定¶

ホスト名を指定します。

変数の設定:

HOST_NAME='handson-cli'

0.6. ACM証明書タグ名の指定¶

CloudFrontディストリビューション名で利用しているACM証明書のタグ名を指定します。

変数の設定:

ACM_CERT_TAG_NAME='handson-cli-website'

パラメータの保存¶

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-route53-resource_record_set-create-expand-alias-cloudfront.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. DIR_R53_RRSET_DOC:"${HOME}/tmp/conf-handson-cli"
         DIR_R53_RRSET_DOC="${DIR_R53_RRSET_DOC}"
  # 0.2. R53_RRSET_ACTION:"UPSERT"
         R53_RRSET_ACTION="${R53_RRSET_ACTION}"
  # 0.3. R53_RRSET_TTL:"300"
         R53_RRSET_TTL="${R53_RRSET_TTL}"
  # 0.4. DOMAIN_NAME:"<ドメイン名>"
         DOMAIN_NAME="${DOMAIN_NAME}"
  # 0.5. HOST_NAME:"handson-cli"
         HOST_NAME="${HOST_NAME}"
  # 0.6. ACM_CERT_TAG_NAME:"handson-cli-website"
         ACM_CERT_TAG_NAME="${ACM_CERT_TAG_NAME}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施¶

タスク標準時間:	6分

1. 前処理¶

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

ドメイン名のFQDNへの変換

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

変数の設定:

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

結果(例):

<ドメイン名>.

リソースレコード名の決定

S3バケット名を、"FQDN名"形式に変換します。

変数の設定:

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

結果(例):

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

1.2. 処理対象の状態確認¶

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

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

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

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

コマンド:

ls -d ${DIR_R53_RRSET_DOC}

結果(例):

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

事前条件2: ドメイン(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を取得します。

コマンド:

R53_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 ${R53_ZONE_ID}

結果(例):

<ゾーンID>

事前条件3: CloudFrontディストリビューションで利用しているACM証明書"handson-cli-website"が存在する。

「CloudFrontディストリビューションで利用しているACM証明書"handson-cli-website"が存在する。」ことを確認します。

コマンド:

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}x" != 'x' ]; then echo "${j}"; fi
done

結果(例):

handson-cli-website

課題

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

事前条件4: Route53ゾーン"<ドメイン名>"に、CloudFrontドメイン名 "<CloudFrontドメイン名>"のエイリアスレコードが存在しない。

「Route53ゾーン"<ドメイン名>"に、CloudFrontドメイン名 "<CloudFrontドメイン名>"のエイリアスレコードが存在しない。」ことを確認します。

コマンド:

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

結果(例):

(出力なし)

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

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

課題

CloudFrontディストリビューションのドメイン名取得

コマンド:

CFRONT_DIST_ID=$( \
  aws cloudfront list-distributions \
    --query "DistributionList.Items[?contains(ViewerCertificate.ACMCertificateArn, \`${ACM_CERT_ARN}\`)].Id" \
    --output text \
  ) \
  && echo ${CFRONT_DIST_ID}

結果(例):

<CloudFrontディストリビューションID>

コマンド:

CFRONT_DOMAIN_NAME=$(
  aws cloudfront get-distribution \
    --id ${CFRONT_DIST_ID} \
    --query 'Distribution.DomainName' \
    --output text \
) \
  && echo ${CFRONT_DOMAIN_NAME}

結果(例):

<CloudFrontドメイン名>

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

変数の設定:

FILE_R53_RRSET_DOC="${DIR_R53_RRSET_DOC}/$(date +%Y-%m-%d)-${R53_RRSET_NAME}-alias_cloudfront-${R53_RRSET_ACTION}.json" \
  && echo ${FILE_R53_RRSET_DOC}

結果(例):

${HOME}/tmp/conf-handson-cli/2019-04-30-handson-cli.<ドメイン名>.-alias_cloudfront-UPSERT.json

変数の確認:

cat << ETX

  # FILE_R53_RRSET_DOC:"${HOME}/tmp/conf-handson-cli/2019-04-30-handson-cli.<ドメイン名>.-alias-UPSERT.json"
    FILE_R53_RRSET_DOC="${FILE_R53_RRSET_DOC}"
  # R53_RRSET_ACTION:"UPSERT"
    R53_RRSET_ACTION="${R53_RRSET_ACTION}"
  # R53_RRSET_NAME:"handson-cli.<ドメイン名>."
    R53_RRSET_NAME="${R53_RRSET_NAME}"
  # CFRONT_DOMAIN_NAME:"<CloudFrontドメイン名>"
    CFRONT_DOMAIN_NAME="${CFRONT_DOMAIN_NAME}"

ETX

コマンド:

cat << EOF > ${FILE_R53_RRSET_DOC}
{
  "Changes": [
    {
      "Action": "${R53_RRSET_ACTION}",
      "ResourceRecordSet": {
        "Name": "${R53_RRSET_NAME}",
        "Type": "A",
        "AliasTarget": {
          "HostedZoneId": "Z2FDTNDATAQYW2",
          "DNSName": "${CFRONT_DOMAIN_NAME}",
          "EvaluateTargetHealth": false
        }
      }
    }
  ]
}
EOF

cat ${FILE_R53_RRSET_DOC}

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

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

コマンド:

jsonlint -q ${FILE_R53_RRSET_DOC}

結果(例):

(出力なし)

出力ファイル名の指定

変数の設定:

FILE_R53_RRSET_OUTPUT="${DIR_R53_RRSET_DOC}/$(date +%Y-%m-%d)-${R53_RRSET_NAME}-alias_cloudfront-${R53_RRSET_ACTION}-output.json" \
  && echo ${FILE_R53_RRSET_OUTPUT}

結果(例):

${HOME}/tmp/conf-handson-cli/2019-04-30-handson-cli.<ドメイン名>.-alias_cloudfront-UPSERT-output.json

2. 主処理¶

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

変数の確認:

cat << ETX

  # R53_ZONE_ID:"<ゾーンID>"
    R53_ZONE_ID="${R53_ZONE_ID}"
  # FILE_R53_RRSET_DOC:"${HOME}/tmp/conf-handson-cli/2019-04-30-handson-cli.<ドメイン名>.-alias_cloudfront-UPSERT.json"
    FILE_R53_RRSET_DOC="${FILE_R53_RRSET_DOC}"
  # FILE_R53_RRSET_OUTPUT:"${HOME}/tmp/conf-handson-cli/2019-04-30-handson-cli.<ドメイン名>.-alias_cloudfront-UPSERT-output.json"
    FILE_R53_RRSET_OUTPUT="${FILE_R53_RRSET_OUTPUT}"

ETX

コマンド:

aws route53 change-resource-record-sets \
  --hosted-zone-id ${R53_ZONE_ID} \
  --change-batch file://${FILE_R53_RRSET_DOC} \
  > ${FILE_R53_RRSET_OUTPUT} \
    && cat ${FILE_R53_RRSET_OUTPUT}

結果(例):

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

3. 後処理¶

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

Change IDの取得

Change IDを取得します。

コマンド:

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

結果(例):

/change/C1LBXXXXXXXXXX

ステータスの確認

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

コマンド:

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

結果(例):

INSYNC

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

3.2. 完了条件の確認¶

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

完了条件1: Route53ゾーン"<ドメイン名>"に、CloudFrontドメイン名 "<CloudFrontドメイン名>"のエイリアスレコードが存在する。

「Route53ゾーン"<ドメイン名>"に、CloudFrontドメイン名 "<CloudFrontドメイン名>"のエイリアスレコードが存在する。」ことを確認します。

コマンド:

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

結果(例):

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

prototype.opslearn.jp

6.4. Route53エイリアスレコードの作成 (CloudFront: <ドメイン名>)¶

作業の目的 [why]¶

作業対象 [what]¶

標準時間(合計)¶

パラメータ設定¶

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

パラメータの指定¶

0.0. ACM証明書のリージョンの指定¶

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

0.2. Route53アクションの指定¶

0.3. TTLの指定¶

0.4. ドメイン名の指定¶

0.5. ホスト名の指定¶

0.6. ACM証明書タグ名の指定¶

パラメータの保存¶

タスクの実施¶

1. 前処理¶

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

1.2. 処理対象の状態確認¶

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

2. 主処理¶

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

3. 後処理¶

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

3.2. 完了条件の確認¶

完了¶