Lokalen Action Hub für Aktionen einrichten, die OAuth und Streaming verwenden

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 hängenden Abfragen kommen und sie können möglicherweise keine OAuth-Aktionen konfigurieren.

Damit Sie Looker-Integrationen verwenden können, müssen der Looker Action Hub und die Looker-Instanz miteinander kommunizieren können. Administratoren von vom Kunden gehosteten Instanzen, die mehr über Lösungen erfahren möchten, die für ihre Instanzarchitektur geeignet sind, können die Empfehlungen im Abschnitt Hinweise zu vom Kunden gehosteten Instanzen auf der Dokumentationsseite Daten über einen Action Hub lesen.

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.

Die Aktionen, die für die Unterstützung gestreamter Ergebnisse oder OAuth konfiguriert sind, finden Sie in der Liste der integrierten Dienste von Looker auf der Dokumentationsseite Administratoreinstellungen – Aktionen.

Auf dieser Seite wird beschrieben, wie Sie einen lokalen Action Hub-Server für Looker-Aktionen einrichten, die gestreamte Ergebnisse unterstützen oder Google OAuth verwenden. Sie können Ihren eigenen lokalen Action Hub-Server einrichten. Erstellen Sie dazu entweder einen Container oder eine virtuelle Maschine (VM), auf der eine geklonte Kopie des Looker Action Hub-Repositorys gehostet wird, und führen Sie dann diese Schritte aus, wie in den folgenden Abschnitten genauer beschrieben:

  1. Erstellen Sie einen Container oder eine virtuelle Maschine (VM) für den Action Hub-Server.
  2. Konfigurieren Sie Google OAuth-Anmeldedaten.
  3. Konfigurieren Sie den Google OAuth-Zustimmungsbildschirm.
  4. Richten Sie die Umgebungsvariablen ein.
  5. Generieren Sie einen API-Schlüssel.
  6. Starte den neuen Action Hub.
  7. Fügen Sie der Looker-Instanz den neuen Action-Hub 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 2 CPU/vCPU-Threads und mindestens 2 GB Arbeitsspeicher zuzuweisen. Wenn Sie davon ausgehen, dass Ihre Aktionen intensiv genutzt werden, sollten Sie den Arbeitsspeicher auf über 2 GB erhöhen.

Netzwerkanforderungen

Der 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 unterstützen:

  • 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 neu erstellten Container klonen:

  • Achten Sie darauf, dass Node 12.13 installiert ist.
  • 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 Ihren Clientschlüssel:

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

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

  2. Nachdem das neue Projekt erstellt wurde, wählen Sie es aus.
  3. Gehen Sie in der linken Seitenleiste der Konsole zur Seite APIs und Dienste > Anmeldedaten.
  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. Sollte dies der Fall sein, folgen Sie der Anleitung im Abschnitt OAuth-Zustimmungsbildschirm konfigurieren weiter unten auf dieser Seite und fahren Sie mit Schritt 7 fort.
  7. Wählen Sie als Anwendungstyp die Option Webanwendung aus.
  8. Geben Sie den Namen Ihrer Anwendung in das Feld Name ein.
  9. Fügen Sie im Abschnitt Autorisierte JavaScript-Quellen die Adresse der Looker-Stammanwendung hinzu, die Sie intern verwenden.
  10. Legen Sie die autorisierten Weiterleitungs-URIs für die Konsole für Google Drive und Google Tabellen fest, wobei ACTION_HUB_BASE_URL die Adresse Ihres Action Hub ist:
                https://<ACTION_HUB_BASE_URL>/actions/google_sheets/oauth_redirect
                https://<ACTION_HUB_BASE_URL>/actions/google_drive/oauth_redirect
            
  11. Klicke auf die Schaltfläche Erstellen, um deine OAuth-Client-ID und den OAuth-Clientschlüssel zu generieren. Beides benötigen Sie später.

Auf dieser Seite der Google API Console können Sie für alle Anwendungen in Ihrem Projekt einen Zustimmungsbildschirm konfigurieren, über den Nutzer Zugriff auf ihre Daten gewähren sowie einen Link zu rechtlichen oder Datenschutzdokumenten bereitstellen können. Wenn Sie diesen Schritt bereits abgeschlossen 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. Legen Sie fest, ob es sich um eine interne oder externe Anwendung handelt, und klicken Sie auf ERSTELLEN.
  3. Geben Sie den Namen Ihrer App in das Feld App-Name ein.
  4. Geben Sie unter E-Mail-Adresse des Nutzersupports eine E-Mail-Adresse ein, die auf dem OAuth-Zustimmungsbildschirm für den Nutzersupport angezeigt werden soll.
  5. Optional können Sie für das App-Logo eine Bilddatei hochladen, die auf dem OAuth-Zustimmungsbildschirm verwendet werden soll.
  6. Optional können Sie den Link zur Startseite der Anwendung eingeben. Dieser sollte sich auf derselben Stammdomain befinden wie Ihr Action Hub.
  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 wie Ihr Action Hub gehostet werden.
  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 Abschnitt 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 Typen 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 Nutzerinformationen enthält, muss Google Ihren OAuth-Zustimmungsbildschirm überprüfen, bevor er veröffentlicht werden kann.
  13. Klicken Sie auf SPEICHERN UND FORTFAHREN.
  14. Optional können Sie im Abschnitt 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, gehen Sie bei der Konfiguration der Google OAuth-Anmeldedaten zu Schritt 7 des Vorgangs 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 folgende 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 für Google Drive und Google Tabellen dieselbe OAuth client ID und dieselbe OAuth client secret verwenden können. Es empfiehlt sich jedoch, 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, sondern nur zur Verschlüsselung von state während eines OAuth-Vorgangs. Im Folgenden finden Sie ein Beispiel für einen hexadezimalen aes-256-Schlüssel:

    C4EFBBE2C364248419776459A00F2F4017CE77E29D9E8F64940687EA440A0CC9

API-Schlüssel generieren

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

y arn generate-api-key

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

Lokalen Action Hub-Server starten

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

yarn start

Action Hub zur Looker-Instanz hinzufügen

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

  1. Gehen Sie in Looker im Admin-Bereich unter Plattform zur Seite Aktionen.
  2. Scrollen Sie zum Ende der Seite und klicken Sie auf die Schaltfläche Add Action Hub.
  3. Geben Sie Ihre ACTION_HUB_BASE_URL ein und klicken Sie auf Add Action Hub. Der Action Hub sollte unter einer neuen Überschrift mit dem 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 Aktionen für Google Drive und Google Tabellen und prüfen Sie im Action Hub, ob sie richtig konfiguriert sind.

Nächster Schritt

Im nächsten Schritt veröffentlichen Sie die Anwendung, die Sie in der Google API Console erstellt haben. Rufen Sie zum Veröffentlichen die Seite OAuth-Zustimmungsbildschirm auf und klicken Sie auf die Schaltfläche Zur Überprüfung einreichen. Die Veröffentlichung des Antrags kann einige Zeit in Anspruch nehmen und einige Überprüfungsschritte bei Google erfordern.