2.1. ACM証明書の作成 (DNS: cert-handson-cli-redmine)

作業の目的 [why]

ホスト名"redmine.<ドメイン名>"で利用する証明書"cert-handson-cli-redmine"を作成します。

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

完了条件 [after]

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

完了条件1
ACM証明書名"cert-handson-cli-redmine"が存在する。

事前条件 [before]

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

事前条件1
一時ファイル用ディレクトリが存在する。
事前条件2
ACM証明書名"cert-handson-cli-redmine"が存在しない。

作業対象 [what]

  • ACMサービス

標準時間(合計)

8分

パラメータ設定

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

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

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

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

  • 今回は"${HOME}/tmp"を一時ファイル用ディレクトリとします。

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

コマンド:

ls -d ${HOME}/tmp

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

${HOME}/tmp

ディレクトリが存在しない場合は作成します。

コマンド:

mkdir -p ${HOME}/tmp

リソース2: ACM証明書名

  • 作成するACM証明書のタグ名です。
  • 今回は"cert-handson-cli-redmine"とします。

リソース3: ドメイン名

  • 証明書を発行するホストの"ホスト名" + "ドメイン名" + "."のうちの"ドメイン名"部分です。
  • 今回は"<ドメイン名>"とします。

リソース4: ホスト名

  • 証明書を発行するホストの"ホスト名" + "ドメイン名" + "."のうちの"ホスト名"部分です。
  • ここでは"redmine"とします。

パラメータの指定

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

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

コマンド:

export AWS_DEFAULT_REGION='|ACM_REGION|'

0.1. tmpファイルディレクトリの指定

変数の設定:

DIR_TMP="${HOME}/tmp"

0.2. ACM証明書名の指定

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

変数の設定:

ACM_CERT_TAG_NAME='cert-handson-cli-redmine'

0.3. ドメイン名の指定

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

変数の設定:

DOMAIN_NAME='<ドメイン名>'

0.4. ホスト名の指定

ホスト名を指定します。

変数の設定:

HOST_NAME='redmine'

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-acm-certificate_dns-create.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"|ACM_REGION|"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. DIR_TMP:"${HOME}/tmp"
         DIR_TMP="${DIR_TMP}"
  # 0.2. ACM_CERT_TAG_NAME:"cert-handson-cli-redmine"
         ACM_CERT_TAG_NAME="${ACM_CERT_TAG_NAME}"
  # 0.3. DOMAIN_NAME:"<ドメイン名>"
         DOMAIN_NAME="${DOMAIN_NAME}"
  # 0.4. HOST_NAME:"redmine"
         HOST_NAME="${HOST_NAME}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

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

ドメイン名にホスト名を付与

変数の設定:

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

1.2. 処理対象の状態確認

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

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

事前条件1: 一時ファイル用ディレクトリが存在する。

「一時ファイル用ディレクトリが存在する。」ことを確認します。

コマンド:

ls -d ${DIR_TMP}

結果(例):

${HOME}/tmp

事前条件2: ACM証明書名"cert-handson-cli-redmine"が存在しない。

「ACM証明書名"cert-handson-cli-redmine"が存在しない。」ことを確認します。

コマンド:

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

結果(例):

(出力なし)

課題

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

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

ファイル名の指定

変数の設定:

FILE_OUTPUT="${DIR_TMP}/$(date +%Y-%m-%d)-acm-${ACM_CERT_TAG_NAME}-${AWS_DEFAULT_REGION}.json" \
  && echo ${FILE_OUTPUT}

結果(例):

${HOME}/tmp/2019-04-30-acm-cert-handson-cli-redmine-|ACM_REGION|.json

2. 主処理

ACM証明書の作成

変数の確認:

cat << ETX

  # ACM_DOMAIN_NAME:"redmine.<ドメイン名>"
    ACM_DOMAIN_NAME="${ACM_DOMAIN_NAME}"
  # FILE_OUTPUT:"${HOME}/tmp/2019-04-30-acm-cert-handson-cli-redmine-|ACM_REGION|.json"
    FILE_OUTPUT="${FILE_OUTPUT}"

ETX

コマンド:

aws acm request-certificate \
  --domain-name ${ACM_DOMAIN_NAME} \
  --validation-method DNS \
  > ${FILE_OUTPUT}

cat ${FILE_OUTPUT}

結果(例):

{
  "CertificateArn": "arn:aws:acm:|ACM_REGION|:XXXXXXXXXXXX:certificate/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

ACM証明書のARN取得

コマンド:

ACM_CERT_ARN=$( \
  cat ${FILE_OUTPUT} \
    | jp.py "CertificateArn" \
    | sed 's/\"//g' \
) \
  && echo ${ACM_CERT_ARN}

結果(例):

arn:aws:acm:<リージョン名>:XXXXXXXXXXXX:certificate/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

3. 後処理

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

タグ情報の設定

変数の設定:

ACM_TAG_KEY='Name'

変数の設定:

ACM_TAG_VALUE="${ACM_CERT_TAG_NAME}" \
  && echo ${ACM_TAG_VALUE}

結果(例):

cert-handson-cli-redmine

変数の確認:

cat << ETX

  # ACM_CERT_ARN:"arn:aws:acm:<リージョン名>:XXXXXXXXXXXX:certificate/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    ACM_CERT_ARN="${ACM_CERT_ARN}"
  # ACM_TAG_KEY:"Name"
    ACM_TAG_KEY="${ACM_TAG_KEY}"
  # ACM_TAG_VALUE:"cert-handson-cli-redmine"
    ACM_TAG_VALUE="${ACM_TAG_VALUE}"

ETX

コマンド:

aws acm add-tags-to-certificate \
  --certificate-arn ${ACM_CERT_ARN} \
  --tags "Key=${ACM_TAG_KEY},Value=${ACM_TAG_VALUE}"

結果(例):

(出力なし)

一時ファイルの削除

コマンド:

rm ${FILE_OUTPUT}

結果:

(出力なし)

3.2. 完了条件の確認

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

完了条件1: ACM証明書名"cert-handson-cli-redmine"が存在する。

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

コマンド:

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

結果(例):

cert-handson-cli-redmine

課題

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

完了