Présentation des intégrations
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 :
Ajout d’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 |
---|
|
Pour répertorier les intégrations configurées pour votre projet:
code language-bash |
---|
|
Exemple de réponse :
code language-terminal |
---|
|
Pour ajouter une intégration à l’aide de la méthodeCloud Console:
-
Dans Paramètres du projet, cliquez sur Integrations.
-
Cliquez sur un type d’intégration ou cliquez sur Add integration.
-
Suivez les étapes de sélection et de configuration du type d’intégration.
-
Une fois l’intégration ajoutée, elle apparaît dans la liste de la vue Intégrations.
Webhooks de commerce
Vous pouvez configurer les webhooks Commerce dans votre projet Cloud à l’aide de l’option ENABLE_WEBHOOKS variable globale. Les webhooks Commerce envoient des requêtes à un serveur externe en réponse aux événements générés par Commerce. La variable Guide de 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 de Cloud à l’aide d’une intégration de webhook personnalisée à POST
Messages JSON à un webhook URL.
Pour ajouter une URL webhook, utilisez la syntaxe suivante ::
magento-cloud integration:add --type=webhook --url=https://hook-url.example.com
type
: indiquez la variablewebhook
type d’intégration.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 spécifiques. events, par exemple en poussant le code vers une branche. Par exemple, vous pouvez spécifier la variable 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 créer des rapports sur les événements d’une pending
, in_progress
, ou complete
state :
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 include ou exclude 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, modifiez les états à partir de complete
to pending
à l’aide des é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
environment.access.add
environment.access.remove
environment.activate
environment.backup
environment.branch
environment.deactivate
environment.delete
environment.initialize
master
branche du projet initialisée avec une première validationenvironment.merge
environment.push
environment.restore
environment.route.create
environment.route.delete
environment.route.update
environment.subscription.update
master
L’environnement a été redimensionné car l’abonnement a changé, mais il n’y a aucune modification du contenu.environment.synchronize
environment.update.http_access
environment.update.restrict_robots
environment.update.smtp
environment.variable.create
environment.variable.delete
environment.variable.update
project.domain.create
project.domain.delete
project.domain.update