Lokalen Aktions-Hub für Aktionen einrichten, bei denen OAuth und Streaming verwendet werden

Wenn eine vom Kunden gehostete Looker-Instanz nicht mit dem von Looker gehosteten Action Hub kommunizieren kann, können Looker-Administratoren möglicherweise keine Aktionen aktivieren, die gestreamte Ergebnisse unterstützen oder OAuth verwenden. Außerdem kann es bei Looker-Nutzern beim Senden oder Planen von Daten an Aktionen, die gestreamte Ergebnisse unterstützen, zu in der Schwebe befindlichen Abfragen kommen. Außerdem können sie möglicherweise keine OAuth-Aktionen konfigurieren.

Damit Looker-Integrationen verwendet werden können, müssen der Looker Action Hub und die Looker-Instanz miteinander kommunizieren können. Administratoren von von Kunden gehosteten Instanzen, die sich über Lösungen informieren möchten, die für ihre Instanzarchitektur geeignet sind, finden auf der Dokumentationsseite Daten über einen Action Hub freigeben im Abschnitt Hinweise für von Kunden gehostete Instanzen entsprechende Empfehlungen.

Wenn die Instanz ein SSL-Zertifikat verwendet, das von einer Zertifizierungsstelle ausgestellt wurde, die sich nicht auf dieser Liste von Root-Zertifikaten befindet, können die OAuth- und Streaming-Aktionen auf einer vom Kunden gehosteten Looker-Instanz möglicherweise nicht verwendet werden.

Eine Liste der Aktionen, die für die Unterstützung gestreamter Ergebnisse oder OAuth konfiguriert wurden, finden Sie in der Dokumentation auf der Seite Administratoreinstellungen – Aktionen in der Liste der integrierten Looker-Dienste.

Auf dieser Seite wird beschrieben, wie Sie einen lokalen Action Hub-Server einrichten, um Looker-Aktionen zu verwenden, die gestreamte Ergebnisse unterstützen oder Google OAuth verwenden. Sie können einen eigenen lokalen Action Hub-Server einrichten, indem Sie entweder einen Container oder eine virtuelle Maschine (VM) erstellen, auf der eine geklonte Kopie des Codes des Looker Action Hub-Repositorys gehostet wird. Führen Sie dann die folgenden Schritte aus, die in den folgenden Abschnitten ausführlicher beschrieben werden:

  1. Erstellen Sie eine Container- oder VM-Einrichtung (virtuelle Maschine) für den Action Hub-Server.
  2. Konfigurieren Sie die Google OAuth-Anmeldedaten.
  3. Konfigurieren Sie den Google OAuth-Zustimmungsbildschirm.
  4. Richten Sie die Umgebungsvariablen ein.
  5. API-Schlüssel generieren
  6. Starten Sie den neuen Aktionshub.
  7. Fügen Sie Ihrer Looker-Instanz den neuen Aktionshub hinzu.

Container- oder VM-Einrichtung für den Action Hub-Server erstellen

Ihre VM oder Ihr Container sollte die folgenden Zuweisungs- und Netzwerkanforderungen und Abhängigkeiten erfüllen:

Looker empfiehlt, diesem Container oder dieser VM zwei CPU-/vCPU-Threads und mindestens 2 GB Arbeitsspeicher zuzuweisen. Wenn Sie eine hohe Auslastung Ihrer Aktionen erwarten, sollten Sie den Arbeitsspeicher auf mehr als 2 GB erhöhen.

Netzwerkanforderungen

Ihr Action-Hub muss entweder eine statische IP-Adresse oder eine Adresse haben, die über ein internes Domain Name System (DNS) aufgelöst werden kann.

Ihr Netzwerk muss die folgenden Kommunikationsanforderungen erfüllen:

  • Die Looker-Instanz muss mit dem Action Hub kommunizieren können.
  • Google Auth muss mit dem Action Hub kommunizieren können.
  • Ein intern verbundener Browser muss den Action Hub erreichen können.
  • Der Action Hub muss die Google Drive-Server erreichen können.

Erforderliche Abhängigkeiten

Wenn Sie das Looker-Aktions-Repository in die neu erstellte VM oder den Container klonen:

  • Node 12.13 muss installiert sein.
  • Führen Sie yarn install aus, um die erforderlichen Pakete zu installieren.

Nachdem Sie Ihre Umgebung eingerichtet haben, müssen Sie in der Google Cloud API Console Google OAuth-Anmeldedaten für Ihren Action Hub-Server erstellen.

Google OAuth-Anmeldedaten konfigurieren

