Configurer un hub d'actions local pour les actions qui utilisent OAuth et le streaming

Si une instance Looker hébergée par un client ne peut pas communiquer avec Action Hub hébergé sur Looker, les administrateurs Looker peuvent ne pas être en mesure d'activer les actions qui acceptent les résultats en flux continu ou qui utilisent OAuth. De plus, les utilisateurs de Looker peuvent être confrontés à des requêtes mises en attente lors de l'envoi ou de la planification de données vers des actions qui prennent en charge les résultats en flux continu, et peuvent ne pas être en mesure de configurer les actions OAuth.

Pour utiliser les intégrations Looker, l'Action Hub Looker et l'instance Looker doivent pouvoir communiquer entre eux. Les administrateurs d'instances hébergées par le client qui souhaitent en savoir plus sur les solutions adaptées à l'architecture de leur instance peuvent consulter les recommandations décrites dans la section Points à prendre en compte pour les instances hébergées par le client de la page de documentation Partager des données via un hub d'actions.

Si l'instance utilise un certificat SSL émis par une autorité de certification (AC) qui ne figure pas dans cette liste de certificats racine, il est possible que les actions OAuth et de streaming ne soient pas utilisables sur une instance Looker hébergée par le client.

Pour afficher les actions configurées pour prendre en charge la diffusion de résultats ou OAuth, consultez la liste des services intégrés de Looker sur la page de documentation Paramètres d'administration – Actions.

Cette page explique comment lancer un serveur Action Hub local pour utiliser les actions Looker qui prennent en charge les résultats diffusés ou qui utilisent Google OAuth. Vous pouvez configurer votre propre serveur Action Hub local en créant un conteneur ou une machine virtuelle (VM) qui héberge une copie clonée du code du dépôt Looker Action Hub, puis en suivant ces étapes, comme décrit plus en détail dans les sections suivantes :

  1. Créez une configuration de conteneur ou de machine virtuelle (VM) pour le serveur de l'Action Hub.
  2. Configurer les identifiants Google OAuth
  3. Configurez l'écran de consentement Google OAuth.
  4. Configurez vos variables d'environnement.
  5. Générez une clé API.
  6. Démarrez le nouveau hub d'actions.
  7. Ajoutez le nouveau hub d'actions à votre instance Looker.

Créer une configuration de conteneur ou de machine virtuelle (VM) pour le serveur Action Hub

Votre VM ou votre conteneur doivent répondre aux exigences et dépendances suivantes en termes d'allocation et de réseau :

Looker recommande d'allouer deux threads de processeur/processeur virtuel et au moins 2 Go de mémoire pour ce conteneur ou cette VM. Si vous prévoyez une utilisation intensive de vos actions, envisagez d'augmenter la mémoire au-delà de 2 Go.

Configuration réseau requise

Votre plate-forme d'actions doit disposer d'une adresse IP statique ou d'une adresse pouvant être résolue via un système de noms de domaine (DNS) interne.

Votre réseau doit répondre aux exigences de communication suivantes :

  • L'instance Looker doit pouvoir communiquer avec le hub d'actions.
  • L'authentification Google doit pouvoir communiquer avec le centre d'actions.
  • Un navigateur connecté en interne doit pouvoir accéder au centre d'action.
  • Le centre d'actions doit pouvoir accéder aux serveurs Google Drive.

Dépendances requises

Lorsque vous clonez le dépôt d'actions Looker dans la VM ou le conteneur que vous venez de créer :

  • Assurez-vous que Node 12.13 est installé.
  • Exécutez yarn install pour installer les packages nécessaires.

Une fois votre environnement configuré, vous devrez créer des identifiants Google OAuth pour votre serveur Action Hub dans la console Google Cloud API.

Configurer les identifiants Google OAuth

Pour configurer les identifiants Google OAuth pour vos actions, vous devez :

Créer les identifiants Google OAuth

