Un point de terminaison de déploiement de webhook invite votre instance Looker à déployer les modifications à partir d'une branche Git, d'un commit SHA ou d'un nom de tag, puis à les transférer vers la version de production de votre projet. Pour la plupart des projets, Looker gère les intégrations Git et déploie les mises à jour en production. Vous n'avez donc pas besoin de configurer un webhook de déploiement.
Toutefois, vous devez utiliser un webhook de déploiement pour déployer les modifications en production dans les cas suivants:
- Vous déployez les mises à jour sur la branche de production distante en dehors de l'IDE Looker, ce qui est courant dans les workflows de développement avec des environnements de préproduction.
- Vous souhaitez utiliser un webhook pour effectuer des déploiements avec le mode de déploiement avancé, qui vous permet de spécifier la branche, le commit SHA ou le nom de tag utilisé pour votre version de production du projet Looker.
- Vous avez configuré votre projet Looker avec des demandes d'extraction Git. Cela signifie que vous devez déclencher un webhook de déploiement après avoir fusionné une demande d'extraction afin de transférer ces modifications vers votre environnement de production Looker. La plupart des services d'hébergement Git peuvent automatiser cette opération si vous ajoutez le webhook à l'interface de votre fournisseur Git.
Si vous êtes un administrateur Looker, vous pouvez configurer le webhook de déploiement pour exiger un secret afin que seules les parties autorisées puissent le déclencher.
Les développeurs Looker qui ne sont pas administrateurs peuvent afficher la page Paramètres du projet, mais ne peuvent pas modifier les options sur celui-ci.
Ajouter un secret de déploiement
Pour définir un secret secret de déploiement de webhook dans votre projet:
- En mode Développement, ouvrez votre projet et sélectionnez l'icône des paramètres dans la barre de navigation IDE pour ouvrir le panneau des paramètres du projet.
- Sélectionnez Configuration dans le panneau des paramètres du projet.
- Faites défiler la page jusqu'à la section Secret du webhook de déploiement, puis cliquez sur Définir un secret de webhook. Looker va générer automatiquement un jeton secret. Vous pouvez utiliser ce secret généré automatiquement ou saisir votre propre jeton secret.
- Que vous utilisiez le secret généré automatiquement ou que vous créiez votre propre secret, copiez le secret de déploiement du webhook et collez-le dans un fichier texte afin d'en disposer si vous devez l'ajouter au webhook de votre dépôt. Assurez-vous de le copier à ce stade. Une fois que vous avez quitté ou actualisé la page Paramètres du projet, vous n'avez plus accès à la clé secrète de déploiement du webhook. Vous devez la modifier ou la supprimer pour récupérer l'accès à votre projet.
- Cliquez sur Save Project Configuration (Enregistrer la configuration du projet).
Le webhook de déploiement pour votre projet nécessite désormais ce secret. Pour les projets qui utilisent une instance de préproduction Looker, vous devez inclure le secret de déploiement du webhook dans votre en-tête HTTP afin de pouvoir effectuer le déploiement en production. Pour les projets avec intégration de demandes d'extraction Git, vous devez accéder à l'interface de votre fournisseur Git pour ajouter le secret au webhook de votre dépôt.
Configuration du secret pour le webhook de votre dépôt Git
Pour les projets intégrant l'intégration de demandes d'extraction Git, si vous avez ajouté un secret de déploiement de webhook à votre projet LookML, vous devez accéder à l'interface de votre fournisseur Git pour ajouter le secret au webhook de votre dépôt. À titre d'exemple, voici comment procéder avec GitHub:
Accédez aux paramètres du dépôt de votre projet sur le site Web de votre fournisseur Git.
CONSEIL: Si vous avez configuré votre projet pour l'intégration de Git, vous pouvez utiliser l'option View Project on Git (Afficher le projet sur Git) du menu Git de votre projet dans Looker.
Dans les paramètres de votre dépôt, cliquez sur Webhooks.
Recherchez le webhook de votre projet LookML, puis cliquez sur son bouton Modifier.
Dans la zone de texte Secret (Secret), collez le secret de déploiement de webhook que vous avez copié dans la section Secret de déploiement de webhook de Looker.
Cliquez sur Mettre à jour le webhook.
Le secret du webhook est désormais nécessaire pour déployer les modifications apportées à la version de production de votre projet. Si nécessaire, vous pouvez modifier le secret ou le supprimer du projet.
Modifier un secret de déploiement
Une fois qu'un secret de déploiement de webhook a été ajouté à votre projet, si vous êtes administrateur Looker, vous pouvez le modifier en procédant comme suit:
- Depuis votre projet, sélectionnez l'icône Paramètres dans la barre de navigation.
- Faites défiler la page jusqu'à la section Secret de déploiement du webhook, puis cliquez sur Réinitialiser le secret. Looker génère automatiquement un nouveau jeton secret. Vous pouvez utiliser ce secret généré automatiquement ou saisir votre nouveau jeton.
- Que vous utilisiez le secret généré automatiquement ou que vous créiez votre propre secret, copiez le secret de déploiement du webhook et collez-le dans un fichier texte afin de l'avoir si vous devez l'ajouter au webhook de votre dépôt. Assurez-vous de le copier depuis le presse-papiers à ce stade. Une fois que vous avez quitté ou actualisé la page Paramètres du projet, vous n'avez plus accès à la clé secrète de déploiement du webhook. Vous devez alors la modifier ou la supprimer complètement.
- Cliquez sur Save Project Configuration (Enregistrer la configuration du projet).
Si votre projet est configuré avec l'intégration de demandes d'extraction Git, vous devez également accéder à l'interface de votre fournisseur Git pour mettre à jour le secret du webhook de votre dépôt.
Supprimer un secret de déploiement
Une fois qu'un secret de déploiement de webhook a été ajouté à votre projet, si vous êtes un administrateur Looker, vous pouvez le supprimer en procédant comme suit:
- Depuis votre projet, sélectionnez l'icône Paramètres dans la barre de navigation.
- Faites défiler la page jusqu'à la section Secret de déploiement du webhook, puis cliquez sur Supprimer le secret. À ce stade, vous pouvez annuler l'opération et garder le déploiement secret en cliquant sur Ne pas supprimer.
- Pour supprimer définitivement le secret de déploiement du webhook de votre projet, cliquez sur Enregistrer la configuration du projet.
Votre projet ne nécessite plus de secret pour le webhook de déploiement. Si votre projet est configuré avec l'intégration de demandes d'extraction Git, vous pouvez désormais accéder à l'interface de votre fournisseur Git pour supprimer le secret du webhook de votre dépôt. Looker ne vérifie plus la présence d'un secret du côté du fournisseur Git. Ainsi, le secret d'un secret configuré dans votre webhook de dépôt Git ne sera pas affecté. Si vous souhaitez supprimer le secret du dépôt Git, consultez la page Configurer le secret du secret de votre dépôt Git pour savoir comment modifier le secret sur l'interface d'un fournisseur Git.