Mode Déploiement avancé

Avec l'intégration Git par défaut de Looker, les développeurs Looker valident leurs modifications dans leur branche de développement, puis fusionnent leur branche de développement dans la branche de production. Ensuite, lorsque vous déployez dans l'environnement Looker, Looker utilise le dernier commit de la branche de production. (Pour connaître le workflow Git par défaut et d'autres options pour les implémentations Git avancées, consultez la page de documentation Utiliser le contrôle des versions et déployer.)

Pour les implémentations Git avancées où vous ne souhaitez pas que le dernier commit de votre branche de production soit utilisé pour votre environnement Looker, un administrateur Looker peut activer le mode de déploiement avancé. Lorsqu'il est activé, le mode de déploiement avancé permet à un développeur disposant de l'autorisation deploy de spécifier un autre SHA de commit ou un autre tag à déployer dans votre environnement de production Looker, au lieu d'utiliser le dernier commit de la branche de production. Si vous souhaitez déployer un commit à partir d'une autre branche, vous pouvez utiliser le webhook du mode de déploiement avancé ou le point de terminaison d'API.

Le mode de déploiement avancé permet de consolider les dépôts dans les workflows de développement multi-environnement, où chaque environnement pointe vers une version différente d'une base de code. Il permet également à un ou plusieurs développeurs ou administrateurs de mieux contrôler les modifications déployées en production.

Lorsque le mode de déploiement avancé est activé, Looker n'invite pas les développeurs à déployer leurs modifications en production. Au lieu de cela, Looker les invite à fusionner leurs modifications dans la branche de production. À partir de là, les modifications ne peuvent être déployées que de la manière suivante :

• À l'aide du gestionnaire de déploiement
• En déclenchant un webhook
• À l'aide d'un point de terminaison d'API

Remarque : Pour les projets pour lesquels le mode de déploiement avancé est activé, si le projet n’a jamais été déployé en production, le déploiement initial en production doit être effectué avec le gestionnaire de déploiement. Vous ne pouvez pas utiliser l'API ni le webhook pour le déploiement initial d'un projet pour lequel le mode de déploiement avancé est activé. Après le déploiement initial en production (même s'il a été déployé initialement sans le mode de déploiement avancé), vous pouvez utiliser le webhook ou l'API pour déployer les modifications ultérieures en production avec le mode de déploiement avancé.

Activer le mode de déploiement avancé

Pour activer le mode de déploiement avancé :

1. Dans l'IDE Looker, accédez à la page Configuration du projet en sélectionnant l'icône Paramètres dans le menu d'icônes, puis en sélectionnant l'onglet Configuration.
2. Sur la page Configuration du projet, cochez la case à côté de Activer le mode de déploiement avancé dans la section Déploiement.
3. Sélectionnez le bouton Enregistrer la configuration du projet pour enregistrer votre modification.

Contrôle des versions avec le mode de déploiement avancé

Lorsque le mode de déploiement avancé est activé, le déploiement en production à partir de Looker n'est plus une option pour les développeurs. Au lieu de cela, lorsque le développeur effectue un commit, le bouton Git l'invite à fusionner ses modifications dans la branche principale au lieu de l'inviter à déployer en production.

Les modifications sont déployées en production à l'aide d'un webhook, de l'API ou du gestionnaire de dépl5oiement.

Gestionnaire de déploiement

Pour les projets pour lesquels le mode de déploiement avancé est activé, les développeurs Looker disposant de l'deployautorisation peuvent utiliser le gestionnaire de déploiement pour déployer un commit ou un tag dans leur environnement de production Looker.

Vous pouvez accéder au gestionnaire de déploiement en sélectionnant l'icône Déployer dans le menu d'icônes.

Le gestionnaire de déploiement affiche tous les commits et tags qui ont été déployés précédemment à l'aide du mode de déploiement avancé.

Remarque : Comme décrit dans la section Déployer un commit à partir du gestionnaire de déploiement de cette page, vous pouvez déployer un commit avec ou sans tag. Si vous déployez un commit avec un tag, le gestionnaire de déploiement affiche le SHA tag, qui est différent d'un SHA commit. Vous pouvez utiliser l'historique des commits de votre projet Looker pour afficher le SHA de commit associé à un tag. Sinon, si vous déployez un commit sans tag, le gestionnaire de déploiement affiche le SHA de commit, qui est le même que celui que vous pouvez voir sur l'interface de votre fournisseur Git ou dans l'historique des commits de votre projet Looker.

Si vous n'avez pas encore utilisé le mode de déploiement avancé pour déployer un commit, cliquez sur le bouton Sélectionner un commit pour afficher l'historique des commits avec les commits que vos développeurs Looker ont fusionnés dans la branche de production.

Pour les projets qui ont utilisé le mode de déploiement avancé pour déployer un commit, l'historique des commits affiche également les tags associés à un commit, le cas échéant, et indique quel commit est la version actuelle utilisée pour la production.

Si la branche de production comporte des commits plus récents que le commit déployé, le gestionnaire de déploiement affiche ces informations et le commit le plus récent que vos développeurs Looker ont fusionné dans la branche de production.

Déployer un commit à partir du gestionnaire de déploiement

Vous pouvez déployer un commit à partir du gestionnaire de déploiement de plusieurs manières :

1. Pour déployer un commit qui n'a pas encore été déployé, cliquez sur le bouton Sélectionner un commit pour sélectionner parmi tous les commits qui ont été fusionnés dans la branche de production distante. (Si vous souhaitez déployer un commit à partir d'une autre branche, utilisez le mode de déploiement avancé webhook ou le point de terminaison d'API.)
2. Pour déployer le commit fusionné le plus récemment dans la branche de production distante, cliquez sur le bouton Déployer la dernière version.
3. Pour déployer un commit ou un tag qui a déjà été déployé, cliquez sur le menu à trois points Options du gestionnaire de déploiement, puis sur Déployer en production.

Si vous choisissez un commit qui n'a pas été déployé précédemment, le gestionnaire de déploiement affiche le menu Déployer le commit. Pour déployer un commit à partir du menu Déployer le commit, procédez comme suit :

1. Pour déployer le commit sans lui attribuer de tag, sélectionnez Déployer sans tag , puis Déployer dans l'environnement. Sinon, laissez l'option Taguer et déployer sélectionnée.

2. Spécifiez un tag pour le commit. Un tag Git marque l'importance du commit dans l'historique du dépôt, par exemple un numéro de version ou un nom de version. Notez les points suivants concernant les tags Git :

   • Les tags Git doivent être uniques dans le dépôt Git. Vous ne pouvez pas utiliser le même tag pour deux commits différents dans votre dépôt.
   • Les tags Git ne peuvent pas contenir d'espaces ni certains caractères spéciaux. Pour connaître les règles de dénomination des références dans Git, consultez la documentation de référence Git.

3. Vous pouvez éventuellement ajouter une description pour le tag afin de fournir plus de détails sur le commit.

4. Sélectionnez Déployer dans l'environnement pour déployer le commit dans la version de production de votre instance Looker.

Une fois que vous avez déployé un commit, le gestionnaire de déploiement le marque comme version actuelle dans votre environnement de production Looker.

Déployer avec des webhooks

Pour les projets avec le mode de déploiement avancé, vous pouvez utiliser le webhook de déploiement pour déployer des modifications en production.

Remarque : Lorsque le mode de déploiement avancé est activé pour un nouveau projet, vous devez utiliser le gestionnaire de déploiement pour le déploiement initial du projet en production. Une fois votre projet déployé en production (même s'il a été déployé initialement sans le mode de déploiement avancé), vous pouvez utiliser le webhook de déploiement pour déployer les modifications ultérieures en production à l'aide du mode de déploiement avancé.

Pour configurer le webhook de déploiement, vous devez d'abord ajouter un secret de webhook pour votre projet Looker à partir de la page Configuration du projet. L'ajout d'un secret de webhook garantit que seules les parties autorisées peuvent déclencher le webhook de déploiement.

Deux webhooks sont disponibles pour déployer des modifications en production lorsque le mode de déploiement avancé est activé. L'un permet de déployer le pointeur HEAD d'une branche, et l'autre de déployer un SHA ou un tag Git spécifique.

Le webhook permettant de déployer le pointeur HEAD d'une branche utilise le format suivant :

<Looker URL>/webhooks/projects/<LookML project name>/deploy/branch/<Git branch name>

Le webhook permettant de déployer un SHA ou un tag de commit utilise le format suivant :

<Looker URL>/webhooks/projects/<LookML project name>/deploy/ref/<commit SHA or tag>

Remplacez les informations entre crochets angulaires < > par les informations spécifiques à l'adresse de votre instance, au projet LookML et au nom de la branche ou au SHA/tag de commit. Voici un exemple de webhook permettant de déployer le nom de tag v1.0 pour le projet e_faa sur l'instance Looker docsexamples.dev.looker.com :

https://docsexamples.dev.looker.com/webhooks/projects/e_faa/deploy/ref/v1.0

Déployer avec l'API

Pour les projets avec le mode de déploiement avancé, vous pouvez utiliser l'API Looker pour déployer des modifications en production.

Remarque : Lorsque le mode de déploiement avancé est activé pour un nouveau projet, vous devez utiliser le gestionnaire de déploiement pour le déploiement initial du projet en production. Une fois votre projet déployé en production (même s'il a été déployé initialement sans le mode de déploiement avancé), vous pouvez utiliser l'API pour déployer les modifications ultérieures en production à l'aide du mode de déploiement avancé.

Pour déployer avec l'API, l'utilisateur de l'API qui effectue l'appel doit disposer de l'autorisation deploy. Pour en savoir plus sur l'authentification et l'utilisation de l'API Looker, consultez les pages de documentation Authentification de l'API Looker et Premiers pas avec l'API.

Pour déployer avec l'API, utilisez le deploy_ref_to_production point de terminaison. Ce point de terminaison peut être appelé de plusieurs manières différentes. Les exemples suivants concernent les méthodes HTTPS et SDK.

HTTPS

Remarque : Lorsque vous utilisez les exemples suivants, veillez à remplacer les informations entre crochets angulaires < > par les informations spécifiques à l'adresse de votre instance, au projet LookML, au nom de la branche, au SHA ou au tag.

Pour effectuer un déploiement manuel à l'aide du point de terminaison d'API deploy_ref_to_production, consultez les exemples suivants, qui utilisent la méthode HTTPS. Pour en savoir plus et obtenir des exemples d'appels manuels à l'API à l'aide de requêtes CURL, consultez le fichier Readme GitHub Comment s'authentifier auprès de l'API ou utilisez l'API Explorer. Vous pouvez installer l'API Explorer sur votre instance Looker à partir de Looker Marketplace.

Utilisez les exemples suivants dans une requête HTTPS pour déployer le pointeur HEAD d'une branche ou un SHA ou un tag de commit spécifique via le point de terminaison d'API deploy_ref_to_production :

Déployer le pointeur HEAD d'une branche: <HOST_URL>/api/4.0/projects/<PROJECT_ID>/deploy_ref_to_production?branch=<BRANCH_NAME>

Déployer un SHA ou un tag de commit: <HOST_URL>/api/4.0/projects/<PROJECT_ID>/deploy_ref_to_production?ref=<SHA_OR_TAG>

SDK

Remarque : Lorsque vous utilisez les exemples suivants, veillez à remplacer les informations entre crochets angulaires < > par les informations spécifiques à votre projet LookML, au nom de la branche, au SHA ou au tag.

Vous pouvez également utiliser l'un des SDK de Looker au lieu d'effectuer des requêtes manuelles auprès de l'API. Les SDK gèrent les détails de l'authentification, de la sérialisation des paramètres et des réponses, ainsi que d'autres aspects.

Le déploiement avec deploy_ref_to_production à l'aide de la méthode SDK se présente comme suit :

Déployer le pointeur HEAD d'une branche: deploy_ref_to_production(<PROJECT_ID>, {branch: <BRANCH_NAME>})

Déployer un SHA ou un tag de commit: deploy_ref_to_production(<PROJECT_ID>, {ref: <SHA_OR_TAG>})