2. ALBルールの作成 (handson-cli-alb)

作業の目的 [why]

ELBv2ロードバランサ"handson-cli-alb"のリスナー(プロトコル"HTTP"、ポート番号"8080")のリスナーに、条件"Field=path-pattern,Values='/handson-cli-container/*'"のルールを作成する。

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

完了条件 [after]

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

完了条件1
ELBv2ロードバランサ"handson-cli-alb"のリスナー(プロトコル"HTTP"、ポート番号"8080")に、条件が"Field=path-pattern,Values='/handson-cli-container/*'"の、アクションが"Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-container-blue-tg/xxxxxxxxxxxxxxxx"の、デフォルトではないルールが存在する。

事前条件 [before]

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

事前条件1
ELBv2ロードバランサ"handson-cli-albが存在する。
事前条件2
ELBv2ロードバランサ"handson-cli-alb"にプロトコル"HTTP"、ポート番号"8080"のリスナーが存在する。
事前条件3
ターゲットグループ"handson-cli-container-blue-tgが存在する。
事前条件4
ELBv2ロードバランサ"handson-cli-alb"のリスナー(プロトコル"HTTP"、ポート番号"8080")に、条件が"Field=path-pattern,Values='/handson-cli-container/*'"の、アクションが"Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-container-blue-tg/xxxxxxxxxxxxxxxx"の、デフォルトではないルールが存在しない。

作業対象 [what]

  • ELBv2サービス

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: ELBv2ロードバランサ名

  • リスナーを作成するELBv2ロードバランサの名称です。
  • 今回は"handson-cli-alb"とします。

リソース2: リスナーのプロトコル名

  • リスナーのプロトコル名です。
  • 今回は"HTTP"とします。

リソース3: リスナーのポート番号

  • リスナーのポート番号です。
  • 今回は"8080"とします。

リソース4: ターゲットグループ名

  • リスナーと関連付けるターゲットグループの名称です。
  • 今回は"handson-cli-container-blue-tg"とします。

リソース5: 優先度

  • ルールの優先度です。
  • 今回は"2"とします。

リソース6: パスパターン

  • ルールの条件となるURLパスのパターンです。
  • 今回は"/handson-cli-container/*"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. ELBv2ロードバランサ名の指定

ELBv2ロードバランサ名を指定します。

変数の設定:

ELBV2_LB_NAME='handson-cli-alb'

0.2. リスナーのプロトコル名の指定

リスナーのプロトコル名を指定します。

変数の設定:

ELBV2_LISTENER_PROTOCOL="HTTP"

0.3. リスナーのポート番号の指定

リスナーのポート番号を指定します。

変数の設定:

ELBV2_LISTENER_PORT="8080"

0.4. ターゲットグループ名の指定

ターゲットグループ名を指定します。

変数の設定:

ELBV2_TARGET_GROUP_NAME="handson-cli-container-blue-tg"

0.5. 優先度の指定

優先度を指定します。

変数の設定:

ELBV2_RULE_PRIORITY='2'

0.6. パスパターンの指定

パスパターンを指定します。

変数の設定:

URL_PATH_PATTERN='/handson-cli-container/*'

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-elbv2-rule-create.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-alb"
         ELBV2_LB_NAME="${ELBV2_LB_NAME}"
  # 0.2. ELBV2_LISTENER_PROTOCOL:"HTTP"
         ELBV2_LISTENER_PROTOCOL="${ELBV2_LISTENER_PROTOCOL}"
  # 0.3. ELBV2_LISTENER_PORT:"8080"
         ELBV2_LISTENER_PORT="${ELBV2_LISTENER_PORT}"
  # 0.4. ELBV2_TARGET_GROUP_NAME:"handson-cli-container-blue-tg"
         ELBV2_TARGET_GROUP_NAME="${ELBV2_TARGET_GROUP_NAME}"
  # 0.5. ELBV2_RULE_PRIORITY:"2"
         ELBV2_RULE_PRIORITY="${ELBV2_RULE_PRIORITY}"
  # 0.6. URL_PATH_PATTERN:"/handson-cli-container/*"
         URL_PATH_PATTERN="${URL_PATH_PATTERN}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: ELBv2ロードバランサ"handson-cli-albが存在する。

「ELBv2ロードバランサ"handson-cli-albが存在する。」ことを確認します。

コマンド:

aws elbv2 describe-load-balancers \
  --name ${ELBV2_LB_NAME} \
  --query 'LoadBalancers[].LoadBalancerName' \
  --output text

結果(例):

handson-cli-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-alb/xxxxxxxxxxxxxxxx

事前条件2: ELBv2ロードバランサ"handson-cli-alb"にプロトコル"HTTP"、ポート番号"8080"のリスナーが存在する。

「ELBv2ロードバランサ"handson-cli-alb"にプロトコル"HTTP"、ポート番号"8080"のリスナーが存在する。」ことを確認します。

コマンド:

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-alb/xxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxx

リスナーのARNを取得します。

コマンド:

ELBV2_LISTENER_ARN=$( \
  aws elbv2 describe-listeners \
    --load-balancer-arn ${ELBV2_LB_ARN} \
    --query "Listeners[? Protocol == \`${ELBV2_LISTENER_PROTOCOL}\` \
      && Port == \`${ELBV2_LISTENER_PORT}\`].ListenerArn" \
    --output text
) \
  && echo ${ELBV2_LISTENER_ARN}

結果(例):

arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:listener/app/handson-cli-alb/xxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxx

事前条件3: ターゲットグループ"handson-cli-container-blue-tgが存在する。

「ターゲットグループ"handson-cli-container-blue-tgが存在する。」ことを確認します。

コマンド:

