Prise en main de VCL personnalisé

Prise en charge rapide d’une version personnalisée du langage de configuration de vernis (VCL) pour adapter la configuration de service Fastly à vos besoins.

Les fragments de code VCL personnalisés sont des blocs de logique VCL ajoutés à la version VCL active chargée sur votre site Adobe Commerce. Un extrait de code VCL personnalisé modifie la manière dont les services de mise en cache rapide répondent au trafic de demande. Par exemple, vous pouvez ajouter un extrait de code VCL personnalisé pour autoriser le trafic de requêtes provenant uniquement d’adresses IP client spécifiées. Vous pouvez également créer un fragment de code afin de bloquer le trafic provenant de sites web connus pour envoyer du courrier indésirable à vos sites Adobe Commerce.

Les fragments de code VCL personnalisés (générés, compilés et transmis à tous les caches rapides) sont chargés et activés sans temps d’arrêt du serveur.

Prise en charge rapide de deux types de fragments de code VCL personnalisés :

Nous vous recommandons d’utiliser des fragments de code VCL personnalisés avec les dictionnaires Edge et les listes de contrôle d’accès (ACL) pour stocker les données utilisées dans votre code personnalisé.

Le dictionnaire et les données ACL sont déployés sur les noeuds Edge rapides accessibles sur plusieurs régions du réseau. En outre, les données peuvent être mises à jour dynamiquement sur le réseau sans que vous ayez à redéployer le code VCL pour votre environnement d’évaluation ou de production.

Tutoriel

Ce tutoriel et ces exemples montrent l’utilisation de fragments de code VCL personnalisés standard avec les dictionnaires Edge et les listes de contrôle d’accès Edge pour personnaliser la configuration de service Fastly pour Adobe Commerce. Pour plus d’informations, voir la documentation Fastly :

Vous pouvez créer et gérer des fragments de code VCL personnalisés à partir de l’administrateur Adobe Commerce ou à l’aide de l’API Fastly :

Exemple de code de fragment de code VCL

L’exemple suivant illustre le fragment de code VCL personnalisé (format JSON) qui filtre le trafic par adresse IP du client :

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

La logique VCL dans le champ content effectue les actions suivantes :

Le tableau suivant fournit des détails sur les données clés des fragments de code VCL personnalisés. Pour une référence plus détaillée, consultez la référence Fragments de code VCL dans la documentation Fastly.

Gestion des VCL personnalisés à partir d’Admin

Vous pouvez ajouter des fragments de code VCL personnalisés à partir de la section Configuration rapide > Fragments de code VCL personnalisés dans l’Admin.

La vue Fragments de code VCL personnalisés affiche uniquement les fragments de code qui ont été ajoutés par l’intermédiaire de l’administrateur. Si des fragments de code sont ajoutés à l’aide de l’API Fastly, utilisez l’API pour les gérer.

Les exemples suivants montrent comment créer et gérer des fragments de code VCL personnalisés à partir de l’administrateur et utiliser des modules Edge Fastly et des dictionnaires Edge :

Gestion de VCL à l’aide de l’API

La présentation suivante vous explique comment créer des fichiers de fragments de code VCL standard et les ajouter à votre configuration de service Fastly à l’aide de l’API Fastly. Vous pouvez créer et gérer les fragments de code à partir de l’application terminal. Vous n’avez pas besoin d’une connexion SSH dans un environnement spécifique.

Conditions préalables :

Ajout de fragments de code VCL

Ce tutoriel décrit les étapes de base pour ajouter des fragments de code personnalisés à l’aide de l’API Fastly.

Conditions préalables

Étape 1 : Localisation de la version VCL active

Utilisez l’opération Fastly API get version pour obtenir le numéro de version VCL actif :

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

Dans la réponse JSON, notez le numéro de version VCL actif renvoyé dans la clé number, par exemple "number": 99. Vous avez besoin du numéro de version lorsque vous clonez le VCL en vue de le modifier.

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

Enregistrez le numéro de version actif dans une variable d’environnement bash afin de l’utiliser dans les demandes d’API suivantes :

export FASTLY_VERSION_ACTIVE=<Version>

Étape 2 : cloner la version VCL active et tous les fragments de code

Avant de pouvoir ajouter ou modifier des fragments de code VCL personnalisés, vous devez créer une copie de la version VCL active pour modification. Utilisez l’opération Fastly API clone :

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

Dans la réponse JSON, le numéro de version est incrémenté et la valeur de clé active est false. Vous pouvez modifier localement la nouvelle version inactive du 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
}

Enregistrez le nouveau numéro de version dans une variable d'environnement de base afin de l'utiliser dans les commandes suivantes :

export FASTLY_EDIT_VERSION=<Version>

Étape 3 : création d’un fragment de code VCL personnalisé

Créez et enregistrez votre code VCL personnalisé dans un fichier JSON avec le contenu et le format suivants :

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

Les valeurs incluent :

Étape 4 : Ajout d’un extrait de code VCL à la configuration Fastly

Utilisez l’opération Fastly API create fragment pour ajouter le fragment de code VCL personnalisé à la version 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> est le nom du fichier que vous avez préparé à l’étape précédente. Répétez cette commande pour chaque extrait de code VCL.

Si vous recevez une réponse 500 Internal Server Error du service Fastly, vérifiez la syntaxe du fichier JSON pour vous assurer que vous chargez un fichier valide.

Étape 5 : validation et activation des fragments de code VCL personnalisés

Après avoir ajouté un extrait de code VCL personnalisé, insère rapidement le fragment de code dans la version VCL que vous modifiez. Pour appliquer des modifications, procédez comme suit pour valider le code du fragment de code VCL et activer la version VCL.

Référence rapide de l’API pour les fragments de code VCL

Ces exemples de requête d’API utilisent des variables d’environnement exportées pour fournir les informations d’identification à authentifier rapidement. Pour plus d’informations sur ces commandes, voir la référence d’API Fastly.