カスタム VCLの概要

Fastlyでは、Varnish Configuration Language （VCL）のカスタマイズバージョンをサポートしており、Fastly サービス設定を要件に合わせてカスタマイズできます。

カスタム VCL スニペットは、Adobe Commerce サイトにアップロードされたアクティブ VCL バージョンに追加されたVCL ロジックのブロックです。 カスタム VCL スニペットは、Fastly キャッシングサービスがリクエストトラフィックに応答する方法を変更します。 例えば、カスタム VCL スニペットを追加して、指定したクライアント IP アドレスからのリクエストトラフィックのみを許可できます。 または、スニペットを作成して、Adobe Commerceのサイトにリファラルスパムを配信しているweb サイトからのトラフィックをブロックすることもできます。

カスタム VCL スニペット（生成、コンパイル、すべてのFastly キャッシュへの送信）をサーバーのダウンタイムなしで読み込み、アクティベートできます。

Fastlyは、次の2種類のカスタム VCL スニペットをサポートしています。

カスタムコードで使用されるデータを保存するには、Edge ディクショナリとアクセス制御リスト（ACL）でカスタム VCL スニペットを使用することをお勧めします。

ディクショナリとACL データは、ネットワークリージョンをまたいでアクセスできるFastlyEdgeノードにデプロイされます。 また、ステージング環境または実稼動環境のVCL コードを再デプロイしなくても、データをネットワーク全体で動的に更新できます。

チュートリアル

このチュートリアルと例では、Adobe CommerceのFastly サービス設定をカスタマイズするために、Edge ディクショナリとEdge ACLで通常のカスタム VCL スニペットを使用する方法を示します。 詳細については、Fastlyのドキュメントを参照してください。

Adobe Commerce管理者またはFastly APIを使用して、カスタム VCL スニペットを作成および管理できます。

VCL スニペットコードの例

次の例は、クライアント IP アドレスでトラフィックをフィルタリングするカスタム VCL スニペット（JSON形式）を示しています。

{
  "service_id": "FASTLY_SERVICE_ID",
  "version": "{Editable Version #}",
  "name": "apply_acl",
  "priority": "100",
  "dynamic": "1",
  "type": "hit",
  "content": "if ((client.ip ~ {ACLNAME}) && !req.http.Fastly-FF){ error 403; }"
}

content フィールドのVCL ロジックは、次のアクションを実行します。

次の表に、カスタム VCL スニペットのキーデータの詳細を示します。 詳しくは、Fastly ドキュメントのVCL スニペット ​のリファレンスを参照してください。

管理者からのカスタム VCLの管理

カスタム VCL スニペット 🔗は、管理者の​Fastly設定 > カスタム VCL スニペット セクションから追加できます。

カスタム VCL スニペット ビューには、管理者を通じて追加されたスニペットのみが表示されます。 スニペットがFastly APIを使用して追加された場合は、APIを使用して管理します。

次の例は、管理者からカスタム VCL スニペットを作成および管理する方法、およびFastly Edge モジュールとEdge ディクショナリを使用する方法を示しています。

Commerce管理者で表示または変更できないスニペット

Commerce管理画面では、一部のスニペットを直接表示または変更することはできません。 例：動的スニペット ​。 「カスタム VCL スニペット」セクションには、Fastly管理ダッシュボード ​にクラウドサポートチームによって直接追加されたスニペットは表示されません。

クラウドサポートチームによって追加されたスニペットを確認するには：

APIを使用したVCLの管理

次のチュートリアルでは、通常のVCL スニペットファイルを作成し、Fastly APIを使用してFastly サービス設定に追加する方法を示します。 スニペットは、ターミナル アプリケーションから作成および管理できます。 特定の環境にSSH接続は必要ありません。

前提条件：

VCL スニペットの追加

このチュートリアルでは、Fastly APIを使用してカスタムスニペットを追加する基本的な手順について説明します。

前提条件

手順1：アクティブなVCL バージョンを探す

Fastly API ​ バージョンを取得操作を使用して、アクティブなVCL バージョン番号を取得します。

curl -H "Fastly-Key: $FASTLY_API_TOKEN" https://api.fastly.com/service/$FASTLY_SERVICE_ID/version/active

JSON応答で、number キー（例："number": 99）で返されるアクティブなVCL バージョン番号をメモします。 編集のためにVCLを複製する場合は、バージョン番号が必要です。

{
  "testing": false,
  "locked": true,
  "number": 99,
  "active": true,
  "service_id": "872zhjyxhto5SIRb3GAE0",
  "staging": false,
  "created_at": "2019-01-29T22:38:53Z",
  "deleted_at": null,
  "comment": "Magento Module uploaded VCL",
  "updated_at": "2019-01-29T22:39:06Z",
  "deployed": false
}

後続のAPI リクエストで使用するために、アクティブなバージョン番号をbash環境変数に保存します。

export FASTLY_VERSION_ACTIVE=<Version>

手順2：アクティブなVCL バージョンとすべてのスニペットを複製する

カスタム VCL スニペットを追加または変更する前に、編集用にアクティブ VCL バージョンのコピーを作成する必要があります。 Fastly API ​ クローン ​操作を使用します。

curl -H "Fastly-Key: $FASTLY_API_TOKEN" https://api.fastly.com/service/$FASTLY_SERVICE_ID/version/$FASTLY_VERSION_ACTIVE/clone -X PUT

JSON応答では、バージョン番号が増分され、active キー値はfalseです。 新しい非アクティブなVCL バージョンをローカルで変更できます。

{
  "testing": false,
  "locked": false,
  "number": 100,
  "active": false,
  "service_id": "vW2bLFWhhto5SIRb3GAE0",
  "staging": false,
  "created_at": "2019-01-29T22:38:53Z",
  "deleted_at": null,
  "comment": "Magento Module uploaded VCL",
  "updated_at": "2019-01-29T22:39:06Z",
  "deployed": false
}

新しいバージョン番号をbash環境変数に保存して、後続のコマンドで使用します。

export FASTLY_EDIT_VERSION=<Version>

手順3：カスタム VCL スニペットの作成

カスタム VCL コードを作成し、次のコンテンツと形式でJSON ファイルに保存します。

{
  "name": "<name>",
  "dynamic": "0",
  "type": "<type>",
  "priority": "100",
  "content": "<code all in one line>"
}

値は次のとおりです。

手順4:VCL スニペットをFastly設定に追加する

Fastly API ​ スニペットを作成操作を使用して、カスタム VCL スニペットをVCL バージョンに追加します。

curl -H "Fastly-Key: $FASTLY_API_TOKEN" https://api.fastly.com/service/$FASTLY_SERVICE_ID/version/$FASTLY_EDIT_VERSION/snippet -H 'Content-Type: application/json' -X POST --data @<filename.json>

<filename.json>は、前の手順で準備したファイルの名前です。 VCL スニペットごとに、このコマンドを繰り返します。

Fastly サービスから500 Internal Server Error応答を受け取った場合は、JSON ファイルの構文を確認して、有効なファイルをアップロードしていることを確認します。

手順5：カスタム VCL スニペットの検証とアクティブ化

カスタム VCL スニペットを追加すると、Fastlyは編集中のVCL バージョンにスニペットを挿入します。 変更を適用するには、次の手順を実行してVCL スニペットコードを検証し、VCL バージョンをアクティベートします。

VCL スニペットのAPI クイックリファレンス

これらのAPI リクエストの例では、書き出された環境変数を使用して、Fastlyで認証するための資格情報を提供します。 これらのコマンドについて詳しくは、Fastly API リファレンス ​を参照してください。