aws elbv2 describe-target-groups \
  --names ${ELBV2_TARGET_GROUP_NAME} \
  --query 'TargetGroups[].TargetGroupName' \
  --output text

結果(例):

handson-cli-container-blue-tg

事前条件4: ELBv2ロードバランサ"handson-cli-alb"のリスナー(プロトコル"HTTP"、ポート番号"8080")に、条件が"Field=path-pattern,Values='/handson-cli-container/*'"の、アクションが"Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-container-blue-tg/xxxxxxxxxxxxxxxx"の、デフォルトではないルールが存在しない。

「ELBv2ロードバランサ"handson-cli-alb"のリスナー(プロトコル"HTTP"、ポート番号"8080")に、条件が"Field=path-pattern,Values='/handson-cli-container/*'"の、アクションが"Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-container-blue-tg/xxxxxxxxxxxxxxxx"の、デフォルトではないルールが存在しない。」ことを確認します。

コマンド:

aws elbv2 describe-rules \
  --listener-arn "${ELBV2_LISTENER_ARN}" \
  --query " \
    Rules[?Priority == \`\"${ELBV2_RULE_PRIORITY}\"\` \
      && IsDefault == \`false\` \
      && Conditions[?Field == \`path-pattern\` \
        && contains(Values[], \`${URL_PATH_PATTERN}\`) \
      ] \
      && Actions[?Type == \`forward\` \
        && TargetGroupArn == \`${ELBV2_TARGET_GROUP_ARN}\` \
      ] \
    ].RuleArn" \
  --output text

結果(例):

(出力なし)

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

条件文字列の生成

変数の設定:

STRING_ELBV2_RULE_CONDITIONS="Field=path-pattern,Values='${URL_PATH_PATTERN}'" \
  && echo ${STRING_ELBV2_RULE_CONDITIONS}

結果(例):

Field=path-pattern,Values='/handson-cli-container/*'

ターゲットグループ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-container-blue-tg/xxxxxxxxxxxxxxxx

アクション文字列の生成

変数の設定:

STRING_ELBV2_RULE_ACTIONS="Type=forward,TargetGroupArn=${ELBV2_TARGET_GROUP_ARN}" \
  && echo ${STRING_ELBV2_RULE_ACTIONS}

結果(例):

Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-container-blue-tg/xxxxxxxxxxxxxxxx

2. 主処理

ルールの作成

変数の確認:

cat << ETX

  # ELBV2_LISTENER_ARN:"arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:listener/app/handson-cli-alb/xxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxx"
    ELBV2_LISTENER_ARN="${ELBV2_LISTENER_ARN}"
  # STRING_ELBV2_RULE_CONDITIONS:"Field=path-pattern,Values='/handson-cli-container/*'"
    STRING_ELBV2_RULE_CONDITIONS="${STRING_ELBV2_RULE_CONDITIONS}"
  # ELBV2_RULE_PRIORITY:"2"
    ELBV2_RULE_PRIORITY="${ELBV2_RULE_PRIORITY}"
  # STRING_ELBV2_RULE_ACTIONS:"Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-container-blue-tg/xxxxxxxxxxxxxxxx"
    STRING_ELBV2_RULE_ACTIONS="${STRING_ELBV2_RULE_ACTIONS}"

ETX

コマンド:

aws elbv2 create-rule \
  --listener-arn ${ELBV2_LISTENER_ARN} \
  --conditions "${STRING_ELBV2_RULE_CONDITIONS}" \
  --priority ${ELBV2_RULE_PRIORITY} \
  --actions ${STRING_ELBV2_RULE_ACTIONS}

結果(例):

{
  "Rules": [
    {
        "RuleArn": "arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:listener-rule/app/handson-cli-alb/3ff0dbe36b8bf939/b50b357c050aef3b/288eb3e2f4edfe71",
        "Priority": "2",
        "Conditions": [
            {
                "Field": "path-pattern",
                "Values": [
                    "/handson-cli-container/*"
                ]
            }
        ],
        "Actions": [
            {
                "Type": "forward",
                "TargetGroupArn": "arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-container-blue-tg/xxxxxxxxxxxxxxxx"
            }
        ],
        "IsDefault": false
    }
  ]
}

3. 後処理

完了条件の確認

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

完了条件1: ELBv2ロードバランサ"handson-cli-alb"のリスナー(プロトコル"HTTP"、ポート番号"8080")に、条件が"Field=path-pattern,Values='/handson-cli-container/*'"の、アクションが"Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-container-blue-tg/xxxxxxxxxxxxxxxx"の、デフォルトではないルールが存在する。

「ELBv2ロードバランサ"handson-cli-alb"のリスナー(プロトコル"HTTP"、ポート番号"8080")に、条件が"Field=path-pattern,Values='/handson-cli-container/*'"の、アクションが"Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:targetgroup/handson-cli-container-blue-tg/xxxxxxxxxxxxxxxx"の、デフォルトではないルールが存在する。」ことを確認します。

コマンド:

aws elbv2 describe-rules \
  --listener-arn "${ELBV2_LISTENER_ARN}" \
  --query " \
    Rules[?Priority == \`\"${ELBV2_RULE_PRIORITY}\"\` \
      && IsDefault == \`false\` \
      && Conditions[?Field == \`path-pattern\` \
        && contains(Values[], \`${URL_PATH_PATTERN}\`) \
      ] \
      && Actions[?Type == \`forward\` \
        && TargetGroupArn == \`${ELBV2_TARGET_GROUP_ARN}\` \
      ] \
    ].RuleArn" \
  --output text

結果(例):

arn:aws:elasticloadbalancing:ap-northeast-1:XXXXXXXXXXXX:listener-rule/app/handson-cli-alb/3ff0dbe36b8bf939/b50b357c050aef3b/288eb3e2f4edfe71

完了