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 tag, puis transférer les modifications vers la version de production de votre projet. (Consultez la section Déployer avec des webhooks pour 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 dans les cas suivants:
- Vous déployez les mises à jour dans 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 à déployer en mode de déploiement avancé, ce qui vous permet de spécifier la branche, le SHA de commit ou le nom de tag utilisé pour votre version de production du projet Looker.
- Vous avez configuré votre projet Looker avec des requêtes d'extraction Git. Par conséquent, vous devez déclencher un webhook de déploiement après la fusion d'une demande d'extraction d'extraction afin d'appliquer ces modifications à votre environnement de production Looker. La plupart des services d'hébergement Git permettent d'automatiser ce processus en ajoutant 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 consulter la page Paramètres du projet, mais ne peuvent pas y modifier les options.
Ajouter un secret de déploiement
Looker accepte les secrets Web pour les fournisseurs Git suivants: GitHub, Bitbucket Server et GitLab.
Pour définir un secret de déploiement de webhook pour votre projet, procédez comme suit:
- 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 Webhook Deploy Secret (Déployer le code secret du webhook), puis cliquez sur Set Webhook Secret (Définir le secret de webhook). Looker générera 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 l'avoir à votre disposition si vous devez ajouter le secret au webhook pour votre dépôt. Veillez à le copier à ce stade. Une fois que vous avez quitté ou actualisé la page Paramètres du projet, vous perdez l'accès au secret de déploiement du webhook et devez modifier ou supprimer ce secret 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 procéder au déploiement en production. Pour les projets avec intégration des demande 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 des demande d'extraction Git, si vous avez ajouté un secret de webhook de déploiement à 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.
ASTUCE: Si vous avez configuré votre projet pour l'intégration Git, vous pouvez utiliser l'option View Project on Git (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 correspondant.
Dans le champ Secret (Code secret), collez le secret de déploiement du webhook que vous avez copié à partir de la section Webhook Deploy Secret (Déployer le code secret de webhook) dans Looker.
Cliquez sur Mettre à jour le webhook.
Le code secret du webhook est désormais requis pour déployer des 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, si vous êtes un administrateur Looker, vous pouvez le modifier en procédant comme suit:
- Dans votre projet, sélectionnez l'icône Paramètres dans la barre de navigation.
- Faites défiler la page jusqu'à la section Webhook Deploy Secret (Déploiement du webhook) et cliquez sur Reset Secret (Réinitialiser le 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 l'avoir à votre disposition si vous devez ajouter le secret au webhook pour votre dépôt. À ce stade, veillez à le copier depuis votre presse-papiers. Une fois que vous aurez quitté ou actualisé la page Paramètres du projet, vous perdrez l'accès au secret de déploiement du webhook et devrez revenir en arrière pour le modifier ou le supprimer complètement.
- Cliquez sur Save Project Configuration (Enregistrer la configuration du projet).
Si votre projet est configuré avec l'intégration des demande 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 un administrateur Looker, vous pouvez le supprimer en procédant comme suit:
- Dans votre projet, sélectionnez l'icône Paramètres dans la barre de navigation.
- Faites défiler la page jusqu'à la section Webhook Deploy Secret (Déploiement du webhook) et cliquez sur Remove Secret (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 des demande 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 lui-même ne recherchera plus de secret du côté du fournisseur Git. Si un secret est toujours configuré dans le webhook de votre dépôt Git, cela n'aura donc aucun impact. 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 en savoir plus sur la modification du secret dans l'interface d'un fournisseur Git.