Un point de terminaison de déploiement de webhook invite votre instance Looker à déployer les modifications à partir d'une branche Git, d'un SHA de commit ou d'un nom de balise, puis à les transférer vers la version de production de votre projet. Consultez la section Déployer avec des webhooks pour en savoir plus sur les formats de webhooks de déploiement Looker. 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 conditions suivantes s'applique :
- Vous déployez les mises à jour vers 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é, ce qui vous permet de spécifier la branche, le commit SHA ou le nom du tag utilisé pour votre version de production du projet Looker.
- Vous avez configuré votre projet Looker avec des requêtes pull Git, ce qui signifie que vous devez déclencher un webhook de déploiement après avoir fusionné une demande d'extraction pour pouvoir appliquer ces modifications à votre environnement de production Looker. La plupart des services d'hébergement Git proposent des moyens d'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 de sorte 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 consulter la page Configuration du projet, mais ne peuvent pas modifier les options qu'elle contient.
Ajouter un secret de déploiement
Looker est compatible avec les secrets Web pour les fournisseurs Git suivants : GitHub, Bitbucket Server et GitLab.
Pour définir un secret de déploiement du webhook pour votre projet, procédez comme suit:
- En mode développement, ouvrez votre projet, puis sélectionnez l'icône 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 Webhook 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 pouvoir l'ajouter au webhook de votre dépôt si nécessaire. N'oubliez pas de le copier à ce stade. Lorsque vous quittez ou actualisez la page Configuration du projet, vous perdez l'accès au secret de déploiement du webhook et devez le modifier ou le supprimer pour récupérer l'accès au projet.
- Cliquez sur 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 procéder au 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.
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 du 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 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 Git, 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 le champ Secret (Secret), collez le secret de déploiement du webhook que vous avez copié dans la section Webhook Deploy Secret (Secret de déploiement du webhook) de Looker.
Cliquez sur Mettre à jour le webhook.
Le secret du webhook est désormais requis pour déployer les modifications dans la version de production de votre projet. Si nécessaire, vous pouvez modifier le code secret ou le supprimer de votre projet.
Modifier un secret de déploiement
Une fois qu'un secret de déploiement du 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 Webhook de déploiement du webhook, puis cliquez sur Réinitialiser le code secret. Looker générera automatiquement un nouveau 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 pouvoir l'ajouter au webhook de votre dépôt si nécessaire. N'oubliez pas de le copier depuis votre presse-papiers à ce stade. Une fois que vous quittez ou actualisez la page Configuration du projet, vous perdez l'accès au secret de déploiement du webhook et devez revenir en arrière pour le modifier ou le supprimer complètement.
- Cliquez sur Enregistrer la configuration du projet.
Si votre projet est configuré avec l'intégration des demandes d'extraction Git, vous devez également accéder à l'interface de votre fournisseur Git pour mettre à jour le secret du webhook pour 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 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 Webhook de déploiement du webhook, puis cliquez sur Supprimer le secret. À ce stade, vous pouvez annuler l'opération et conserver le secret de déploiement 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 demande d'extraction Git, vous pouvez désormais accéder à l'interface de votre fournisseur Git pour supprimer le code secret du webhook de votre dépôt. Looker ne recherchera plus de secret côté fournisseur Git. Il n'y a donc pas de mal à savoir si un secret est toujours configuré dans le webhook de votre dépôt Git. Si vous souhaitez supprimer le secret de votre dépôt Git, consultez Configurer le secret pour le webhook de votre dépôt Git pour savoir comment modifier le secret dans l'interface d'un fournisseur Git.