Pour créer votre ID client et votre code secret du client Google OAuth :

  1. Accédez à la page Gérer les ressources de Google Cloud, puis cliquez sur CRÉER UN PROJET pour créer un projet.

    Pour en savoir plus sur la création d'un projet, consultez le guide Créer et gérer des projets.

  2. Une fois votre nouveau projet créé, sélectionnez-le.
  3. Dans la barre latérale de gauche de la console, accédez à la page API et services > Identifiants.
  4. Cliquez sur Créer des identifiants.
  5. Dans le menu déroulant, cliquez sur ID client OAuth.
  6. Vous devrez peut-être configurer un écran de consentement OAuth. Si c'est le cas, suivez les instructions de la section Configurer l'écran de consentement OAuth plus loin sur cette page, puis passez à l'étape 7.
  7. Dans le champ Type d'application, sélectionnez Application Web.
  8. Saisissez le nom de votre application dans le champ Nom.
  9. Dans la section Origines JavaScript autorisées, ajoutez l'adresse de l'application Looker racine que vous utilisez en interne.
  10. Définissez les URI de redirection autorisés pour les consoles Google Drive et Google Sheets, où ACTION_HUB_BASE_URL correspond à l'adresse de votre hub d'actions : 
                https://<ACTION_HUB_BASE_URL>/actions/google_sheets/oauth_redirect
            https://<ACTION_HUB_BASE_URL>/actions/google_drive/oauth_redirect
  11. Cliquez sur le bouton Créer pour générer votre ID client OAuth et le code secret du client OAuth. Vous en aurez besoin ultérieurement.

Cette page de la console Google APIs vous permet de configurer un écran de consentement pour toutes les applications de votre projet. Les utilisateurs peuvent ainsi accorder l'accès à leurs données et obtenir un lien vers les documents juridiques ou de confidentialité. Si vous avez déjà effectué cette étape ou si vous n'avez pas besoin de configurer un écran de consentement, ignorez cette section et revenez à la fenêtre de votre terminal pour définir vos variables d'environnement, comme décrit dans Définir vos variables d'environnement plus loin sur cette page.

Pour configurer l'écran d'autorisation :

  1. Cliquez sur CONFIGURER L'ÉCRAN DE CONSENTEMENT.
  2. Indiquez s'il s'agit d'une application interne ou externe, puis cliquez sur CRÉER.
  3. Saisissez le nom de votre application dans le champ Nom de l'application.
  4. Pour l'adresse e-mail d'assistance utilisateur, saisissez une adresse e-mail à afficher sur l'écran de consentement OAuth pour l'assistance utilisateur.
  5. Si vous le souhaitez, pour le logo de l'application, importez un fichier image à utiliser sur l'écran de consentement OAuth.
  6. Vous pouvez également saisir le lien vers la page d'accueil de votre application, qui doit être hébergée sur le même domaine racine que votre hub d'actions.
  7. Si vous le souhaitez, saisissez un lien vers les règles de confidentialité de votre application dans le champ Lien vers les règles de confidentialité de l'application. Le lien doit être hébergé sur le même domaine racine que votre plate-forme d'actions.
  8. Vous pouvez également saisir un lien vers les conditions d'utilisation de votre application dans le champ Lien vers les conditions d'utilisation de l'application. Le lien doit être hébergé sur le même domaine racine que votre plate-forme d'actions.
  9. Dans la section Domaines autorisés, cliquez sur AJOUTER UN DOMAINE, puis saisissez le domaine racine utilisé par votre plate-forme d'actions.
  10. Dans le champ Coordonnées du développeur, saisissez une adresse e-mail à laquelle Google peut vous contacter.
  11. Cliquez sur SAVE AND CONTINUE (ENREGISTRER ET CONTINUER).
  12. Dans la section Niveaux d'accès, ajoutez les types de données utilisateur auxquels votre application doit accéder. Cela inclut l'adresse e-mail, le profil, OpenID et https://mail.google.com. Comme cette liste inclut des informations utilisateur sensibles, Google devra valider votre écran de consentement OAuth avant de pouvoir la publier.
  13. Cliquez sur SAVE AND CONTINUE (ENREGISTRER ET CONTINUER).
  14. Si vous le souhaitez, dans la section Utilisateurs de test, ajoutez les utilisateurs auxquels vous souhaitez donner accès au hub d'actions avant la validation.
  15. Cliquez sur SAVE AND CONTINUE (ENREGISTRER ET CONTINUER).
  16. Cliquez sur RETOUR AU TABLEAU DE BORD.
  17. Dans la barre latérale de gauche, cliquez sur Identifiants pour revenir à la configuration de vos identifiants OAuth.

