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 de SHA ou d'un nom de tag, puis les envoie à 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 si l'une des circonstances suivantes s'applique:
- 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 un déploiement en 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. Vous devez donc déclencher un webhook de déploiement lorsque vous fusionnez une demande d'extraction'extraction pour pouvoir appliquer ces modifications à votre environnement de production Looker. La plupart des services d'hébergement Git disposent de moyens d'automatisation 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 qu'il exige 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 ses options.
Ajouter un secret de déploiement
Pour définir un 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 de l'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 de déploiement du webhook, puis cliquez sur Définir le secret du webhook. Looker génère 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 de le disposer si vous avez besoin de l'ajouter au webhook pour votre dépôt. Veillez à le copier à ce stade. Si vous quittez ou actualisez la page Paramètres du projet, vous n'aurez plus accès au secret de déploiement du webhook et devrez modifier ou supprimer ce secret pour récupérer l'accès à votre projet.
- Cliquez sur Enregistrer la configuration du projet.
Le secret de déploiement de 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 déployer en production. Pour les projets intégrant l'intégration de demande d'extraction Git, vous devez accéder à l'interface de votre fournisseur Git pour ajouter le secret au webhook pour votre dépôt.
Configurer le secret pour le webhook de votre dépôt Git
Pour les projets avec intégration de demande 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. Par exemple, voici comment faire à l'aide de 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é l'intégration Git pour votre projet, vous pouvez utiliser l'option Afficher le projet sur Git dans le 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 le bouton Modifier.
Dans la zone de texte Secret, collez le secret que vous avez copié dans la section Webhook Deploy Secret de Looker.
Cliquez sur Mettre à jour le webhook.
Le secret du webhook est désormais nécessaire pour déployer les modifications dans la version de production de votre projet. Si nécessaire, vous pouvez modifier le secret ou le supprimer de votre projet.
Modifier un secret de déploiement
Une fois qu'un secret de déploiement de webhook a été ajouté à votre projet, vous pouvez le modifier en tant qu'administrateur Looker:
- Dans 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 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 de le conserver si vous avez besoin de l'ajouter au webhook pour votre dépôt. N'oubliez pas de le copier depuis le presse-papiers. Si vous quittez ou actualisez la page Paramètres du projet, vous n'aurez plus accès au secret de déploiement du webhook et devrez le modifier ou le supprimer complètement.
- Cliquez sur Enregistrer la configuration du projet.
Si votre projet est configuré avec l'intégration de demande d'extraction Git, vous devez également accéder à l'interface de votre fournisseur Git pour mettre à jour le secret de 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, procédez comme suit si vous êtes un administrateur Looker:
- Dans 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 n'a plus besoin d'un secret pour le déploiement du webhook. Si votre projet est configuré avec l'intégration de demande d'extraction Git, vous pouvez désormais supprimer l'objet secret du webhook de votre dépôt depuis l'interface de votre fournisseur Git. Looker ne recherchera plus de secret du côté du fournisseur Git. Il n'y a donc pas de problème si un secret est encore configuré pour votre webhook Git. Si vous souhaitez supprimer le secret de votre dépôt Git, consultez l'article Configurer le secret pour le webhook de votre dépôt Git pour en savoir plus sur la modification du secret dans l'interface d'un fournisseur Git.