So konfigurieren Sie Google OAuth-Anmeldedaten für Ihre Aktionen:

Google OAuth-Anmeldedaten erstellen

So erstellen Sie Ihre Google OAuth-Client-ID und Ihr Client-Secret:

  1. Rufen Sie die Google Cloud-Seite Ressourcen verwalten auf und klicken Sie auf PROJEKT ERSTELLLEN, um ein neues Projekt zu erstellen.

    Weitere Informationen zum Erstellen eines Projekts finden Sie im Leitfaden Projekte erstellen und verwalten.

  2. Wählen Sie das neue Projekt aus.
  3. Rufen Sie in der linken Seitenleiste der Console die Seite APIs & Dienste > Anmeldedaten auf.
  4. Klicken Sie auf Anmeldedaten erstellen.
  5. Klicken Sie im Drop-down-Menü auf OAuth-Client-ID.
  6. Möglicherweise müssen Sie einen OAuth-Zustimmungsbildschirm konfigurieren. Folgen Sie in diesem Fall der Anleitung im Abschnitt OAuth-Zustimmungsbildschirm konfigurieren weiter unten und fahren Sie dann mit Schritt 7 fort.
  7. Wählen Sie als Anwendungstyp die Option Webanwendung aus.
  8. Geben Sie im Feld Name den Namen Ihrer Anwendung an.
  9. Fügen Sie im Abschnitt Autorisierte JavaScript-Quellen die Looker-Stammadresse hinzu, die Sie intern verwenden.
  10. Legen Sie die Autorisierten Weiterleitungs-URIs für die Google Drive- und Google Tabellen-Konsolen fest. Dabei ist ACTION_HUB_BASE_URL die Adresse Ihres Action Hooks: 
                https://<ACTION_HUB_BASE_URL>/actions/google_sheets/oauth_redirect
            https://<ACTION_HUB_BASE_URL>/actions/google_drive/oauth_redirect
  11. Klicken Sie auf die Schaltfläche Erstellen, um Ihre OAuth-Client-ID und das OAuth-Client-Secret zu generieren. Beide werden später benötigt.

Auf dieser Seite der Google API Console können Sie einen Zustimmungsbildschirm für alle Anwendungen in Ihrem Projekt konfigurieren, auf dem Nutzer Zugriff auf ihre Daten gewähren und einen Link zu rechtlichen oder datenschutzbezogenen Dokumenten bereitstellen können. Wenn Sie diesen Schritt bereits ausgeführt haben oder keinen Zustimmungsbildschirm konfigurieren müssen, überspringen Sie diesen Abschnitt und kehren Sie zum Terminalfenster zurück, um die Umgebungsvariablen festzulegen, wie unter Umgebungsvariablen festlegen weiter unten auf dieser Seite beschrieben.

So konfigurieren Sie den Zustimmungsbildschirm:

  1. Klicken Sie auf Zustimmungsbildschirm konfigurieren.
  2. Wählen Sie aus, ob es sich um eine interne oder externe Anwendung handelt, und klicken Sie auf ERSTELLEN.
  3. Geben Sie den Namen Ihrer Anwendung in das Feld App-Name ein.
  4. Geben Sie unter E-Mail-Adresse für den Nutzersupport eine E-Mail-Adresse ein, die auf dem OAuth-Zustimmungsbildschirm für den Nutzersupport angezeigt werden soll.
  5. Laden Sie optional für das App-Logo eine Bilddatei hoch, die auf dem OAuth-Zustimmungsbildschirm verwendet werden soll.
  6. Geben Sie optional den Link zur Startseite der Anwendung ein, der auf derselben Stammdomain wie Ihr Action Hub gehostet werden sollte.
  7. Optional können Sie im Feld Link zur Datenschutzerklärung der Anwendung einen Link zur Datenschutzerklärung Ihrer App eingeben. Der Link muss auf derselben Stammdomain gehostet werden wie dein Action Hub.
  8. Optional können Sie im Feld Link zu den Nutzungsbedingungen der Anwendung einen Link zu den Nutzungsbedingungen Ihrer Anwendung eingeben. Der Link muss auf derselben Stammdomain wie Ihr Action-Hub gehostet werden.
  9. Klicken Sie im Bereich Autorisierte Domains auf DOMAIN HINZUFÜGEN und geben Sie die Stammdomain ein, die Ihr Action-Hub verwendet.
  10. Geben Sie im Feld Kontaktdaten des Entwicklers eine E-Mail-Adresse ein, unter der Sie für Google erreichbar sind.
  11. Klicken Sie auf SPEICHERN UND FORTFAHREN.
  12. Fügen Sie im Abschnitt Bereiche die Arten von Nutzerdaten hinzu, auf die Ihre Anwendung zugreifen muss. Dazu gehören E-Mail-Adresse, Profil, OpenID und https://mail.google.com. Da diese Liste vertrauliche Nutzerdaten enthält, muss Google Ihren OAuth-Zustimmungsbildschirm überprüfen, bevor er veröffentlicht werden kann.
  13. Klicken Sie auf SPEICHERN UND WEITER.
  14. Optional können Sie im Bereich Testnutzer alle Nutzer hinzufügen, die vor der Bestätigung Zugriff auf den Action Hub haben sollen.
  15. Klicken Sie auf SPEICHERN UND FORTFAHREN.
  16. Klicken Sie auf ZURÜCK ZUM DASHBOARD.
  17. Klicken Sie in der linken Seitenleiste auf Anmeldedaten, um zur Konfiguration Ihrer OAuth-Anmeldedaten zurückzukehren.

