2.6. リスナーの作成 (80)

作業の目的 [why]

ELBv2ロードバランサ"handson-2017-10-09"にリスナーを作成します。

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

完了条件 [after]

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

完了条件1
ELBv2ロードバランサ"handson-2017-10-09"にリスナーが存在する。

事前条件 [before]

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

事前条件1
ELBv2ロードバランサ"handson-2017-10-09が存在する。
事前条件2
ターゲットグループ"handson-target-group-2017-10-09が存在する。
事前条件3
ELBv2ロードバランサ"handson-2017-10-09"にリスナーが存在しない。

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

課題

(未検証)

作業対象 [what]

  • ELBv2サービス

標準時間

8分

前提条件

作業権限条件 [who]

本作業は、以下の作業権限を有する人が行います。

作業権限条件: ELBv2への権限

ELBに対してフル権限があること。

作業環境条件 [where]

本作業は、以下の作業環境で行います。

作業環境条件1: OSとバージョン

Amazon Linuxの以下のバージョンで動作確認済

コマンド:

cat /etc/issue | head -1

結果(例):

Amazon Linux AMI release 2016.09

作業環境条件2: シェルとバージョン

bashの以下のバージョンで動作確認済

コマンド:

bash --version -v | head -1

結果(例):

GNU bash, バージョン 4.2.46(1)-release (x86_64-redhat-linux-gnu)

作業環境条件3: AWS CLIのバージョン

以下のバージョンで動作確認済

  • AWS CLI 1.11.117

コマンド:

aws --version

結果(例):

aws-cli/1.11.166 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.7.24

バージョンが古い場合は最新版に更新しましょう。

コマンド:

sudo -H pip install -U awscli

開始条件

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

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

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

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

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

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

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

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

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

  • リスナーと関連付けるターゲットグループの名称です。
  • 今回は"handson-target-group-2017-10-09"とします。

リソース5: リスナーのデフォルトアクションタイプ

  • リスナーのデフォルトのアクションです。
  • 今回は"forward"とします。

作業開始 [when]

以下を全て満たしているとき、作業を開始します。

  • 開始の指示があった場合。

タスクの実施

0. パラメータの指定

まず変数の確認をします。

変数の確認:

cat << ETX

  0.a. AWS_DEFAULT_PROFILE          actual: ${AWS_DEFAULT_PROFILE}
                                    expect: <IAMのフル権限を許可されたプロファイル>
  0.b. AWS_DEFAULT_REGION           actual: ${AWS_DEFAULT_REGION}
                                    expect: ap-northeast-1

  0.1. ELBV2_LB_NAME                actual: ${ELBV2_LB_NAME}
                                    expect: handson-2017-10-09
  0.2. ELBV2_LISTENER_PROTOCOL      actual: ${ELBV2_LISTENER_PROTOCOL}
                                    expect: HTTP
  0.3. ELBV2_LISTENER_PORT          actual: ${ELBV2_LISTENER_PORT}
                                    expect: 80
  0.4. ELBV2_TARGET_GROUP_NAME      actual: ${ELBV2_TARGET_GROUP_NAME}
                                    expect: handson-target-group-2017-10-09
  0.5. ELBV2_LB_DEFAULT_ACTION_TYPE actual: ${ELBV2_LB_DEFAULT_ACTION_TYPE}
                                    expect: forward

ETX

変数が入っていない、適切でない場合は、それぞれの手順番号について作業を行います。

0.a. プロファイルの指定

プロファイルの一覧を確認します。

コマンド:

cat ~/.aws/credentials \
 | grep '\[' \
 | sed 's/\[//g' | sed 's/\]//g'

結果(例):

iamFull-prjz-mbpr13
<IAMのフル権限を許可されたプロファイル>

変数の設定:

export AWS_DEFAULT_PROFILE='<IAMのフル権限を許可されたプロファイル>'

0.b. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

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

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

変数の設定:

ELBV2_LB_NAME='handson-2017-10-09'

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

リスナーのプロトコル名です。

変数の設定:

ELBV2_LISTENER_PROTOCOL="HTTP"

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

リスナーのポート番号です。

変数の設定:

ELBV2_LISTENER_PORT="80"

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

リスナーと関連付けるターゲットグループの名称です。

変数の設定:

ELBV2_TARGET_GROUP_NAME="handson-target-group-2017-10-09"

0.5. リスナーのデフォルトアクションタイプの指定

