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. (Pour connaître les formats de webhook de déploiement Looker, consultez la section Déploiement avec des webhooks.) 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 de webhook de déploiement.
Toutefois, vous devez utiliser un webhook de déploiement pour transférer les modifications en production si l'une des circonstances suivantes s'applique :
- Vous transférez des 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 avec le mode de déploiement avancé, qui vous permet de spécifier la branche, le SHA de commit ou le nom de balise utilisé pour la version de production de votre projet Looker.
- Vous avez configuré votre projet Looker avec des demandes d'extraction Git, ce qui signifie que vous devez déclencher un webhook de déploiement une fois que vous avez 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 permettent d'automatiser ce processus si vous ajoutez le webhook à l'interface de votre fournisseur Git.
Si vous êtes administrateur Looker, vous pouvez configurer le webhook de déploiement pour qu'il nécessite 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 qui s'y trouvent.
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 de webhook pour 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 Webhook Deploy Secret (Secret de déploiement de webhook), puis cliquez sur Set Webhook Secret (Définir le secret de 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 de webhook et collez-le dans un fichier texte. Vous pourrez ainsi l'utiliser si vous devez l'ajouter au webhook de votre dépôt. Veillez à le copier à ce stade. Une fois que vous quittez ou actualisez la page Configuration du projet, vous perdez l'accès au secret de déploiement de webhook et vous devrez le modifier ou le supprimer pour y accéder à nouveau.
- Cliquez sur Save Project Configuration (Enregistrer la configuration du projet).
Le webhook 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 de webhook dans votre en-tête HTTP afin d'effectuer un déploiement en production. Pour les projets avec intégration de 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 de 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. Voici un exemple de procédure 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 Edit (Modifier).
Dans le champ Secret, collez le secret de déploiement de webhook que vous avez copié dans la section Webhook Deploy Secret (Secret de déploiement de webhook) de Looker.
Cliquez sur Update webhook (Mettre à jour le webhook).
Le secret de webhook est désormais obligatoire pour déployer les modifications dans la version de production de votre projet. Si nécessaire, vous pouvez modifier le secret ou supprimer le secret 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 administrateur Looker, vous pouvez le modifier en procédant comme suit :
- Dans votre projet, sélectionnez l'icône Settings (Paramètres) dans la barre de navigation.
- Faites défiler la page jusqu'à la section Webhook Deploy Secret (Secret de déploiement de webhook), puis cliquez sur Reset Secret (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 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 de webhook et collez-le dans un fichier texte. Vous pourrez ainsi l'utiliser si vous devez l'ajouter au webhook de votre dépôt. Veillez à le copier à ce stade. Une fois que vous quittez ou actualisez la page Configuration du projet, vous perdez l'accès au secret de déploiement de webhook et vous devrez 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 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, si vous êtes administrateur Looker, vous pouvez le supprimer en procédant comme suit :
- Dans votre projet, sélectionnez l'icône Settings (Paramètres) dans la barre de navigation.
- Faites défiler la page jusqu'à la section Webhook Deploy Secret (Secret de déploiement de webhook), puis 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 Don't Remove (Ne pas supprimer).
- Pour supprimer définitivement le secret de déploiement de webhook de votre projet, cliquez sur Save Project Configuration (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 maintenant accéder à l'interface de votre fournisseur Git pour supprimer le secret de webhook de votre dépôt. Looker lui-même ne vérifiera plus la présence d'un secret côté fournisseur Git. Il n'est donc pas nécessaire de supprimer le secret du webhook de votre dépôt Git. Si vous souhaitez supprimer le secret de votre dépôt Git, consultez la section 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.