Ein Webhook-Bereitstellungsendpunkt fordert Ihre Looker-Instanz auf, Änderungen aus einem Git-Branch, einem Commit-SHA oder einem Tag-Namen bereitzustellen und die Änderungen dann in die Produktionsversion Ihres Projekts zu übertragen. Die Formate für den Looker-Bereitstellungs-Webhook finden Sie im Abschnitt Mit Webhooks bereitstellen. Bei den meisten Projekten übernimmt Looker die Git-Integrationen und stellt Updates in der Produktion bereit. Sie müssen also keinen Bereitstellungs-Webhook einrichten.
Sie müssen jedoch einen Bereitstellungs-Webhook verwenden, um Änderungen in die Produktion zu übertragen, wenn einer der folgenden Umstände zutrifft:
- Sie übertragen Updates außerhalb der Looker-IDE in den Remote-Produktions-Branch. Das ist in Entwicklungs-Workflows mit Staging-Umgebungen üblich.
- Sie möchten einen Webhook verwenden, um mit dem erweiterten Bereitstellungsmodus bereitzustellen. So können Sie den Branch, den Commit-SHA oder den Tag-Namen angeben, der für die Produktionsversion des Looker-Projekts verwendet wird.
- Sie haben Ihr Looker-Projekt mit Git Pull-Anfragen konfiguriert. Das bedeutet, dass Sie einen Bereitstellungs-Webhook auslösen müssen, sobald Sie eine Pull-Anfrage zusammenführen, um diese Änderungen in Ihre Looker-Produktionsumgebung zu übertragen. Die meisten Git-Hostingdienste bieten Möglichkeiten, dies zu automatisieren, wenn Sie den Webhook der Benutzeroberfläche Ihres Git-Anbieters hinzufügen.
Wenn Sie Looker-Administrator sind, können Sie den Bereitstellungs-Webhook so konfigurieren, dass ein Secret erforderlich ist, damit er nur von autorisierten Parteien ausgelöst werden kann. Looker-Entwickler, die keine Administratoren sind, können die Seite Projektkonfiguration aufrufen, die Optionen dort aber nicht ändern.
Bereitstellungs-Secret hinzufügen
Looker unterstützt Web-Secrets für die folgenden Git-Anbieter: GitHub, Bitbucket Server und GitLab.
So legen Sie ein Webhook-Bereitstellungs-Secret für Ihr Projekt fest:
- Öffnen Sie im Entwicklungsmodus Ihr Projekt und wählen Sie in der IDE-Navigationsleiste das Symbol für die Einstellungen aus, um den Bereich mit den Projekteinstellungen zu öffnen.
- Wählen Sie im Bereich mit den Projekteinstellungen Konfiguration aus.
- Scrollen Sie zum Abschnitt Webhook-Bereitstellungs-Secret und klicken Sie auf Webhook-Secret festlegen. Looker generiert automatisch ein Secret-Token. Sie können dieses automatisch generierte Secret verwenden oder ein eigenes Secret-Token eingeben.
- Kopieren Sie das Webhook-Bereitstellungs-Secret und fügen Sie es in eine Textdatei ein, damit Sie es zur Hand haben, wenn Sie das Secret dem Webhook für Ihr Repository hinzufügen müssen. Das gilt unabhängig davon, ob Sie das automatisch generierte Secret verwenden oder ein eigenes Secret erstellen. Kopieren Sie es jetzt. Sobald Sie die Seite Projektkonfiguration verlassen oder aktualisieren, verlieren Sie den Zugriff auf das Webhook-Bereitstellungs-Secret. Sie müssen das Webhook-Bereitstellungs-Secret ändern oder entfernen, um wieder auf Ihr Projekt zugreifen zu können.
- Klicken Sie auf Projektkonfiguration speichern.
Für den Bereitstellungs-Webhook Ihres Projekts ist jetzt dieses Secret erforderlich. Bei Projekten, die eine Looker-Staging-Instanz verwenden, müssen Sie das Webhook-Bereitstellungs-Secret in den HTTP-Header einfügen, um in der Produktion bereitzustellen. Bei Projekten mit Git-Pull-Anfrage-Integration müssen Sie die Benutzeroberfläche Ihres Git-Anbieters aufrufen, um das Secret dem Webhook für Ihr Repository hinzuzufügen.
Secret für den Webhook Ihres Git-Repositorys konfigurieren
Bei Projekten mit Git-Pull-Anfrage-Integration müssen Sie die Benutzeroberfläche Ihres Git-Anbieters aufrufen, um das Secret dem Webhook für Ihr Repository hinzuzufügen, wenn Sie Ihrem LookML-Projekt ein Bereitstellungs-Webhook-Secret hinzugefügt haben. Hier ein Beispiel, wie Sie das mit GitHub tun:
Rufen Sie auf der Website Ihres Git-Anbieters die Repository-Einstellungen Ihres Projekts auf.
TIPP: Wenn Sie Ihr Projekt für die Git-Integration eingerichtet haben, können Sie die Option Projekt in Git ansehen im Git-Menü Ihres Projekts in Looker verwenden.
Klicken Sie in den Einstellungen Ihres Repositorys auf Webhooks.
Suchen Sie den Webhook für Ihr LookML-Projekt und klicken Sie auf die Schaltfläche Bearbeiten.
Fügen Sie im Feld Secret das Webhook-Bereitstellungs-Secret ein, das Sie im Abschnitt Webhook-Bereitstellungs-Secret in Looker kopiert haben.
Klicken Sie auf Webhook aktualisieren.
Das Webhook-Secret ist jetzt erforderlich, um Änderungen in der Produktionsversion Ihres Projekts bereitzustellen. Bei Bedarf können Sie das Secret ändern oder aus Ihrem Projekt entfernen.
Bereitstellungs-Secret ändern
Wenn Ihrem Projekt ein Webhook-Bereitstellungs-Secret hinzugefügt wurde, können Sie als Looker-Administrator das Secret so ändern:
- Wählen Sie in Ihrem Projekt in der Navigationsleiste das Symbol Einstellungen aus.
- Scrollen Sie zum Abschnitt Webhook-Bereitstellungs-Secret und klicken Sie auf Secret zurücksetzen. Looker generiert automatisch ein neues Secret-Token. Sie können dieses automatisch generierte Secret verwenden oder ein eigenes neues Secret-Token eingeben.
- Kopieren Sie das Webhook-Bereitstellungs-Secret und fügen Sie es in eine Textdatei ein, damit Sie es zur Hand haben, wenn Sie das Secret dem Webhook für Ihr Repository hinzufügen müssen. Das gilt unabhängig davon, ob Sie das automatisch generierte Secret verwenden oder ein eigenes Secret erstellen. Kopieren Sie es jetzt aus der Zwischenablage. Sobald Sie die Seite Projektkonfiguration verlassen oder aktualisieren, verlieren Sie den Zugriff auf das Webhook-Bereitstellungs-Secret. Sie müssen dann zurückkehren und es ändern oder es ganz entfernen.
- Klicken Sie auf Projektkonfiguration speichern.
Wenn Ihr Projekt mit der Git-Pull-Anfrage-Integration konfiguriert ist, müssen Sie auch die Benutzeroberfläche Ihres Git-Anbieters aufrufen, um das Webhook-Secret für Ihr Repository zu aktualisieren.
Bereitstellungs-Secret entfernen
Wenn Ihrem Projekt ein Webhook-Bereitstellungs-Secret hinzugefügt wurde, können Sie als Looker-Administrator das Secret so entfernen:
- Wählen Sie in Ihrem Projekt in der Navigationsleiste das Symbol Einstellungen aus.
- Scrollen Sie zum Abschnitt Webhook-Bereitstellungs-Secret und klicken Sie auf Secret entfernen. An dieser Stelle können Sie den Vorgang abbrechen und das Bereitstellungs-Secret beibehalten, indem Sie auf Nicht entfernen klicken.
- Klicken Sie auf Projektkonfiguration speichern, um das Webhook-Bereitstellungs-Secret endgültig aus Ihrem Projekt zu entfernen.
Für den Bereitstellungs-Webhook Ihres Projekts ist kein Secret mehr erforderlich. Wenn Ihr Projekt mit der Git-Pull-Anfrage-Integration konfiguriert ist, können Sie jetzt die Benutzeroberfläche Ihres Git-Anbieters aufrufen, um das Webhook-Secret aus Ihrem Repository zu entfernen. Looker selbst prüft nicht mehr, ob beim Git-Anbieter ein Secret vorhanden ist. Es schadet also nicht, wenn für den Webhook Ihres Git-Repositorys weiterhin ein Secret konfiguriert ist. Wenn Sie das Secret aus Ihrem Git-Repository entfernen möchten, finden Sie unter Secret für den Webhook Ihres Git-Repositorys konfigurieren Informationen zum Bearbeiten des Secrets auf der Benutzeroberfläche eines Git-Anbieters.