はじめに

先日業務でメンテナンス画面を表示して、その間にメンテナンス作業をするタスクをすることになりました。どのようにこのタスクを行ったのかを記して、自分への備忘録として、かつ、同じようなタスクを与えられたエンジニアへ向けて参考になればと思い、投稿させていただきます。

やりたいこと

一般のユーザーにはメンテナンス画面を表示する。

一方でメンテナンス作業をするエンジニアにはアプリの機能を通常通り操作できるようにする。

環境

AWSのALBとCloudFrontを使用している。

作業手順

1. 準備

まずは、準備としてメンテナンス作業を行うエンジニアの環境のグローバルIPアドレスを調べましょう。

以下のサイトにアクセスすると確認できます。

https://www.cman.jp/network/support/go_access.cgi

2. ALBの設定

AWSコンソールからログインをしてロードバランサーの設定画面でリスナーの設定をしましょう。

作業手順は以下のように行います。

ルールを編集画面へ

ルールを挿入する

ヘッダーの＋ボタンをクリックする
ルールを追加したい位置の「ルール挿入」をクリックする（ルールは順番に上から適応されるので注意）

全てのパスからのアクセスをメンテナンス画面に遷移させるようにする

条件の追加をクリックして「パス…」を選択する
パスに*を指定して設定する（*は「すべて」を意味する）
アクションの追加をクリックして「固定レスポンスを返す…」を選択する
レスポンス本文に一般ユーザーに表示させたい画面のデータを入れる

※今回は「メンテナンス中です。」と文字しか入れてませんが、制限はありますが、凝ったHTMLを入れることも可能です。（https://blog.serverworks.co.jp/alb-fixed-response）

作業をする環境のIPアドレスからのアクセス時のみ、サーバーにアクセスするようにする

条件の追加から「HTTPヘッダー…」を選択する

HTTPヘッダーに「X-forwarded-for」と入力して、値にメンテナンスする環境のグローバルIPアドレスを入力する。

X-forwarded-forとは？（https://www.infraexpert.com/study/loadbalancer11.html）

◆　XFF（ X-Forwarded-For ）とは

　X-Forwarded-Forとは、HTTPヘッダフィールドの1つであり、ロードバランサなどの機器を経由して
　Webサーバに接続するクライアントの送信元IPアドレスを特定する際のデファクトスタンダードです。
　クライアントの送信元IPアドレスの特定は、ロードバランサなどでクライアントの送信元IPアドレスが
　変換された場合でも、HTTPヘッダに元のクライアントIPアドレスの情報を付加することで実現します。

アクションの追加で「転送先…」を選択する
メンテナンス作業をしたいターゲットグループを選択する

ルールの順番を確認して保存する

順番を確認して保存する
1. IPアドレスが指定したものか判定
2. 指定したものでなければメンテナンス画面へ
3. ルールを保存

3. 動作確認

許可されていないIPアドレスで入る
許可されたIPアドレスで入ると通常のサーバーの画面が表示される。（画面は割愛させていただきます。）
作業が終わったらルールを削除してください。これにて終了です。

4. さいごに

他の手段もあるようですが、この方法は簡単ではないかと思います。

複雑な画面を表示しないのであれば参考にしていただければと思います。

またこちらの記事は私の初めての投稿でできるだけ駆け出しでもパニックを起こさないように少ない文字数で作成してみました。なので至らぬ点もあるかもしれません。その際はコメントいただけると今後に繋がりますのでご指摘いただければと思います。

参考記事

ALBでのメンテナンス画面の表示

パスについて

パス名について（https://www.tohoho-web.com/ex/draft/path.htm）

X-forwarded-for

XFF （ X-Forwarded-For ）