Une fois que vous avez configuré votre écran de consentement OAuth, si vous étiez en train de configurer des identifiants Google OAuth, revenez à l'étape 7 de cette procédure et terminez la configuration des identifiants. Sinon, vous pouvez revenir à la fenêtre de terminal pour définir vos variables d'environnement.

Définir vos variables d'environnement

Dans votre environnement de VM ou de conteneur, définissez les variables d'environnement suivantes : 

    ACTION_HUB_LABEL=<your action hub label name>
        ACTION_HUB_SECRET=<some secret>
        ACTION_HUB_BASE_URL=<your action hub base address>
            # For example https://actions.company.com
            # DO NOT INCLUDE A TRAILING SLASH
        GOOGLE_SHEET_CLIENT_ID=<OAuth client ID>
        GOOGLE_SHEET_CLIENT_SECRET=<OAuth client secret>
        GOOGLE_DRIVE_CLIENT_ID=<OAuth client ID>
        GOOGLE_DRIVE_CLIENT_SECRET=<OAuth client secret>

Vous devriez pouvoir utiliser les mêmes OAuth client ID et OAuth client secret pour Google Drive et Google Sheets. Toutefois, il est préférable de définir les deux ensembles de jetons d'API Google.

Définissez également la clé de chiffrement : 

    CIPHER_MASTER="<hex aes-256 key>"

Cette clé n'est pas utilisée pour le chiffrement à long terme. Elle sert uniquement à chiffrer state lors d'un flux OAuth. Voici un exemple de clé AES-256 hexadécimale : 

    C4EFBBE2C364248419776459A00F2F4017CE77E29D9E8F64940687EA440A0CC9

Générer une clé API

Pour obtenir votre clé API, exécutez cette commande :

y arn generate-api-key

Conservez la clé générée pour l'utiliser ultérieurement dans la configuration. Cette clé est générée en fonction de ACTION_HUB_SECRET.

Démarrer votre serveur local Action Hub

Pour démarrer votre hub d'actions, exécutez la commande suivante :

yarn start

Ajouter votre Action Hub à votre instance Looker

Pour ajouter votre Action Hub à votre instance Looker :

  1. Dans Looker, accédez à la page Actions sous Plate-forme dans le panneau Admin.
  2. Faites défiler la page jusqu'en bas, puis cliquez sur le bouton Ajouter un hub d'actions.
  3. Saisissez votre ACTION_HUB_BASE_URL, puis cliquez sur Ajouter Action Hub. Votre centre d'actions devrait apparaître sous un nouveau titre avec son nom et ACTION_HUB_BASE_URL. Vos actions Google Drive et Google Sheets devraient apparaître sous cet en-tête.
  4. Si la connexion échoue, saisissez le api-key que vous avez généré précédemment dans le champ Jeton d'autorisation, puis cliquez sur le lien Actualiser en haut du titre de votre hub d'actions.
  5. Activez vos actions Google Drive et Google Sheets, puis vérifiez qu'elles sont correctement configurées dans votre centre d'actions.

Étape suivante

L'étape suivante consiste à publier l'application que vous avez créée dans la console Google APIs. Pour publier l'application, accédez à la page Écran d'autorisation OAuth, puis cliquez sur le bouton Soumettre pour validation. Veuillez noter que la publication de l'application peut prendre un certain temps et nécessitera quelques étapes de validation avec Google.