Erste Schritte mit benutzerdefinierter VCL

Fastly unterstützt eine angepasste Version der Varnish Configuration Language (VCL), um die Fastly-Service-Konfiguration an Ihre Anforderungen anzupassen.

Benutzerdefinierte VCL-Snippets sind Blöcke von VCL-Logik, die zur aktiven VCL-Version hinzugefügt werden, die auf Ihre Adobe Commerce-Site hochgeladen wird. Ein benutzerdefiniertes VCL-Fragment ändert, wie Fastly-Caching-Services auf Anfrage-Traffic reagieren. Sie können beispielsweise ein benutzerdefiniertes VCL-Fragment hinzufügen, um Anfrage-Traffic nur von angegebenen Client-IP-Adressen zuzulassen. Oder erstellen Sie einen Code-Ausschnitt, um den Traffic von Websites zu blockieren, die als Spam für Verweise an Ihre Adobe Commerce-Sites bekannt sind.

Benutzerdefinierte VCL-Snippets - generiert, kompiliert und an alle Fastly-Caches übertragen - werden geladen und aktiviert, ohne dass der Server ausfällt.

Fastly unterstützt zwei Arten von benutzerdefinierten VCL-Snippets:

Es wird empfohlen, benutzerdefinierte VCL-Snippets mit Edge Dictionaries und Zugriffssteuerungslisten (ACL) zu verwenden, um die in Ihrem benutzerdefinierten Code verwendeten Daten zu speichern.

Das Wörterbuch und die ACL-Daten werden auf den Fastly Edge-Knoten bereitgestellt, auf die über Netzwerkregionen zugegriffen werden kann. Außerdem können die Daten dynamisch über das Netzwerk aktualisiert werden, ohne dass Sie den VCL-Code für Ihre Staging- oder Produktionsumgebung erneut bereitstellen müssen.

Tutorial

In diesem Tutorial und den Beispielen wird die Verwendung regulärer benutzerdefinierter VCL-Snippets mit Edge-Wörterbüchern und Edge-ACLs veranschaulicht, um die Fastly-Service-Konfiguration für Adobe Commerce anzupassen. Weitere Informationen finden Sie in der Fastly-Dokumentation:

Sie können benutzerdefinierte VCL-Snippets über Adobe Commerce Admin oder die Fastly-API erstellen und verwalten:

Beispiel für VCL-Code-Ausschnitt

Das folgende Beispiel zeigt das benutzerdefinierte VCL-Snippet (JSON-Format), das Traffic nach Client-IP-Adresse filtert:

{
  "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; }"
}

Die VCL-Logik im content führt die folgenden Aktionen aus:

Die folgende Tabelle enthält Details zu Schlüsseldaten für benutzerdefinierte VCL-Snippets. Eine detailliertere Referenz finden Sie unter der Referenz VCL-Snippets in der Fastly-Dokumentation.

Benutzerdefinierte VCL von Admin aus verwalten

Sie können benutzerdefinierte VCL-Snippets hinzufügen im Abschnitt Fastly-Konfiguration > Benutzerdefinierte VCL-Snippets in Admin hinzufügen.

Die Benutzerdefinierte VCL-" zeigt nur Ausschnitte an, die über die Admin hinzugefügt wurden. Wenn Snippets mit der Fastly-API hinzugefügt werden, verwenden Sie die API, um sie zu verwalten.

Die folgenden Beispiele zeigen, wie Sie benutzerdefinierte VCL-Snippets vom Administrator erstellen und verwalten und Fastly Edge-Module und Edge-Wörterbücher verwenden:

Verwalten von VCL mithilfe der API

Die folgende Anleitung zeigt Ihnen, wie Sie mit der Fastly-API reguläre VCL-Snippet-Dateien erstellen und zu Ihrer Fastly-Service-Konfiguration hinzufügen können. Sie können die Snippets über das Programm Terminal erstellen und verwalten. Sie benötigen keine SSH-Verbindung zu einer bestimmten Umgebung.

Voraussetzungen:

VCL-Snippets hinzufügen

In diesem Tutorial werden die grundlegenden Schritte zum Hinzufügen benutzerdefinierter Snippets mithilfe der Fastly-API beschrieben.

Voraussetzungen

Schritt 1: Suchen der aktiven VCL-Version

Verwenden Sie den Fastly-APIVorgang „Version abrufen, um die aktive VCL-Versionsnummer abzurufen:

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

Beachten Sie in der JSON-Antwort die aktive VCL-Versionsnummer, die im number zurückgegeben wird, z. B. "number": 99. Sie benötigen die Versionsnummer, wenn Sie die VCL zur Bearbeitung klonen.

{
  "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
}

Speichern Sie die aktive Versionsnummer in einer Bash-Umgebungsvariablen zur Verwendung in nachfolgenden API-Anfragen:

export FASTLY_VERSION_ACTIVE=<Version>

Schritt 2: Klonen Sie die aktive VCL-Version und alle Snippets

Bevor Sie benutzerdefinierte VCL-Snippets hinzufügen oder ändern können, müssen Sie eine Kopie der aktiven VCL-Version zur Bearbeitung erstellen. Verwenden Sie den Fastly-APIKlon-Vorgang:

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

In der JSON-Antwort wird die Versionsnummer erhöht und der active-Schlüsselwert wird false. Sie können die neue, inaktive VCL-Version lokal ändern.

{
  "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
}

Speichern Sie die neue Versionsnummer in einer Bash-Umgebungsvariablen zur Verwendung in nachfolgenden Befehlen:

export FASTLY_EDIT_VERSION=<Version>

Schritt 3: Erstellen eines benutzerdefinierten VCL-Snippets

Erstellen und speichern Sie den benutzerdefinierten VCL-Code in einer JSON-Datei mit folgendem Inhalt und Format:

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

Die Werte umfassen:

Schritt 4: Hinzufügen eines VCL-Snippets zur Fastly-Konfiguration

Verwenden Sie den Fastly-APISnippet erstellen-Vorgang, um das benutzerdefinierte VCL-Snippet zur VCL-Version hinzuzufügen.

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>

Der <filename.json> ist der Name der Datei, die Sie im vorherigen Schritt vorbereitet haben. Wiederholen Sie diesen Befehl für jeden VCL-Code-Ausschnitt.

Wenn Sie eine 500 Internal Server Error Antwort vom Fastly-Service erhalten, überprüfen Sie die JSON-Dateisyntax, um sicherzustellen, dass Sie eine gültige Datei hochladen.

Schritt 5: Validieren und Aktivieren benutzerdefinierter VCL-Snippets

Nachdem Sie ein benutzerdefiniertes VCL-Snippet hinzugefügt haben, fügt Fastly das Snippet in die VCL-Version ein, die Sie bearbeiten. Um Änderungen anzuwenden, führen Sie die folgenden Schritte aus, um den VCL-Code-Ausschnitt zu validieren und die VCL-Version zu aktivieren.

API-Schnellreferenz für VCL-Snippets

Diese API-Anfragebeispiele verwenden exportierte Umgebungsvariablen, um die Anmeldeinformationen bereitzustellen, mit denen sich Fastly authentifizieren kann. Weitere Informationen zu diesen Befehlen finden Sie in der Fastly-API-Referenz.