Akamai Agent

概要

NetFUNNEL Akamai エージェントは、Akamai EdgeWorker から NetFUNNEL サーバーと通信する NetFUNNEL 専用クライアントです。

EdgeWorker の作成

• メニューの [EdgeWorkers] をクリックします。
• [Create EdgeWorker ID] をクリックします。
• 内容を入力し、[Create EdgeWorker ID] をクリックして EdgeWorker を作成します。
• 作成した EdgeWorker を選択し、[Create version] をクリックします。
• [Open editor] をクリックします。

エージェントコードのアップロード

• https://agent-lib.stclab.com/agents/cdn/akamai/netfunnel-akamai-agent-latest.js から netfunnel-akamai-agent.js ファイルをダウンロードしてください。
• [Code Bundle] タブで main.js ファイルを選択し、netfunnel-akamai-agent.js の内容を貼り付けます。
• bundle.json ファイルを選択し、以下のコードを参考に作成してください。

{
    "edgeworker-version": "1.0.0",
    "description" : "akamai-agent-1.0.0"
}

• [Create new version] をクリックしてバージョンを作成します。

EdgeWorker のデプロイ

• 作成が完了したら [Activate version] をクリックします。
• [Production] を選択し、[Activate version] をクリックしてデプロイします。
• デプロイが完了すると、Current Status が Complete になります。

Property 設定

Property の作成

備考

すでに Property を作成している場合は、Property 設定の手順に進んでください。

• メニューの [Properties] をクリックします。
• [New Property] をクリックします。
• [Create Property] をクリックします。
• [Guide me] をクリックします。
• 内容を入力し、[Next] をクリックします。
• 入力した Hostname の値が正しく登録されているか確認し、[Next] をクリックします。
• STEP1 に進みます。
• 内容を入力し、[Validate] をクリックし、環境に合った EDGE CERTIFICATE を選択します。
• [Continue] をクリックし、キャッシュ設定後に [Next] をクリックします。
• STEP2 に進みます。[Next] をクリックします。
• STEP3 に進みます。[Activate] をクリックします。
• 完了したら [Next] をクリックします。
• STEP4 に進みます。[Next] をクリックします。
• STEP5 に進みます。[Exit] をクリックして Property の作成を完了します。

Property 設定

Property の選択

• メニューの [Properties] をクリックします。
• 作成した Property を選択します。
• 編集するバージョンを選択します。（一番上のバージョンを選択してください。）

Property Variables の設定

• 以下の表を参考に Property Variables を追加します。

VARIABLE NAME	INITIAL VALUE
NF_CLIENT_ID	CLIENT_ID

備考

CLIENT_ID は NetFUNNEL コンソールで確認できます。

Property Configuration Settings の設定

EdgeWorker ルールの追加

