DocumentationCommerceGuide de Commerce sur les infrastructures cloud

Présentation des intégrations

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • Développeur

Les intégrations sont utiles pour utiliser des services externes (tels que l’hébergement Git ou les robots de Slack) et pour gérer vos processus de développement actuels, comme l’utilisation de la fonction de demande d’extraction de révision de code dans GitHub. Vous pouvez ajouter les intégrations suivantes à votre projet d’infrastructure cloud Adobe Commerce :

Intégrations

CLI

Pour ajouter une intégration à l’aide de l’interface de ligne de commande de Cloud :

La commande suivante lance des invites interactives pour sélectionner le type et les options de la nouvelle intégration.

code language-bash 
magento-cloud integration:add

Pour répertorier les intégrations configurées pour votre projet :

code language-bash 
magento-cloud integration:list

Exemple de réponse :

code language-none 
+----------+--------------+---------------------------------------------------------------------------+
| ID       | Type         | Summary                                                                   |
+----------+--------------+---------------------------------------------------------------------------+
| <int-id> | bitbucket    | Repository: user/magento-int                                              |
|          |              | Hook URL:                                                                 |
|          |              | https://magento-url.cloud/api/projects/projectID/integrations/int-ID/hook |
| <int-id> | health.email | From: you@example.com                                                     |
|          |              | To: them@example.com                                                      |
+----------+--------------+---------------------------------------------------------------------------+
Console

Pour ajouter une intégration à l’aide deCloud Console :

  1. Dans Paramètres du projet, cliquez sur Integrations.

  2. Cliquez sur un type d'intégration ou sur Add integration.

  3. Suivez les étapes de sélection et de configuration du type d’intégration.

  4. Une fois l’intégration ajoutée, elle apparaît dans la liste de la vue Intégrations.

Webhooks Commerce

Vous pouvez configurer des webhooks Commerce dans votre projet Cloud avec la variable globale ENABLE_WEBHOOKS. Les webhooks Commerce envoient des requêtes à un serveur externe en réponse aux événements générés par Commerce. Le Guide des webhooks décrit cette fonctionnalité en détail.

Webhooks génériques

Vous pouvez capturer et générer des rapports sur les événements d’infrastructure et de référentiel Cloud à l’aide d’une intégration webhook personnalisée à des messages JSON POST sur une URL webhook.

Pour ajouter une URL webhook, utilisez la syntaxe suivante :

magento-cloud integration:add --type=webhook --url=https://hook-url.example.com
  • type : spécifiez le type d’intégration webhook.
  • url : indiquez l’URL webhook pouvant recevoir les messages JSON.

L’exemple de réponse affiche une série d’invites qui offrent une opportunité de personnaliser l’intégration. L’utilisation de la réponse (vide) par défaut envoie des messages sur tous les événements dans tous les environnements d’un projet.

Vous pouvez personnaliser l’intégration pour créer des rapports sur des événements spécifiques, comme envoyer du code vers une branche. Par exemple, vous pouvez spécifier l’événement environment.push pour envoyer un message lorsqu’un utilisateur envoie du code à une branche :

Events to report (--events)
A list of events to report, e.g. environment.push
Default: *
Enter comma-separated values (or leave this blank)
>

Vous pouvez choisir de signaler les événements à l’état pending, in_progress ou complete :

States to report (--states)
A list of states to report, e.g. pending, in_progress, complete
Default: complete
Enter comma-separated values (or leave this blank)
>

Et vous pouvez inclure ou exclure messages pour des environnements spécifiques :

Included environments (--environments)
The environment IDs to include
Default: *
Enter comma-separated values (or leave this blank)
>

Excluded environments (--excluded-environments)
The environment IDs to exclude
Enter comma-separated values (or leave this blank)
>

Une fois l’intégration terminée, vous recevez un résumé des valeurs :

Created integration integration-ID (type: webhook)
+-----------------------+------------------------------+
| Property              | Value                        |
+-----------------------+------------------------------+
| id                    | integration-ID               |
| type                  | webhook                      |
| events                | - '*'                        |
| environments          | - '*'                        |
| excluded_environments | {  }                         |
| states                | - complete                   |
| url                   | https://hook-url.example.com |
+-----------------------+------------------------------+

Mettre à jour l’intégration existante

Vous pouvez mettre à jour une intégration existante. Par exemple, remplacez les états complete par pending en utilisant les éléments suivants :

magento-cloud integration:update --states=pending <int-id>

Exemple de réponse :

Integration integration-ID (webhook) updated
+-----------------------+------------------------------+
| Property              | Value                        |
+-----------------------+------------------------------+
| id                    | integration-ID               |
| type                  | webhook                      |
| events                | - '*'                        |
| environments          | - '*'                        |
| excluded_environments | {  }                         |
| states                | - pending                    |
| url                   | https://hook-url.example.com |
+-----------------------+------------------------------+

Événements à signaler

Événement
Description
environment.access.add
Un accès à l’environnement a été accordé à un utilisateur
environment.access.remove
Un utilisateur a été supprimé de l’environnement.
environment.activate
Une branche a été "activée" avec un environnement.
environment.backup
Un utilisateur a déclenché un instantané
environment.branch
Une branche a été créée à l’aide de la console de gestion.
environment.deactivate
Une branche a été désactivée. Le code est toujours là mais l'environnement a été détruit
environment.delete
Une branche a été supprimée.
environment.initialize
La branche master du projet initialisée avec une première validation
environment.merge
Une branche active a été fusionnée à l’aide de la console de gestion ou de l’API.
environment.push
Un utilisateur a envoyé le code vers une branche.
environment.restore
Un utilisateur a restauré un instantané
environment.route.create
Un itinéraire a été créé à l’aide de la console de gestion.
environment.route.delete
Un itinéraire a été supprimé à l’aide de la console de gestion.
environment.route.update
Un itinéraire a été modifié à l’aide de la console de gestion.
environment.subscription.update
L’environnement master a été redimensionné car l’abonnement a changé, mais il n’y a aucune modification du contenu.
environment.synchronize
Des données ou du code ont été copiés dans un environnement parent.
environment.update.http_access
Les règles d’accès HTTP pour un environnement ont été modifiées.
environment.update.restrict_robots
La fonction block-all-robots a été activée ou désactivée.
environment.update.smtp
L’envoi d’emails a été activé ou désactivé pour un environnement.
environment.variable.create
Une variable a été créée.
environment.variable.delete
Une variable a été supprimée.
environment.variable.update
Une variable a été modifiée.
project.domain.create
Un domaine a été créé et ajouté au projet.
project.domain.delete
Un domaine associé au projet a été supprimé.
project.domain.update
Un domaine associé au projet a été mis à jour.
recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26