Wenn Sie den OAuth-Zustimmungsbildschirm konfiguriert haben und Google OAuth-Anmeldedaten konfigurieren waren, kehren Sie zu Schritt 7 dieses Verfahrens zurück und schließen Sie die Konfiguration der Anmeldedaten ab. Andernfalls können Sie zu Ihrem Terminalfenster zurückkehren, um die Umgebungsvariablen festzulegen.

Umgebungsvariablen festlegen

Legen Sie in Ihrer VM- oder Containerumgebung die folgenden Umgebungsvariablen fest: 

    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>

Sie sollten dieselben OAuth client ID und OAuth client secret für Google Drive und Google Tabellen verwenden können. Es ist jedoch am besten, beide Sätze von Google API-Tokens festzulegen.

Legen Sie auch den Verschlüsselungsschlüssel fest: 

    CIPHER_MASTER="<hex aes-256 key>"

Dieser Schlüssel wird nicht für die Langzeitverschlüsselung verwendet. Es wird nur zur Verschlüsselung von state während eines OAuth-Ablaufs verwendet. Das folgende Beispiel zeigt einen Hex-Schlüssel vom Typ aes-256: 

    C4EFBBE2C364248419776459A00F2F4017CE77E29D9E8F64940687EA440A0CC9

API-Schlüssel generieren

Führen Sie den folgenden Befehl aus, um den API-Schlüssel abzurufen:

y arn generate-api-key

Bewahren Sie den generierten Schlüssel für die spätere Verwendung bei der Einrichtung auf. Dieser Schlüssel wird anhand des ACTION_HUB_SECRET generiert.

Lokalen Action Hub-Server starten

Führen Sie den folgenden Befehl aus, um den Action-Hub zu starten:

yarn start

Looker-Instanz einen Action Hub hinzufügen

So fügen Sie Ihrer Looker-Instanz Ihren Action Hub hinzu:

  1. Rufen Sie in Looker im Bereich Verwaltung die Seite Aktionen unter Plattform auf.
  2. Scrollen Sie auf der Seite ganz nach unten und klicken Sie auf die Schaltfläche Add Action Hub (Aktions-Hub hinzufügen).
  3. Geben Sie den ACTION_HUB_BASE_URL ein und klicken Sie auf Add Action Hub (Aktions-Hub hinzufügen). Ihr Aktionshub sollte unter einer neuen Überschrift mit seinem Namen und ACTION_HUB_BASE_URL angezeigt werden. Ihre Aktionen für Google Drive und Google Tabellen sollten unter dieser Überschrift angezeigt werden.
  4. Wenn die Verbindung fehlschlägt, geben Sie den zuvor generierten api-key in das Feld Authorization Token (Autorisierungstoken) ein und klicken Sie oben in der Überschrift des Action Hub auf den Link Refresh (Aktualisieren).
  5. Aktivieren Sie Ihre Google Drive- und Google Tabellen-Aktionen und prüfen Sie, ob sie im Action Hub richtig konfiguriert sind.

Nächster Schritt

Im nächsten Schritt veröffentlichen Sie die Anwendung, die Sie in der Google API Console erstellt haben. Wenn Sie die App veröffentlichen möchten, rufen Sie den OAuth-Zustimmungsbildschirm auf und klicken Sie auf die Schaltfläche Zur Überprüfung einreichen. Die Veröffentlichung des Antrags kann einige Zeit dauern und erfordert einige Überprüfungsschritte bei Google.