リスナーのデフォルトのアクションタイプです。

変数の設定:

ELBV2_LB_DEFAULT_ACTION_TYPE="forward"

再確認

設定されている変数の内容を再確認します。

変数の確認:

cat << ETX

  0.a. AWS_DEFAULT_PROFILE          actual: ${AWS_DEFAULT_PROFILE}
                                    expect: <IAMのフル権限を許可されたプロファイル>
  0.b. AWS_DEFAULT_REGION           actual: ${AWS_DEFAULT_REGION}
                                    expect: ap-northeast-1

  0.1. ELBV2_LB_NAME                actual: ${ELBV2_LB_NAME}
                                    expect: handson-2017-10-09
  0.2. ELBV2_LISTENER_PROTOCOL      actual: ${ELBV2_LISTENER_PROTOCOL}
                                    expect: HTTP
  0.3. ELBV2_LISTENER_PORT          actual: ${ELBV2_LISTENER_PORT}
                                    expect: 80
  0.4. ELBV2_TARGET_GROUP_NAME      actual: ${ELBV2_TARGET_GROUP_NAME}
                                    expect: handson-target-group-2017-10-09
  0.5. ELBV2_LB_DEFAULT_ACTION_TYPE actual: ${ELBV2_LB_DEFAULT_ACTION_TYPE}
                                    expect: forward

ETX

1. 前処理

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

sample

1.2. 処理対象の状態確認

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

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

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

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

コマンド:

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

結果(例):

[
  "handson-2017-10-09"
]

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:<AWS ID>:loadbalancer/app/handson-2017-10-09/67925c69284037c4

事前条件2: ターゲットグループ"handson-target-group-2017-10-09が存在する。

「ターゲットグループ"handson-target-group-2017-10-09が存在する。」ことを確認します。

コマンド:

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

結果(例):

[
  "handson-target-group-2017-10-09"
]

ターゲットグループの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:<AWS ID>:targetgroup/handson-target-group-2017-10-09/xxxxxxxxxxxxxxxx

事前条件3: ELBv2ロードバランサ"handson-2017-10-09"にリスナーが存在しない。

「ELBv2ロードバランサ"handson-2017-10-09"にリスナーが存在しない。」ことを確認します。

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

設定文字列の生成

変数の設定:

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:<AWS ID>:targetgroup/handson-target-group-2017-10-09/xxxxxxxxxxxxxxxx

2. 主処理

リスナの作成

変数の確認:

cat << ETX

  ELBV2_LB_ARN             actual: ${ELBV2_LB_ARN}
                           expect: arn:aws:elasticloadbalancing:ap-northeast-1:<AWS ID>:loadbalancer/app/handson-2017-10-09/67925c69284037c4
  ELBV2_LISTENER_PROTOCOL  actual: ${ELBV2_LISTENER_PROTOCOL}
                           expect: HTTP
  ELBV2_LISTENER_PORT      actual: ${ELBV2_LISTENER_PORT}
                           expect: 80
  ELBV2_LB_DEFAULT_ACTIONS actual: ${ELBV2_LB_DEFAULT_ACTIONS}
                           expect: Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:ap-northeast-1:<AWS ID>:targetgroup/handson-target-group-2017-10-09/xxxxxxxxxxxxxxxx

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}

結果(例):

{
  "Listeners": [
    {
        "Protocol": "HTTP",
        "DefaultActions": [
            {
                "TargetGroupArn": "arn:aws:elasticloadbalancing:ap-northeast-1:<AWS ID>:targetgroup/handson-target-group-2017-10-09/xxxxxxxxxxxxxxxx",
                "Type": "forward"
            }
        ],
        "LoadBalancerArn": "arn:aws:elasticloadbalancing:ap-northeast-1:<AWS ID>:loadbalancer/app/handson-2017-10-09/67925c69284037c4",
        "Port": 80,
        "ListenerArn": "arn:aws:elasticloadbalancing:ap-northeast-1:<AWS ID>:listener/app/handson-2017-10-09/handson-2017-10-09/xxxxxxxxxxxxxxxx"
    }
  ]
}

3. 後処理

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

sample

3.2. 完了条件の確認

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

完了条件1: ELBv2ロードバランサ"handson-2017-10-09"にリスナーが存在する。

「ELBv2ロードバランサ"handson-2017-10-09"にリスナーが存在する。」ことを確認します。

完了