5.2. リスナーの作成 (HTTPS: handson-cli-webapp-stateless-alb)¶
作業の目的 [why]¶
ALBロードバランサ"handson-cli-webapp-stateless-alb"に"443/HTTPS"のリスナー(HTTPS)を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- ELBv2ロードバランサ"handson-cli-webapp-stateless-alb"にプロトコル"HTTPS"、ポート番号"443"のリスナーが存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- ELBv2ロードバランサ"handson-cli-webapp-stateless-albが存在する。
- 事前条件2
- ELBv2ロードバランサ"handson-cli-webapp-stateless-alb"にプロトコル"HTTPS"、ポート番号"443"のリスナーが存在しない。
- 事前条件3
- ターゲットグループ"handson-cli-webapp-stateless-tgが存在する。
- 事前条件4
- ACM証明書名"handson-cli-webapp-stateless-cert"が存在する。
作業対象 [what]¶
- ELBv2サービス
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: ELBv2ロードバランサ名
- リスナーを作成するELBv2ロードバランサの名称です。
- 今回は"handson-cli-webapp-stateless-alb"とします。
リソース2: リスナーのプロトコル名
- リスナーのプロトコル名です。
- 今回は"HTTPS"とします。
リソース3: リスナーのポート番号
- リスナーのポート番号です。
- 今回は"443"とします。
リソース4: ターゲットグループ名
- リスナーと関連付けるターゲットグループの名称です。
- 今回は"handson-cli-webapp-stateless-tg"とします。
リソース5: リスナーのデフォルトアクションタイプ
- リスナーのデフォルトのアクションです。
- 今回は"forward"とします。
リソース6: ACM証明書
- 作成するELBv2リスナに添付するACM証明書のドメイン名です。
- 今回は"<ホスト名>.<ドメイン名>"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.4. ターゲットグループ名の指定¶
ターゲットグループ名を指定します。
変数の設定:
ELBV2_TARGET_GROUP_NAME="handson-cli-webapp-stateless-tg"
0.5. リスナーのデフォルトアクションタイプの指定¶
リスナーのデフォルトのアクションタイプを指定します。
変数の設定:
ELBV2_LB_DEFAULT_ACTION_TYPE="forward"
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-webapp-stateless" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-elbv2-listener-create-expand-https.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-webapp-stateless/2019-05-19-elbv2-listener-create-expand-https.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. ELBV2_LB_NAME:"handson-cli-webapp-stateless-alb" ELBV2_LB_NAME="${ELBV2_LB_NAME}" # 0.2. ELBV2_LISTENER_PROTOCOL:"HTTPS" ELBV2_LISTENER_PROTOCOL="${ELBV2_LISTENER_PROTOCOL}" # 0.3. ELBV2_LISTENER_PORT:"443" ELBV2_LISTENER_PORT="${ELBV2_LISTENER_PORT}" # 0.4. ELBV2_TARGET_GROUP_NAME:"handson-cli-webapp-stateless-tg" ELBV2_TARGET_GROUP_NAME="${ELBV2_TARGET_GROUP_NAME}" # 0.5. ELBV2_LB_DEFAULT_ACTION_TYPE:"forward" ELBV2_LB_DEFAULT_ACTION_TYPE="${ELBV2_LB_DEFAULT_ACTION_TYPE}" # 0.6. ACM_CERT_TAG_NAME:"handson-cli-webapp-stateless-cert" ACM_CERT_TAG_NAME="${ACM_CERT_TAG_NAME}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: ELBv2ロードバランサ"handson-cli-webapp-stateless-albが存在する。
「ELBv2ロードバランサ"handson-cli-webapp-stateless-albが存在する。」ことを確認します。
コマンド:
aws elbv2 describe-load-balancers \ --name ${ELBV2_LB_NAME} \ --query 'LoadBalancers[].LoadBalancerName' \ --output text
結果(例):
handson-cli-webapp-stateless-alb
ELBV2ロードバランサのARNを取得します。
コマンド:
ELBV2_LB_ARN=$( \ aws elbv2 describe-load-balancers \ --name ${ELBV2_LB_NAME} \ --query 'LoadBalancers[].LoadBalancerArn' \ --output text \ ) \ && echo ${ELBV2_LB_ARN}
結果(例):
arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:loadbalancer/app/handson-cli-webapp-stateless-alb/xxxxxxxxxxxxxxxx
事前条件2: ELBv2ロードバランサ"handson-cli-webapp-stateless-alb"にプロトコル"HTTPS"、ポート番号"443"のリスナーが存在しない。
「ELBv2ロードバランサ"handson-cli-webapp-stateless-alb"にプロトコル"HTTPS"、ポート番号"443"のリスナーが存在しない。」ことを確認します。
コマンド:
aws elbv2 describe-listeners \ --load-balancer-arn ${ELBV2_LB_ARN} \ --query "Listeners[? Protocol == \`${ELBV2_LISTENER_PROTOCOL}\` \ && Port == \`${ELBV2_LISTENER_PORT}\`].ListenerArn" \ --output text
結果(例):
(出力なし)
事前条件3: ターゲットグループ"handson-cli-webapp-stateless-tgが存在する。
「ターゲットグループ"handson-cli-webapp-stateless-tgが存在する。」ことを確認します。
コマンド:
aws elbv2 describe-target-groups \ --names ${ELBV2_TARGET_GROUP_NAME} \ --query 'TargetGroups[].TargetGroupName' \ --output text
結果(例):
handson-cli-webapp-stateless-tg
事前条件4: ACM証明書名"handson-cli-webapp-stateless-cert"が存在する。
「ACM証明書名"handson-cli-webapp-stateless-cert"が存在する。」ことを確認します。
コマンド:
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-webapp-stateless-cert
課題
list-certificatesコマンドがタグ表示できないため、同名の証明書が複数ある場合、全ての証明書をlist-tags-for-certificateコマンドでタグの有無をチェックするしか方法がない。
1.2. 主処理に必要な情報の取得¶
ターゲットグループARNの取得
コマンド:
ELBV2_TARGET_GROUP_ARN=$( \ aws elbv2 describe-target-groups \ --names ${ELBV2_TARGET_GROUP_NAME} \ --query 'TargetGroups[].TargetGroupArn' \ --output text \ ) \ && echo ${ELBV2_TARGET_GROUP_ARN}
結果(例):
arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-webapp-stateless-tg/xxxxxxxxxxxxxxxx
デフォルトアクション設定文字列の生成
変数の設定:
ELBV2_LB_DEFAULT_ACTIONS="Type=${ELBV2_LB_DEFAULT_ACTION_TYPE},TargetGroupArn=${ELBV2_TARGET_GROUP_ARN}" \ && echo ${ELBV2_LB_DEFAULT_ACTIONS}
結果(例):
Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-webapp-stateless-tg/xxxxxxxxxxxxxxxx
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:ap-northeast-1:XXXXXXXXXXXX:certificate/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
課題
list-certificatesコマンドがタグ表示できないため、同名の証明書が複数ある場合、全ての証明書をlist-tags-for-certificateコマンドでタグの有無をチェックするしか方法がない。
証明書指定文字列の生成
変数の設定:
STRING_LISTENER_CERTIFICATES="CertificateArn=${ACM_CERT_ARN}" \ && echo ${STRING_LISTENER_CERTIFICATES}
結果(例):
CertificateArn=arn:aws:acm:ap-northeast-1:XXXXXXXXXXXX:certificate/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
2. 主処理¶
HTTPSリスナの作成¶
変数の確認:
cat << ETX # ELBV2_LB_ARN:"arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:loadbalancer/app/handson-cli-webapp-stateless-alb/xxxxxxxxxxxxxxxx" ELBV2_LB_ARN="${ELBV2_LB_ARN}" # ELBV2_LISTENER_PROTOCOL:"HTTPS" ELBV2_LISTENER_PROTOCOL="${ELBV2_LISTENER_PROTOCOL}" # ELBV2_LISTENER_PORT:"443" ELBV2_LISTENER_PORT="${ELBV2_LISTENER_PORT}" # ELBV2_LB_DEFAULT_ACTIONS:"Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-webapp-stateless-tg/xxxxxxxxxxxxxxxx" ELBV2_LB_DEFAULT_ACTIONS="${ELBV2_LB_DEFAULT_ACTIONS}" # STRING_LISTENER_CERTIFICATES:"CertificateArn=arn:aws:acm:ap-northeast-1:XXXXXXXXXXXX:certificate/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" STRING_LISTENER_CERTIFICATES="${STRING_LISTENER_CERTIFICATES}" ETX
コマンド:
aws elbv2 create-listener \ --load-balancer-arn ${ELBV2_LB_ARN} \ --protocol ${ELBV2_LISTENER_PROTOCOL} \ --port ${ELBV2_LISTENER_PORT} \ --default-actions ${ELBV2_LB_DEFAULT_ACTIONS} \ --certificates ${STRING_LISTENER_CERTIFICATES}
結果(例):
{ "Listeners": [ { "Protocol": "HTTPS", "DefaultActions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-webapp-stateless-tg/xxxxxxxxxxxxxxxx", "Type": "forward" } ], "SslPolicy": "ELBSecurityPolicy-2016-08", "Certificates": [ { "CertificateArn": "arn:aws:acm:ap-northeast-1:XXXXXXXXXXXX:certificate/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "LoadBalancerArn": "arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:loadbalancer/app/handson-cli-webapp-stateless-alb/xxxxxxxxxxxxxxxx", "Port": 80, "ListenerArn": "arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:listener/app/handson-cli-webapp-stateless-alb/handson-cli-webapp-stateless-alb/xxxxxxxxxxxxxxxx" } ] }
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: ELBv2ロードバランサ"handson-cli-webapp-stateless-alb"にプロトコル"HTTPS"、ポート番号"443"のリスナーが存在する。
「ELBv2ロードバランサ"handson-cli-webapp-stateless-alb"にプロトコル"HTTPS"、ポート番号"443"のリスナーが存在する。」ことを確認します。
コマンド:
aws elbv2 describe-listeners \ --load-balancer-arn ${ELBV2_LB_ARN} \ --query "Listeners[? Protocol == \`${ELBV2_LISTENER_PROTOCOL}\` \ && Port == \`${ELBV2_LISTENER_PORT}\`].ListenerArn" \ --output text
結果(例):
arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:listener/app/handson-cli-webapp-stateless-alb/xxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxx