Komma igång med anpassad VCL

Stöd snabbt för en anpassad version av VCL (Varnish Configuration Language) för att anpassa snabbtjänstkonfigurationen efter dina behov.

Anpassade VCL-kodfragment är block med VCL-logik som lagts till i den aktiva VCL-versionen som överförts till din Adobe Commerce-webbplats. Ett anpassat VCL-fragment ändrar hur Fast caching-tjänster svarar på förfrågningstrafik. Du kan t.ex. lägga till ett anpassat VCL-kodfragment som endast tillåter begärandetrafik från angivna IP-adresser för klienten. Du kan också skapa ett fragment som blockerar trafik från webbplatser som är kända för att skicka skräppost till dina Adobe Commerce-webbplatser.

Anpassade VCL-kodfragment - genererade, kompilerade och överförda till alla fast cacheminnen - laddas och aktiveras utan serverdriftavbrott.

Stöd för två typer av anpassade VCL-fragment:

Vi rekommenderar att du använder anpassade VCL-kodfragment med Edge-ordlistor och ACL-listor (Access Control Lists) för att lagra data som används i din anpassade kod.

Ordlistan och ACL-data distribueras till Edge-noder med snabb åtkomst över olika nätverksregioner. Data kan också uppdateras dynamiskt i nätverket utan att du behöver omdistribuera VCL-koden för din staging- eller produktionsmiljö.

Självstudiekurs

I den här självstudiekursen och exemplen visas hur du använder vanliga anpassade VCL-fragment med Edge-ordlistor och Edge ACL:er för att anpassa snabbtjänstkonfigurationen för Adobe Commerce. Mer detaljerad information finns i Snabb-dokumentationen:

Du kan skapa och hantera anpassade VCL-kodfragment från Adobe Commerce Admin eller via Fast API:

Exempel på VCL-kodfragment

I följande exempel visas det anpassade VCL-kodfragment (JSON-format) som filtrerar trafik efter klientens IP-adress:

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

VCL-logiken i fältet content utför följande åtgärder:

Följande tabell innehåller information om nyckeldata för anpassade VCL-fragment. Mer information finns i referensen VCL-kodfragment i dokumentationen för Snabb.

Hantera anpassad VCL från administratör

Du kan lägga till anpassade VCL-fragment under Snabbkonfiguration > Anpassade VCL-fragment i Admin.

Vyn Anpassade VCL-kodfragment visar endast fragment som har lagts till via administratören. Om fragment läggs till med API:t Snabb använder du API:t för att hantera dem.

I följande exempel visas hur du skapar och hanterar anpassade VCL-kodfragment från administratören och använder Fastly Edge-moduler och Edge-ordlistor:

Hantera VCL med API

I följande genomgång visas hur du skapar vanliga VCL-kodfragmentfiler och lägger till dem i din snabbtjänstkonfiguration med API:t Snabb. Du kan skapa och hantera fragment från programmet terminal. Du behöver ingen SSH-anslutning till en viss miljö.

Förutsättningar:

Lägg till VCL-fragment

I den här självstudiekursen beskrivs de grundläggande stegen för att lägga till anpassade fragment med hjälp av API:t Snabb.

Förutsättningar

Steg 1: Hitta den aktiva VCL-versionen

Använd åtgärden hämta version för snabbprogrammeringsgränssnittet för att hämta det aktiva versionsnumret för VCL:

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

Observera det aktiva versionsnumret för VCL i JSON-svaret som returneras i number-nyckeln, till exempel "number": 99. Versionsnumret behövs när du klonar VCL för redigering.

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

Spara det aktiva versionsnumret i en basmiljövariabel för användning i efterföljande API-begäranden:

export FASTLY_VERSION_ACTIVE=<Version>

Steg 2: Klona den aktiva VCL-versionen och alla kodfragment

Innan du kan lägga till eller ändra anpassade VCL-fragment måste du skapa en kopia av den aktiva VCL-versionen för redigering. Använd åtgärden clone för snabbprogrammeringsgränssnittet:

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

I JSON-svaret ökas versionsnumret och nyckelvärdet active är false. Du kan ändra den nya, inaktiva VCL-versionen lokalt.

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

Spara det nya versionsnumret i en basmiljövariabel och använd det i följande kommandon:

export FASTLY_EDIT_VERSION=<Version>

Steg 3: Skapa ett anpassat VCL-fragment

Skapa och spara egen VCL-kod i en JSON-fil med följande innehåll och format:

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

Värdena är:

Steg 4: Lägg till VCL-kodfragment för snabb konfiguration

Använd snabbmeny-API:t skapa fragment för att lägga till det anpassade VCL-fragmentet i VCL-versionen.

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> är namnet på filen som du förberedde i föregående steg. Upprepa det här kommandot för varje VCL-fragment.

Om du får ett 500 Internal Server Error-svar från tjänsten Snabbt kontrollerar du JSON-filsyntaxen för att vara säker på att du överför en giltig fil.

Steg 5: Validera och aktivera anpassade VCL-fragment

När du har lagt till ett anpassat VCL-fragment infogar snabbt fragmentet i den VCL-version som du redigerar. Följ de här stegen för att validera VCL-fragmentkoden och aktivera VCL-versionen om du vill tillämpa ändringarna.

API-snabbreferens för VCL-fragment

I dessa API-frågeexempel används exporterade miljövariabler för att tillhandahålla autentiseringsuppgifter för att autentisera med Fast. Mer information om de här kommandona finns i Snabb API-referens.