• Property Configuration Settings で [+Rules] をクリックします。
• [Blank Rule Template] を選択し、入力欄に NF EdgeWorker と入力して [Insert Rule] をクリックします。
• Criteria で [+Match] をクリックし、次のように設定します。
  • Path
  • matches one of
  • /*
• [+Match] をクリックし、次のように設定します。
  • File Extension
  • is not one of
  • hdml、html 以外のすべての拡張子を選択します。
  • フォント、動画、音声、ドキュメントファイルなどを除外するため、次の拡張子も追加します: woff, woff2, ttf, eot, otf, sfnt, svg, webp, avif, map, mp4, webm, ogg, ogv, flac, acc, docx, xls, xlsx, ppt, pptx, csv, xml, json
• Behaviors で [+Behavior] をクリックし、Standard property behavior を選択します。
• EdgeWorkers を選択し、[Insert Behavior] をクリックします。
• Identifier で、先に作成した EdgeWorker を選択します。

Core Origin ルールの追加

• Property Configuration Settings で [+Rules] をクリックします。
• [Blank Rule Template] を選択し、入力欄に NF Core Origin と入力して [Insert Rule] をクリックします。
• Criteria で [+Match] をクリックし、次のように設定します。
  • Path
  • matches one of
  • /ts.wseq
• Behaviors で [+Behavior] をクリックし、Standard property behavior を選択します。
• Origin Server を選択し、[Insert Behavior] をクリックします。
• 以下の表を参考に設定してください。（表にない項目は既定値で設定してください。）

Origin Type	Your Origin
Origin Server Hostname	{CLIENT_ID}.netfunnel.stclab.com e.g. stclab-0601.netfunnel.stclab.com
Forward Host Header	Origin Hostname
Cache Key Hostname	Origin Hostname

Setting Origin ルールの追加

• Property Configuration Settings で [+Rules] をクリックします。
• [Blank Rule Template] を選択し、入力欄に NF Setting Origin と入力して [Insert Rule] をクリックします。
• Criteria で [+Match] をクリックし、次のように設定します。
  • Path
  • matches one of
  • {{NF_SETTING_URL}} の Path（例: /stclab-0601.netfunnel/nf-setting.json）
• Behaviors で [+Behavior] をクリックし、Standard property behavior を選択します。
• Origin Server を選択し、[Insert Behavior] をクリックします。
• 以下の表を参考に設定してください。（表にない項目は既定値で設定してください。）

Origin Type	Your Origin
Origin Server Hostname	nf-setting-bucket.stclab.com
Forward Host Header	Origin Hostname
Cache Key Hostname	Origin Hostname

Property の保存と有効化

• 右下の [Save] をクリックします。
• 上部の [Activate] タブをクリックし、Production Network で [Activate {version} on Production] をクリックします。
• Verifying が完了したら、上部の警告メッセージのボックスにチェックを入れ、[Activate {version} on Production] をクリックします。
• 処理が終わると、Property の有効化が完了します。

追加機能

Good Bot の例外処理

Property 設定により、特定の User-Agent が含まれる場合にエージェントの動作から除外できます。

Property 設定

• EdgeWorker が適用されている Property を選択します。
• Property Configuration Settings で NF EdgeWorker を選択します。
• Criteria で [+Match] をクリックします。
• User Agent、is not one of を選択します。
• 除外したい Good Bot の User-Agent を追加します。
• 右下の [Save] をクリックします。
• 上部の [Activate] タブをクリックし、Production Network で [Activate {version} on Production] をクリックします。
• Verifying が完了したら、上部の警告メッセージのボックスにチェックを入れ、[Activate {version} on Production] をクリックします。

進入キーの自動返却

NetFUNNEL Akamai エージェントは、進入後に NetFUNNEL キーを自動で返却し、次の待機者が進入できるようにしています。 NetFUNNEL キーを即座に返却せず、セグメントで設定したタイムアウト時に返却したい場合にこの機能を使用できます。

Property 設定

• EdgeWorker が適用されている Property を選択します。
• 以下の表を参考に Property Variables を追加します。

VARIABLE NAME	INITIAL VALUE
NF_RETURN_KEY	true

備考

true（既定値）の場合、待機完了後の進入時にエージェントが NetFUNNEL キーを自動で返却します。 false の場合、セグメントで設定したタイムアウト時にキーが返却されます。

• 右下の [Save] をクリックします。
• 上部の [Activate] タブをクリックし、Production Network で [Activate {version} on Production] をクリックします。
• Verifying が完了したら、上部の警告メッセージのボックスにチェックを入れ、[Activate {version} on Production] をクリックします。

待機室ドメインの変更

NetFUNNEL 待機室ページのドメインは agent-lib.stclab.com です。 サービスで使用するドメインに変更する場合は、NetFUNNEL サービスチームに希望ドメインを伝え、Property 設定を変更してください。

Property 設定

• EdgeWorker が適用されている Property を選択します。
• 以下の表を参考に Property Variables を追加します。

VARIABLE NAME	INITIAL VALUE
NF_VWR_PAGE_DOMAIN	http(s)://{CNAME_DOMAIN} e.g. https://wait.stclab.com

• 右下の [Save] をクリックします。
• 上部の [Activate] タブをクリックし、Production Network で [Activate {version} on Production] をクリックします。
• Verifying が完了したら、上部の警告メッセージのボックスにチェックを入れ、[Activate {version} on Production] をクリックします。

クッキードメインの設定

NetFUNNEL サーバーから発行されたキーは、現在のページのドメインを基準にクッキーに保存されます。 サブドメイン間でキーを共有する必要がある場合は、メインドメインがクッキーに保存されるよう設定します。

備考

develop.stclab.com と staging.stclab.com のようにサブドメインが異なるページでクッキーを共有するには、.stclab.com と設定します。

Property 設定

• EdgeWorker が適用されている Property を選択します。
• 以下の表を参考に Property Variables を追加します。

VARIABLE NAME	INITIAL VALUE
NF_COOKIE_DOMAIN	.{MAIN_DOMAIN} e.g. .stclab.com

• 右下の [Save] をクリックします。
• 上部の [Activate] タブをクリックし、Production Network で [Activate {version} on Production] をクリックします。
• Verifying が完了したら、上部の警告メッセージのボックスにチェックを入れ、[Activate {version} on Production] をクリックします。