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 zu abgebrochenen Abfragen kommen, wenn sie Daten an Aktionen senden oder planen, die gestreamte Ergebnisse unterstützen. Möglicherweise können sie auch 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 kundengehosteten Instanzen, die sich für Lösungen interessieren, die für ihre Instanzarchitektur geeignet sind, finden entsprechende Empfehlungen im Abschnitt Überlegungen zu kundengehosteten Instanzen auf der Dokumentationsseite Daten über einen Action Hub freigeben.

Wenn für die Instanz ein SSL-Zertifikat verwendet wird, das von einer Zertifizierungsstelle (Certificate Authority, CA) ausgestellt wurde, die nicht in dieser Liste von Root-Zertifikaten enthalten ist, sind die OAuth- und Streamingvorgänge möglicherweise nicht auf einer vom Kunden gehosteten Looker-Instanz verfügbar.

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

Auf dieser Seite wird beschrieben, wie Sie einen lokalen Action Hub-Server starten, 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 VM erstellen, auf der eine geklonte Kopie des Codes aus dem Looker Action Hub-Repository gehostet wird. Führen Sie dann die folgenden Schritte aus, die in den folgenden Abschnitten genauer beschrieben werden:

1. Container- oder VM-Einrichtung für den Action Hub-Server erstellen
2. Google OAuth-Anmeldedaten konfigurieren
3. Google OAuth-Zustimmungsbildschirm konfigurieren
4. Umgebungsvariablen einrichten
5. API-Schlüssel generieren
6. Neuen Aktionshub starten
7. Fügen Sie Ihrer Looker-Instanz den neuen Aktionshub hinzu.

Hinweis :Wenn Sie eine Berechtigung haben, die nur Zugriff auf bestimmte Seiten im Admin-Bereich bietet, z. B. manage_schedules, manage_themes oder see_admin, aber nicht die Administratorrolle, sind die hier beschriebenen Seiten möglicherweise nicht im Admin-Bereich sichtbar.

Container- oder VM-Einrichtung für den Aktionshub-Server erstellen

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

• Empfohlene Speicherzuweisung
• Netzwerkanforderungen
• Erforderliche Abhängigkeiten

Empfohlene Arbeitsspeicherzuweisung

Looker empfiehlt, für diesen Container oder diese VM 2 Threads der CPU/vCPU und mindestens 2 GB Arbeitsspeicher zuzuweisen. Wenn Sie eine intensive Nutzung 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 auf den Aktionshub zugreifen können.
• Der Aktionshub muss die Google Drive-Server erreichen können.

Erforderliche Abhängigkeiten

Wenn Sie das Looker-Aktionen-Repository in Ihre neu erstellte VM oder Ihren neu erstellten Container klonen:

• Prüfen Sie, ob 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:

• OAuth-Anmeldedaten erstellen
• OAuth-Zustimmungsbildschirm konfigurieren

Google OAuth-Anmeldedaten erstellen

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

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 Sie das neue Projekt erstellt haben, wählen Sie es aus.
3. Rufen Sie in der Console in der linken Seitenleiste 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 auf dieser Seite und fahren Sie dann mit Schritt 7 fort.
7. Wählen Sie als Anwendungstyp die Option Webanwendung aus.
8. Geben Sie den Namen Ihrer Anwendung im Feld Name ein.
9. Fügen Sie im Abschnitt Autorisierte JavaScript-Quellen die Looker-Anwendungs-Root-Adresse 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 Hubs:

                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. Sie benötigen beide später.

OAuth-Zustimmungsbildschirm konfigurieren

Auf dieser Seite der Google API Console können Sie einen Zustimmungsbildschirm für alle Anwendungen in Ihrem Projekt konfigurieren. So können Nutzer den Zugriff auf ihre Daten gewähren und erhalten einen Link zu allen rechtlichen Dokumenten oder Datenschutzdokumenten. Wenn Sie diesen Schritt bereits ausgeführt haben oder keinen Einwilligungsbildschirm konfigurieren müssen, überspringen Sie diesen Abschnitt und kehren Sie zu Ihrem Terminalfenster zurück, um Ihre Umgebungsvariablen festzulegen, wie später auf dieser Seite unter Umgebungsvariablen festlegen 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 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, der in derselben Stammdomain wie Ihr Aktionshub gehostet werden sollte.
7. Geben Sie optional im Feld Link zur Datenschutzerklärung der Anwendung einen Link zur Datenschutzerklärung Ihrer Anwendung ein. Der Link muss auf derselben Stammdomain wie Ihr Aktionshub 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 Aktionshub gehostet werden.
9. Klicken Sie im Abschnitt Autorisierte Domains auf DOMAIN HINZUFÜGEN und geben Sie die Stammdomain ein, die von Ihrem Aktionshub verwendet wird.
10. Geben Sie im Feld Kontaktdaten des Entwicklers eine E-Mail-Adresse ein, unter der Google Sie kontaktieren kann.
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 Nutzerinformationen enthält, muss Google Ihren OAuth-Zustimmungsbildschirm bestätigen, bevor sie veröffentlicht werden kann.
13. Klicken Sie auf SPEICHERN UND FORTFAHREN.
14. Optional: Fügen Sie im Bereich Testnutzer alle Nutzer hinzu, die vor der Überprüfung Zugriff auf den Aktionshub 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 gerade dabei waren, Google-OAuth-Anmeldeinformationen zu konfigurieren, kehren Sie zu Schritt 7 dieser Anleitung zurück und schließen Sie die Konfiguration der Anmeldeinformationen ab. Andernfalls können Sie zu Ihrem Terminalfenster zurückkehren, um Ihre 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 Gruppen 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 langfristige Verschlüsselung verwendet, sondern nur zum Verschlüsseln von state während eines OAuth-Ablaufs. Das folgende Beispiel zeigt einen AES-256-Schlüssel im Hexadezimalformat:

    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 bei der Einrichtung auf. Dieser Schlüssel wird auf Grundlage von ACTION_HUB_SECRET generiert.

Lokalen Hub-Server für Aktionen starten

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

yarn start

Action Hub Ihrer Looker-Instanz hinzufügen

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

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

Nächster Schritt

Als Nächstes müssen Sie die Anwendung, die Sie in der Google API Console erstellt haben, veröffentlichen. Klicken Sie zum Veröffentlichen auf der Seite OAuth-Zustimmungsbildschirm auf die Schaltfläche Zur Überprüfung einreichen. Die Veröffentlichung der Anwendung kann einige Zeit in Anspruch nehmen und erfordert einige Überprüfungsschritte durch Google.